WorldGroupModule (Nu)

WorldGroupModule Module

Namespace: Nu
Assembly: Nu.dll

Group functions for the world (2/2).

Type extensions

Type extension	Description
`this.ChangeEvent` Full Usage: `this.ChangeEvent` Parameters: propertyName : `string` Returns: `ChangeData Address`	Extended Type: `Group` propertyName : `string` Returns: `ChangeData Address`
`this.Destroying` Full Usage: `this.Destroying` Parameters: () : `unit` Returns: `Lens<bool, Group>`	Extended Type: `Group` () : `unit` Returns: `Lens<bool, Group>`
`this.Destroying` Full Usage: `this.Destroying` Returns: `Lens<bool, Group>`	Extended Type: `Group` Returns: `Lens<bool, Group>`
`this.Dispatcher` Full Usage: `this.Dispatcher` Parameters: () : `unit` Returns: `Lens<GroupDispatcher, Group>`	Extended Type: `Group` () : `unit` Returns: `Lens<GroupDispatcher, Group>`
`this.Dispatcher` Full Usage: `this.Dispatcher` Returns: `Lens<GroupDispatcher, Group>`	Extended Type: `Group` Returns: `Lens<GroupDispatcher, Group>`
`this.Get` Full Usage: `this.Get` Parameters: propertyName : `string` world : `World` Returns: `'a`	Get an xtension property value. Extended Type: `Group` propertyName : `string` world : `World` Returns: `'a`
`this.GetDestroying` Full Usage: `this.GetDestroying` Parameters: world : `World` Returns: `bool`	Extended Type: `Group` world : `World` Returns: `bool`
`this.GetDispatcher` Full Usage: `this.GetDispatcher` Parameters: world : `World` Returns: `GroupDispatcher`	Extended Type: `Group` world : `World` Returns: `GroupDispatcher`
`this.GetExists` Full Usage: `this.GetExists` Parameters: world : `World` Returns: `bool`	Check that a group exists in the world. Extended Type: `Group` world : `World` Returns: `bool`
`this.GetId` Full Usage: `this.GetId` Parameters: world : `World` Returns: `uint64`	Extended Type: `Group` world : `World` Returns: `uint64`
`this.GetModelGeneric` Full Usage: `this.GetModelGeneric` Parameters: world : `World` Returns: `'a`	Extended Type: `Group` world : `World` Returns: `'a`
`this.GetOrder` Full Usage: `this.GetOrder` Parameters: world : `World` Returns: `int64`	Extended Type: `Group` world : `World` Returns: `int64`
`this.GetPersistent` Full Usage: `this.GetPersistent` Parameters: world : `World` Returns: `bool`	Extended Type: `Group` world : `World` Returns: `bool`
`this.GetProperty` Full Usage: `this.GetProperty` Parameters: propertyName : `string` world : `World` Returns: `Property`	Get a property value and type. Extended Type: `Group` propertyName : `string` world : `World` Returns: `Property`
`this.GetProtected` Full Usage: `this.GetProtected` Parameters: world : `World` Returns: `bool`	Extended Type: `Group` world : `World` Returns: `bool`
`this.GetSelected` Full Usage: `this.GetSelected` Parameters: world : `World` Returns: `bool`	Check that a group is selected. Extended Type: `Group` world : `World` Returns: `bool`
`this.GetVisible` Full Usage: `this.GetVisible` Parameters: world : `World` Returns: `bool`	Extended Type: `Group` world : `World` Returns: `bool`
`this.Id` Full Usage: `this.Id` Parameters: () : `unit` Returns: `Lens<uint64, Group>`	Extended Type: `Group` () : `unit` Returns: `Lens<uint64, Group>`
`this.Id` Full Usage: `this.Id` Returns: `Lens<uint64, Group>`	Extended Type: `Group` Returns: `Lens<uint64, Group>`
`this.Is` Full Usage: `this.Is` Parameters: dispatcherType : `Type` world : `World` Returns: `bool`	Check that a group dispatches in the same manner as the dispatcher with the given type. Extended Type: `Group` dispatcherType : `Type` world : `World` Returns: `bool`
`this.Is` Full Usage: `this.Is` Parameters: world : `World` Returns: `bool`	Check that a group dispatches in the same manner as the dispatcher with the given type. Extended Type: `Group` world : `World` Returns: `bool`
`this.ModelGeneric` Full Usage: `this.ModelGeneric` Parameters: () : `unit` Returns: `Lens<'a, Group>`	Extended Type: `Group` () : `unit` Returns: `Lens<'a, Group>`
`this.NotifyModelChange` Full Usage: `this.NotifyModelChange` Parameters: world : `World`	Notify the engine that a group's MMCC model has changed in some automatically undetectable way (such as being mutated directly by user code). Extended Type: `Group` world : `World`
`this.Order` Full Usage: `this.Order` Parameters: () : `unit` Returns: `Lens<int64, Group>`	Extended Type: `Group` () : `unit` Returns: `Lens<int64, Group>`
`this.Order` Full Usage: `this.Order` Returns: `Lens<int64, Group>`	Extended Type: `Group` Returns: `Lens<int64, Group>`
`this.Persistent` Full Usage: `this.Persistent` Parameters: () : `unit` Returns: `Lens<bool, Group>`	Extended Type: `Group` () : `unit` Returns: `Lens<bool, Group>`
`this.Persistent` Full Usage: `this.Persistent` Returns: `Lens<bool, Group>`	Extended Type: `Group` Returns: `Lens<bool, Group>`
`this.PostUpdateEvent` Full Usage: `this.PostUpdateEvent` Parameters: () : `unit` Returns: `unit Address`	Extended Type: `Group` () : `unit` Returns: `unit Address`
`this.PostUpdateEvent` Full Usage: `this.PostUpdateEvent` Returns: `unit Address`	Extended Type: `Group` Returns: `unit Address`
`this.PreUpdateEvent` Full Usage: `this.PreUpdateEvent` Parameters: () : `unit` Returns: `unit Address`	Extended Type: `Group` () : `unit` Returns: `unit Address`
`this.PreUpdateEvent` Full Usage: `this.PreUpdateEvent` Returns: `unit Address`	Extended Type: `Group` Returns: `unit Address`
`this.Protected` Full Usage: `this.Protected` Parameters: () : `unit` Returns: `Lens<bool, Group>`	Extended Type: `Group` () : `unit` Returns: `Lens<bool, Group>`
`this.Protected` Full Usage: `this.Protected` Returns: `Lens<bool, Group>`	Extended Type: `Group` Returns: `Lens<bool, Group>`
`this.RegisterEvent` Full Usage: `this.RegisterEvent` Parameters: () : `unit` Returns: `unit Address`	Extended Type: `Group` () : `unit` Returns: `unit Address`
`this.RegisterEvent` Full Usage: `this.RegisterEvent` Returns: `unit Address`	Extended Type: `Group` Returns: `unit Address`
`this.Set` Full Usage: `this.Set` Parameters: propertyName : `string` value : `'a` world : `World`	Set an xtension property value. Extended Type: `Group` propertyName : `string` value : `'a` world : `World`
`this.SetModelGeneric` Full Usage: `this.SetModelGeneric` Parameters: value : `'a` world : `World`	Extended Type: `Group` value : `'a` world : `World`
`this.SetPersistent` Full Usage: `this.SetPersistent` Parameters: value : `bool` world : `World`	Extended Type: `Group` value : `bool` world : `World`
`this.SetProperty` Full Usage: `this.SetProperty` Parameters: propertyName : `string` property : `Property` world : `World`	Set a property value with explicit type. Extended Type: `Group` propertyName : `string` property : `Property` world : `World`
`this.SetVisible` Full Usage: `this.SetVisible` Parameters: value : `bool` world : `World`	Extended Type: `Group` value : `bool` world : `World`
`this.Signal` Full Usage: `this.Signal` Parameters: signal : `Signal` world : `World`	Send a signal to a group. Extended Type: `Group` signal : `Signal` world : `World`
`this.TimeUpdateEvent` Full Usage: `this.TimeUpdateEvent` Parameters: () : `unit` Returns: `unit Address`	Extended Type: `Group` () : `unit` Returns: `unit Address`
`this.TimeUpdateEvent` Full Usage: `this.TimeUpdateEvent` Returns: `unit Address`	Extended Type: `Group` Returns: `unit Address`
`this.TryGet` Full Usage: `this.TryGet` Parameters: propertyName : `string` world : `World` Returns: `'a voption`	Try to get an xtension property value. Extended Type: `Group` propertyName : `string` world : `World` Returns: `'a voption`
`this.TryGetProperty` Full Usage: `this.TryGetProperty` Parameters: propertyName : `string` world : `World` Returns: `Property option`	Try to get a property value and type. Extended Type: `Group` propertyName : `string` world : `World` Returns: `Property option`
`this.TrySet` Full Usage: `this.TrySet` Parameters: propertyName : `string` value : `'a` world : `World` Returns: `bool * bool`	To try set an xtension property value. Extended Type: `Group` propertyName : `string` value : `'a` world : `World` Returns: `bool * bool`
`this.TrySetProperty` Full Usage: `this.TrySetProperty` Parameters: propertyName : `string` property : `Property` world : `World` Returns: `bool * bool`	Try to set a property value with explicit type. Extended Type: `Group` propertyName : `string` property : `Property` world : `World` Returns: `bool * bool`
`this.UnregisteringEvent` Full Usage: `this.UnregisteringEvent` Parameters: () : `unit` Returns: `unit Address`	Extended Type: `Group` () : `unit` Returns: `unit Address`
`this.UnregisteringEvent` Full Usage: `this.UnregisteringEvent` Returns: `unit Address`	Extended Type: `Group` Returns: `unit Address`
`this.UpdateEvent` Full Usage: `this.UpdateEvent` Parameters: () : `unit` Returns: `unit Address`	Extended Type: `Group` () : `unit` Returns: `unit Address`
`this.UpdateEvent` Full Usage: `this.UpdateEvent` Returns: `unit Address`	Extended Type: `Group` Returns: `unit Address`
`this.Visible` Full Usage: `this.Visible` Parameters: () : `unit` Returns: `Lens<bool, Group>`	Extended Type: `Group` () : `unit` Returns: `Lens<bool, Group>`
`this.Visible` Full Usage: `this.Visible` Returns: `Lens<bool, Group>`	Extended Type: `Group` Returns: `Lens<bool, Group>`
`World.createGroup nameOpt screen world` Full Usage: `World.createGroup nameOpt screen world` Parameters: nameOpt : `string option` screen : `Screen` world : `World` Returns: `Group`	Create a group and add it to the world. Extended Type: `World` nameOpt : `string option` screen : `Screen` world : `World` Returns: `Group`
`World.createGroup3 descriptor screen world` Full Usage: `World.createGroup3 descriptor screen world` Parameters: descriptor : `SimulantDescriptor` screen : `Screen` world : `World` Returns: `Group`	Create a group from a simulant descriptor. Extended Type: `World` descriptor : `SimulantDescriptor` screen : `Screen` world : `World` Returns: `Group`
`World.createGroup5 skipProcessing dispatcherName nameOpt screen world` Full Usage: `World.createGroup5 skipProcessing dispatcherName nameOpt screen world` Parameters: skipProcessing : `bool` dispatcherName : `string` nameOpt : `string option` screen : `Screen` world : `World` Returns: `Group`	Create a group and add it to the world. Extended Type: `World` skipProcessing : `bool` dispatcherName : `string` nameOpt : `string option` screen : `Screen` world : `World` Returns: `Group`
`World.destroyGroup group world` Full Usage: `World.destroyGroup group world` Parameters: group : `Group` world : `World`	Destroy a group in the world at the end of the current update. Extended Type: `World` group : `Group` world : `World`
`World.destroyGroupImmediate group world` Full Usage: `World.destroyGroupImmediate group world` Parameters: group : `Group` world : `World`	Destroy a group in the world immediately. Can be dangerous if existing in-flight publishing depends on the group's existence. Consider using World.destroyGroup instead. Extended Type: `World` group : `Group` world : `World`
`World.destroyGroups groups world` Full Usage: `World.destroyGroups groups world` Parameters: groups : `Group seq` world : `World`	Destroy multiple groups from the world at the end of the current update. Extended Type: `World` groups : `Group seq` world : `World`
`World.destroyGroupsImmediate groups world` Full Usage: `World.destroyGroupsImmediate groups world` Parameters: groups : `Group seq` world : `World`	Destroy multiple groups in the world immediately. Can be dangerous if existing in-flight publishing depends on any of the groups' existences. Consider using World.destroyGroups instead. Extended Type: `World` groups : `Group seq` world : `World`
`World.editGroup operation group world` Full Usage: `World.editGroup operation group world` Parameters: operation : `EditOperation` group : `Group` world : `World`	Edit a game with the given operation using the ImGui APIs. Intended only to be called by editors like Gaia. Extended Type: `World` operation : `EditOperation` group : `Group` world : `World`
`World.getGroups screen world` Full Usage: `World.getGroups screen world` Parameters: screen : `Screen` world : `World` Returns: `Group seq`	Get all the groups in a screen. Extended Type: `World` screen : `Screen` world : `World` Returns: `Group seq`
`World.readGroup groupDescriptor nameOpt screen world` Full Usage: `World.readGroup groupDescriptor nameOpt screen world` Parameters: groupDescriptor : `GroupDescriptor` nameOpt : `string option` screen : `Screen` world : `World` Returns: `Group`	Read a group from a group descriptor. Extended Type: `World` groupDescriptor : `GroupDescriptor` nameOpt : `string option` screen : `Screen` world : `World` Returns: `Group`
`World.readGroupFromFile filePath nameOpt screen world` Full Usage: `World.readGroupFromFile filePath nameOpt screen world` Parameters: filePath : `string` nameOpt : `string option` screen : `Screen` world : `World` Returns: `Group`	Read a group from a file. Extended Type: `World` filePath : `string` nameOpt : `string option` screen : `Screen` world : `World` Returns: `Group`
`World.readGroups groupDescriptors screen world` Full Usage: `World.readGroups groupDescriptors screen world` Parameters: groupDescriptors : `GroupDescriptor seq` screen : `Screen` world : `World` Returns: `Group list`	Read multiple groups from a screen descriptor. Extended Type: `World` groupDescriptors : `GroupDescriptor seq` screen : `Screen` world : `World` Returns: `Group list`
`World.renameGroup source destination world` Full Usage: `World.renameGroup source destination world` Parameters: source : `Group` destination : `Group` world : `World`	Rename a group. Extended Type: `World` source : `Group` destination : `Group` world : `World`
`World.renameGroupImmediate source destination world` Full Usage: `World.renameGroupImmediate source destination world` Parameters: source : `Group` destination : `Group` world : `World`	Rename a group. Note that since this destroys the renamed group immediately, you should not call this inside an event handler that involves the reassigned group itself. Note this also renames all of its descendents accordingly. Extended Type: `World` source : `Group` destination : `Group` world : `World`
`World.tryTruncateGroupModel model group world` Full Usage: `World.tryTruncateGroupModel model group world` Parameters: model : `'model` group : `Group` world : `World` Returns: `'model option`	Attempt to truncate a group model. Extended Type: `World` model : `'model` group : `Group` world : `World` Returns: `'model option`
`World.tryUntruncateGroupModel model group world` Full Usage: `World.tryUntruncateGroupModel model group world` Parameters: model : `'model` group : `Group` world : `World` Returns: `'model option`	Attempt to untruncate a group model. Extended Type: `World` model : `'model` group : `Group` world : `World` Returns: `'model option`
`World.writeGroup groupDescriptor group world` Full Usage: `World.writeGroup groupDescriptor group world` Parameters: groupDescriptor : `GroupDescriptor` group : `Group` world : `World` Returns: `GroupDescriptor`	Write a group to a group descriptor. Extended Type: `World` groupDescriptor : `GroupDescriptor` group : `Group` world : `World` Returns: `GroupDescriptor`
`World.writeGroupToFile filePath group world` Full Usage: `World.writeGroupToFile filePath group world` Parameters: filePath : `string` group : `Group` world : `World`	Write a group to a file. Extended Type: `World` filePath : `string` group : `Group` world : `World`
`World.writeGroups groups world` Full Usage: `World.writeGroups groups world` Parameters: groups : `Group seq` world : `World` Returns: `GroupDescriptor list`	Write multiple groups to a screen descriptor. Extended Type: `World` groups : `Group seq` world : `World` Returns: `GroupDescriptor list`