Documentation Docs/en/reference/ai-control-protocol/commands-events.md

AiControl Commands and Events

Generated reference. Do not edit directly. Update BuildTools/AiControlProtocol.json, then run python BuildTools/docs_ai_control_protocol.py --write.

Index

Wire

Methods

Commands and events

Security

Integration and validation

Canonical JSON

Guide

Stable ID	Field	Type	Contract	Source
`ai-control-protocol.command.type`	`type`	`string`	Required non-empty project command discriminator.	BuildTools/ai_control_client.py
`ai-control-protocol.command.target-id`	`targetId`	`project identifier`	Optional primary target identifier.	BuildTools/ai_control_client.py
`ai-control-protocol.command.item-id`	`itemId`	`project identifier`	Optional item identifier.	BuildTools/ai_control_client.py
`ai-control-protocol.command.aux-id`	`auxId`	`project identifier`	Optional auxiliary identifier.	BuildTools/ai_control_client.py
`ai-control-protocol.command.x`	`x`	`integer`	Optional project world or grid X coordinate.	BuildTools/ai_control_client.py
`ai-control-protocol.command.y`	`y`	`integer`	Optional project world or grid Y coordinate.	BuildTools/ai_control_client.py
`ai-control-protocol.command.screen-x`	`screenX`	`integer`	Optional screen-space X coordinate.	BuildTools/ai_control_client.py
`ai-control-protocol.command.screen-y`	`screenY`	`integer`	Optional screen-space Y coordinate.	BuildTools/ai_control_client.py
`ai-control-protocol.command.int-arg`	`intArg`	`integer`	Optional project-defined integer payload.	BuildTools/ai_control_client.py
`ai-control-protocol.command.string-arg`	`stringArg`	`string`	Optional project-defined string payload.	BuildTools/ai_control_client.py
`ai-control-protocol.command.append`	`append`	`boolean`	Optional request for project-defined append rather than replace semantics.	BuildTools/ai_control_client.py

Completion envelope

An accepted command returns a commandSeq. The project later appends an event with type=command_completed, the same commandSeq, a boolean success, and a project-readable message. Acceptance never implies success.