Class PlayerNameOverrideService

Namespace: Anvil.Services

Assembly: NWN.Anvil.dll

[ServiceBinding(typeof(PlayerNameOverrideService))]
public sealed class PlayerNameOverrideService

Inheritance: object

PlayerNameOverrideService

Inherited Members: object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

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

CollectionExtensions.Yield<T>(T)

Constructors

PlayerNameOverrideService(HookService)

Properties

OverwriteDisplayName: Gets or sets if global overrides change the underlying display name value. This applies the name change globally to scripts, and DMs.
When set to false, the override name is only visible to players - scripts and DMs see the original names unless ShowOverridesToDM is set to true.

PlayerListNameType: Gets or sets the type of name override to use from the in-game player list.

ShowOverridesToDM: DM observers will see global or personal overrides as well as being able to have their own name overridden for other observers.

Methods

ClearPlayerNameOverride(NwPlayer, NwPlayer): Clears an overridden player character name for a specific observer.

ClearPlayerNameOverride(NwPlayer, bool): Clears an overridden player character name.

GetOverridesForObserver(NwPlayer, bool): Gets a list of all name overrides for the specified observer.

GetPlayerNameOverride(NwPlayer?, NwPlayer?): Gets the current name override for the specified player.

SetPlayerNameOverride(NwPlayer, PlayerNameOverride): Sets an override player character name and community name on the player list for all players. Is not persistent.

SetPlayerNameOverride(NwPlayer, PlayerNameOverride, NwPlayer): Sets an override player character name and community name on the player list as observed by a specific player. Is not persistent.

Edit this page