CreateLoopedParticleEffectOnEntity

From GTA Network Wiki
Jump to: navigation, search

CreateLoopedParticleEffectOnEntity
Server-Side Function

utilities-terminal.png Server-Side csharp.png C#

Creates a looped Particle effect on an entity.

This function is similar to CreateParticleEffectOnEntity but is looped and returns a ParticleEffect.

Syntax

ParticleEffect NAPI.Particle.CreateLoopedParticleEffectOnEntity(string ptfxLib, string ptfxName, NetHandle entity, Vector3 offset, Vector3 rotation, float scale [, int bone = -1, uint dimension = NAPI.GlobalDimension ]);

Required Arguments

  • ptfxLib: parameter input should be in string type.
  • ptfxName: parameter input should be in string type.
  • entity: parameter input should be in NetHandle type.
  • offset: parameter input should be in Vector3 type.
  • rotation: parameter input should be in Vector3 type.
  • scale: parameter input should be in float type.

Optional Arguments

  • bone: parameter input should be in int type.
  • dimension: parameter input should be in uint type.

NOTE: This function returns data in ParticleEffect type.

Usage example

   ParticleEffect myEffect = NAPI.Particle.CreateLoopedParticleEffectOnEntity(ptfxLib, ptfxName, entity, offset, rotation, scale);

Changelog

Version Description
1.0 Release.

References