Documentation

Unity Engine

User Manual

Script Reference

Unity Engine

SamplePlayableGraph(PlayableGraph, int, float)

Samples the specified output index of a PlayableGraph and also records modified properties when in Animation mode.
Read time 1 minuteLast updated 6 days ago

Definition

  • Type: Method
  • Namespace: UnityEditor
  • Assembly: UnityEditor.CoreModule
public static void SamplePlayableGraph(PlayableGraph graph, int index, float time)

Parameters

graph

PlayableGraph
The PlayableGraph to sample.

index

int
The output index to sample in the Playable Graph.

time

float
The time at which to sample.

Remarks

To successfully use this method, AnimationMode.BeginSampling must be called before this method and AnimationMode.EndSampling must be called after. If a property is no longer sampled (for example, through AnimationMode.SampleAnimationClip, AnimationMode.SamplePlayableGraph, or AnimationMode.AddPropertyModification), the property reverts to its original value when AnimationMode.EndSampling is called.