Inheritance diagram for GTA.ParticleEffect:

Public Member Functions
void	SetParameter (string parameterName, float value)
	Modifys parameters of this ParticleEffect. More...

override void	Delete ()
	Stops and removes this ParticleEffect. More...

override bool	Exists ()
	Determines if this Checkpoint exists. More...

override bool	Equals (object obj)
	Determines if an object refers to the same effect as this ParticleEffect. More...

override int	GetHashCode ()

override string	ToString ()

Static Public Member Functions
static bool	operator== (ParticleEffect left, ParticleEffect right)
	Determines if two ParticleEffects refer to the same effect. More...

static bool	operator!= (ParticleEffect left, ParticleEffect right)
	Determines if two ParticleEffects don't refer to the same effect. More...

static implicit	operator InputArgument (ParticleEffect effect)
	Converts a ParticleEffect to a native input argument. More...

Public Attributes
IntPtr	MemoryAddress => SHVDN.NativeMemory.GetPtfxAddress(Handle)
	Gets the memory address where this ParticleEffect is located in game memory. More...

Properties
Entity?	Entity `[get]`
	Gets the GTA.Entity this ParticleEffect is attached to or `null` if there is none. More...

EntityBone	Bone `[get]`
	Gets the EntityBone that this ParticleEffect is attached to or `null` if there is none. More...

string	AssetName `[get]`
	Gets the name of the asset used for this ParticleEffect. More...

string	EffectName `[get]`
	Gets the name of the effect used for this ParticleEffect. More...

Vector3	Offset `[get, set]`
	Gets or sets the offset. If this ParticleEffect is attached to an Entity, this refers to the offset from the Entity; otherwise, this refers to its position in World coordinates More...

Vector3	Rotation `[set]`
	Sets the rotation of this ParticleEffect More...

Color	Color `[get, set]`
	Gets or sets the Color of this ParticleEffect. More...

float	Scale `[get, set]`
	Gets or sets the size scaling factor of this ParticleEffect. More...

float	Range `[get, set]`
	Gets or sets the range of this ParticleEffect. More...

Properties inherited from GTA.PoolObject
int	Handle `[get, protected set]`
	The handle of the object. More...

ulong	NativeValue `[get, set]`
	The handle of the object translated to a native value. More...

Properties inherited from GTA.Native.INativeValue
ulong	NativeValue `[get, set]`

Additional Inherited Members
Protected Member Functions inherited from GTA.PoolObject
	PoolObject (int handle)

Member Function Documentation

◆ Delete()

override void GTA.ParticleEffect.Delete ( )

virtual

Stops and removes this ParticleEffect.

Implements GTA.PoolObject.

◆ Equals()

override bool GTA.ParticleEffect.Equals ( object obj )

Determines if an object refers to the same effect as this ParticleEffect.

Parameters

obj	The object to check.

Returns: true if the obj is the same effect as this ParticleEffect; otherwise, false.

◆ Exists()

override bool GTA.ParticleEffect.Exists ( )

virtual

Determines if this Checkpoint exists.

Returns: true if this Checkpoint exists; otherwise, false.

Implements GTA.PoolObject.

◆ GetHashCode()

override int GTA.ParticleEffect.GetHashCode ( )

◆ operator InputArgument()

static implicit GTA.ParticleEffect.operator InputArgument ( ParticleEffect effect )

static

Converts a ParticleEffect to a native input argument.

◆ operator!=()

static bool GTA.ParticleEffect.operator!=	(	ParticleEffect	left,
		ParticleEffect	right
	)

static

Determines if two ParticleEffects don't refer to the same effect.

Parameters

left	The left ParticleEffect.
right	The right ParticleEffect.

Returns: true if left is not the same effect as right ; otherwise, false.

◆ operator==()

static bool GTA.ParticleEffect.operator==	(	ParticleEffect	left,
		ParticleEffect	right
	)

static

Determines if two ParticleEffects refer to the same effect.

Parameters

left	The left ParticleEffect.
right	The right ParticleEffect.

Returns: true if left is the same effect as right ; otherwise, false.

◆ SetParameter()

void GTA.ParticleEffect.SetParameter	(	string	parameterName,
		float	value
	)

Modifys parameters of this ParticleEffect.

Parameters

parameterName	Name of the parameter you want to modify, these are stored inside the effect files.
value	The new value for the parameter.

◆ ToString()

override string GTA.ParticleEffect.ToString ( )

Member Data Documentation

◆ MemoryAddress

IntPtr GTA.ParticleEffect.MemoryAddress => SHVDN.NativeMemory.GetPtfxAddress(Handle)

Gets the memory address where this ParticleEffect is located in game memory.

Property Documentation

◆ AssetName

string GTA.ParticleEffect.AssetName

get

Gets the name of the asset used for this ParticleEffect.

◆ Bone

EntityBone GTA.ParticleEffect.Bone

get

Gets the EntityBone that this ParticleEffect is attached to or null if there is none.

◆ Color

Color GTA.ParticleEffect.Color

getset

Gets or sets the Color of this ParticleEffect.

◆ EffectName

string GTA.ParticleEffect.EffectName

get

Gets the name of the effect used for this ParticleEffect.

◆ Entity

Entity? GTA.ParticleEffect.Entity

get

Gets the GTA.Entity this ParticleEffect is attached to or null if there is none.

◆ Offset

Vector3 GTA.ParticleEffect.Offset

getset

Gets or sets the offset. If this ParticleEffect is attached to an Entity, this refers to the offset from the Entity; otherwise, this refers to its position in World coordinates

◆ Range

float GTA.ParticleEffect.Range

getset

Gets or sets the range of this ParticleEffect.

◆ Rotation

Vector3 GTA.ParticleEffect.Rotation

set

Sets the rotation of this ParticleEffect

◆ Scale

float GTA.ParticleEffect.Scale

getset

Gets or sets the size scaling factor of this ParticleEffect.

The scale, default = 1.0f; To Decrease the size use a value less than 1.0f; To Increase the size use a value greater than 1.0f;

The documentation for this class was generated from the following file:

C:/Users/nitan/source/repos/scripthookvdotnet/source/scripting_v3/GTA/Particles/ParticleEffect.cs

Public Member Functions

Static Public Member Functions

Public Attributes

Properties

Additional Inherited Members

Member Function Documentation

◆ Delete()

◆ Equals()

◆ Exists()

◆ GetHashCode()

◆ operator InputArgument()

◆ operator!=()

◆ operator==()

◆ SetParameter()

◆ ToString()

Member Data Documentation

◆ MemoryAddress

Property Documentation

◆ AssetName

◆ Bone

◆ Color

◆ EffectName

◆ Entity

◆ Offset

◆ Range

◆ Rotation

◆ Scale