Struct StrRef

Namespace: Anvil.API

Assembly: NWN.Anvil.dll

A talk table (tlk) string reference.

public readonly struct StrRef

Inherited Members: ValueType.Equals(object)

ValueType.GetHashCode()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

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

CollectionExtensions.Yield<T>(T)

Constructors

StrRef(int)

StrRef(uint): A talk table (tlk) string reference.

Fields

Id: Gets the index/key for this StrRef.

Properties

CustomId: Gets the index/key for this StrRef relative to the module's custom talk table. (-16777216)

Override: Gets or sets a string override that this StrRef should return instead of the tlk file definition.

Methods

ClearOverride(): Clears the current text override for this StrRef.

ClearPlayerOverride(NwPlayer, bool): Clears the string override for the specified player, optionally restoring the global override.

FromCustomTlk(uint): Gets a StrRef from the module's custom tlk table.
Use the index from the custom tlk. This factory method will automatically offset the id value.

SetPlayerOverride(NwPlayer, string?): Overrides the string for the specified player only.
Overrides will not persist through re-logging.

ToParsedString(): Gets the formatted string associated with this string reference/token number.
This will parse any tokens (e.g. <CUSTOM0>) as their current set token values.

ToString(): Gets the raw string associated with this string reference/token number.

Edit this page