Version: 2018.3 (switch to 2019.1)
LanguageEnglish
  • C#
Experimental: this API is experimental and might be changed or removed in the future.

VisualEffect

class in UnityEngine.Experimental.VFX

/

Inherits from:Behaviour

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

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

Properties

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 Methods

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

Properties

enabledEnabled Behaviours are Updated, disabled Behaviours are not.
isActiveAndEnabledHas the Behaviour had active and enabled called?
gameObjectThe game object this component is attached to. A component is always attached to a game object.
tagThe tag of this game object.
transformThe Transform attached to this GameObject.
hideFlagsShould the object be hidden, saved with the Scene or modifiable by the user?
nameThe name of the object.

Public Methods

BroadcastMessageCalls the method named methodName on every MonoBehaviour in this game object or any of its children.
CompareTagIs this game object tagged with tag ?
GetComponentReturns the component of Type type if the game object has one attached, null if it doesn't.
GetComponentInChildrenReturns the component of Type type in the GameObject or any of its children using depth first search.
GetComponentInParentReturns the component of Type type in the GameObject or any of its parents.
GetComponentsReturns all components of Type type in the GameObject.
GetComponentsInChildrenReturns all components of Type type in the GameObject or any of its children.
GetComponentsInParentReturns all components of Type type in the GameObject or any of its parents.
SendMessageCalls the method named methodName on every MonoBehaviour in this game object.
SendMessageUpwardsCalls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour.
GetInstanceIDReturns the instance id of the object.
ToStringReturns the name of the GameObject.

Static Methods

DestroyRemoves a gameobject, component or asset.
DestroyImmediateDestroys the object obj immediately. You are strongly recommended to use Destroy instead.
DontDestroyOnLoadDo not destroy the target Object when loading a new Scene.
FindObjectOfTypeReturns the first active loaded object of Type type.
FindObjectsOfTypeReturns a list of all active loaded objects of Type type.
InstantiateClones the object original and returns the clone.

Operators

boolDoes the object exist?
operator !=Compares if two objects refer to a different object.
operator ==Compares two object references to see if they refer to the same object.

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