Header menu logo Nu

GamePropertyDescriptor Module

Game PropertyDescriptor functions.

Functions and values

Function or value Description

GamePropertyDescriptor.containsPropertyDescriptor propertyName game world

Full Usage: GamePropertyDescriptor.containsPropertyDescriptor propertyName game world

Parameters:
    propertyName : string
    game : Game
    world : World

Returns: bool

Check that the described property exists for the game.

propertyName : string
game : Game
world : World
Returns: bool

GamePropertyDescriptor.getCategory propertyDescriptor

Full Usage: GamePropertyDescriptor.getCategory propertyDescriptor

Parameters:
Returns: string

Get the editor category of the described property.

propertyDescriptor : PropertyDescriptor
Returns: string

GamePropertyDescriptor.getEditable propertyDescriptor

Full Usage: GamePropertyDescriptor.getEditable propertyDescriptor

Parameters:
Returns: bool

Get whether the described property is editable.

propertyDescriptor : PropertyDescriptor
Returns: bool

GamePropertyDescriptor.getPropertyDescriptors game world

Full Usage: GamePropertyDescriptor.getPropertyDescriptors game world

Parameters:
Returns: PropertyDescriptor list

Get the property descriptors for the game.

game : Game
world : World
Returns: PropertyDescriptor list

GamePropertyDescriptor.getValue propertyDescriptor game world

Full Usage: GamePropertyDescriptor.getValue propertyDescriptor game world

Parameters:
Returns: obj

Get the value of the described property for the game.

propertyDescriptor : PropertyDescriptor
game : Game
world : World
Returns: obj

GamePropertyDescriptor.trySetValue value propertyDescriptor game world

Full Usage: GamePropertyDescriptor.trySetValue value propertyDescriptor game world

Parameters:
Returns: Either<string, unit>

Attempt to set the value of the described property for the game.

value : obj
propertyDescriptor : PropertyDescriptor
game : Game
world : World
Returns: Either<string, unit>

Type something to start searching.