ambition.get
Overview
- Returns the target character's ambition state: currently playing ambition item, current step, completed count, all-completed flag, and playable ambition item ids.
Metadata
| Field | Value |
|---|---|
| Display | Get Ambition |
| Category | ambition |
| 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 |
is_playing | bool | yes | Whether an ambition is in progress |
playing_ambition_item_id | string | yes | Currently playing ambition item id |
current_step | int | yes | Current step (-1 if none playing) |
complete_count | int | yes | Number of completed ambitions |
is_all_completed | bool | yes | Whether all ambitions are completed |
playable_ids | array | yes | Playable ambition item ids |
Usage
await inzoi.cli.execute('ambition.get', {
entity_id: 0, // optional
});