Header menu logo Nu

WorldScreenModule Module

Screen functions for the world (2/2).

Type extensions

Type extension Description

this.ChangeEvent

Full Usage: this.ChangeEvent

Parameters:
    propertyName : string

Returns: ChangeData Address

Extended Type: Screen

propertyName : string
Returns: ChangeData Address

this.DeselectingEvent

Full Usage: this.DeselectingEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.DeselectingEvent

Full Usage: this.DeselectingEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.Destroying

Full Usage: this.Destroying

Parameters:
    () : unit

Returns: Lens<bool, Screen>

Extended Type: Screen

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

this.Destroying

Full Usage: this.Destroying

Returns: Lens<bool, Screen>

Extended Type: Screen

Returns: Lens<bool, Screen>

this.Dispatcher

Full Usage: this.Dispatcher

Parameters:
    () : unit

Returns: Lens<ScreenDispatcher, Screen>

Extended Type: Screen

() : unit
Returns: Lens<ScreenDispatcher, Screen>

this.Dispatcher

Full Usage: this.Dispatcher

Returns: Lens<ScreenDispatcher, Screen>

Extended Type: Screen

Returns: Lens<ScreenDispatcher, Screen>

this.Get

Full Usage: this.Get

Parameters:
    propertyName : string
    world : World

Returns: 'a

Get an xtension property value.

Extended Type: Screen

propertyName : string
world : World
Returns: 'a

this.GetDestroying

Full Usage: this.GetDestroying

Parameters:
Returns: bool

Extended Type: Screen

world : World
Returns: bool

this.GetDispatcher

Full Usage: this.GetDispatcher

Parameters:
Returns: ScreenDispatcher

Extended Type: Screen

world : World
Returns: ScreenDispatcher

this.GetExists

Full Usage: this.GetExists

Parameters:
Returns: bool

Check that a screen exists in the world.

Extended Type: Screen

world : World
Returns: bool

this.GetId

Full Usage: this.GetId

Parameters:
Returns: uint64

Extended Type: Screen

world : World
Returns: uint64

this.GetIdling

Full Usage: this.GetIdling

Parameters:
Returns: bool

Check that a screen is in an idling state (not transitioning in nor out).

Extended Type: Screen

world : World
Returns: bool

this.GetIncoming

Full Usage: this.GetIncoming

Parameters:
Returns: Transition

Extended Type: Screen

world : World
Returns: Transition

this.GetModelGeneric

Full Usage: this.GetModelGeneric

Parameters:
Returns: 'a

Extended Type: Screen

world : World
Returns: 'a

this.GetNav3d

Full Usage: this.GetNav3d

Parameters:
Returns: Nav3d

Extended Type: Screen

world : World
Returns: Nav3d

this.GetOrder

Full Usage: this.GetOrder

Parameters:
Returns: int64

Extended Type: Screen

world : World
Returns: int64

this.GetOutgoing

Full Usage: this.GetOutgoing

Parameters:
Returns: Transition

Extended Type: Screen

world : World
Returns: Transition

this.GetPersistent

Full Usage: this.GetPersistent

Parameters:
Returns: bool

Extended Type: Screen

world : World
Returns: bool

this.GetProperty

Full Usage: this.GetProperty

Parameters:
    propertyName : string
    world : World

Returns: Property

Get a property value and type.

Extended Type: Screen

propertyName : string
world : World
Returns: Property

this.GetProtected

Full Usage: this.GetProtected

Parameters:
Returns: bool

Extended Type: Screen

world : World
Returns: bool

this.GetRequestedSong

Full Usage: this.GetRequestedSong

Parameters:
Returns: RequestedSong

Extended Type: Screen

world : World
Returns: RequestedSong

this.GetSelected

Full Usage: this.GetSelected

Parameters:
Returns: bool

Check that a screen is selected.

Extended Type: Screen

world : World
Returns: bool

this.GetSlideOpt

Full Usage: this.GetSlideOpt

Parameters:
Returns: Slide option

Extended Type: Screen

world : World
Returns: Slide option

this.GetTransitionState

Full Usage: this.GetTransitionState

Parameters:
Returns: TransitionState

Extended Type: Screen

world : World
Returns: TransitionState

this.Id

Full Usage: this.Id

Parameters:
    () : unit

Returns: Lens<uint64, Screen>

Extended Type: Screen

() : unit
Returns: Lens<uint64, Screen>

this.Id

Full Usage: this.Id

Returns: Lens<uint64, Screen>

Extended Type: Screen

Returns: Lens<uint64, Screen>

this.Incoming

Full Usage: this.Incoming

Parameters:
    () : unit

Returns: Lens<Transition, Screen>

Extended Type: Screen

() : unit
Returns: Lens<Transition, Screen>

this.Incoming

Full Usage: this.Incoming

Returns: Lens<Transition, Screen>

Extended Type: Screen

Returns: Lens<Transition, Screen>

this.IncomingFinishEvent

Full Usage: this.IncomingFinishEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.IncomingFinishEvent

Full Usage: this.IncomingFinishEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.IncomingStartEvent

Full Usage: this.IncomingStartEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.IncomingStartEvent

Full Usage: this.IncomingStartEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.Is

Full Usage: this.Is

Parameters:
Returns: bool

Check that a screen dispatches in the same manner as the dispatcher with the given type.

Extended Type: Screen

dispatcherType : Type
world : World
Returns: bool

this.Is

Full Usage: this.Is

Parameters:
Returns: bool

Check that a screen dispatches in the same manner as the dispatcher with the given type.

Extended Type: Screen

world : World
Returns: bool

this.ModelGeneric

Full Usage: this.ModelGeneric

Parameters:
    () : unit

Returns: Lens<'a, Screen>

Extended Type: Screen

() : unit
Returns: Lens<'a, Screen>

this.Nav3d

Full Usage: this.Nav3d

Parameters:
    () : unit

Returns: Lens<Nav3d, Screen>

Extended Type: Screen

() : unit
Returns: Lens<Nav3d, Screen>

this.Nav3d

Full Usage: this.Nav3d

Returns: Lens<Nav3d, Screen>

Extended Type: Screen

Returns: Lens<Nav3d, Screen>

this.NotifyModelChange

Full Usage: this.NotifyModelChange

Parameters:

Notify the engine that a screen's MMCC model has changed in some automatically undetectable way (such as being mutated directly by user code).

Extended Type: Screen

world : World

this.Order

Full Usage: this.Order

Parameters:
    () : unit

Returns: Lens<int64, Screen>

Extended Type: Screen

() : unit
Returns: Lens<int64, Screen>

this.Order

Full Usage: this.Order

Returns: Lens<int64, Screen>

Extended Type: Screen

Returns: Lens<int64, Screen>

this.Outgoing

Full Usage: this.Outgoing

Parameters:
    () : unit

Returns: Lens<Transition, Screen>

Extended Type: Screen

() : unit
Returns: Lens<Transition, Screen>

this.Outgoing

Full Usage: this.Outgoing

Returns: Lens<Transition, Screen>

Extended Type: Screen

Returns: Lens<Transition, Screen>

this.OutgoingFinishEvent

Full Usage: this.OutgoingFinishEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.OutgoingFinishEvent

Full Usage: this.OutgoingFinishEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.OutgoingStartEvent

Full Usage: this.OutgoingStartEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.OutgoingStartEvent

Full Usage: this.OutgoingStartEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.Persistent

Full Usage: this.Persistent

Parameters:
    () : unit

Returns: Lens<bool, Screen>

Extended Type: Screen

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

this.Persistent

Full Usage: this.Persistent

Returns: Lens<bool, Screen>

Extended Type: Screen

Returns: Lens<bool, Screen>

this.PostUpdateEvent

Full Usage: this.PostUpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.PostUpdateEvent

Full Usage: this.PostUpdateEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.PreUpdateEvent

Full Usage: this.PreUpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.PreUpdateEvent

Full Usage: this.PreUpdateEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.Protected

Full Usage: this.Protected

Parameters:
    () : unit

Returns: Lens<bool, Screen>

Extended Type: Screen

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

this.Protected

Full Usage: this.Protected

Returns: Lens<bool, Screen>

Extended Type: Screen

Returns: Lens<bool, Screen>

this.RegisterEvent

Full Usage: this.RegisterEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.RegisterEvent

Full Usage: this.RegisterEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.RequestedSong

Full Usage: this.RequestedSong

Parameters:
    () : unit

Returns: Lens<RequestedSong, Screen>

Extended Type: Screen

() : unit
Returns: Lens<RequestedSong, Screen>

this.RequestedSong

Full Usage: this.RequestedSong

Returns: Lens<RequestedSong, Screen>

Extended Type: Screen

Returns: Lens<RequestedSong, Screen>

this.SelectEvent

Full Usage: this.SelectEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.SelectEvent

Full Usage: this.SelectEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.Set

Full Usage: this.Set

Parameters:
    propertyName : string
    value : 'a
    world : World

Set an xtension property value.

Extended Type: Screen

propertyName : string
value : 'a
world : World

this.SetIncoming

Full Usage: this.SetIncoming

Parameters:

Extended Type: Screen

value : Transition
world : World

this.SetModelGeneric

Full Usage: this.SetModelGeneric

Parameters:
    value : 'a
    world : World

Extended Type: Screen

value : 'a
world : World

this.SetOutgoing

Full Usage: this.SetOutgoing

Parameters:

Extended Type: Screen

value : Transition
world : World

this.SetPersistent

Full Usage: this.SetPersistent

Parameters:
    value : bool
    world : World

Extended Type: Screen

value : bool
world : World

this.SetProperty

Full Usage: this.SetProperty

Parameters:

Set a property value with explicit type.

Extended Type: Screen

propertyName : string
property : Property
world : World

this.SetRequestedSong

Full Usage: this.SetRequestedSong

Parameters:

Extended Type: Screen

value : RequestedSong
world : World

this.SetSlideOpt

Full Usage: this.SetSlideOpt

Parameters:

Extended Type: Screen

value : Slide option
world : World

this.SetTransitionState

Full Usage: this.SetTransitionState

Parameters:

Extended Type: Screen

value : TransitionState
world : World

this.Signal

Full Usage: this.Signal

Parameters:
    signal : 'a
    world : World

Send a signal to a screen.

Extended Type: Screen

signal : 'a
world : World

this.SlideOpt

Full Usage: this.SlideOpt

Parameters:
    () : unit

Returns: Lens<Slide option, Screen>

Extended Type: Screen

() : unit
Returns: Lens<Slide option, Screen>

this.SlideOpt

Full Usage: this.SlideOpt

Returns: Lens<Slide option, Screen>

Extended Type: Screen

Returns: Lens<Slide option, Screen>

this.TimeUpdateEvent

Full Usage: this.TimeUpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.TimeUpdateEvent

Full Usage: this.TimeUpdateEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.TransitionState

Full Usage: this.TransitionState

Parameters:
    () : unit

Returns: Lens<TransitionState, Screen>

Extended Type: Screen

() : unit
Returns: Lens<TransitionState, Screen>

this.TransitionState

Full Usage: this.TransitionState

Returns: Lens<TransitionState, Screen>

Extended Type: Screen

Returns: Lens<TransitionState, Screen>

this.TryGet

Full Usage: this.TryGet

Parameters:
    propertyName : string
    world : World

Returns: 'a voption

Try to get an xtension property value.

Extended Type: Screen

propertyName : string
world : World
Returns: 'a voption

this.TryGetProperty

Full Usage: this.TryGetProperty

Parameters:
    propertyName : string
    world : World

Returns: Property option

Try to get a property value and type.

Extended Type: Screen

propertyName : string
world : World
Returns: Property option

this.TrySet

Full Usage: this.TrySet

Parameters:
    propertyName : string
    value : 'a
    world : World

Returns: bool * bool

To try set an xtension property value.

Extended Type: Screen

propertyName : string
value : 'a
world : World
Returns: bool * bool

this.TrySetProperty

Full Usage: this.TrySetProperty

Parameters:
Returns: bool * bool

Try to set a property value with explicit type.

Extended Type: Screen

propertyName : string
property : Property
world : World
Returns: bool * bool

this.UnregisteringEvent

Full Usage: this.UnregisteringEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.UnregisteringEvent

Full Usage: this.UnregisteringEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

this.UpdateEvent

Full Usage: this.UpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Screen

() : unit
Returns: unit Address

this.UpdateEvent

Full Usage: this.UpdateEvent

Returns: unit Address

Extended Type: Screen

Returns: unit Address

World.applyScreenBehavior setScreenSlide behavior screen world

Full Usage: World.applyScreenBehavior setScreenSlide behavior screen world

Parameters:

Apply a screen behavior to a screen.

Extended Type: World

setScreenSlide : SlideDescriptor -> Screen -> Screen -> World -> unit
behavior : ScreenBehavior
screen : Screen
world : World

World.createDissolveScreen nameOpt dissolveDescriptor songOpt world

Full Usage: World.createDissolveScreen nameOpt dissolveDescriptor songOpt world

Parameters:
Returns: Screen

Create a screen with a dissolving transition, and add it to the world.

Extended Type: World

nameOpt : string option
dissolveDescriptor : DissolveDescriptor
songOpt : SongDescriptor option
world : World
Returns: Screen

World.createDissolveScreen5 dispatcherName nameOpt dissolveDescriptor songOpt world

Full Usage: World.createDissolveScreen5 dispatcherName nameOpt dissolveDescriptor songOpt world

Parameters:
Returns: Screen

Create a screen with a dissolving transition, and add it to the world.

Extended Type: World

dispatcherName : string
nameOpt : string option
dissolveDescriptor : DissolveDescriptor
songOpt : SongDescriptor option
world : World
Returns: Screen

World.createScreen nameOpt world

Full Usage: World.createScreen nameOpt world

Parameters:
    nameOpt : string option
    world : World

Returns: Screen

Create a screen and add it to the world.

Extended Type: World

nameOpt : string option
world : World
Returns: Screen

World.createScreen2 descriptor world

Full Usage: World.createScreen2 descriptor world

Parameters:
Returns: Screen

Create a screen from a simulant descriptor.

Extended Type: World

descriptor : SimulantDescriptor
world : World
Returns: Screen

World.createScreen4 dispatcherName nameOpt world

Full Usage: World.createScreen4 dispatcherName nameOpt world

Parameters:
    dispatcherName : string
    nameOpt : string option
    world : World

Returns: Screen

Create a screen and add it to the world.

Extended Type: World

dispatcherName : string
nameOpt : string option
world : World
Returns: Screen

World.destroyScreen screen world

Full Usage: World.destroyScreen screen world

Parameters:

Destroy a screen in the world at the end of the current update.

Extended Type: World

screen : Screen
world : World

World.destroyScreenImmediate screen world

Full Usage: World.destroyScreenImmediate screen world

Parameters:

Destroy a screen in the world immediately. Can be dangerous if existing in-flight publishing depends on the screen's existence. Consider using World.destroyScreen instead.

Extended Type: World

screen : Screen
world : World

World.editScreen operation screen world

Full Usage: World.editScreen operation screen world

Parameters:

Edit a screen with the given operation using the ImGui APIs. Intended only to be called by editors like Gaia.

Extended Type: World

operation : EditOperation
screen : Screen
world : World

World.getScreens world

Full Usage: World.getScreens world

Parameters:
Returns: Screen seq

Get all the screens in the world.

Extended Type: World

world : World
Returns: Screen seq

World.nav3dFace turnSpeed rotation navDirection world

Full Usage: World.nav3dFace turnSpeed rotation navDirection world

Parameters:
Returns: Quaternion * Vector3

Compute angular velocity for the given turn speed and navDirection.

Extended Type: World

turnSpeed : float32
rotation : Quaternion
navDirection : Vector3
world : World
Returns: Quaternion * Vector3

World.nav3dFollow distanceMinOpt distanceMaxOpt moveSpeed turnSpeed position rotation destination screen world

Full Usage: World.nav3dFollow distanceMinOpt distanceMaxOpt moveSpeed turnSpeed position rotation destination screen world

Parameters:
    distanceMinOpt : float32 option
    distanceMaxOpt : float32 option
    moveSpeed : float32
    turnSpeed : float32
    position : Vector3
    rotation : Quaternion
    destination : Vector3
    screen : Screen
    world : World

Returns: NavOutput

Compute navigation information that results in following the given destination.

Extended Type: World

distanceMinOpt : float32 option
distanceMaxOpt : float32 option
moveSpeed : float32
turnSpeed : float32
position : Vector3
rotation : Quaternion
destination : Vector3
screen : Screen
world : World
Returns: NavOutput

World.readScreen screenDescriptor nameOpt world

Full Usage: World.readScreen screenDescriptor nameOpt world

Parameters:
Returns: Screen

Read a screen from a screen descriptor.

Extended Type: World

screenDescriptor : ScreenDescriptor
nameOpt : string option
world : World
Returns: Screen

World.readScreenFromFile filePath nameOpt world

Full Usage: World.readScreenFromFile filePath nameOpt world

Parameters:
    filePath : string
    nameOpt : string option
    world : World

Returns: Screen

Read a screen from a file.

Extended Type: World

filePath : string
nameOpt : string option
world : World
Returns: Screen

World.readScreens screenDescriptors world

Full Usage: World.readScreens screenDescriptors world

Parameters:
Returns: Screen list

Read multiple screens from a game descriptor.

Extended Type: World

screenDescriptors : ScreenDescriptor seq
world : World
Returns: Screen list

World.setNav3dConfig config screen world

Full Usage: World.setNav3dConfig config screen world

Parameters:

Set the given screen's 3d navigation configuration.

Extended Type: World

config : Nav3dConfig
screen : Screen
world : World

World.setScreenDissolve dissolveDescriptor songOpt screen world

Full Usage: World.setScreenDissolve dissolveDescriptor songOpt screen world

Parameters:

Set the dissolve aspects of a screen.

Extended Type: World

dissolveDescriptor : DissolveDescriptor
songOpt : SongDescriptor option
screen : Screen
world : World

World.synchronizeNav3d forceRebuild filePathOpt screen world

Full Usage: World.synchronizeNav3d forceRebuild filePathOpt screen world

Parameters:
    forceRebuild : bool
    filePathOpt : string option
    screen : Screen
    world : World

Attempt to synchronize the given screen's 3d navigation information.

Extended Type: World

forceRebuild : bool
filePathOpt : string option
screen : Screen
world : World

World.tryNav3dFollowQuery moveSpeed startPosition endPosition navConfig navMesh query

Full Usage: World.tryNav3dFollowQuery moveSpeed startPosition endPosition navConfig navMesh query

Parameters:
Returns: Vector3 option

A nav3d query that attempts to compute navigation information that results in following the given destination.

Extended Type: World

moveSpeed : float32
startPosition : Vector3
endPosition : Vector3
navConfig : Nav3dConfig
navMesh : DtNavMesh
query : DtNavMeshQuery
Returns: Vector3 option

World.tryQueryNav3d query screen world

Full Usage: World.tryQueryNav3d query screen world

Parameters:
Returns: 'a option

Query the given screen's 3d navigation information if it exists.

Extended Type: World

query : Nav3dConfig -> DtNavMesh -> DtNavMeshQuery -> 'a
screen : Screen
world : World
Returns: 'a option

World.tryTruncateScreenModel model screen world

Full Usage: World.tryTruncateScreenModel model screen world

Parameters:
Returns: 'model option

Attempt to truncate a model.

Extended Type: World

model : 'model
screen : Screen
world : World
Returns: 'model option

World.tryUntruncateScreenModel model screen world

Full Usage: World.tryUntruncateScreenModel model screen world

Parameters:
Returns: 'model option

Attempt to untruncate a model.

Extended Type: World

model : 'model
screen : Screen
world : World
Returns: 'model option

World.writeScreen screenDescriptor screen world

Full Usage: World.writeScreen screenDescriptor screen world

Parameters:
Returns: ScreenDescriptor

Write a screen to a screen descriptor.

Extended Type: World

screenDescriptor : ScreenDescriptor
screen : Screen
world : World
Returns: ScreenDescriptor

World.writeScreenToFile filePath screen world

Full Usage: World.writeScreenToFile filePath screen world

Parameters:

Write a screen to a file.

Extended Type: World

filePath : string
screen : Screen
world : World

World.writeScreens screens world

Full Usage: World.writeScreens screens world

Parameters:
Returns: ScreenDescriptor list

Write multiple screens to a game descriptor.

Extended Type: World

screens : Screen seq
world : World
Returns: ScreenDescriptor list

Type something to start searching.