Skip to main content

appearance.get_outfit_category

Overview

  • Returns the character's current base outfit category and any active overlay outfits.

Metadata

FieldValue
DisplayGet Outfit Category
Categoryappearance
AccessPublic
ScopeB2Authority
Tags
Aliases

Parameters

NameTypeRequiredDefaultDescription
entity_identityIdnoCharacter entity ID (default: possessed)

Returns

Returns a JSON object with the following fields:

FieldTypeRequiredDescription
base_categorystringyesCurrent base outfit category
active_overlaysarraynoActive overlay outfits (present only when any exist)
active_overlays[].categorystringyesOverlay outfit category

Usage

await inzoi.cli.execute('appearance.get_outfit_category', {
entity_id: 0, // optional
});