a library to speed up the development of Fivem scripts and frameworks
fivem-ts - Documentation v0.7.5 • Docs
fivem-ts - Documentation v0.7.5 / Client / ParticleEffect
abstract ParticleEffectAn abstract class representing a particle effect.
This class provides methods and properties to manage and control various aspects of a particle effect such as its asset, effect name, offset, rotation, color, scale, range, and axis inversion.
getAsset():string
string
getAssetName():string
string
getColor():Color
setColor(color):void
• color: Color
getEffectName():string
string
getHandle():number
setHandle(handle):void
• handle: number
number
getInvertAxis():InvertAxis
setInvertAxis(invertAxis):void
• invertAxis: InvertAxis
getIsActive():boolean
boolean
getOffset():Vector3
setOffset(offset):void
• offset: Vector3
getRange():number
setRange(range):void
• range: number
number
getRotation():Vector3
setRotation(rotation):void
• rotation: Vector3
getScale():number
setScale(scale):void
• scale: number
number
setParameter(
parameterName,value):void
Sets the value of a specific parameter for the particle effect.
• parameterName: string
The name of the parameter to set.
• value: number
The value to set for the specified parameter.
void
abstractstart():boolean
boolean
stop():
void
Stops the particle effect if it is currently active. This method will remove the particle effect associated with the current handle.
void
toString():
string
Returns a string representation of the asset and effect names.
string
A string combining the asset name and effect name separated by a backslash.