PrivateAddCharacter

Callable

• PrivateAddCharacter(Template: NPCCharacter, Archetype?: | NPCArchetype, CustomData?: boolean, Module?: ModuleType, Screen?: string): NPCCharacter

---

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

  ---

  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

    Whether or not the character has non-random traits.

  • optionalModule: ModuleType = null

  • optionalScreen: string = null

  Returns NPCCharacter

  • The new private room character.