hope.list
Overview
- Returns the target character's currently selected hopes (wishes): hope_id, expire tick, fixed flag.
Metadata
| Field | Value |
|---|---|
| Display | List Hopes |
| Category | hope |
| Access | Public |
| Scope | B2Authority |
| Tags | — |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| entity_id | entityId | no | — | Target entity ID (default: possessed) |
Returns
Returns a JSON object with the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
entity_id | entityId | yes | Target entity id |
max_hope_size | int | yes | Max simultaneous hope slots |
selected_count | int | yes | Number of selected hopes |
selected | array | yes | Currently selected hopes |
selected[].hope_id | string | yes | Hope id |
selected[].expire_ticks | int | yes | Expiration time in ticks |
selected[].fixed | bool | yes | Whether the hope is pinned |
Usage
await inzoi.cli.execute('hope.list', {
entity_id: 0, // optional
});