Class NPCImpostorCatalog

Namespace

S1API.Entities.Impostors

Assembly

S1API.dll

Provides access to avatar impostors discovered from the game's runtime character settings resources.

public static class NPCImpostorCatalog

Inheritance

object

NPCImpostorCatalog

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Methods

Find(string)

Finds an impostor by character settings name or resource path.

public static AvatarImpostorDefinition? Find(string name)

Parameters

name string

Name such as Kyle, or path such as charactersettings/Kyle.

Returns

AvatarImpostorDefinition

The matched impostor definition, or null if no match was found.

GetAll()

Gets all currently discoverable game-owned NPC impostors.

public static IReadOnlyList<AvatarImpostorDefinition> GetAll()

Returns

IReadOnlyList<AvatarImpostorDefinition>

Definitions for character settings that contain an impostor texture.

GetRandom(int)

Selects a deterministic random impostor from all currently discoverable impostors.

public static AvatarImpostorDefinition? GetRandom(int seed)

Parameters

seed int

Seed used to choose the impostor.

Returns

AvatarImpostorDefinition

A discovered impostor definition, or null when none are available.

TryFind(string, out AvatarImpostorDefinition?)

Finds an impostor by character settings name or resource path.

public static bool TryFind(string name, out AvatarImpostorDefinition? impostor)

Parameters

name string

Name such as Kyle, or path such as charactersettings/Kyle.

impostor AvatarImpostorDefinition

The matched impostor definition, if found.

Returns

bool

true when a matching impostor was found.