Skip to main content

entity.schema

Overview

  • Return UPROPERTY schema (name, type, enum values) for an entity or component.

Metadata

FieldValue
DisplayEntity Schema
Categoryentity
AccessUserCheat
ScopeB2Authority
Tags
AliasesEntitySchema

Parameters

NameTypeRequiredDefaultDescription
entity_identityIdnoTarget entity ID (default: possessed)
componentstringnoComponent type name (optional)

Returns

  • Freeform result (shape is not fixed).

Object with entity_id, _type and a properties[] array; each property has name, type, cpp_type, optional enum_values[] and a recursively nested properties[] for struct/array-of-struct fields. Nesting depth is variable.

Usage

await inzoi.cli.execute('entity.schema', {
entity_id: 0, // optional
component: '', // optional
});