docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class ParticleControlPlayable

    Playable that synchronizes a particle system simulation.

    Inheritance
    object
    PlayableBehaviour
    ParticleControlPlayable
    Implements
    IPlayableBehaviour
    ICloneable
    Inherited Members
    PlayableBehaviour.OnGraphStart(Playable)
    PlayableBehaviour.OnGraphStop(Playable)
    PlayableBehaviour.OnPlayableCreate(Playable)
    PlayableBehaviour.OnBehaviourDelay(Playable, FrameData)
    PlayableBehaviour.PrepareData(Playable, FrameData)
    PlayableBehaviour.ProcessFrame(Playable, FrameData, object)
    PlayableBehaviour.Clone()
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: UnityEngine.Timeline
    Assembly: Unity.Timeline.dll
    Syntax
    public class ParticleControlPlayable : PlayableBehaviour, IPlayableBehaviour, ICloneable

    Properties

    particleSystem

    The particle system to control

    Declaration
    public ParticleSystem particleSystem { get; }
    Property Value
    Type Description
    ParticleSystem

    Methods

    Create(PlayableGraph, ParticleSystem, uint)

    Creates a Playable with a ParticleControlPlayable behaviour attached

    Declaration
    public static ScriptPlayable<ParticleControlPlayable> Create(PlayableGraph graph, ParticleSystem component, uint randomSeed)
    Parameters
    Type Name Description
    PlayableGraph graph

    The PlayableGraph to inject the Playable into.

    ParticleSystem component

    The particle system to control

    uint randomSeed

    A random seed to use for particle simulation

    Returns
    Type Description
    ScriptPlayable<ParticleControlPlayable>

    Returns the created Playable.

    Initialize(ParticleSystem, uint)

    Initializes the behaviour with a particle system and random seed.

    Declaration
    public void Initialize(ParticleSystem ps, uint randomSeed)
    Parameters
    Type Name Description
    ParticleSystem ps

    The particle system to control

    uint randomSeed

    A random seed to use for particle simulation

    OnBehaviourPause(Playable, FrameData)

    This function is called when the Playable play state is changed to PlayState.Paused.

    Declaration
    public override void OnBehaviourPause(Playable playable, FrameData info)
    Parameters
    Type Name Description
    Playable playable

    The playable this behaviour is attached to.

    FrameData info

    A FrameData structure that contains information about the current frame context.

    Overrides
    PlayableBehaviour.OnBehaviourPause(Playable, FrameData)

    OnBehaviourPlay(Playable, FrameData)

    This function is called when the Playable play state is changed to Playables.PlayState.Playing.

    Declaration
    public override void OnBehaviourPlay(Playable playable, FrameData info)
    Parameters
    Type Name Description
    Playable playable

    The Playable that owns the current PlayableBehaviour.

    FrameData info

    A FrameData structure that contains information about the current frame context.

    Overrides
    PlayableBehaviour.OnBehaviourPlay(Playable, FrameData)

    OnPlayableDestroy(Playable)

    This function is called when the Playable that owns the PlayableBehaviour is destroyed.

    Declaration
    public override void OnPlayableDestroy(Playable playable)
    Parameters
    Type Name Description
    Playable playable

    The playable this behaviour is attached to.

    Overrides
    PlayableBehaviour.OnPlayableDestroy(Playable)

    PrepareFrame(Playable, FrameData)

    This function is called during the PrepareFrame phase of the PlayableGraph.

    Declaration
    public override void PrepareFrame(Playable playable, FrameData data)
    Parameters
    Type Name Description
    Playable playable

    The Playable that owns the current PlayableBehaviour.

    FrameData data

    A FrameData structure that contains information about the current frame context.

    Overrides
    PlayableBehaviour.PrepareFrame(Playable, FrameData)

    Implements

    IPlayableBehaviour
    ICloneable
    In This Article
    Back to top
    Copyright © 2025 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)