class in UnityEngine.Experimental.VFX
/
Inherits from:Behaviour
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.
CloseFor 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.
CloseThe visual effect class that references an VisualEffectAsset instance within the Scene.
aliveParticleCount | Returns the sum of all alive particles within the visual effect. |
culled | Is this visual effect culled (not visible) from any camera ? (Read Only) |
pause | The paused state of visual effect. |
playRate | A multiplier applied to the delta time when updating the VisualEffect. The default value is 1.0f. |
resetSeedOnPlay | Controls whether the visual effect generates a new random number to seed the random number generator for each call to VisualEffect.Play function. |
startSeed | The initial seed used used for internal random number generator. |
visualEffectAsset | The visual effect asset used by the visual effect. |
VisualEffect | The visual effect constructor. |
AdvanceOneFrame | If VisualEffect.pause is true, the method processes the next visual effect update for exactly one frame with the current delta time. |
CreateVFXEventAttribute | Create a new event attribute class. |
GetAnimationCurve | Gets a named exposed animation curve. |
GetBool | Get a named exposed boolean. |
GetFloat | Gets a named exposed float (o. |
GetGradient | Gets a named exposed gradient. |
GetInt | Get named exposed integer. |
GetMatrix4x4 | Gets named exposed Matrix4x4. |
GetMesh | Gets named exposed mesh. |
GetTexture | Gets named exposed texture. |
GetTextureDimension | Get expected texture dimension for a named exposed texture. |
GetUInt | Get named exposed unsigned integer. |
GetVector2 | Gets named exposed Vector2. |
GetVector3 | Gets named exposed Vector3. |
GetVector4 | Gets named exposed Vector4. |
HasAnimationCurve | Returns true if visual effect can override this named animation curve. |
HasBool | Returns true if the visual effect can override the boolean. |
HasFloat | Returns true if the visual effect can override this named float. |
HasGradient | Returns true if visual effect can override this named gradient. |
HasInt | Returns true if the visual effect can override this named integer. |
HasMatrix4x4 | Returns true if visual effect can override this named Matrix4x4. |
HasMesh | Returns true if visual effect can override this named mesh. |
HasTexture | Returns true if visual effect can override this named texture. |
HasUInt | Returns true if the visual effect can override this named unsigned integer. |
HasVector2 | Returns true if visual effect can override this named Vector2. |
HasVector3 | Returns true if visual effect can override this named Vector3. |
HasVector4 | Returns true if visual effect can override this named Vector4. |
Play | Sends 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. |
Reinit | Reintialize visual effect. |
ResetOverride | Sets the overridden state to false, and restores the default value that is specified in the visual effect Asset. |
SendEvent | Send a custom named event. |
SetAnimationCurve | Sets a named animation curve value. |
SetBool | Sets the value for a named boolean. |
SetFloat | Sets the value for a named float. |
SetGradient | Sets a named gradient value. |
SetInt | Sets the value for a named integer. |
SetMatrix4x4 | Sets a named Matrix4x4 value. |
SetMesh | Sets a named mesh value. |
SetTexture | Sets a named texture value. |
SetUInt | Sets the value for a named unsigned integer. |
SetVector2 | Sets the value for a named Vector2. |
SetVector3 | Sets the value for a named Vector3. |
SetVector4 | Sets a named Vector4 value. |
Simulate | Fast-forward the visual effect by simulating all systems for several step counts using the specified delta time. |
Stop | Send a stop event to all Spawn systems. |
enabled | Enabled Behaviours are Updated, disabled Behaviours are not. |
isActiveAndEnabled | Has the Behaviour had active and enabled called? |
gameObject | The game object this component is attached to. A component is always attached to a game object. |
tag | The tag of this game object. |
transform | The Transform attached to this GameObject. |
hideFlags | Should the object be hidden, saved with the Scene or modifiable by the user? |
name | The name of the object. |
BroadcastMessage | Calls the method named methodName on every MonoBehaviour in this game object or any of its children. |
CompareTag | Is this game object tagged with tag ? |
GetComponent | Returns the component of Type type if the game object has one attached, null if it doesn't. |
GetComponentInChildren | Returns the component of Type type in the GameObject or any of its children using depth first search. |
GetComponentInParent | Returns the component of Type type in the GameObject or any of its parents. |
GetComponents | Returns all components of Type type in the GameObject. |
GetComponentsInChildren | Returns all components of Type type in the GameObject or any of its children. |
GetComponentsInParent | Returns all components of Type type in the GameObject or any of its parents. |
SendMessage | Calls the method named methodName on every MonoBehaviour in this game object. |
SendMessageUpwards | Calls the method named methodName on every MonoBehaviour in this game object and on every ancestor of the behaviour. |
TryGetComponent | Gets the component of the specified type, if it exists. |
GetInstanceID | Returns the instance id of the object. |
ToString | Returns the name of the object. |
Destroy | Removes a GameObject, component or asset. |
DestroyImmediate | Destroys the object obj immediately. You are strongly recommended to use Destroy instead. |
DontDestroyOnLoad | Do not destroy the target Object when loading a new Scene. |
FindObjectOfType | Returns the first active loaded object of Type type. |
FindObjectsOfType | Returns a list of all active loaded objects of Type type. |
Instantiate | Clones the object original and returns the clone. |
bool | Does 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. |