Experimental: this API is experimental and might be changed or removed in the future.

VisualEffect

class in UnityEngine.Experimental.VFX

/

Inherits from:Behaviour

Switch to Manual

Description

The visual effect class that references an VisualEffectAsset instance within the Scene.

Variables

aliveParticleCountReturns the sum of all alive particles within the visual effect.
culledIs this visual effect culled (not visible) from any camera ? (Read Only)
pauseThe paused state of visual effect.
playRateA multiplier applied to the delta time when updating the VisualEffect. The default value is 1.0f.
resetSeedOnPlayControls whether the visual effect generates a new random number to seed the random number generator for each call to VisualEffect.Play function.
startSeedThe initial seed used used for internal random number generator.
visualEffectAssetThe visual effect asset used by the visual effect.

Constructors

VisualEffectThe visual effect constructor.

Public Functions

AdvanceOneFrameIf VisualEffect.pause is true, the method processes the next visual effect update for exactly one frame with the current delta time.
CreateVFXEventAttributeCreate a new event attribute class.
GetAnimationCurveGets a named exposed animation curve.
GetBoolGet a named exposed boolean.
GetFloatGets a named exposed float (o.
GetGradientGets a named exposed gradient.
GetIntGet named exposed integer.
GetMatrix4x4Gets named exposed Matrix4x4.
GetMeshGets named exposed mesh.
GetTextureGets named exposed texture.
GetTextureDimensionGet expected texture dimension for a named exposed texture.
GetUIntGet named exposed unsigned integer.
GetVector2Gets named exposed Vector2.
GetVector3Gets named exposed Vector3.
GetVector4Gets named exposed Vector4.
HasAnimationCurveReturns true if visual effect can override this named animation curve.
HasBoolReturns true if the visual effect can override the boolean.
HasFloatReturns true if the visual effect can override this named float.
HasGradientReturns true if visual effect can override this named gradient.
HasIntReturns true if the visual effect can override this named integer.
HasMatrix4x4Returns true if visual effect can override this named Matrix4x4.
HasMeshReturns true if visual effect can override this named mesh.
HasTextureReturns true if visual effect can override this named texture.
HasUIntReturns true if the visual effect can override this named unsigned integer.
HasVector2Returns true if visual effect can override this named Vector2.
HasVector3Returns true if visual effect can override this named Vector3.
HasVector4Returns true if visual effect can override this named Vector4.
PlaySends a stop event to all Spawn systems. If VisualEffect.resetSeedOnPlay is true, this methods recomputes a new random seed for the random value generator and resets internal total time to zero.
ReinitReintialize visual effect.
ResetOverrideSets the overridden state to false, and restores the default value that is specified in the visual effect Asset.
SendEventSend a custom named event.
SetAnimationCurveSets a named animation curve value.
SetBoolSets the value for a named boolean.
SetFloatSets the value for a named float.
SetGradientSets a named gradient value.
SetIntSets the value for a named integer.
SetMatrix4x4Sets a named Matrix4x4 value.
SetMeshSets a named mesh value.
SetTextureSets a named texture value.
SetUIntSets the value for a named unsigned integer.
SetVector2Sets the value for a named Vector2.
SetVector3Sets the value for a named Vector3.
SetVector4Sets a named Vector4 value.
StopSend a stop event to all Spawn systems.

Inherited members

Variables

enabled启用的 Behaviour 可更新,禁用的 Behaviour 不可更新。
isActiveAndEnabledHas the Behaviour had active and enabled called?
gameObject此组件附加到的游戏对象。始终将组件附加到游戏对象。
tag此游戏对象的标签。
transform附加到此 GameObject 的 Transform。
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
name对象的名称。

Public Functions

BroadcastMessage调用此游戏对象或其任何子项中的每个 MonoBehaviour 上名为 methodName 的方法。
CompareTag此游戏对象是否使用 tag 进行了标记?
GetComponent如果游戏对象附加了类型为 type 的组件,则将其返回,否则返回 null。
GetComponentInChildren使用深度首次搜索返回 GameObject 或其任何子项中类型为 type 的组件。
GetComponentInParent返回 GameObject 或其任何父项中类型为 type 的组件。
GetComponents返回 GameObject 中类型为 type 的所有组件。
GetComponentsInChildren返回 GameObject 或其任何子项中类型为 type 的所有组件。
GetComponentsInParent返回 GameObject 或其任何父项中类型为 type 的所有组件。
SendMessage调用此游戏对象中的每个 MonoBehaviour 上名为 methodName 的方法。
SendMessageUpwards调用此游戏对象中的每个 MonoBehaviour 上或此行为的每个父级上名为 methodName 的方法。
GetInstanceID返回对象的实例 ID。
ToString返回 GameObject 的名称。

Static Functions

Destroy删除 GameObject、组件或资源。
DestroyImmediate立即销毁对象 /obj/。强烈建议您改用 Destroy。
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfType返回第一个类型为 type 的已加载的激活对象。
FindObjectsOfType返回所有类型为 type 的已加载的激活对象的列表。
Instantiate克隆 original 对象并返回克隆对象。

Operators

bool该对象是否存在?
operator !=比较两个对象是否引用不同的对象。
operator ==比较两个对象引用,判断它们是否引用同一个对象。