PrivateAddCharacter

Callable

• PrivateAddCharacter<T>(Template: NPCCharacter, Archetype?: | NPCArchetype, CustomData?: boolean): NPCCharacter

---

• Triggered when a new character is added to the player's private room.

  ---

  Type parameters

  • T: keyof ModuleScreens

  Parameters

  • Template: NPCCharacter

    The base of the character, includes the name and appearance.

  • optionalArchetype: | NPCArchetype

    The type of character such as maid or mistress.

  • optionalCustomData: boolean = false

    Whether or not the character has non-random traits. Passing true will also skip calling ().

  Returns NPCCharacter

  • The new private room character.