Class VisualEffect

Inheritance

Object

Object

Component

Behaviour

VisualEffect

Inherited Members

Behaviour.enabled

Behaviour.isActiveAndEnabled

Component.transform

Component.gameObject

Component.GetComponent(Type)

Component.GetComponent<T>()

Component.GetComponent(String)

Component.GetComponentInChildren(Type, Boolean)

Component.GetComponentInChildren(Type)

Component.GetComponentInChildren<T>(Boolean)

Component.GetComponentInChildren<T>()

Component.GetComponentsInChildren(Type, Boolean)

Component.GetComponentsInChildren(Type)

Component.GetComponentsInChildren<T>(Boolean)

Component.GetComponentsInChildren<T>(Boolean, List<T>)

Component.GetComponentsInChildren<T>()

Component.GetComponentsInChildren<T>(List<T>)

Component.GetComponentInParent(Type)

Component.GetComponentInParent<T>()

Component.GetComponentsInParent(Type, Boolean)

Component.GetComponentsInParent(Type)

Component.GetComponentsInParent<T>(Boolean)

Component.GetComponentsInParent<T>(Boolean, List<T>)

Component.GetComponentsInParent<T>()

Component.GetComponents(Type)

Component.GetComponents(Type, List<Component>)

Component.GetComponents<T>(List<T>)

Component.tag

Component.GetComponents<T>()

Component.CompareTag(String)

Component.SendMessageUpwards(String, Object, SendMessageOptions)

Component.SendMessageUpwards(String, Object)

Component.SendMessageUpwards(String)

Component.SendMessageUpwards(String, SendMessageOptions)

Component.SendMessage(String, Object)

Component.SendMessage(String)

Component.SendMessage(String, Object, SendMessageOptions)

Component.SendMessage(String, SendMessageOptions)

Component.BroadcastMessage(String, Object, SendMessageOptions)

Component.BroadcastMessage(String, Object)

Component.BroadcastMessage(String)

Component.BroadcastMessage(String, SendMessageOptions)

Object.GetInstanceID()

Object.GetHashCode()

Object.Equals(Object)

Object.name

Object.Instantiate(Object, Vector3, Quaternion)

Object.Instantiate(Object, Vector3, Quaternion, Transform)

Object.Instantiate(Object)

Object.Instantiate(Object, Transform)

Object.Instantiate(Object, Transform, Boolean)

Object.Instantiate<T>(T)

Object.Instantiate<T>(T, Vector3, Quaternion)

Object.Instantiate<T>(T, Vector3, Quaternion, Transform)

Object.Instantiate<T>(T, Transform)

Object.Instantiate<T>(T, Transform, Boolean)

Object.Destroy(Object, Single)

Object.Destroy(Object)

Object.DestroyImmediate(Object, Boolean)

Object.DestroyImmediate(Object)

Object.FindObjectsOfType(Type)

Object.DontDestroyOnLoad(Object)

Object.hideFlags

Object.DestroyObject(Object, Single)

Object.DestroyObject(Object)

Object.FindSceneObjectsOfType(Type)

Object.FindObjectsOfTypeIncludingAssets(Type)

Object.FindObjectsOfType<T>()

Object.FindObjectOfType<T>()

Object.FindObjectsOfTypeAll(Type)

Object.FindObjectOfType(Type)

Object.ToString()

Object.Equals(Object, Object)

Object.ReferenceEquals(Object, Object)

Object.GetType()

Object.MemberwiseClone()

Namespace: UnityEngine.Experimental.VFX

Assembly: UnityEngine.dll

Syntax

[RequireComponent(typeof(Transform))]
public class VisualEffect : Behaviour

Properties

aliveParticleCount

Declaration

public int aliveParticleCount { get; }

Property Value

Type	Description
Int32

culled

Declaration

public bool culled { get; }

Property Value

Type	Description
Boolean

pause

Declaration

public bool pause { get; set; }

Property Value

Type	Description
Boolean

playRate

Declaration

public float playRate { get; set; }

Property Value

Type	Description
Single

resetSeedOnPlay

Declaration

public bool resetSeedOnPlay { get; set; }

Property Value

Type	Description
Boolean

startSeed

Declaration

public uint startSeed { get; set; }

Property Value

Type	Description
UInt32

visualEffectAsset

Declaration

public VisualEffectAsset visualEffectAsset { get; set; }

Property Value

Type	Description
VisualEffectAsset

Methods

AdvanceOneFrame()

Declaration

public void AdvanceOneFrame()

CreateVFXEventAttribute()

Declaration

public VFXEventAttribute CreateVFXEventAttribute()

Returns

Type	Description
VFXEventAttribute

GetAnimationCurve(Int32)

Declaration

public AnimationCurve GetAnimationCurve(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
AnimationCurve

GetAnimationCurve(String)

Declaration

public AnimationCurve GetAnimationCurve(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
AnimationCurve

GetBool(Int32)

Declaration

public bool GetBool(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

GetBool(String)

Declaration

public bool GetBool(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

GetFloat(Int32)

Declaration

public float GetFloat(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Single

GetFloat(String)

Declaration

public float GetFloat(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Single

GetGradient(Int32)

Declaration

public Gradient GetGradient(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Gradient

GetGradient(String)

Declaration

public Gradient GetGradient(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Gradient

GetInt(Int32)

Declaration

public int GetInt(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Int32

GetInt(String)

Declaration

public int GetInt(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Int32

GetMatrix4x4(Int32)

Declaration

public Matrix4x4 GetMatrix4x4(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Matrix4x4

GetMatrix4x4(String)

Declaration

public Matrix4x4 GetMatrix4x4(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Matrix4x4

GetMesh(Int32)

Declaration

public Mesh GetMesh(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Mesh

GetMesh(String)

Declaration

public Mesh GetMesh(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Mesh

GetTexture(Int32)

Declaration

public Texture GetTexture(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Texture

GetTexture(String)

Declaration

public Texture GetTexture(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Texture

GetTextureDimension(Int32)

Declaration

public TextureDimension GetTextureDimension(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
TextureDimension

GetTextureDimension(String)

Declaration

public TextureDimension GetTextureDimension(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
TextureDimension

GetUInt(Int32)

Declaration

public uint GetUInt(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
UInt32

GetUInt(String)

Declaration

public uint GetUInt(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
UInt32

GetVector2(Int32)

Declaration

public Vector2 GetVector2(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Vector2

GetVector2(String)

Declaration

public Vector2 GetVector2(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Vector2

GetVector3(Int32)

Declaration

public Vector3 GetVector3(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Vector3

GetVector3(String)

Declaration

public Vector3 GetVector3(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Vector3

GetVector4(Int32)

Declaration

public Vector4 GetVector4(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Vector4

GetVector4(String)

Declaration

public Vector4 GetVector4(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Vector4

HasAnimationCurve(Int32)

Declaration

public bool HasAnimationCurve(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasAnimationCurve(String)

Declaration

public bool HasAnimationCurve(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasBool(Int32)

Declaration

public bool HasBool(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasBool(String)

Declaration

public bool HasBool(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasFloat(Int32)

Declaration

public bool HasFloat(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasFloat(String)

Declaration

public bool HasFloat(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasGradient(Int32)

Declaration

public bool HasGradient(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasGradient(String)

Declaration

public bool HasGradient(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasInt(Int32)

Declaration

public bool HasInt(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasInt(String)

Declaration

public bool HasInt(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasMatrix4x4(Int32)

Declaration

public bool HasMatrix4x4(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasMatrix4x4(String)

Declaration

public bool HasMatrix4x4(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasMesh(Int32)

Declaration

public bool HasMesh(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasMesh(String)

Declaration

public bool HasMesh(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasTexture(Int32)

Declaration

public bool HasTexture(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasTexture(String)

Declaration

public bool HasTexture(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasUInt(Int32)

Declaration

public bool HasUInt(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasUInt(String)

Declaration

public bool HasUInt(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasVector2(Int32)

Declaration

public bool HasVector2(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasVector2(String)

Declaration

public bool HasVector2(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasVector3(Int32)

Declaration

public bool HasVector3(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasVector3(String)

Declaration

public bool HasVector3(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

HasVector4(Int32)

Declaration

public bool HasVector4(int nameID)

Parameters

Type	Name	Description
Int32	nameID

Returns

Type	Description
Boolean

HasVector4(String)

Declaration

public bool HasVector4(string name)

Parameters

Type	Name	Description
String	name

Returns

Type	Description
Boolean

Play()

Declaration

public void Play()

Play(VFXEventAttribute)

Declaration

public void Play(VFXEventAttribute eventAttribute)

Parameters

Type	Name	Description
VFXEventAttribute	eventAttribute

Reinit()

Declaration

public void Reinit()

ResetOverride(Int32)

Declaration

public void ResetOverride(int nameID)

Parameters

Type	Name	Description
Int32	nameID

ResetOverride(String)

Declaration

public void ResetOverride(string name)

Parameters

Type	Name	Description
String	name

SendEvent(Int32, VFXEventAttribute)

Declaration

public void SendEvent(int eventNameID, VFXEventAttribute eventAttribute)

Parameters

Type	Name	Description
Int32	eventNameID
VFXEventAttribute	eventAttribute

SendEvent(String)

Declaration

public void SendEvent(string eventName)

Parameters

Type	Name	Description
String	eventName

SendEvent(String, VFXEventAttribute)

Declaration

public void SendEvent(string eventName, VFXEventAttribute eventAttribute)

Parameters

Type	Name	Description
String	eventName
VFXEventAttribute	eventAttribute

SetAnimationCurve(Int32, AnimationCurve)

Declaration

public void SetAnimationCurve(int nameID, AnimationCurve c)

Parameters

Type	Name	Description
Int32	nameID
AnimationCurve	c

SetAnimationCurve(String, AnimationCurve)

Declaration

public void SetAnimationCurve(string name, AnimationCurve c)

Parameters

Type	Name	Description
String	name
AnimationCurve	c

SetBool(Int32, Boolean)

Declaration

public void SetBool(int nameID, bool b)

Parameters

Type	Name	Description
Int32	nameID
Boolean	b

SetBool(String, Boolean)

Declaration

public void SetBool(string name, bool b)

Parameters

Type	Name	Description
String	name
Boolean	b

SetFloat(Int32, Single)

Declaration

public void SetFloat(int nameID, float f)

Parameters

Type	Name	Description
Int32	nameID
Single	f

SetFloat(String, Single)

Declaration

public void SetFloat(string name, float f)

Parameters

Type	Name	Description
String	name
Single	f

SetGradient(Int32, Gradient)

Declaration

public void SetGradient(int nameID, Gradient g)

Parameters

Type	Name	Description
Int32	nameID
Gradient	g

SetGradient(String, Gradient)

Declaration

public void SetGradient(string name, Gradient g)

Parameters

Type	Name	Description
String	name
Gradient	g

SetInt(Int32, Int32)

Declaration

public void SetInt(int nameID, int i)

Parameters

Type	Name	Description
Int32	nameID
Int32	i

SetInt(String, Int32)

Declaration

public void SetInt(string name, int i)

Parameters

Type	Name	Description
String	name
Int32	i

SetMatrix4x4(Int32, Matrix4x4)

Declaration

public void SetMatrix4x4(int nameID, Matrix4x4 v)

Parameters

Type	Name	Description
Int32	nameID
Matrix4x4	v

SetMatrix4x4(String, Matrix4x4)

Declaration

public void SetMatrix4x4(string name, Matrix4x4 v)

Parameters

Type	Name	Description
String	name
Matrix4x4	v

SetMesh(Int32, Mesh)

Declaration

public void SetMesh(int nameID, Mesh m)

Parameters

Type	Name	Description
Int32	nameID
Mesh	m

SetMesh(String, Mesh)

Declaration

public void SetMesh(string name, Mesh m)

Parameters

Type	Name	Description
String	name
Mesh	m

SetTexture(Int32, Texture)

Declaration

public void SetTexture(int nameID, Texture t)

Parameters

Type	Name	Description
Int32	nameID
Texture	t

SetTexture(String, Texture)

Declaration

public void SetTexture(string name, Texture t)

Parameters

Type	Name	Description
String	name
Texture	t

SetUInt(Int32, UInt32)

Declaration

public void SetUInt(int nameID, uint i)

Parameters

Type	Name	Description
Int32	nameID
UInt32	i

SetUInt(String, UInt32)

Declaration

public void SetUInt(string name, uint i)

Parameters

Type	Name	Description
String	name
UInt32	i

SetVector2(Int32, Vector2)

Declaration

public void SetVector2(int nameID, Vector2 v)

Parameters

Type	Name	Description
Int32	nameID
Vector2	v

SetVector2(String, Vector2)

Declaration

public void SetVector2(string name, Vector2 v)

Parameters

Type	Name	Description
String	name
Vector2	v

SetVector3(Int32, Vector3)

Declaration

public void SetVector3(int nameID, Vector3 v)

Parameters

Type	Name	Description
Int32	nameID
Vector3	v

SetVector3(String, Vector3)

Declaration

public void SetVector3(string name, Vector3 v)

Parameters

Type	Name	Description
String	name
Vector3	v

SetVector4(Int32, Vector4)

Declaration

public void SetVector4(int nameID, Vector4 v)

Parameters

Type	Name	Description
Int32	nameID
Vector4	v

SetVector4(String, Vector4)

Declaration

public void SetVector4(string name, Vector4 v)

Parameters

Type	Name	Description
String	name
Vector4	v

Stop()

Declaration

public void Stop()

Stop(VFXEventAttribute)

Declaration

public void Stop(VFXEventAttribute eventAttribute)

Parameters

Type	Name	Description
VFXEventAttribute	eventAttribute

Extension Methods

MustExtensions.MustBeEqual<T>(T, T)

MustExtensions.MustBeEqual<T>(T, T, String)

MustExtensions.MustNotBeEqual<T>(T, T)

MustExtensions.MustNotBeEqual<T>(T, T, String)

MustExtensions.MustBeNull<T>(T)

MustExtensions.MustBeNull<T>(T, String)

MustExtensions.MustNotBeNull<T>(T)

MustExtensions.MustNotBeNull<T>(T, String)