ScreenState (Nu) | Nu

ScreenState Type

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

Hosts the ongoing state of a screen.

Record fields

Record Field	Description
`Content` Full Usage: `Content` Field type: `ScreenContent`	Field type: `ScreenContent`
`Dispatcher` Full Usage: `Dispatcher` Field type: `ScreenDispatcher`	Field type: `ScreenDispatcher`
`Id` Full Usage: `Id` Field type: `uint64`	Field type: `uint64`
`Incoming` Full Usage: `Incoming` Field type: `Transition`	Field type: `Transition`
`Model` Full Usage: `Model` Field type: `DesignerProperty` Modifiers: mutable	Field type: `DesignerProperty`
`Name` Full Usage: `Name` Field type: `string`	Field type: `string`
`Nav3d` Full Usage: `Nav3d` Field type: `Nav3d`	Field type: `Nav3d`
`Order` Full Usage: `Order` Field type: `int64`	Field type: `int64`
`Outgoing` Full Usage: `Outgoing` Field type: `Transition`	Field type: `Transition`
`Persistent` Full Usage: `Persistent` Field type: `bool`	Field type: `bool`
`Protected` Full Usage: `Protected` Field type: `bool`	Field type: `bool`
`RequestedSong` Full Usage: `RequestedSong` Field type: `RequestedSong`	Field type: `RequestedSong`
`SlideOpt` Full Usage: `SlideOpt` Field type: `Slide option`	Field type: `Slide option`
`TransitionState` Full Usage: `TransitionState` Field type: `TransitionState`	Field type: `TransitionState`
`Xtension` Full Usage: `Xtension` Field type: `Xtension` Modifiers: mutable	Field type: `Xtension`

Static members

Static member	Description
`ScreenState.attachProperty name property screenState` Full Usage: `ScreenState.attachProperty name property screenState` Parameters: name : `string` property : `Property` screenState : `ScreenState` Returns: `ScreenState`	Attach an xtension property. name : `string` property : `Property` screenState : `ScreenState` Returns: `ScreenState`
`ScreenState.copy this` Full Usage: `ScreenState.copy this` Parameters: this : `ScreenState` Returns: `ScreenState`	Copy a screen state such as when, say, you need it to be mutated with reflection but you need to preserve persistence. this : `ScreenState` Returns: `ScreenState`
`ScreenState.detachProperty name screenState` Full Usage: `ScreenState.detachProperty name screenState` Parameters: name : `string` screenState : `ScreenState` Returns: `ScreenState`	Detach an xtension property. name : `string` screenState : `ScreenState` Returns: `ScreenState`
`ScreenState.getProperty propertyName screenState` Full Usage: `ScreenState.getProperty propertyName screenState` Parameters: propertyName : `string` screenState : `ScreenState` Returns: `Property`	Get an xtension property and its type information. propertyName : `string` screenState : `ScreenState` Returns: `Property`
`ScreenState.make time nameOpt dispatcher` Full Usage: `ScreenState.make time nameOpt dispatcher` Parameters: time : `GameTime` nameOpt : `string option` dispatcher : `ScreenDispatcher` Returns: `ScreenState`	Make a screen state value. time : `GameTime` nameOpt : `string option` dispatcher : `ScreenDispatcher` Returns: `ScreenState`
`ScreenState.setProperty propertyName property screenState` Full Usage: `ScreenState.setProperty propertyName property screenState` Parameters: propertyName : `string` property : `Property` screenState : `ScreenState` Returns: `ScreenState`	Set an xtension property with explicit type information. propertyName : `string` property : `Property` screenState : `ScreenState` Returns: `ScreenState`
`ScreenState.tryGetProperty (propertyName, screenState, propertyRef)` Full Usage: `ScreenState.tryGetProperty (propertyName, screenState, propertyRef)` Parameters: propertyName : `string` screenState : `ScreenState` propertyRef : `outref<Property>` Returns: `bool`	Try to get an xtension property and its type information. propertyName : `string` screenState : `ScreenState` propertyRef : `outref<Property>` Returns: `bool`
`ScreenState.trySetProperty propertyName property screenState` Full Usage: `ScreenState.trySetProperty propertyName property screenState` Parameters: propertyName : `string` property : `Property` screenState : `ScreenState` Returns: `bool * ScreenState`	Try to set an xtension property with explicit type information. propertyName : `string` property : `Property` screenState : `ScreenState` Returns: `bool * ScreenState`