Skip to main content

character.possess

Overview

  • Switches play to the specified character. Same household -> avatar swap; different household -> household switch. Handles camera, spawn, and UI transition.

Metadata

FieldValue
DisplayPossess Character
Categorycharacter
AccessPublic
ScopeB1Standalone
Tags—
Aliases—

Parameters

NameTypeRequiredDefaultDescription
character_identityIdyes—Character entity ID to possess
household_identityIdno—Household entity ID the character belongs to (optional, enables cross-household switch)

Usage

await inzoi.cli.execute('character.possess', {
character_id: 0,
household_id: 0, // optional
});