Header menu logo Nu

Group Type

Forms a logical group of entities.

Constructors

Constructor Description

Group(gameName, screenName, groupName)

Full Usage: Group(gameName, screenName, groupName)

Parameters:
    gameName : string
    screenName : string
    groupName : string

Returns: Group

Create a group reference from a the required names.

gameName : string
screenName : string
groupName : string
Returns: Group

Group(groupNames)

Full Usage: Group(groupNames)

Parameters:
    groupNames : string list

Returns: Group

Create a group reference from a list of names.

groupNames : string list
Returns: Group

Group(groupNames)

Full Usage: Group(groupNames)

Parameters:
    groupNames : string array

Returns: Group

Create a group reference from a list of names.

groupNames : string array
Returns: Group

Group(groupAddressStr)

Full Usage: Group(groupAddressStr)

Parameters:
    groupAddressStr : string

Returns: Group

Create a group reference from an address string.

groupAddressStr : string
Returns: Group

Group(groupAddress)

Full Usage: Group(groupAddress)

Parameters:
Returns: Group
groupAddress : Group Address
Returns: Group

Instance members

Instance member Description

this.GroupAddress

Full Usage: this.GroupAddress

Returns: Group Address

The address of the group.

Returns: Group Address

this.Name

Full Usage: this.Name

Returns: string
Modifiers: inline

Get the name of a group.

Returns: string

this.Names

Full Usage: this.Names

Returns: string array
Modifiers: inline

Get the names of a group.

Returns: string array

this.Screen

Full Usage: this.Screen

Returns: Screen

The containing screen of the group.

Returns: Screen

Static members

Static member Description

address --> group

Full Usage: address --> group

Parameters:
Returns: 'a Address

Concatenate an address with a group's address.

address : 'a Address
group : Group
Returns: 'a Address

group / entityName

Full Usage: group / entityName

Parameters:
    group : Group
    entityName : string

Returns: Entity

Derive an entity from its group.

group : Group
entityName : string
Returns: Entity

Type something to start searching.