Header menu logo Nu

EffectSystem Module

Types

Type Description

EffectSystem

Evaluates effect descriptors.

Functions and values

Function or value Description

EffectSystem.eval descriptor slice history effectSystem

Full Usage: EffectSystem.eval descriptor slice history effectSystem

Parameters:
Returns: DataToken * EffectSystem
 Evaluates an EffectDescriptor, applying the effect if it is still alive, with the following parameters:
   - descriptor: The EffectDescriptor to be evaluated.
   - slice: The Slice to apply the effect on.
   - history: A history of the effect's previous states.
   - effectSystem: The current state of the effect system.
 The function evaluates the EffectDescriptor to determine if the effect is still alive.
 If the effect is alive, it modifies the effectSystem to apply the effect to the given slice.
 If the effect is not alive, it simply releases the effectSystem without applying the effect.
descriptor : EffectDescriptor
slice : Slice
history : Slice seq
effectSystem : EffectSystem
Returns: DataToken * EffectSystem

EffectSystem.make localTime absolute castShadow presence shadowOffset renderType globalEnv

Full Usage: EffectSystem.make localTime absolute castShadow presence shadowOffset renderType globalEnv

Parameters:
Returns: EffectSystem
 Creates a new EffectSystem with the following parameters -
   - localTime: The time basis of the effect.
   - absolute: A flag indicating if the effect is absolute.
   - presence: The presence of the effect.
   - shadowOffset: How far to offset shadows of any billboards.
   - renderType: The render type of the effect.
   - globalEnv: The global environment for the effect.
localTime : GameTime
absolute : bool
castShadow : bool
presence : Presence
shadowOffset : single
renderType : RenderType
globalEnv : Definitions
Returns: EffectSystem

Type something to start searching.