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: IEquatable<NuiWindowToken>

Inherited Members: ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Extension Methods: CollectionExtensions.SafeYield<T>(T?)

CollectionExtensions.Yield<T>(T)

Fields

Invalid: Represents an invalid window token.

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(): Disposes this token by destroying the underlying NUI window if valid. Invokes NuiDestroy(uint, int).

Equals(NuiWindowToken): Indicates whether this token is equal to another.

Equals(object?): Indicates whether this instance is equal to a specified object.

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 a hash code for this token.

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: Triggered when an event is raised in the NUI system.

Operators

operator ==(NuiWindowToken, NuiWindowToken): Determines whether two NuiWindowToken values are equal.

operator !=(NuiWindowToken, NuiWindowToken): Determines whether two NuiWindowToken values are not equal.

Edit this page