Talos docs

POST /entity/{id}/teleport

Since 0.6

Move one entity outright: the same path as a behaviour's ctx.entity.teleport, answered after the move is published.

Plain text

Request

Request body: TeleportRequest

POST /entity/{id}/teleport request: put the entity somewhere else outright.

FieldTypeRequiredDescription
positionnumber[3]yesWhere to, [x, y, z]: the entity's own position, local to its parent if it has one.
yawnumbernoHeading in radians about +Y, 0 facing -Z. Absent: the facing is left alone.

Response

Response: TeleportResponse

POST /entity/{id}/teleport response.

FieldTypePresentDescription
entitystringalwaysThe entity moved.
positionnumber[3]alwaysWhere it landed. A character put inside geometry is pushed out of it, so this can differ from the position asked for.
frameintegeralwaysThe frame the move is part of: a read at this frame or later sees it.

Response: EventRecord

One frame-stamped thing that happened.

FieldTypePresentDescription
seqintegeralwaysMonotonic per-process sequence number. Strictly increasing, no gaps.
frameintegeralwaysThe frame the event fired on.
timenumberalwaysSimulated seconds since the scene loaded.
kindEventKindalwaysWhat happened.

Response: EventKind

The payload of an EventRecord, tagged by type on the wire.

ValueMeaning
collisionTwo colliders started or stopped touching. Mirrors argus_host::GameEvent::Collision.
triggerA sensor volume was entered or left. Mirrors argus_host::GameEvent::Trigger.
customctx.events.emit(name, data) from a behavior, or ctx.events.emitTo(to, name, data).
script_errorA behavior threw, ran away or blew its per-tick budget and was disabled — or, with disabled false, keeps running: it threw a stale handle (entity-despawned) from a per-tick hook, or its update stayed over its wall-clock budget (phase budget) under the host's default OverrunPolicy::Warn.
script_warningA behavior did something the engine let pass but its author almost certainly did not mean. The behavior keeps running; nothing is disabled.
uiThe game UI's stack, focus or an activation changed (PLAN-UI.md §3).
logctx.log(...) from a behavior.

Path parameters

NameTypeDescription
idstringTaken from the path: id.

Example

curl -X POST "http://127.0.0.1:7700/entity/<id>/teleport" --json @body.json

Start a server with argus run --serve; the port is --port (7700 by default). The request and response fields are in the query API guide.