Version: 2017.3 (switch to 2017.4)
LanguageEnglish
  • C#
  • JS

Script language

Select your preferred scripting language. All code snippets will be displayed in this language.

FrameData

struct in UnityEngine.Playables

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

Description

This structure contains the frame information a Playable receives in Playable.PrepareFrame.

Properties

deltaTimeTime difference between this frame and the preceding frame.
effectiveParentDelayThe accumulated delay of the parent Playable during the PlayableGraph traversal.
effectiveParentSpeedThe accumulated speed of the parent Playable during the PlayableGraph traversal.
effectiveSpeedThe accumulated speed of the Playable during the PlayableGraph traversal.
effectiveWeightThe accumulated weight of the Playable during the PlayableGraph traversal.
evaluationTypeIndicates the type of evaluation that caused PlayableGraph.PrepareFrame to be called.
frameIdThe current frame identifier.
seekOccurredIndicates that the local time was explicitly set.
timeHeldIndicates the local time did not advance because it has reached the duration and the extrapolation mode is set to Hold.
timeLoopedIndicates the local time wrapped because it has reached the duration and the extrapolation mode is set to Loop.
weightThe weight of the current Playable.

Did you find this page useful? Please give it a rating: