Header menu logo Nu

GroupPropertyDescriptor Module

Group PropertyDescriptor functions.

Functions and values

Function or value Description

GroupPropertyDescriptor.containsPropertyDescriptor propertyName group world

Full Usage: GroupPropertyDescriptor.containsPropertyDescriptor propertyName group world

Parameters:
    propertyName : string
    group : Group
    world : World

Returns: bool

Check that the described property exists for the given group.

propertyName : string
group : Group
world : World
Returns: bool

GroupPropertyDescriptor.getCategory propertyDescriptor

Full Usage: GroupPropertyDescriptor.getCategory propertyDescriptor

Parameters:
Returns: string

Get the editor category of the described property.

propertyDescriptor : PropertyDescriptor
Returns: string

GroupPropertyDescriptor.getEditable propertyDescriptor

Full Usage: GroupPropertyDescriptor.getEditable propertyDescriptor

Parameters:
Returns: bool

Get whether the described property is editable.

propertyDescriptor : PropertyDescriptor
Returns: bool

GroupPropertyDescriptor.getPropertyDescriptors group world

Full Usage: GroupPropertyDescriptor.getPropertyDescriptors group world

Parameters:
Returns: PropertyDescriptor list

Get the property descriptors for the given group.

group : Group
world : World
Returns: PropertyDescriptor list

GroupPropertyDescriptor.getValue propertyDescriptor group world

Full Usage: GroupPropertyDescriptor.getValue propertyDescriptor group world

Parameters:
Returns: obj

Get the value of the described property for the given group.

propertyDescriptor : PropertyDescriptor
group : Group
world : World
Returns: obj

GroupPropertyDescriptor.trySetValue value propertyDescriptor group world

Full Usage: GroupPropertyDescriptor.trySetValue value propertyDescriptor group world

Parameters:
Returns: Either<string, unit>

Attempt to set the value of the described property for the given group.

value : obj
propertyDescriptor : PropertyDescriptor
group : Group
world : World
Returns: Either<string, unit>

Type something to start searching.