Class VFXOutputEventAbstractHandler

A VFXOutputEventAbstractHandler is an API helper that hooks into an Output Event to allow you to execute scripts based on the event.

Inheritance
Object
Object
Component
Behaviour
MonoBehaviour
VFXOutputEventAbstractHandler
Inherited Members
UnityEngine.Object.FindObjectsOfType<T>(System.Boolean)
UnityEngine.Object.FindObjectOfType<T>(System.Boolean)
Namespace: UnityEngine.VFX.Utility
Syntax
[ExecuteAlways]
[RequireComponent(typeof(VisualEffect))]
public abstract class VFXOutputEventAbstractHandler : MonoBehaviour

Fields

executeInEditor

Property to enable or disable the execution in editor.

Declaration
public bool executeInEditor
Field Value
Type Description
Boolean

outputEvent

The name of the output event to catch.

Declaration
public ExposedProperty outputEvent
Field Value
Type Description
ExposedProperty

Properties

canExecuteInEditor

Returns false if this output event handler can only be executed in play mode or runtime.

Declaration
public abstract bool canExecuteInEditor { get; }
Property Value
Type Description
Boolean

m_VisualEffect

The VisualEffect emitter of the output event.

Declaration
protected VisualEffect m_VisualEffect { get; }
Property Value
Type Description
VisualEffect

Methods

OnDisable()

This function is called when the behavior becomes disabled.

Declaration
protected virtual void OnDisable()

OnEnable()

This function is called when the object becomes enabled and active.

Declaration
protected virtual void OnEnable()

OnVFXOutputEvent(VFXEventAttribute)

This function is called when the specified event in outputEvent on the attached VisualEffect is triggered. The VFXEventAttribute passed as parameter is temporary and can be modified in a later process.

Declaration
public abstract void OnVFXOutputEvent(VFXEventAttribute eventAttribute)
Parameters
Type Name Description
VFXEventAttribute eventAttribute

The VFXEventAttribute handling properties from the spawn event.