Header menu logo Nu

GroupState Type

Hosts the ongoing state of a group.

Record fields

Record Field Description

Content

Full Usage: Content

Field type: GroupContent
Field type: GroupContent

Dispatcher

Full Usage: Dispatcher

Field type: GroupDispatcher
Field type: GroupDispatcher

Id

Full Usage: Id

Field type: uint64
Field type: uint64

Model

Full Usage: Model

Field type: DesignerProperty
Modifiers: mutable
Field type: DesignerProperty

Name

Full Usage: Name

Field type: string
Field type: string

Order

Full Usage: Order

Field type: int64
Field type: int64

Persistent

Full Usage: Persistent

Field type: bool
Field type: bool

Protected

Full Usage: Protected

Field type: bool
Field type: bool

Visible

Full Usage: Visible

Field type: bool
Field type: bool

Xtension

Full Usage: Xtension

Field type: Xtension
Modifiers: mutable
Field type: Xtension

Static members

Static member Description

GroupState.attachProperty name property groupState

Full Usage: GroupState.attachProperty name property groupState

Parameters:
Returns: GroupState

Attach an xtension property.

name : string
property : Property
groupState : GroupState
Returns: GroupState

GroupState.copy this

Full Usage: GroupState.copy this

Parameters:
Returns: GroupState

Copy a group state such as when, say, you need it to be mutated with reflection but you need to preserve persistence.

this : GroupState
Returns: GroupState

GroupState.detachProperty name groupState

Full Usage: GroupState.detachProperty name groupState

Parameters:
Returns: GroupState

Detach an xtension property.

name : string
groupState : GroupState
Returns: GroupState

GroupState.getProperty propertyName groupState

Full Usage: GroupState.getProperty propertyName groupState

Parameters:
Returns: Property

Get an xtension property and its type information.

propertyName : string
groupState : GroupState
Returns: Property

GroupState.make nameOpt dispatcher

Full Usage: GroupState.make nameOpt dispatcher

Parameters:
Returns: GroupState

Make a group state value.

nameOpt : string option
dispatcher : GroupDispatcher
Returns: GroupState

GroupState.setProperty propertyName property groupState

Full Usage: GroupState.setProperty propertyName property groupState

Parameters:
Returns: GroupState

Set an xtension property with explicit type information.

propertyName : string
property : Property
groupState : GroupState
Returns: GroupState

GroupState.tryGetProperty (propertyName, groupState, propertyRef)

Full Usage: GroupState.tryGetProperty (propertyName, groupState, propertyRef)

Parameters:
Returns: bool

Try to get an xtension property and its type information.

propertyName : string
groupState : GroupState
propertyRef : outref<Property>
Returns: bool

GroupState.trySetProperty propertyName property groupState

Full Usage: GroupState.trySetProperty propertyName property groupState

Parameters:
Returns: bool * GroupState

Try to set an xtension property with explicit type information.

propertyName : string
property : Property
groupState : GroupState
Returns: bool * GroupState

Type something to start searching.