Header menu logo Nu

WorldGameModule Module

Game functions for the world (2/2).

Type extensions

Type extension Description

this.AssetsReloadEvent

Full Usage: this.AssetsReloadEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.AssetsReloadEvent

Full Usage: this.AssetsReloadEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

this.BodyAddingEvent

Full Usage: this.BodyAddingEvent

Parameters:
    () : unit

Returns: BodyId Address

Extended Type: Game

() : unit
Returns: BodyId Address

this.BodyAddingEvent

Full Usage: this.BodyAddingEvent

Returns: BodyId Address

Extended Type: Game

Returns: BodyId Address

this.BodyRemovingEvent

Full Usage: this.BodyRemovingEvent

Parameters:
    () : unit

Returns: BodyId Address

Extended Type: Game

() : unit
Returns: BodyId Address

this.BodyRemovingEvent

Full Usage: this.BodyRemovingEvent

Returns: BodyId Address

Extended Type: Game

Returns: BodyId Address

this.BodySeparationImplicitEvent

Full Usage: this.BodySeparationImplicitEvent

Parameters:
    () : unit

Returns: BodySeparationImplicitData Address

Extended Type: Game

() : unit
Returns: BodySeparationImplicitData Address

this.BodySeparationImplicitEvent

Full Usage: this.BodySeparationImplicitEvent

Returns: BodySeparationImplicitData Address

Extended Type: Game

Returns: BodySeparationImplicitData Address

this.ChangeEvent

Full Usage: this.ChangeEvent

Parameters:
    propertyName : string

Returns: ChangeData Address

Extended Type: Game

propertyName : string
Returns: ChangeData Address

this.CodeReloadEvent

Full Usage: this.CodeReloadEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.CodeReloadEvent

Full Usage: this.CodeReloadEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

this.DesiredScreen

Full Usage: this.DesiredScreen

Parameters:
    () : unit

Returns: Lens<DesiredScreen, Game>

Extended Type: Game

() : unit
Returns: Lens<DesiredScreen, Game>

this.DesiredScreen

Full Usage: this.DesiredScreen

Returns: Lens<DesiredScreen, Game>

Extended Type: Game

Returns: Lens<DesiredScreen, Game>

this.Dispatcher

Full Usage: this.Dispatcher

Parameters:
    () : unit

Returns: Lens<GameDispatcher, Game>

Extended Type: Game

() : unit
Returns: Lens<GameDispatcher, Game>

this.Dispatcher

Full Usage: this.Dispatcher

Returns: Lens<GameDispatcher, Game>

Extended Type: Game

Returns: Lens<GameDispatcher, Game>

this.ExitRequestEvent

Full Usage: this.ExitRequestEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.ExitRequestEvent

Full Usage: this.ExitRequestEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

this.Eye2dCenter

Full Usage: this.Eye2dCenter

Parameters:
    () : unit

Returns: Lens<Vector2, Game>

Extended Type: Game

() : unit
Returns: Lens<Vector2, Game>

this.Eye2dCenter

Full Usage: this.Eye2dCenter

Returns: Lens<Vector2, Game>

Extended Type: Game

Returns: Lens<Vector2, Game>

this.Eye2dSize

Full Usage: this.Eye2dSize

Parameters:
    () : unit

Returns: Lens<Vector2, Game>

Extended Type: Game

() : unit
Returns: Lens<Vector2, Game>

this.Eye2dSize

Full Usage: this.Eye2dSize

Returns: Lens<Vector2, Game>

Extended Type: Game

Returns: Lens<Vector2, Game>

this.Eye3dCenter

Full Usage: this.Eye3dCenter

Parameters:
    () : unit

Returns: Lens<Vector3, Game>

Extended Type: Game

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

this.Eye3dCenter

Full Usage: this.Eye3dCenter

Returns: Lens<Vector3, Game>

Extended Type: Game

Returns: Lens<Vector3, Game>

this.Eye3dFieldOfView

Full Usage: this.Eye3dFieldOfView

Parameters:
    () : unit

Returns: Lens<single, Game>

Extended Type: Game

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

this.Eye3dFieldOfView

Full Usage: this.Eye3dFieldOfView

Returns: Lens<single, Game>

Extended Type: Game

Returns: Lens<single, Game>

this.Eye3dRotation

Full Usage: this.Eye3dRotation

Parameters:
    () : unit

Returns: Lens<Quaternion, Game>

Extended Type: Game

() : unit
Returns: Lens<Quaternion, Game>

this.Eye3dRotation

Full Usage: this.Eye3dRotation

Returns: Lens<Quaternion, Game>

Extended Type: Game

Returns: Lens<Quaternion, Game>

this.GamepadButtonChangeEvent

Full Usage: this.GamepadButtonChangeEvent

Parameters:
    index : int

Returns: GamepadButtonData Address

Extended Type: Game

index : int
Returns: GamepadButtonData Address

this.GamepadButtonDownEvent

Full Usage: this.GamepadButtonDownEvent

Parameters:
    index : int

Returns: GamepadButtonData Address

Extended Type: Game

index : int
Returns: GamepadButtonData Address

this.GamepadButtonUpEvent

Full Usage: this.GamepadButtonUpEvent

Parameters:
    index : int

Returns: GamepadButtonData Address

Extended Type: Game

index : int
Returns: GamepadButtonData Address

this.GamepadDirectionChangeEvent

Full Usage: this.GamepadDirectionChangeEvent

Parameters:
    index : int

Returns: GamepadDirectionData Address

Extended Type: Game

index : int
Returns: GamepadDirectionData Address

this.Get

Full Usage: this.Get

Parameters:
    propertyName : string
    world : World

Returns: 'a

Get an xtension property value.

Extended Type: Game

propertyName : string
world : World
Returns: 'a

this.GetDesiredScreen

Full Usage: this.GetDesiredScreen

Parameters:
Returns: DesiredScreen

Extended Type: Game

world : World
Returns: DesiredScreen

this.GetDispatcher

Full Usage: this.GetDispatcher

Parameters:
Returns: GameDispatcher

Extended Type: Game

world : World
Returns: GameDispatcher

this.GetEye2dCenter

Full Usage: this.GetEye2dCenter

Parameters:
Returns: Vector2

Extended Type: Game

world : World
Returns: Vector2

this.GetEye2dSize

Full Usage: this.GetEye2dSize

Parameters:
Returns: Vector2

Extended Type: Game

world : World
Returns: Vector2

this.GetEye3dCenter

Full Usage: this.GetEye3dCenter

Parameters:
Returns: Vector3

Extended Type: Game

world : World
Returns: Vector3

this.GetEye3dFieldOfView

Full Usage: this.GetEye3dFieldOfView

Parameters:
Returns: single

Extended Type: Game

world : World
Returns: single

this.GetEye3dRotation

Full Usage: this.GetEye3dRotation

Parameters:
Returns: Quaternion

Extended Type: Game

world : World
Returns: Quaternion

this.GetId

Full Usage: this.GetId

Parameters:
Returns: uint64

Extended Type: Game

world : World
Returns: uint64

this.GetModelGeneric

Full Usage: this.GetModelGeneric

Parameters:
Returns: 'a

Extended Type: Game

world : World
Returns: 'a

this.GetOrder

Full Usage: this.GetOrder

Parameters:
Returns: int64

Extended Type: Game

world : World
Returns: int64

this.GetProperty

Full Usage: this.GetProperty

Parameters:
    propertyName : string
    world : World

Returns: Property

Get a property value and type.

Extended Type: Game

propertyName : string
world : World
Returns: Property

this.GetScreenTransitionDestinationOpt

Full Usage: this.GetScreenTransitionDestinationOpt

Parameters:
Returns: Screen option

Extended Type: Game

world : World
Returns: Screen option

this.GetSelectedScreenOpt

Full Usage: this.GetSelectedScreenOpt

Parameters:
Returns: Screen option

Extended Type: Game

world : World
Returns: Screen option

this.Id

Full Usage: this.Id

Parameters:
    () : unit

Returns: Lens<uint64, Game>

Extended Type: Game

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

this.Id

Full Usage: this.Id

Returns: Lens<uint64, Game>

Extended Type: Game

Returns: Lens<uint64, Game>

this.IntegrationEvent

Full Usage: this.IntegrationEvent

Parameters:
    () : unit

Returns: IntegrationData Address

Extended Type: Game

() : unit
Returns: IntegrationData Address

this.IntegrationEvent

Full Usage: this.IntegrationEvent

Returns: IntegrationData Address

Extended Type: Game

Returns: IntegrationData Address

this.Is

Full Usage: this.Is

Parameters:
Returns: bool

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

Extended Type: Game

dispatcherType : Type
world : World
Returns: bool

this.Is

Full Usage: this.Is

Parameters:
Returns: bool

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

Extended Type: Game

world : World
Returns: bool

this.KeyboardKeyChangeEvent

Full Usage: this.KeyboardKeyChangeEvent

Parameters:
    () : unit

Returns: KeyboardKeyData Address

Extended Type: Game

() : unit
Returns: KeyboardKeyData Address

this.KeyboardKeyChangeEvent

Full Usage: this.KeyboardKeyChangeEvent

Returns: KeyboardKeyData Address

Extended Type: Game

Returns: KeyboardKeyData Address

this.KeyboardKeyDownEvent

Full Usage: this.KeyboardKeyDownEvent

Parameters:
    () : unit

Returns: KeyboardKeyData Address

Extended Type: Game

() : unit
Returns: KeyboardKeyData Address

this.KeyboardKeyDownEvent

Full Usage: this.KeyboardKeyDownEvent

Returns: KeyboardKeyData Address

Extended Type: Game

Returns: KeyboardKeyData Address

this.KeyboardKeyUpEvent

Full Usage: this.KeyboardKeyUpEvent

Parameters:
    () : unit

Returns: KeyboardKeyData Address

Extended Type: Game

() : unit
Returns: KeyboardKeyData Address

this.KeyboardKeyUpEvent

Full Usage: this.KeyboardKeyUpEvent

Returns: KeyboardKeyData Address

Extended Type: Game

Returns: KeyboardKeyData Address

this.KeyedValueChangeEvent

Full Usage: this.KeyedValueChangeEvent

Parameters:
    key : string

Returns: KeyedValueChangeData Address

Extended Type: Game

key : string
Returns: KeyedValueChangeData Address

this.LifeCycleEvent

Full Usage: this.LifeCycleEvent

Parameters:
    simulantTypeName : string

Returns: LifeCycleEventData Address

Extended Type: Game

simulantTypeName : string
Returns: LifeCycleEventData Address

this.ModelGeneric

Full Usage: this.ModelGeneric

Parameters:
    () : unit

Returns: Lens<'a, Game>

Extended Type: Game

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

this.MouseDragEvent

Full Usage: this.MouseDragEvent

Parameters:
    () : unit

Returns: MouseMoveData Address

Extended Type: Game

() : unit
Returns: MouseMoveData Address

this.MouseDragEvent

Full Usage: this.MouseDragEvent

Returns: MouseMoveData Address

Extended Type: Game

Returns: MouseMoveData Address

this.MouseLeftChangeEvent

Full Usage: this.MouseLeftChangeEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseLeftChangeEvent

Full Usage: this.MouseLeftChangeEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseLeftDownEvent

Full Usage: this.MouseLeftDownEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseLeftDownEvent

Full Usage: this.MouseLeftDownEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseLeftUpEvent

Full Usage: this.MouseLeftUpEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseLeftUpEvent

Full Usage: this.MouseLeftUpEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseMiddleChangeEvent

Full Usage: this.MouseMiddleChangeEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseMiddleChangeEvent

Full Usage: this.MouseMiddleChangeEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseMiddleDownEvent

Full Usage: this.MouseMiddleDownEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseMiddleDownEvent

Full Usage: this.MouseMiddleDownEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseMiddleUpEvent

Full Usage: this.MouseMiddleUpEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseMiddleUpEvent

Full Usage: this.MouseMiddleUpEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseMoveEvent

Full Usage: this.MouseMoveEvent

Parameters:
    () : unit

Returns: MouseMoveData Address

Extended Type: Game

() : unit
Returns: MouseMoveData Address

this.MouseMoveEvent

Full Usage: this.MouseMoveEvent

Returns: MouseMoveData Address

Extended Type: Game

Returns: MouseMoveData Address

this.MouseRightChangeEvent

Full Usage: this.MouseRightChangeEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseRightChangeEvent

Full Usage: this.MouseRightChangeEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseRightDownEvent

Full Usage: this.MouseRightDownEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseRightDownEvent

Full Usage: this.MouseRightDownEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseRightUpEvent

Full Usage: this.MouseRightUpEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseRightUpEvent

Full Usage: this.MouseRightUpEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseWheelEvent

Full Usage: this.MouseWheelEvent

Parameters:
    () : unit

Returns: MouseWheelData Address

Extended Type: Game

() : unit
Returns: MouseWheelData Address

this.MouseWheelEvent

Full Usage: this.MouseWheelEvent

Returns: MouseWheelData Address

Extended Type: Game

Returns: MouseWheelData Address

this.MouseX1ChangeEvent

Full Usage: this.MouseX1ChangeEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseX1ChangeEvent

Full Usage: this.MouseX1ChangeEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseX1DownEvent

Full Usage: this.MouseX1DownEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseX1DownEvent

Full Usage: this.MouseX1DownEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseX1UpEvent

Full Usage: this.MouseX1UpEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseX1UpEvent

Full Usage: this.MouseX1UpEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseX2ChangeEvent

Full Usage: this.MouseX2ChangeEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseX2ChangeEvent

Full Usage: this.MouseX2ChangeEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseX2DownEvent

Full Usage: this.MouseX2DownEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseX2DownEvent

Full Usage: this.MouseX2DownEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.MouseX2UpEvent

Full Usage: this.MouseX2UpEvent

Parameters:
    () : unit

Returns: MouseButtonData Address

Extended Type: Game

() : unit
Returns: MouseButtonData Address

this.MouseX2UpEvent

Full Usage: this.MouseX2UpEvent

Returns: MouseButtonData Address

Extended Type: Game

Returns: MouseButtonData Address

this.NotifyModelChange

Full Usage: this.NotifyModelChange

Parameters:

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

Extended Type: Game

world : World

this.Order

Full Usage: this.Order

Parameters:
    () : unit

Returns: Lens<int64, Game>

Extended Type: Game

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

this.Order

Full Usage: this.Order

Returns: Lens<int64, Game>

Extended Type: Game

Returns: Lens<int64, Game>

this.PostUpdateEvent

Full Usage: this.PostUpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.PostUpdateEvent

Full Usage: this.PostUpdateEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

this.PreUpdateEvent

Full Usage: this.PreUpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.PreUpdateEvent

Full Usage: this.PreUpdateEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

this.RegisterEvent

Full Usage: this.RegisterEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.RegisterEvent

Full Usage: this.RegisterEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

this.ScreenTransitionDestinationOpt

Full Usage: this.ScreenTransitionDestinationOpt

Parameters:
    () : unit

Returns: Lens<Screen option, Game>

Extended Type: Game

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

this.ScreenTransitionDestinationOpt

Full Usage: this.ScreenTransitionDestinationOpt

Returns: Lens<Screen option, Game>

Extended Type: Game

Returns: Lens<Screen option, Game>

this.SelectedScreenOpt

Full Usage: this.SelectedScreenOpt

Parameters:
    () : unit

Returns: Lens<Screen option, Game>

Extended Type: Game

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

this.SelectedScreenOpt

Full Usage: this.SelectedScreenOpt

Returns: Lens<Screen option, Game>

Extended Type: Game

Returns: Lens<Screen option, Game>

this.Set

Full Usage: this.Set

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

Set an xtension property value.

Extended Type: Game

propertyName : string
value : 'a
world : World

this.SetDesiredScreen

Full Usage: this.SetDesiredScreen

Parameters:

Extended Type: Game

value : DesiredScreen
world : World

this.SetEye2dCenter

Full Usage: this.SetEye2dCenter

Parameters:

Extended Type: Game

value : Vector2
world : World

this.SetEye2dSize

Full Usage: this.SetEye2dSize

Parameters:

Extended Type: Game

value : Vector2
world : World

this.SetEye3dCenter

Full Usage: this.SetEye3dCenter

Parameters:

Extended Type: Game

value : Vector3
world : World

this.SetEye3dFieldOfView

Full Usage: this.SetEye3dFieldOfView

Parameters:
    value : single
    world : World

Extended Type: Game

value : single
world : World

this.SetEye3dRotation

Full Usage: this.SetEye3dRotation

Parameters:

Extended Type: Game

value : Quaternion
world : World

this.SetModelGeneric

Full Usage: this.SetModelGeneric

Parameters:
    value : 'a
    world : World

Extended Type: Game

value : 'a
world : World

this.SetProperty

Full Usage: this.SetProperty

Parameters:

Set a property value with explicit type.

Extended Type: Game

propertyName : string
property : Property
world : World

this.SetScreenTransitionDestinationOpt

Full Usage: this.SetScreenTransitionDestinationOpt

Parameters:

Extended Type: Game

value : Screen option
world : World

this.Signal

Full Usage: this.Signal

Parameters:

Send a signal to a game.

Extended Type: Game

signal : Signal
world : World

this.TextInputEvent

Full Usage: this.TextInputEvent

Parameters:
    () : unit

Returns: TextInputData Address

Extended Type: Game

() : unit
Returns: TextInputData Address

this.TextInputEvent

Full Usage: this.TextInputEvent

Returns: TextInputData Address

Extended Type: Game

Returns: TextInputData Address

this.TimeUpdateEvent

Full Usage: this.TimeUpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.TimeUpdateEvent

Full Usage: this.TimeUpdateEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

this.TryGet

Full Usage: this.TryGet

Parameters:
    propertyName : string
    world : World

Returns: 'a voption

Try to get an xtension property value.

Extended Type: Game

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: Game

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: Game

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: Game

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

this.UnregisteringEvent

Full Usage: this.UnregisteringEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.UnregisteringEvent

Full Usage: this.UnregisteringEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

this.UpdateEvent

Full Usage: this.UpdateEvent

Parameters:
    () : unit

Returns: unit Address

Extended Type: Game

() : unit
Returns: unit Address

this.UpdateEvent

Full Usage: this.UpdateEvent

Returns: unit Address

Extended Type: Game

Returns: unit Address

World.editGame operation game world

Full Usage: World.editGame operation game world

Parameters:

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

Extended Type: World

operation : EditOperation
game : Game
world : World

World.getEntities1 world

Full Usage: World.getEntities1 world

Parameters:
Returns: Entity seq

Get all the entities in the world.

Extended Type: World

world : World
Returns: Entity seq

World.getGroups1 world

Full Usage: World.getGroups1 world

Parameters:
Returns: Group seq

Get all the groups in the world.

Extended Type: World

world : World
Returns: Group seq

World.getSelectedEntities world

Full Usage: World.getSelectedEntities world

Parameters:
Returns: Entity USet seq

Get all the entities in the selected screen, if any.

Extended Type: World

world : World
Returns: Entity USet seq

World.getSelectedGroups world

Full Usage: World.getSelectedGroups world

Parameters:
Returns: Group seq

Get all the groups in the selected screen, if any.

Extended Type: World

world : World
Returns: Group seq

World.getSelectedSovereignEntities world

Full Usage: World.getSelectedSovereignEntities world

Parameters:
Returns: Entity seq seq

Get all the entities directly parented by a group in the selected screen, if any.

Extended Type: World

world : World
Returns: Entity seq seq

World.readGame gameDescriptor name world

Full Usage: World.readGame gameDescriptor name world

Parameters:
Returns: Game

Read a game from a game descriptor.

Extended Type: World

gameDescriptor : GameDescriptor
name : Game Address
world : World
Returns: Game

World.readGameFromFile filePath world

Full Usage: World.readGameFromFile filePath world

Parameters:
Returns: World -> Game

Read a game from a file.

Extended Type: World

filePath : string
world : Game Address
Returns: World -> Game

World.tryTruncateGameModel model game world

Full Usage: World.tryTruncateGameModel model game world

Parameters:
Returns: 'model option

Attempt to truncate a game model.

Extended Type: World

model : 'model
game : Game
world : World
Returns: 'model option

World.tryUntruncateGameModel model game world

Full Usage: World.tryUntruncateGameModel model game world

Parameters:
Returns: 'model option

Attempt to untruncate a game model.

Extended Type: World

model : 'model
game : Game
world : World
Returns: 'model option

World.writeGame gameDescriptor game world

Full Usage: World.writeGame gameDescriptor game world

Parameters:
Returns: GameDescriptor

Write a game to a game descriptor.

Extended Type: World

gameDescriptor : GameDescriptor
game : Game
world : World
Returns: GameDescriptor

World.writeGameToFile filePath game world

Full Usage: World.writeGameToFile filePath game world

Parameters:
    filePath : string
    game : Game
    world : World

Write a game to a file.

Extended Type: World

filePath : string
game : Game
world : World

Type something to start searching.