WorldSimulantModule (Nu) | Nu

WorldSimulantModule Module

Namespace: Nu
Assembly: Nu.dll

Generalized simulant functions for the world.

Type extensions

Type extension	Description
`World.deriveFromAddress address` Full Usage: `World.deriveFromAddress address` Parameters: address : `Address` Returns: `Simulant`	Convert an address to a concrete simulant reference. Extended Type: `World` address : `Address` Returns: `Simulant`
`World.deriveFromEventAddress event` Full Usage: `World.deriveFromEventAddress event` Parameters: event : `Address` Returns: `Simulant`	Convert an event address to the concrete simulant that it targets. Extended Type: `World` event : `Address` Returns: `Simulant`
`World.deriveFromNames names` Full Usage: `World.deriveFromNames names` Parameters: names : `string seq` Returns: `Simulant`	Convert an address to a concrete simulant reference. Extended Type: `World` names : `string seq` Returns: `Simulant`
`World.destroy simulant world` Full Usage: `World.destroy simulant world` Parameters: simulant : `Simulant` world : `World`	Destroy the given simulant. Extended Type: `World` simulant : `Simulant` world : `World`
`World.destroyImmediate simulant world` Full Usage: `World.destroyImmediate simulant world` Parameters: simulant : `Simulant` world : `World`	Destroy the given simulant. Extended Type: `World` simulant : `Simulant` world : `World`
`World.edit operation simulant world` Full Usage: `World.edit operation simulant world` Parameters: operation : `EditOperation` simulant : `Simulant` world : `World`	Edit a simulant with the given operation using the ImGui APIs. Intended only to be called by editors like Gaia. Extended Type: `World` operation : `EditOperation` simulant : `Simulant` world : `World`
`World.getChildren simulant world` Full Usage: `World.getChildren simulant world` Parameters: simulant : `Simulant` world : `World` Returns: `IEnumerable<Simulant>`	Get the existing children of the given simulant. Extended Type: `World` simulant : `Simulant` world : `World` Returns: `IEnumerable<Simulant>`
`World.getDispatcher simulant world` Full Usage: `World.getDispatcher simulant world` Parameters: simulant : `Simulant` world : `World` Returns: `Dispatcher`	Get the given simulant's dispatcher. Extended Type: `World` simulant : `Simulant` world : `World` Returns: `Dispatcher`
`World.getExists simulant world` Full Usage: `World.getExists simulant world` Parameters: simulant : `Simulant` world : `World` Returns: `bool`	Check that a simulant exists in the world. Extended Type: `World` simulant : `Simulant` world : `World` Returns: `bool`
`World.getParent simulant world` Full Usage: `World.getParent simulant world` Parameters: simulant : `Simulant` world : `World` Returns: `Simulant`	Get the parent of the given simulant. Extended Type: `World` simulant : `Simulant` world : `World` Returns: `Simulant`
`World.getPropertyDefinitions simulant world` Full Usage: `World.getPropertyDefinitions simulant world` Parameters: simulant : `Simulant` world : `World` Returns: `Map<string, PropertyDefinition>`	Get the property definitions of the given simulant. Extended Type: `World` simulant : `Simulant` world : `World` Returns: `Map<string, PropertyDefinition>`
`World.getSelected simulant world` Full Usage: `World.getSelected simulant world` Parameters: simulant : `Simulant` world : `World` Returns: `bool`	Determine if a simulant is contained by, or is the same as, any currently selected screen. Game is always considered 'selected' as well. Extended Type: `World` simulant : `Simulant` world : `World` Returns: `bool`
`World.notifyModelChange simulant world` Full Usage: `World.notifyModelChange simulant world` Parameters: simulant : `Simulant` world : `World`	Notify the engine that a simulant's MMCC model has changed in some automatically undetectable way (such as being mutated directly by user code). Extended Type: `World` simulant : `Simulant` world : `World`
`World.tryGetParent simulant world` Full Usage: `World.tryGetParent simulant world` Parameters: simulant : `Simulant` world : `World` Returns: `Simulant option`	Attempt to get the parent of the given simulant. Extended Type: `World` simulant : `Simulant` world : `World` Returns: `Simulant option`
`World.tryTruncateModel model simulant world` Full Usage: `World.tryTruncateModel model simulant world` Parameters: model : `'model` simulant : `Simulant` world : `World` Returns: `'model option`	Attempt to truncate a model. Extended Type: `World` model : `'model` simulant : `Simulant` world : `World` Returns: `'model option`
`World.tryUntruncateModel model simulant world` Full Usage: `World.tryUntruncateModel model simulant world` Parameters: model : `'model` simulant : `Simulant` world : `World` Returns: `'model option`	Attempt to untruncate a model. Extended Type: `World` model : `'model` simulant : `Simulant` world : `World` Returns: `'model option`