GraphicsClient

startParticleFxLoopedOnPedBone

START_PARTICLE_FX_LOOPED_ON_PED_BONE0xF28DA9F38CD1787C

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

SignatureJavaScript
startParticleFxLoopedOnPedBone(
  effectName: string,
  ped: Ped,
  xOffset: number,
  yOffset: number,
  zOffset: number,
  xRot: number,
  yRot: number,
  zRot: number,
  boneIndex: number,
  scale: number,
  xAxis: boolean,
  yAxis: boolean,
  zAxis: boolean
): number
SignatureLua
startParticleFxLoopedOnPedBone(
  effectName: string,
  ped: Ped,
  xOffset: number,
  yOffset: number,
  zOffset: number,
  xRot: number,
  yRot: number,
  zRot: number,
  boneIndex: integer,
  scale: number,
  xAxis: boolean,
  yAxis: boolean,
  zAxis: boolean
): integer

Usage

JavaScript
const result = startParticleFxLoopedOnPedBone(
  effectName, ped, xOffset, yOffset, zOffset, xRot, yRot, zRot, boneIndex, scale, xAxis, yAxis,
  zAxis
);
Lua
local result = startParticleFxLoopedOnPedBone(
    effectName, ped, xOffset, yOffset, zOffset, xRot, yRot, zRot, boneIndex, 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 = startParticleFxLoopedOnPedBone(
  effectName, ped, offset, rot, boneIndex, scale, xAxis, yAxis, zAxis
);
Lua · with vectors
local result = startParticleFxLoopedOnPedBone(
    effectName, ped, offset, rot, boneIndex, scale, xAxis, yAxis, zAxis
)

Parameters

ParameterTypeJavaScriptLua
effectNamestringstringstring
pedPednumberinteger
xOffsetfloatnumbernumber
yOffsetfloatnumbernumber
zOffsetfloatnumbernumber
xRotfloatnumbernumber
yRotfloatnumbernumber
zRotfloatnumbernumber
boneIndexintnumberinteger
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_PED_BONE(const char* effectName, Ped ped, float xOffset, float yOffset, float zOffset, float xRot, float yRot, float zRot, int boneIndex, float scale, BOOL xAxis, BOOL yAxis, BOOL zAxis)
Hash
0xF28DA9F38CD1787C

Open in the interactive natives reference