Header menu logo Nu

Effect Module

Types

Type Description

Effect

A time-based effect.

EffectConverter

Converts effects, always providing an empty effect when converting from Symbol.

Functions and values

Function or value Description

Effect.empty

Full Usage: Effect.empty

Returns: Effect

The empty effect.

Returns: Effect

Effect.make startTime offset transform shadowOffset renderType descriptor

Full Usage: Effect.make startTime offset transform shadowOffset renderType descriptor

Parameters:
Returns: Effect

Make an effect.

startTime : GameTime
offset : Vector3
transform : Transform
shadowOffset : single
renderType : RenderType
descriptor : EffectDescriptor
Returns: Effect

Effect.makePlus startTime offset transform shadowOffset renderType particleSystem historyMax history definitions descriptor

Full Usage: Effect.makePlus startTime offset transform shadowOffset renderType particleSystem historyMax history definitions descriptor

Parameters:
Returns: Effect

Make an effect.

startTime : GameTime
offset : Vector3
transform : Transform
shadowOffset : single
renderType : RenderType
particleSystem : ParticleSystem
historyMax : int
history : Deque<Slice>
definitions : Definitions
descriptor : EffectDescriptor
Returns: Effect

Effect.run effect world

Full Usage: Effect.run effect world

Parameters:
Returns: bool * Effect * DataToken

Run an effect, returning any resulting requests as data tokens.

effect : Effect
world : World
Returns: bool * Effect * DataToken

Type something to start searching.