Header menu logo Nu

Screen Type

The screen type that allows transitioning to and from other screens, and also hosts the currently interactive groups of entities.

Constructors

Constructor Description

Screen(gameName, screenName)

Full Usage: Screen(gameName, screenName)

Parameters:
    gameName : string
    screenName : string

Returns: Screen

Create a screen reference from a name string.

gameName : string
screenName : string
Returns: Screen

Screen(screenNames)

Full Usage: Screen(screenNames)

Parameters:
    screenNames : string list

Returns: Screen

Create a screen reference from a list of names.

screenNames : string list
Returns: Screen

Screen(screenNames)

Full Usage: Screen(screenNames)

Parameters:
    screenNames : string array

Returns: Screen

Create a screen reference from a list of names.

screenNames : string array
Returns: Screen

Screen(screenAddressStr)

Full Usage: Screen(screenAddressStr)

Parameters:
    screenAddressStr : string

Returns: Screen

Create a group reference from an address string.

screenAddressStr : string
Returns: Screen

Screen(screenAddress)

Full Usage: Screen(screenAddress)

Parameters:
Returns: Screen
screenAddress : Screen Address
Returns: Screen

Instance members

Instance member Description

this.Name

Full Usage: this.Name

Returns: string
Modifiers: inline

Get the name of a screen.

Returns: string

this.Names

Full Usage: this.Names

Returns: string array
Modifiers: inline

Get the names of a screen.

Returns: string array

this.ScreenAddress

Full Usage: this.ScreenAddress

Returns: Screen Address

The address of the screen.

Returns: Screen Address

Static members

Static member Description

address --> screen

Full Usage: address --> screen

Parameters:
Returns: 'a Address

Concatenate an address with a screen's address.

address : 'a Address
screen : Screen
Returns: 'a Address

screen / groupName

Full Usage: screen / groupName

Parameters:
    screen : Screen
    groupName : string

Returns: Group

Derive a group from its screen.

screen : Screen
groupName : string
Returns: Group

Type something to start searching.