Method CreateParticleEffectNonLooped

CreateParticleEffectNonLooped(ParticleEffectAsset, String, Vector3, Vector3, Single, InvertAxisFlags)

Starts a Particle Effect that runs once at a given position then is destroyed.

Declaration

public static bool CreateParticleEffectNonLooped(ParticleEffectAsset asset, string effectName, Vector3 pos, Vector3 rot = default(Vector3), float scale = 1F, InvertAxisFlags invertAxis = InvertAxisFlags.None)

Parameters

Type	Name	Description
ParticleEffectAsset	asset	The effect asset to use.
System.String	effectName	The name of the effect.
Vector3	pos	The World position where the effect is.
Vector3	rot	What rotation to apply to the effect.
System.Single	scale	How much to scale the size of the effect by.
InvertAxisFlags	invertAxis	Which axis to flip the effect in.

Returns

Type	Description
System.Boolean	`true`If the effect was able to start; otherwise, `false`.

CreateParticleEffectNonLooped(ParticleEffectAsset, String, Entity, Vector3, Vector3, Single, InvertAxisFlags)

Starts a Particle Effect on an Entity that runs once then is destroyed.

Declaration

public static bool CreateParticleEffectNonLooped(ParticleEffectAsset asset, string effectName, Entity entity, Vector3 off = default(Vector3), Vector3 rot = default(Vector3), float scale = 1F, InvertAxisFlags invertAxis = InvertAxisFlags.None)

Parameters

Type	Name	Description
ParticleEffectAsset	asset	The effect asset to use.
System.String	effectName	the name of the effect.
Entity	entity	The Entity the effect is attached to.
Vector3	off	The offset from the `entity` to attach the effect.
Vector3	rot	The rotation, relative to the `entity`, the effect has.
System.Single	scale	How much to scale the size of the effect by.
InvertAxisFlags	invertAxis	Which axis to flip the effect in. For a car side exahust you may need to flip in the Y Axis

Returns

Type	Description
System.Boolean	`true`If the effect was able to start; otherwise, `false`.

CreateParticleEffectNonLooped(ParticleEffectAsset, String, EntityBone, Vector3, Vector3, Single, InvertAxisFlags)

Starts a Particle Effect on an EntityBone that runs once then is destroyed.

Declaration

public static bool CreateParticleEffectNonLooped(ParticleEffectAsset asset, string effectName, EntityBone entityBone, Vector3 off = default(Vector3), Vector3 rot = default(Vector3), float scale = 1F, InvertAxisFlags invertAxis = InvertAxisFlags.None)

Parameters

Type	Name	Description
ParticleEffectAsset	asset	The effect asset to use.
System.String	effectName	the name of the effect.
EntityBone	entityBone	The EntityBone the effect is attached to.
Vector3	off	The offset from the `entityBone` to attach the effect.
Vector3	rot	The rotation, relative to the `entityBone`, the effect has.
System.Single	scale	How much to scale the size of the effect by.
InvertAxisFlags	invertAxis	Which axis to flip the effect in. For a car side exahust you may need to flip in the Y Axis

Returns

Type	Description
System.Boolean	`true`If the effect was able to start; otherwise, `false`.