EntityPropertyDescriptor (Nu) | Nu

EntityPropertyDescriptor Module

Namespace: Nu
Assembly: Nu.dll

Entity PropertyDescriptor functions.

Functions and values

Function or value	Description
`EntityPropertyDescriptor.containsPropertyDescriptor propertyName entity world` Full Usage: `EntityPropertyDescriptor.containsPropertyDescriptor propertyName entity world` Parameters: propertyName : `string` entity : `Entity` world : `World` Returns: `bool`	Check that the described property exists for the given entity. propertyName : `string` entity : `Entity` world : `World` Returns: `bool`
`EntityPropertyDescriptor.getCategorizedPropertyDescriptors entity world` Full Usage: `EntityPropertyDescriptor.getCategorizedPropertyDescriptors entity world` Parameters: entity : `Entity` world : `World` Returns: `(Either<string, Type> * PropertyDescriptor seq) seq`	Get the editor-categorized property descriptors for the given entity. entity : `Entity` world : `World` Returns: `(Either<string, Type> * PropertyDescriptor seq) seq`
`EntityPropertyDescriptor.getEditable propertyDescriptor` Full Usage: `EntityPropertyDescriptor.getEditable propertyDescriptor` Parameters: propertyDescriptor : `PropertyDescriptor` Returns: `bool`	Get whether the described property is editable. propertyDescriptor : `PropertyDescriptor` Returns: `bool`
`EntityPropertyDescriptor.getPropertyDescriptors entity world` Full Usage: `EntityPropertyDescriptor.getPropertyDescriptors entity world` Parameters: entity : `Entity` world : `World` Returns: `PropertyDescriptor seq`	Get the property descriptors for the given entity. entity : `Entity` world : `World` Returns: `PropertyDescriptor seq`
`EntityPropertyDescriptor.getValue propertyDescriptor entity world` Full Usage: `EntityPropertyDescriptor.getValue propertyDescriptor entity world` Parameters: propertyDescriptor : `PropertyDescriptor` entity : `Entity` world : `World` Returns: `obj`	Get the value of the described property for the given entity. propertyDescriptor : `PropertyDescriptor` entity : `Entity` world : `World` Returns: `obj`
`EntityPropertyDescriptor.trySetValue value propertyDescriptor entity world` Full Usage: `EntityPropertyDescriptor.trySetValue value propertyDescriptor entity world` Parameters: value : `obj` propertyDescriptor : `PropertyDescriptor` entity : `Entity` world : `World` Returns: `Either<string, unit>`	Attempt to set the value of the described property for the given entity. value : `obj` propertyDescriptor : `PropertyDescriptor` entity : `Entity` world : `World` Returns: `Either<string, unit>`