Header menu logo Nu

EffectFacetExtensions Module

Type extensions

Type extension Description

this.EffectCastShadow

Full Usage: this.EffectCastShadow

Parameters:
    () : unit

Returns: Lens<bool, Entity>

Extended Type: Entity

() : unit
Returns: Lens<bool, Entity>

this.EffectCastShadow

Full Usage: this.EffectCastShadow

Returns: Lens<bool, Entity>

Extended Type: Entity

Returns: Lens<bool, Entity>

this.EffectDataToken

Full Usage: this.EffectDataToken

Parameters:
    () : unit

Returns: Lens<DataToken, Entity>

Extended Type: Entity

() : unit
Returns: Lens<DataToken, Entity>

this.EffectDataToken

Full Usage: this.EffectDataToken

Returns: Lens<DataToken, Entity>

Extended Type: Entity

Returns: Lens<DataToken, Entity>

this.EffectDefinitions

Full Usage: this.EffectDefinitions

Parameters:
    () : unit

Returns: Lens<Definitions, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Definitions, Entity>

this.EffectDefinitions

Full Usage: this.EffectDefinitions

Returns: Lens<Definitions, Entity>

Extended Type: Entity

Returns: Lens<Definitions, Entity>

this.EffectDescriptor

Full Usage: this.EffectDescriptor

Parameters:
    () : unit

Returns: Lens<EffectDescriptor, Entity>

Extended Type: Entity

() : unit
Returns: Lens<EffectDescriptor, Entity>

this.EffectDescriptor

Full Usage: this.EffectDescriptor

Returns: Lens<EffectDescriptor, Entity>

Extended Type: Entity

Returns: Lens<EffectDescriptor, Entity>

this.EffectHistory

Full Usage: this.EffectHistory

Parameters:
    () : unit

Returns: Lens<Deque<Slice>, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Deque<Slice>, Entity>

this.EffectHistory

Full Usage: this.EffectHistory

Returns: Lens<Deque<Slice>, Entity>

Extended Type: Entity

Returns: Lens<Deque<Slice>, Entity>

this.EffectHistoryMax

Full Usage: this.EffectHistoryMax

Parameters:
    () : unit

Returns: Lens<int, Entity>

Extended Type: Entity

() : unit
Returns: Lens<int, Entity>

this.EffectHistoryMax

Full Usage: this.EffectHistoryMax

Returns: Lens<int, Entity>

Extended Type: Entity

Returns: Lens<int, Entity>

this.EffectOffset

Full Usage: this.EffectOffset

Parameters:
    () : unit

Returns: Lens<Vector3, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Vector3, Entity>

this.EffectOffset

Full Usage: this.EffectOffset

Returns: Lens<Vector3, Entity>

Extended Type: Entity

Returns: Lens<Vector3, Entity>

this.EffectRenderType

Full Usage: this.EffectRenderType

Parameters:
    () : unit

Returns: Lens<RenderType, Entity>

Extended Type: Entity

() : unit
Returns: Lens<RenderType, Entity>

this.EffectRenderType

Full Usage: this.EffectRenderType

Returns: Lens<RenderType, Entity>

Extended Type: Entity

Returns: Lens<RenderType, Entity>

this.EffectShadowOffset

Full Usage: this.EffectShadowOffset

Parameters:
    () : unit

Returns: Lens<single, Entity>

Extended Type: Entity

() : unit
Returns: Lens<single, Entity>

this.EffectShadowOffset

Full Usage: this.EffectShadowOffset

Returns: Lens<single, Entity>

Extended Type: Entity

Returns: Lens<single, Entity>

this.EffectStartTimeOpt

Full Usage: this.EffectStartTimeOpt

Parameters:
    () : unit

Returns: Lens<GameTime option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<GameTime option, Entity>

this.EffectStartTimeOpt

Full Usage: this.EffectStartTimeOpt

Returns: Lens<GameTime option, Entity>

Extended Type: Entity

Returns: Lens<GameTime option, Entity>

this.EffectSymbolOpt

Full Usage: this.EffectSymbolOpt

Parameters:
    () : unit

Returns: Lens<Symbol AssetTag option, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Symbol AssetTag option, Entity>

this.EffectSymbolOpt

Full Usage: this.EffectSymbolOpt

Returns: Lens<Symbol AssetTag option, Entity>

Extended Type: Entity

Returns: Lens<Symbol AssetTag option, Entity>

this.EffectTagTokens

Full Usage: this.EffectTagTokens

Parameters:
    () : unit

Returns: Lens<Map<string, Slice>, Entity>

Extended Type: Entity

() : unit
Returns: Lens<Map<string, Slice>, Entity>

this.EffectTagTokens

Full Usage: this.EffectTagTokens

Returns: Lens<Map<string, Slice>, Entity>

Extended Type: Entity

Returns: Lens<Map<string, Slice>, Entity>

this.GetEffectCastShadow

Full Usage: this.GetEffectCastShadow

Parameters:
Returns: bool

Extended Type: Entity

world : World
Returns: bool

this.GetEffectDataToken

Full Usage: this.GetEffectDataToken

Parameters:
Returns: DataToken

Extended Type: Entity

world : World
Returns: DataToken

this.GetEffectDefinitions

Full Usage: this.GetEffectDefinitions

Parameters:
Returns: Definitions

Extended Type: Entity

world : World
Returns: Definitions

this.GetEffectDescriptor

Full Usage: this.GetEffectDescriptor

Parameters:
Returns: EffectDescriptor

Extended Type: Entity

world : World
Returns: EffectDescriptor

this.GetEffectHistory

Full Usage: this.GetEffectHistory

Parameters:
Returns: Deque<Slice>

Extended Type: Entity

world : World
Returns: Deque<Slice>

this.GetEffectHistoryMax

Full Usage: this.GetEffectHistoryMax

Parameters:
Returns: int

Extended Type: Entity

world : World
Returns: int

this.GetEffectOffset

Full Usage: this.GetEffectOffset

Parameters:
Returns: Vector3

Extended Type: Entity

world : World
Returns: Vector3

this.GetEffectRenderType

Full Usage: this.GetEffectRenderType

Parameters:
Returns: RenderType

Extended Type: Entity

world : World
Returns: RenderType

this.GetEffectShadowOffset

Full Usage: this.GetEffectShadowOffset

Parameters:
Returns: single

Extended Type: Entity

world : World
Returns: single

this.GetEffectStartTimeOpt

Full Usage: this.GetEffectStartTimeOpt

Parameters:
Returns: GameTime option

Extended Type: Entity

world : World
Returns: GameTime option

this.GetEffectSymbolOpt

Full Usage: this.GetEffectSymbolOpt

Parameters:
Returns: Symbol AssetTag option

Extended Type: Entity

world : World
Returns: Symbol AssetTag option

this.GetEffectTagTokens

Full Usage: this.GetEffectTagTokens

Parameters:
Returns: Map<string, Slice>

Extended Type: Entity

world : World
Returns: Map<string, Slice>

this.GetRunMode

Full Usage: this.GetRunMode

Parameters:
Returns: RunMode

Extended Type: Entity

world : World
Returns: RunMode

this.RunMode

Full Usage: this.RunMode

Parameters:
    () : unit

Returns: Lens<RunMode, Entity>

Extended Type: Entity

() : unit
Returns: Lens<RunMode, Entity>

this.RunMode

Full Usage: this.RunMode

Returns: Lens<RunMode, Entity>

Extended Type: Entity

Returns: Lens<RunMode, Entity>

this.SetEffectCastShadow

Full Usage: this.SetEffectCastShadow

Parameters:
    value : bool
    world : World

Extended Type: Entity

value : bool
world : World

this.SetEffectDataToken

Full Usage: this.SetEffectDataToken

Parameters:

Extended Type: Entity

value : DataToken
world : World

this.SetEffectDefinitions

Full Usage: this.SetEffectDefinitions

Parameters:

Extended Type: Entity

value : Definitions
world : World

this.SetEffectDescriptor

Full Usage: this.SetEffectDescriptor

Parameters:

When RunMode is set to RunEarly, call this AFTER setting the rest of the entity's properties. This is because setting the effect descriptin in RunEarly mode will immediately run the first frame of the effect due to a semantic limitation in Nu.

Extended Type: Entity

value : EffectDescriptor
world : World

this.SetEffectHistoryMax

Full Usage: this.SetEffectHistoryMax

Parameters:
    value : int
    world : World

Extended Type: Entity

value : int
world : World

this.SetEffectOffset

Full Usage: this.SetEffectOffset

Parameters:

Extended Type: Entity

value : Vector3
world : World

this.SetEffectRenderType

Full Usage: this.SetEffectRenderType

Parameters:

Extended Type: Entity

value : RenderType
world : World

this.SetEffectShadowOffset

Full Usage: this.SetEffectShadowOffset

Parameters:
    value : single
    world : World

Extended Type: Entity

value : single
world : World

this.SetEffectStartTimeOpt

Full Usage: this.SetEffectStartTimeOpt

Parameters:

Extended Type: Entity

value : GameTime option
world : World

this.SetEffectSymbolOpt

Full Usage: this.SetEffectSymbolOpt

Parameters:

Extended Type: Entity

value : Symbol AssetTag option
world : World

this.SetEffectTagTokens

Full Usage: this.SetEffectTagTokens

Parameters:

Extended Type: Entity

value : Map<string, Slice>
world : World

this.SetRunMode

Full Usage: this.SetRunMode

Parameters:

Extended Type: Entity

value : RunMode
world : World

Type something to start searching.