fivem-ts

a library to speed up the development of Fivem scripts and frameworks

---

Project maintained by Purpose-Dev Hosted on GitHub Pages — Theme by mattgraham

fivem-ts - Documentation v0.7.5 • Docs

---

fivem-ts - Documentation v0.7.5 / Client / ParticleEffectAsset

Class: ParticleEffectAsset

Constructors

new ParticleEffectAsset()

new ParticleEffectAsset(assetName): ParticleEffectAsset

Parameters

• assetName: string

Returns

ParticleEffectAsset

Defined in

client/ParticleEffectAsset.ts:6

Accessors

Asset

get Asset(): string

Returns

string

Defined in

client/ParticleEffectAsset.ts:12

---

AssetName

get AssetName(): string

Returns

string

Defined in

client/ParticleEffectAsset.ts:8

---

IsLoaded

get IsLoaded(): boolean

Returns

boolean

Defined in

client/ParticleEffectAsset.ts:16

Methods

markAsNoLongerNeeded()

markAsNoLongerNeeded(): void

Returns

void

Defined in

client/ParticleEffectAsset.ts:24

---

request()

request(timeout): Promise<boolean>

Parameters

• timeout: number

Returns

Promise<boolean>

Defined in

client/ParticleEffectAsset.ts:28

---

startLoopedAtCoords()

startLoopedAtCoords(effectName, position, rotation, scale, invertAxis): boolean

Parameters

• effectName: string

• position: Vector3

• rotation: Vector3 = ...

• scale: number = 1.0

• invertAxis = ...

• invertAxis.flags: InvertAxisFlags = InvertAxisFlags.None

Returns

boolean

Defined in

client/ParticleEffectAsset.ts:56

---

startLoopedOnEntity()

startLoopedOnEntity(effectName, entity, offset, rotation, scale, invertAxis): boolean

Parameters

• effectName: string

• entity: Entity

• offset: Vector3 = ...

• rotation: Vector3 = ...

• scale: number = 1.0

• invertAxis = ...

• invertAxis.flags: InvertAxisFlags = InvertAxisFlags.None

Returns

boolean

Defined in

client/ParticleEffectAsset.ts:145

---

startNetworkedLoopedOnEntity()

startNetworkedLoopedOnEntity(effectName, entity, offset, rotation, scale, invertAxis): boolean

Parameters

• effectName: string

• entity: Entity

• offset: Vector3 = ...

• rotation: Vector3 = ...

• scale: number = 1.0

• invertAxis = ...

• invertAxis.flags: InvertAxisFlags = InvertAxisFlags.None

Returns

boolean

Defined in

client/ParticleEffectAsset.ts:207

---

startNetworkedNonLoopedAtCoords()

startNetworkedNonLoopedAtCoords(effectName, position, rotation, scale, invertAxis): boolean

Parameters

• effectName: string

• position: Vector3

• rotation: Vector3 = ...

• scale: number = 1.0

• invertAxis = ...

• invertAxis.flags: InvertAxisFlags = InvertAxisFlags.None

Returns

boolean

Defined in

client/ParticleEffectAsset.ts:117

---

startNetworkedNonLoopedOnEntity()

startNetworkedNonLoopedOnEntity(effectName, entity, offset, rotation, scale, invertAxis): boolean

Parameters

• effectName: string

• entity: Entity

• offset: Vector3 = ...

• rotation: Vector3 = ...

• scale: number = 1.0

• invertAxis = ...

• invertAxis.flags: InvertAxisFlags = InvertAxisFlags.None

Returns

boolean

Defined in

client/ParticleEffectAsset.ts:239

---

startNonLoopedAtCoords()

startNonLoopedAtCoords(effectName, position, rotation, scale, invertAxis): boolean

Parameters

• effectName: string

• position: Vector3

• rotation: Vector3 = ...

• scale: number = 1.0

• invertAxis = ...

• invertAxis.flags: InvertAxisFlags = InvertAxisFlags.None

Returns

boolean

Defined in

client/ParticleEffectAsset.ts:87

---

startNonLoopedOnEntity()

startNonLoopedOnEntity(effectName, entity, offset, rotation, scale, invertAxis): boolean

Parameters

• effectName: string

• entity: Entity

• offset: Vector3 = ...

• rotation: Vector3 = ...

• scale: number = 1.0

• invertAxis = ...

• invertAxis.flags: InvertAxisFlags = InvertAxisFlags.None

Returns

boolean

Defined in

client/ParticleEffectAsset.ts:177

---

toString()

toString(): string

Returns

string

Defined in

client/ParticleEffectAsset.ts:20