EntityState (Nu)

EntityState Type

Namespace: Nu
Assembly: Nu.dll
Base Type: obj
All Interfaces: SimulantState

Hosts the ongoing state of an entity.

Record fields

Record Field	Description
`AnglesLocal` Full Usage: `AnglesLocal` Field type: `Vector3` Modifiers: mutable	Field type: `Vector3`
`Content` Full Usage: `Content` Field type: `EntityContent` Modifiers: mutable	Field type: `EntityContent`
`Dispatcher` Full Usage: `Dispatcher` Field type: `EntityDispatcher` Modifiers: mutable	Field type: `EntityDispatcher`
`ElevationLocal` Full Usage: `ElevationLocal` Field type: `single` Modifiers: mutable	Field type: `single`
`FacetNames` Full Usage: `FacetNames` Field type: `Set<string>` Modifiers: mutable	Field type: `Set<string>`
`Facets` Full Usage: `Facets` Field type: `Facet array` Modifiers: mutable	Field type: `Facet array`
`Id` Full Usage: `Id` Field type: `uint64`	Field type: `uint64`
`Model` Full Usage: `Model` Field type: `DesignerProperty` Modifiers: mutable	Field type: `DesignerProperty`
`MountOpt` Full Usage: `MountOpt` Field type: `Entity Relation option` Modifiers: mutable	Field type: `Entity Relation option`
`Order` Full Usage: `Order` Field type: `int64` Modifiers: mutable	Field type: `int64`
`OverlayNameOpt` Full Usage: `OverlayNameOpt` Field type: `string option` Modifiers: mutable	Field type: `string option`
`PositionLocal` Full Usage: `PositionLocal` Field type: `Vector3` Modifiers: mutable	Field type: `Vector3`
`PropagatedDescriptorOpt` Full Usage: `PropagatedDescriptorOpt` Field type: `EntityDescriptor option` Modifiers: mutable	Field type: `EntityDescriptor option`
`PropagationSourceOpt` Full Usage: `PropagationSourceOpt` Field type: `Entity option` Modifiers: mutable	Field type: `Entity option`
`RotationLocal` Full Usage: `RotationLocal` Field type: `Quaternion` Modifiers: mutable	Field type: `Quaternion`
`ScaleLocal` Full Usage: `ScaleLocal` Field type: `Vector3` Modifiers: mutable	Field type: `Vector3`
`Surnames` Full Usage: `Surnames` Field type: `string array`	Field type: `string array`
`Transform` Full Usage: `Transform` Field type: `Transform` Modifiers: mutable	Field type: `Transform`
`Xtension` Full Usage: `Xtension` Field type: `Xtension` Modifiers: mutable	Field type: `Xtension`

Instance members

Instance member	Description
`this.Absolute` Full Usage: `this.Absolute`
`this.AffineMatrix` Full Usage: `this.AffineMatrix` Returns: `Matrix4x4`	Returns: `Matrix4x4`
`this.AlwaysRender` Full Usage: `this.AlwaysRender`
`this.AlwaysUpdate` Full Usage: `this.AlwaysUpdate`
`this.Angles` Full Usage: `this.Angles`
`this.Bounds` Full Usage: `this.Bounds` Returns: `Box3`	Returns: `Box3`
`this.CastShadow` Full Usage: `this.CastShadow`
`this.Degrees` Full Usage: `this.Degrees`
`this.DegreesLocal` Full Usage: `this.DegreesLocal`
`this.Elevation` Full Usage: `this.Elevation`
`this.Enabled` Full Usage: `this.Enabled`
`this.EnabledLocal` Full Usage: `this.EnabledLocal`
`this.Is2d` Full Usage: `this.Is2d` Returns: `bool`	Returns: `bool`
`this.Is3d` Full Usage: `this.Is3d` Returns: `bool`	Returns: `bool`
`this.Light` Full Usage: `this.Light` Returns: `bool`	Returns: `bool`
`this.LightProbe` Full Usage: `this.LightProbe` Returns: `bool`	Returns: `bool`
`this.Mounted` Full Usage: `this.Mounted`
`this.Offset` Full Usage: `this.Offset`
`this.Optimized` Full Usage: `this.Optimized` Parameters: imperative : `bool` Returns: `bool`	imperative : `bool` Returns: `bool`
`this.Overflow` Full Usage: `this.Overflow`
`this.Perimeter` Full Usage: `this.Perimeter`
`this.PerimeterBottom` Full Usage: `this.PerimeterBottom`
`this.PerimeterBottomLeft` Full Usage: `this.PerimeterBottomLeft`
`this.PerimeterBottomLeftLocal` Full Usage: `this.PerimeterBottomLeftLocal` Returns: `Vector3`	Returns: `Vector3`
`this.PerimeterBottomLocal` Full Usage: `this.PerimeterBottomLocal` Returns: `Vector3`	Returns: `Vector3`
`this.PerimeterCenter` Full Usage: `this.PerimeterCenter`
`this.PerimeterCenterLocal` Full Usage: `this.PerimeterCenterLocal` Returns: `Vector3`	Returns: `Vector3`
`this.PerimeterMax` Full Usage: `this.PerimeterMax`
`this.PerimeterMaxLocal` Full Usage: `this.PerimeterMaxLocal` Returns: `Vector3`	Returns: `Vector3`
`this.PerimeterMin` Full Usage: `this.PerimeterMin`
`this.PerimeterMinLocal` Full Usage: `this.PerimeterMinLocal` Returns: `Vector3`	Returns: `Vector3`
`this.PerimeterUnscaled` Full Usage: `this.PerimeterUnscaled`
`this.Persistent` Full Usage: `this.Persistent`
`this.Physical` Full Usage: `this.Physical` Returns: `bool`	Returns: `bool`
`this.Pickable` Full Usage: `this.Pickable`
`this.Position` Full Usage: `this.Position`
`this.Presence` Full Usage: `this.Presence`
`this.PresenceOverride` Full Usage: `this.PresenceOverride`
`this.Protected` Full Usage: `this.Protected`
`this.PublishChangeEvents` Full Usage: `this.PublishChangeEvents`
`this.PublishUpdates` Full Usage: `this.PublishUpdates`
`this.Rotation` Full Usage: `this.Rotation`
`this.RotationMatrix` Full Usage: `this.RotationMatrix` Returns: `Matrix4x4`	Returns: `Matrix4x4`
`this.Scale` Full Usage: `this.Scale`
`this.Size` Full Usage: `this.Size`
`this.Static` Full Usage: `this.Static`
`this.Visible` Full Usage: `this.Visible`
`this.VisibleLocal` Full Usage: `this.VisibleLocal`

Static members

Static member	Description
`EntityState.attachProperty name property entityState` Full Usage: `EntityState.attachProperty name property entityState` Parameters: name : `string` property : `Property` entityState : `EntityState` Returns: `EntityState`	Attach an xtension property. name : `string` property : `Property` entityState : `EntityState` Returns: `EntityState`
`EntityState.containsRuntimeProperties entityState` Full Usage: `EntityState.containsRuntimeProperties entityState` Parameters: entityState : `EntityState` Returns: `bool` Modifiers: inline	Check that there exists an xtenstion property that is a runtime property. entityState : `EntityState` Returns: `bool`
`EntityState.copy entityState` Full Usage: `EntityState.copy entityState` Parameters: entityState : `EntityState` Returns: `EntityState` Modifiers: inline	Copy an entity state, invalidating the incoming reference. This is used when we want to retain an old version of an entity state in face of mutation. entityState : `EntityState` Returns: `EntityState`
`EntityState.detachProperty name entityState` Full Usage: `EntityState.detachProperty name entityState` Parameters: name : `string` entityState : `EntityState` Returns: `EntityState`	Detach an xtension property. name : `string` entityState : `EntityState` Returns: `EntityState`
`EntityState.getProperty propertyName entityState` Full Usage: `EntityState.getProperty propertyName entityState` Parameters: propertyName : `string` entityState : `EntityState` Returns: `Property`	Get an xtension property and its type information. propertyName : `string` entityState : `EntityState` Returns: `Property`
`EntityState.make imperative surnamesOpt overlayNameOpt dispatcher` Full Usage: `EntityState.make imperative surnamesOpt overlayNameOpt dispatcher` Parameters: imperative : `bool` surnamesOpt : `string array option` overlayNameOpt : `string option` dispatcher : `EntityDispatcher` Returns: `EntityState`	Make an entity state value. imperative : `bool` surnamesOpt : `string array option` overlayNameOpt : `string option` dispatcher : `EntityDispatcher` Returns: `EntityState`
`EntityState.setProperty propertyName property entityState` Full Usage: `EntityState.setProperty propertyName property entityState` Parameters: propertyName : `string` property : `Property` entityState : `EntityState` Returns: `EntityState`	Set an xtension property with explicit type information. propertyName : `string` property : `Property` entityState : `EntityState` Returns: `EntityState`
`EntityState.tryGetProperty (propertyName, entityState, propertyRef)` Full Usage: `EntityState.tryGetProperty (propertyName, entityState, propertyRef)` Parameters: propertyName : `string` entityState : `EntityState` propertyRef : `outref<Property>` Returns: `bool`	Try to get an xtension property and its type information. propertyName : `string` entityState : `EntityState` propertyRef : `outref<Property>` Returns: `bool`
`EntityState.trySetProperty propertyName property entityState` Full Usage: `EntityState.trySetProperty propertyName property entityState` Parameters: propertyName : `string` property : `Property` entityState : `EntityState` Returns: `bool * EntityState`	Try to set an xtension property with explicit type information. propertyName : `string` property : `Property` entityState : `EntityState` Returns: `bool * EntityState`