entity.schema
Overview
- Return UPROPERTY schema (name, type, enum values) for an entity or component.
Metadata
| Field | Value |
|---|---|
| Display | Entity Schema |
| Category | entity |
| Access | UserCheat |
| Scope | B2Authority |
| Tags | — |
| Aliases | EntitySchema |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| entity_id | entityId | no | — | Target entity ID (default: possessed) |
| component | string | no | — | Component 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
});