EffectManager

Summary

Methods

Method Returns
PlayEffect(asset: DataContainer, transform: LinearTransform, params: EffectParams, firstPersonEffect: bool) int
StopEffect(handle: int) void
ResetEffect(handle: int) void
SetEffectParameterBool(handle: int, name: string, value: bool) void
SetEffectParameterInt(handle: int, name: string, value: int) void
SetEffectParameterFloat(handle: int, name: string, value: float) void
SetEffectTransform(handle: int, transform: LinearTransform) void
IsEffectPlaying(handle: int) bool
IsEffectDead(handle: int) bool
DisableEffects(disableTimer: float) void
Clear() void

Methods

PlayEffect

PlayEffect(asset: DataContainer, transform: LinearTransform, params: EffectParams, firstPersonEffect: bool): int

Parameters

Name Type Description
asset DataContainer
transform LinearTransform
params EffectParams
firstPersonEffect bool

Returns

Type Description
int

StopEffect

StopEffect(handle: int)

Parameters

Name Type Description
handle int

ResetEffect

ResetEffect(handle: int)

Parameters

Name Type Description
handle int

SetEffectParameterBool

SetEffectParameterBool(handle: int, name: string, value: bool)

Parameters

Name Type Description
handle int
name string
value bool

SetEffectParameterInt

SetEffectParameterInt(handle: int, name: string, value: int)

Parameters

Name Type Description
handle int
name string
value int

SetEffectParameterFloat

SetEffectParameterFloat(handle: int, name: string, value: float)

Parameters

Name Type Description
handle int
name string
value float

SetEffectTransform

SetEffectTransform(handle: int, transform: LinearTransform)

Parameters

Name Type Description
handle int
transform LinearTransform

IsEffectPlaying

IsEffectPlaying(handle: int): bool

Parameters

Name Type Description
handle int

Returns

Type Description
bool

IsEffectDead

IsEffectDead(handle: int): bool

Parameters

Name Type Description
handle int

Returns

Type Description
bool

DisableEffects

DisableEffects(disableTimer: float)

Parameters

Name Type Description
disableTimer float

Clear

Clear()

Last modified April 27, 2020: Regenerate all API documentation (0b49d6be)