GraphicsClient

startParticleFxLoopedOnEntity

START_PARTICLE_FX_LOOPED_ON_ENTITY0x1AE42C1660FD6517

The GTA V native START_PARTICLE_FX_LOOPED_ON_ENTITY of the GRAPHICS namespace, as LS:MP client scripts call it: the global function startParticleFxLoopedOnEntity, in JavaScript and in Lua.

SignatureJavaScript
startParticleFxLoopedOnEntity(
  effectName: string,
  entity: Entity,
  xOffset: number,
  yOffset: number,
  zOffset: number,
  xRot: number,
  yRot: number,
  zRot: number,
  scale: number,
  xAxis: boolean,
  yAxis: boolean,
  zAxis: boolean
): number
SignatureLua
startParticleFxLoopedOnEntity(
  effectName: string,
  entity: Entity,
  xOffset: number,
  yOffset: number,
  zOffset: number,
  xRot: number,
  yRot: number,
  zRot: number,
  scale: number,
  xAxis: boolean,
  yAxis: boolean,
  zAxis: boolean
): integer

Usage

JavaScript
const result = startParticleFxLoopedOnEntity(
  effectName, entity, xOffset, yOffset, zOffset, xRot, yRot, zRot, scale, xAxis, yAxis, zAxis
);
Lua
local result = startParticleFxLoopedOnEntity(
    effectName, entity, xOffset, yOffset, zOffset, xRot, yRot, zRot, scale, xAxis, yAxis, zAxis
)

Three consecutive numbers can be given as one vector: { x, y, z } (or [x, y, z]) in JavaScript, a Vector3 in Lua.

JavaScript · with vectors
const result = startParticleFxLoopedOnEntity(
  effectName, entity, offset, rot, scale, xAxis, yAxis, zAxis
);
Lua · with vectors
local result = startParticleFxLoopedOnEntity(
    effectName, entity, offset, rot, scale, xAxis, yAxis, zAxis
)

Parameters

ParameterTypeJavaScriptLua
effectNamestringstringstring
entityEntitynumberinteger
xOffsetfloatnumbernumber
yOffsetfloatnumbernumber
zOffsetfloatnumbernumber
xRotfloatnumbernumber
yRotfloatnumbernumber
zRotfloatnumbernumber
scalefloatnumbernumber
xAxisBOOLbooleanboolean
yAxisBOOLbooleanboolean
zAxisBOOLbooleanboolean

Returns

int JavaScript number, Lua integer

Notes

From the community native database. Names are LS:MP’s; samples may be written for C++ or another framework.

Full list of particle effect dictionaries and effects by DurtyFree: https://github.com/DurtyFree/gta-v-data-dumps/blob/master/particleEffectsCompact.json

Reference

Namespace
Graphics GRAPHICS
In the game
int START_PARTICLE_FX_LOOPED_ON_ENTITY(const char* effectName, Entity entity, float xOffset, float yOffset, float zOffset, float xRot, float yRot, float zRot, float scale, BOOL xAxis, BOOL yAxis, BOOL zAxis)
Hash
0x1AE42C1660FD6517

Open in the interactive natives reference