Class NPCVoiceCatalog

Namespace

S1API.Entities.Voices

Assembly

S1API.dll

Provides stable identifiers for the supported base-game NPC voices.

public static class NPCVoiceCatalog

Inheritance

object

NPCVoiceCatalog

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

All

Gets every supported voice definition.

public static IReadOnlyList<NPCVoiceDefinition> All { get; }

Property Value

IReadOnlyList<NPCVoiceDefinition>

Cold

Gets the cold voice.

public static NPCVoiceDefinition Cold { get; }

Property Value

NPCVoiceDefinition

Crackhead

Gets the crackhead voice.

public static NPCVoiceDefinition Crackhead { get; }

Property Value

NPCVoiceDefinition

Female1

Gets the first female voice.

public static NPCVoiceDefinition Female1 { get; }

Property Value

NPCVoiceDefinition

Female2

Gets the second female voice.

public static NPCVoiceDefinition Female2 { get; }

Property Value

NPCVoiceDefinition

Goblin

Gets the goblin voice.

public static NPCVoiceDefinition Goblin { get; }

Property Value

NPCVoiceDefinition

Hippie

Gets the hippie voice.

public static NPCVoiceDefinition Hippie { get; }

Property Value

NPCVoiceDefinition

Joel

Gets the Joel voice.

public static NPCVoiceDefinition Joel { get; }

Property Value

NPCVoiceDefinition

Monotone

Gets the monotone voice.

public static NPCVoiceDefinition Monotone { get; }

Property Value

NPCVoiceDefinition

Redneck

Gets the redneck voice.

public static NPCVoiceDefinition Redneck { get; }

Property Value

NPCVoiceDefinition

Timid

Gets the timid voice.

public static NPCVoiceDefinition Timid { get; }

Property Value

NPCVoiceDefinition

Tyler

Gets the Tyler voice.

public static NPCVoiceDefinition Tyler { get; }

Property Value

NPCVoiceDefinition

Methods

Get(string)

Gets a voice by its stable identifier.

public static NPCVoiceDefinition Get(string identifier)

Parameters

identifier string

The case-insensitive voice identifier.

Returns

NPCVoiceDefinition

The matching voice definition.

Exceptions

ArgumentException

Thrown when the identifier is missing or unsupported.

TryGet(string, out NPCVoiceDefinition?)

Attempts to get a voice by its stable identifier.

public static bool TryGet(string identifier, out NPCVoiceDefinition? definition)

Parameters

identifier string

The case-insensitive voice identifier.

definition NPCVoiceDefinition

The matching definition, or null when no match exists.

Returns

bool

true when the identifier is supported; otherwise, false.