Table of Contents

Struct NuiWindowToken

Namespace
Anvil.API
Assembly
NWN.Anvil.dll

Represents a NUI window instance for a certain player.

public readonly struct NuiWindowToken : IEquatable<NuiWindowToken>
Implements
Inherited Members
Extension Methods

Fields

Invalid

Properties

Player

The player associated with this token.

Token

The window unique token for this player.

WindowId

The user assigned window id of this token.
Creating a new window with the same window id will replace the existing window.

Methods

Close()

Close this window instance.

Dispose()
Equals(NuiWindowToken)

Indicates whether the current object is equal to another object of the same type.

Equals(object?)

Indicates whether this instance and a specified object are equal.

GetBindValue<T>(NuiBind<T>)

Gets the current value of the specified bind for this window instance.

GetBindValues<T>(NuiBind<T>)

Gets the current values of the specified bind for this window instance.

GetHashCode()

Returns the hash code for this instance.

GetUserData<T>()

Get the userdata of this token.

SetBindValue<T>(NuiBind<T>, T)

Sets the current value of the specified bind for this window instance.

SetBindValues<T>(NuiBind<T>, IEnumerable<T>)

Sets the current values of the specified bind for this window instance.

SetBindWatch<T>(NuiBind<T>, bool)

Marks the specified bind as watched/unwatched for this player.

SetGroupLayout(NuiGroup, NuiLayout)

Applies the specified group layout for this player.

SetUserData<T>(T)

Sets an arbitrary json value as userdata on this token.
This userdata is not read or handled by the game engine and not sent to clients.
This mechanism only exists as a convenience for the programmer to store data bound to a windows' lifecycle.
Will do nothing if the window does not exist.

Events

OnNuiEvent

Called when a player triggers an event in the NUI system.

Operators

operator ==(NuiWindowToken, NuiWindowToken)
operator !=(NuiWindowToken, NuiWindowToken)