Version: 2023.2
LanguageEnglish
  • C#

PlayableBehaviour.OnBehaviourPause

Suggest a change

Success!

Thank you for helping us improve the quality of Unity Documentation. Although we cannot accept all submissions, we do read each suggested change from our users and will make updates where applicable.

Close

Submission failed

For some reason your suggested change could not be submitted. Please <a>try again</a> in a few minutes. And thank you for taking the time to help us improve the quality of Unity Documentation.

Close

Cancel

Declaration

public void OnBehaviourPause(Playables.Playable playable, Playables.FrameData info);

Parameters

playable The Playable that owns the current PlayableBehaviour.
info A FrameData structure that contains information about the current frame context.

Description

This method is invoked when one of the following situations occurs:

The effective play state during traversal is changed to PlayState.Paused. This state is indicated by FrameData.effectivePlayState.

The PlayableGraph is stopped while the playable play state is Playing. This state is indicated by PlayableGraph.IsPlaying returning true.