Header menu logo Nu

Entity Type

The type around which the whole game engine is based! Used in combination with dispatchers to implement things like buttons, characters, blocks, and things of that sort.

Constructors

Constructor Description

Entity(gameName, screenName, groupName, entityName)

Full Usage: Entity(gameName, screenName, groupName, entityName)

Parameters:
    gameName : string
    screenName : string
    groupName : string
    entityName : string

Returns: Entity

Create an entity reference from a the required names.

gameName : string
screenName : string
groupName : string
entityName : string
Returns: Entity

Entity(surnames)

Full Usage: Entity(surnames)

Parameters:
    surnames : string list

Returns: Entity

Create an entity reference from a list of names.

surnames : string list
Returns: Entity

Entity(surnames)

Full Usage: Entity(surnames)

Parameters:
    surnames : string array

Returns: Entity

Create an entity reference from an array of names.

surnames : string array
Returns: Entity

Entity(entityAddressStr)

Full Usage: Entity(entityAddressStr)

Parameters:
    entityAddressStr : string

Returns: Entity

Create an entity reference from an address string.

entityAddressStr : string
Returns: Entity

Entity(entityAddress)

Full Usage: Entity(entityAddress)

Parameters:
Returns: Entity
entityAddress : Entity Address
Returns: Entity

Instance members

Instance member Description

this.EntityAddress

Full Usage: this.EntityAddress

Returns: Entity Address

The address of the entity.

Returns: Entity Address

this.Group

Full Usage: this.Group

Returns: Group

The containing group of the entity.

Returns: Group

this.Name

Full Usage: this.Name

Returns: string

Get the last name of an entity.

Returns: string

this.Names

Full Usage: this.Names

Returns: string array

Get the names of an entity.

Returns: string array

this.Parent

Full Usage: this.Parent

Returns: Simulant

The containing parent of the entity.

Returns: Simulant

this.Screen

Full Usage: this.Screen

Returns: Screen

The containing screen of the entity.

Returns: Screen

this.Surnames

Full Usage: this.Surnames

Returns: string array

Get the surnames of an entity (the names of an entity not including group or screen).

Returns: string array

Static members

Static member Description

address --> entity

Full Usage: address --> entity

Parameters:
Returns: 'a Address

Concatenate an address with an entity.

address : 'a Address
entity : Entity
Returns: 'a Address

parentEntity / entityName

Full Usage: parentEntity / entityName

Parameters:
    parentEntity : Entity
    entityName : string

Returns: Entity

Derive an entity from its parent entity.

parentEntity : Entity
entityName : string
Returns: Entity

Type something to start searching.