SimulantPropertyDescriptor (Nu) | Nu

SimulantPropertyDescriptor Module

Namespace: Nu
Assembly: Nu.dll

Simulant PropertyDescriptor functions.

Functions and values

Function or value	Description
`SimulantPropertyDescriptor.containsPropertyDescriptor propertyName simulant world` Full Usage: `SimulantPropertyDescriptor.containsPropertyDescriptor propertyName simulant world` Parameters: propertyName : `string` simulant : `Simulant` world : `World` Returns: `bool`	Check that the described property exists for the given simulant. propertyName : `string` simulant : `Simulant` world : `World` Returns: `bool`
`SimulantPropertyDescriptor.getCategory propertyDesciptor simulant` Full Usage: `SimulantPropertyDescriptor.getCategory propertyDesciptor simulant` Parameters: propertyDesciptor : `PropertyDescriptor` simulant : `Simulant` Returns: `string`	Get the editor category of the described property. propertyDesciptor : `PropertyDescriptor` simulant : `Simulant` Returns: `string`
`SimulantPropertyDescriptor.getEditable propertyDesciptor simulant` Full Usage: `SimulantPropertyDescriptor.getEditable propertyDesciptor simulant` Parameters: propertyDesciptor : `PropertyDescriptor` simulant : `Simulant` Returns: `bool`	Get whether the described property is editable. propertyDesciptor : `PropertyDescriptor` simulant : `Simulant` Returns: `bool`
`SimulantPropertyDescriptor.getPropertyDescriptors simulant world` Full Usage: `SimulantPropertyDescriptor.getPropertyDescriptors simulant world` Parameters: simulant : `Simulant` world : `World` Returns: `PropertyDescriptor list`	Get the property descriptors for the given simulant. simulant : `Simulant` world : `World` Returns: `PropertyDescriptor list`
`SimulantPropertyDescriptor.getValue propertyDescriptor simulant world` Full Usage: `SimulantPropertyDescriptor.getValue propertyDescriptor simulant world` Parameters: propertyDescriptor : `PropertyDescriptor` simulant : `Simulant` world : `World` Returns: `obj`	Get the value of the described property for the given simulant. propertyDescriptor : `PropertyDescriptor` simulant : `Simulant` world : `World` Returns: `obj`
`SimulantPropertyDescriptor.trySetValue value propertyDescriptor simulant world` Full Usage: `SimulantPropertyDescriptor.trySetValue value propertyDescriptor simulant world` Parameters: value : `'a` propertyDescriptor : `PropertyDescriptor` simulant : `Simulant` world : `World` Returns: `Either<string, unit>`	Attempt to set the value of the described property for the given simulant. value : `'a` propertyDescriptor : `PropertyDescriptor` simulant : `Simulant` world : `World` Returns: `Either<string, unit>`