Class MyParticleEffect

Inheritance

System.Object

MyParticleEffect

Namespace: VRage.Game

Assembly: VRage.Game.dll

Syntax

public class MyParticleEffect : Object

Constructors

MyParticleEffect()

Declaration

public MyParticleEffect()

Properties

Autodelete

Declaration

public bool Autodelete { get; set; }

Property Value

Type	Description
System.Boolean

CameraSoftRadiusMultiplier

Declaration

public float CameraSoftRadiusMultiplier { get; set; }

Property Value

Type	Description
System.Single

Data

Declaration

public MyParticleEffectData Data { get; }

Property Value

Type	Description
VRage.Render.Particles.MyParticleEffectData

DistanceMax

Declaration

public float DistanceMax { get; }

Property Value

Type	Description
System.Single

DurationMax

Declaration

public float DurationMax { get; }

Property Value

Type	Description
System.Single

Id

Declaration

public uint Id { get; }

Property Value

Type	Description
System.UInt32

IsEmittingStopped

Declaration

public bool IsEmittingStopped { get; }

Property Value

Type	Description
System.Boolean

IsStopped

Declaration

public bool IsStopped { get; }

Property Value

Type	Description
System.Boolean

Loop

Declaration

public bool Loop { get; }

Property Value

Type	Description
System.Boolean

SoftParticleDistanceScaleMultiplier

Declaration

public float SoftParticleDistanceScaleMultiplier { get; set; }

Property Value

Type	Description
System.Single

UserBirthMultiplier

Declaration

public float UserBirthMultiplier { get; set; }

Property Value

Type	Description
System.Single

UserColorIntensityMultiplier

Declaration

public float UserColorIntensityMultiplier { get; set; }

Property Value

Type	Description
System.Single

UserColorMultiplier

Declaration

public Vector4 UserColorMultiplier { get; set; }

Property Value

Type	Description
Vector4

UserEmitterScale

Declaration

public float UserEmitterScale { get; set; }

Property Value

Type	Description
System.Single

UserFadeMultiplier

Declaration

public float UserFadeMultiplier { get; set; }

Property Value

Type	Description
System.Single

UserLifeMultiplier

Declaration

public float UserLifeMultiplier { get; set; }

Property Value

Type	Description
System.Single

UserRadiusMultiplier

Declaration

public float UserRadiusMultiplier { get; set; }

Property Value

Type	Description
System.Single

UserScale

Declaration

public float UserScale { get; set; }

Property Value

Type	Description
System.Single

UserVelocityMultiplier

Declaration

public float UserVelocityMultiplier { get; set; }

Property Value

Type	Description
System.Single

Velocity

Declaration

public Vector3 Velocity { set; }

Property Value

Type	Description
Vector3

WorldMatrix

Declaration

public MatrixD WorldMatrix { get; set; }

Property Value

Type	Description
MatrixD

Methods

AssertUnload()

Declaration

public void AssertUnload()

Clear()

Declaration

public void Clear()

Close()

Declaration

public void Close()

GetElapsedTime()

Declaration

public float GetElapsedTime()

Returns

Type	Description
System.Single

GetName()

Declaration

public string GetName()

Returns

Type	Description
System.String

Init(MyParticleEffectData, ref MatrixD, UInt32)

Declaration

public void Init(MyParticleEffectData data, ref MatrixD effectMatrix, uint parentId)

Parameters

Type	Name	Description
VRage.Render.Particles.MyParticleEffectData	data
MatrixD	effectMatrix
System.UInt32	parentId

OnRemoved()

Declaration

public void OnRemoved()

Pause()

This methods freezes effect and particles

Declaration

public void Pause()

Play()

This method restores effect

Declaration

public void Play()

SetDirty()

Declaration

public void SetDirty()

SetTranslation(Vector3D)

Declaration

public void SetTranslation(Vector3D trans)

Parameters

Type	Name	Description
Vector3D	trans

SetTranslation(ref Vector3D)

Declaration

public void SetTranslation(ref Vector3D trans)

Parameters

Type	Name	Description
Vector3D	trans

Stop(Boolean)

This method stops and deletes effect completely

Declaration

public void Stop(bool instant = true)

Parameters

Type	Name	Description
System.Boolean	instant

StopEmitting(Single)

This method stops generating any new particles

Declaration

public void StopEmitting(float timeout = 0F)

Parameters

Type	Name	Description
System.Single	timeout

StopLights()

This method stops all lights

Declaration

public void StopLights()

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Update()

Declaration

public void Update()

Events

OnDelete

Declaration

public event Action<MyParticleEffect> OnDelete

Event Type

Type	Description
System.Action<MyParticleEffect>