movement.get_site_move_interaction
Overview
- Returns an interaction.execute descriptor for walking a single character to a target site without creating a Zoi group.
Metadata
| Field | Value |
|---|---|
| Display | Get Site Move Interaction |
| Category | movement |
| Access | Public |
| Scope | B2Authority |
| Tags | — |
| Aliases | — |
Parameters
| Name | Type | Required | Default | Description |
|---|---|---|---|---|
| site_id | name | no | — | Target site ID |
| target_entity_id | entityId | no | — | Target site entity ID |
| entity_id | entityId | no | — | Character entity ID (default: possessed) |
Returns
Returns a JSON object with the following fields:
| Field | Type | Required | Description |
|---|---|---|---|
execution_tool | string | yes | CLI tool to execute the descriptor with |
entity_id | entityId | yes | Moving character entity id |
interaction_bag_id | string | yes | Interaction bag id (walk-to-site) |
target_entity_id | entityId | yes | Target site entity id |
target_site_id | string | yes | Target site id |
movement_type | string | yes | Movement type (walk) |
requires_zoi_group | bool | yes | Whether a Zoi group is required |
Usage
await inzoi.cli.execute('movement.get_site_move_interaction', {
site_id: '', // optional
target_entity_id: 0, // optional
entity_id: 0, // optional
});