DPSF(Particle, Vertex).CParticleEvents.RemoveTimedEvent Method

Collapse AllExpand All Code: All Code: Multiple Code: C# Code: Visual Basic Code: Visual C++

[TCheckBoxFormControlObj]C#

[TCheckBoxFormControlObj]Visual Basic

[TCheckBoxFormControlObj]

Visual C++

DPSF API Documentation

DPSF

(Of

(<'Particle, Vertex>)>)>..::..CParticleEvents..::..RemoveTimedEvent Method

DPSF

<(Of <(<'Particle, Vertex>)>)>..::..CParticleEvents Class See Also Send Feedback

Removes a Timed Event with the specified Function, Time To Fire, Execution Order, and Group. Returns true if the Event was found and removed, false if not.

Namespace: DPSF

Assembly: DPSF (in DPSF.dll) Version: 2.5.0.0

Syntax

public bool RemoveTimedEvent(

float fTimeToFire,

DPSF<(Of <(<'Particle, Vertex>)>)>..::..UpdateParticleDelegate cFunction,

int iExecutionOrder,

int iGroup

)

Visual Basic

Public Function RemoveTimedEvent (

fTimeToFire As Single,

cFunction As DPSF<(Of <(<'Particle, Vertex>)>)>..::..UpdateParticleDelegate,

iExecutionOrder As Integer,

iGroup As Integer

) As Boolean

Visual C++

public:

bool RemoveTimedEvent(

float fTimeToFire,

DPSF<(Of <(<'Particle, Vertex>)>)>..::..UpdateParticleDelegate^ cFunction,

int iExecutionOrder,

int iGroup

)

Parameters

fTimeToFire

Type: System..::..Single

The Time the Event is scheduled to fire at

cFunction

Type: DPSF..::..DPSF<(Of <(<'Particle, Vertex>)>)>..::..UpdateParticleDelegate

The Function that is called when the Event fires

iExecutionOrder

Type: System..::..Int32

The Execution Order of the Event to remove. Default is zero.

iGroup

Type: System..::..Int32

The Group that the Event to remove is in. Default is zero.

Return Value

Type: Boolean

Returns true if the Event was found and removed, false if not.