Class ParticleEffect

Inheritance
Object
PoolObject
ParticleEffect
Inherited Members
Namespace: GTA
Assembly: ScriptHookVDotNet3.dll
Syntax
public sealed class ParticleEffect : PoolObject, INativeValue, IDeletable, IExistable

Properties

| Improve this Doc View Source

AssetName

Gets the name of the asset used for this ParticleEffect.

Declaration
public string AssetName { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Bone

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

Declaration
public EntityBone Bone { get; }
Property Value
Type Description
EntityBone
| Improve this Doc View Source

Color

Gets or sets the Color of this ParticleEffect.

Declaration
public Color Color { get; set; }
Property Value
Type Description
Color
| Improve this Doc View Source

EffectName

Gets the name of the effect used for this ParticleEffect.

Declaration
public string EffectName { get; }
Property Value
Type Description
String
| Improve this Doc View Source

Entity

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

Declaration
public Entity Entity { get; }
Property Value
Type Description
Entity
| Improve this Doc View Source

MemoryAddress

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

Declaration
public IntPtr MemoryAddress { get; }
Property Value
Type Description
IntPtr
| Improve this Doc View Source

Offset

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

Declaration
public Vector3 Offset { get; set; }
Property Value
Type Description
Vector3
| Improve this Doc View Source

Range

Gets or sets the range of this ParticleEffect.

Declaration
public float Range { get; set; }
Property Value
Type Description
Single
| Improve this Doc View Source

Rotation

Sets the rotation of this ParticleEffect

Declaration
public Vector3 Rotation { set; }
Property Value
Type Description
Vector3
| Improve this Doc View Source

Scale

Gets or sets the size scaling factor of this ParticleEffect.

Declaration
public float Scale { get; set; }
Property Value
Type Description
Single

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;

Methods

| Improve this Doc View Source

Delete()

Stops and removes this ParticleEffect.

Declaration
public override void Delete()
Overrides
| Improve this Doc View Source

Equals(Object)

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

Declaration
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The Object to check.
Returns
Type Description
Boolean

true if the obj is the same effect as this ParticleEffect; otherwise, false.
Overrides
| Improve this Doc View Source

Exists()

Determines if this Checkpoint exists.

Declaration
public override bool Exists()
Returns
Type Description
Boolean

true if this Checkpoint exists; otherwise, false.
Overrides
| Improve this Doc View Source

GetHashCode()

Declaration
public override int GetHashCode()
Returns
Type Description
Int32
Overrides
| Improve this Doc View Source

SetParameter(String, Single)

Modifys parameters of this ParticleEffect.

Declaration
public void SetParameter(string parameterName, float value)
Parameters
Type Name Description
String parameterName

Name of the parameter you want to modify, these are stored inside the effect files.
Single value

The new value for the parameter.
| Improve this Doc View Source

ToString()

Declaration
public override string ToString()
Returns
Type Description
String
Overrides

Operators

| Improve this Doc View Source

Equality(ParticleEffect, ParticleEffect)

Determines if two ParticleEffects refer to the same effect.

Declaration
public static bool operator ==(ParticleEffect left, ParticleEffect right)
Parameters
Type Name Description
ParticleEffect left

The left ParticleEffect.
ParticleEffect right

The right ParticleEffect.
Returns
Type Description
Boolean

true if left is the same effect as right; otherwise, false.
| Improve this Doc View Source

Implicit(ParticleEffect to InputArgument)

Converts a ParticleEffect to a native input argument.

Declaration
public static implicit operator InputArgument(ParticleEffect effect)
Parameters
Type Name Description
ParticleEffect effect
Returns
Type Description
InputArgument
| Improve this Doc View Source

Inequality(ParticleEffect, ParticleEffect)

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

Declaration
public static bool operator !=(ParticleEffect left, ParticleEffect right)
Parameters
Type Name Description
ParticleEffect left

The left ParticleEffect.
ParticleEffect right

The right ParticleEffect.
Returns
Type Description
Boolean

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

Implements