startParticleFxNonLoopedOnEntityBone
START_PARTICLE_FX_NON_LOOPED_ON_ENTITY_BONE0x02B1F2A72E0F5325The GTA V native START_PARTICLE_FX_NON_LOOPED_ON_ENTITY_BONE of the GRAPHICS namespace, as LS:MP client scripts call it: the global function startParticleFxNonLoopedOnEntityBone, in JavaScript and in Lua.
startParticleFxNonLoopedOnEntityBone(
effectName: string,
entity: Entity,
offsetX: number,
offsetY: number,
offsetZ: number,
rotX: number,
rotY: number,
rotZ: number,
boneIndex: number,
scale: number,
axisX: boolean,
axisY: boolean,
axisZ: boolean
): booleanstartParticleFxNonLoopedOnEntityBone(
effectName: string,
entity: Entity,
offsetX: number,
offsetY: number,
offsetZ: number,
rotX: number,
rotY: number,
rotZ: number,
boneIndex: integer,
scale: number,
axisX: boolean,
axisY: boolean,
axisZ: boolean
): booleanUsage
JavaScript
const result = startParticleFxNonLoopedOnEntityBone(
effectName, entity, offsetX, offsetY, offsetZ, rotX, rotY, rotZ, boneIndex, scale, axisX,
axisY, axisZ
);Lua
local result = startParticleFxNonLoopedOnEntityBone(
effectName, entity, offsetX, offsetY, offsetZ, rotX, rotY, rotZ, boneIndex, scale, axisX,
axisY, axisZ
)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 = startParticleFxNonLoopedOnEntityBone(
effectName, entity, offset, rot, boneIndex, scale, axisX, axisY, axisZ
);Lua · with vectors
local result = startParticleFxNonLoopedOnEntityBone(
effectName, entity, offset, rot, boneIndex, scale, axisX, axisY, axisZ
)Parameters
| Parameter | Type | JavaScript | Lua |
|---|---|---|---|
effectName | string | string | string |
entity | Entity | number | integer |
offsetX | float | number | number |
offsetY | float | number | number |
offsetZ | float | number | number |
rotX | float | number | number |
rotY | float | number | number |
rotZ | float | number | number |
boneIndex | int | number | integer |
scale | float | number | number |
axisX | BOOL | boolean | boolean |
axisY | BOOL | boolean | boolean |
axisZ | BOOL | boolean | boolean |
Returns
BOOL JavaScript boolean, Lua booleanNotes
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
BOOL START_PARTICLE_FX_NON_LOOPED_ON_ENTITY_BONE(const char* effectName, Entity entity, float offsetX, float offsetY, float offsetZ, float rotX, float rotY, float rotZ, int boneIndex, float scale, BOOL axisX, BOOL axisY, BOOL axisZ)- Hash
0x02B1F2A72E0F5325- Introduced
- Game build 2189 legacy numbering
- Formerly
_START_NETWORKED_PARTICLE_FX_NON_LOOPED_ON_ENTITY_BONE