observations/events/player/victim_placed

← All message topics  ·  schema VictimPlaced/victim_placed_event_message.json

header

FieldTypeRequiredAllowed valuesDescription
timestamp string ✓
message_type string ✓ event
version string ✓ The message format version

msg

FieldTypeRequiredAllowed valuesDescription
experiment_id string ✓
trial_id string
timestamp string ✓
source string ✓
sub_type string ✓ Event:VictimPlaced
version string ✓
replay_parent_type string|null TRIAL REPLAY null
replay_parent_id string|null
replay_id string|null

data

FieldTypeRequiredAllowed valuesDescription
mission_timer string ✓
elapsed_milliseconds number ✓
participant_id string ✓
playername string
type string ✓ victim_a victim_b victim_c victim_saved_a victim_saved_b victim_saved_c
victim_x number ✓
victim_y number ✓
victim_z number ✓
victim_id number ✓

Example message

{"header": {
	"timestamp": "2019-12-26T12:47:23.1234Z",
	"message_type": "event",
	"version": "0.6"
	},
"msg": {
	"experiment_id": "123e4567-e89b-12d3-a456-426655440000", 
    "trial_id": "123e4567-e89b-12d3-a456-426655440000",
	"timestamp": "2019-12-26T14:05:02.1412Z",
	"source": "simulator",
	"sub_type": "Event:VictimPlaced",
	"version": "2.1"},
"data": {
	"mission_timer":"8 : 36",
	"elapsed_milliseconds": 15113,
	"participant_id": "E000321",
	"type":"victim_c",	
	"victim_x": -2185,
	"victim_y":28,
	"victim_z":198,
	"victim_id":33
	}
}
Raw JSON Schema (resolved) 
{
  "$id": "https://gitlab-external.aptima.com/adapt/testbed/MessageSpecs/VictimPlaced/victim_placed_event_message.json",
  "$schema": "http://json-schema.org/draft-07/schema#",
  "definitions": {},
  "properties": {
    "data": {
      "$id": "#/properties/data",
      "properties": {
        "elapsed_milliseconds": {
          "$id": "#/properties/event/state/elapsed_milliseconds",
          "examples": [
            5000,
            77459,
            689457
          ],
          "pattern": "^[0-9]+$",
          "title": "The Elapsed Milliseconds Schema",
          "type": "number"
        },
        "mission_timer": {
          "$id": "#/properties/data/properties/mission_timer",
          "examples": [
            "8 : 36"
          ],
          "pattern": "^(.*)$",
          "title": "The Mission Timer Schema",
          "type": "string"
        },
        "participant_id": {
          "$id": "#/properties/data/participant_id",
          "examples": [
            "E000321"
          ],
          "pattern": "^(.*)$",
          "title": "The Participant id Schema",
          "type": "string"
        },
        "playername": {
          "$id": "#/properties/data/playername",
          "examples": [
            "Aptiminer1"
          ],
          "pattern": "^(.*)$",
          "title": "The Playername Schema",
          "type": "string"
        },
        "type": {
          "$id": "#/properties/data/properties/type",
          "enum": [
            "victim_a",
            "victim_b",
            "victim_c",
            "victim_saved_a",
            "victim_saved_b",
            "victim_saved_c"
          ],
          "examples": [
            "victim_a"
          ],
          "title": "The Type Schema",
          "type": "string"
        },
        "victim_id": {
          "$id": "#/properties/victim_id",
          "examples": [
            1,
            33,
            55
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Victim Id Schema",
          "type": "number"
        },
        "victim_x": {
          "$id": "#/properties/data/properties/victim_x",
          "examples": [
            -2185
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Victim_X Schema",
          "type": "number"
        },
        "victim_y": {
          "$id": "#/properties/data/properties/victim_y",
          "examples": [
            52
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Victim_Y Schema",
          "type": "number"
        },
        "victim_z": {
          "$id": "#/properties/data/properties/victim_z",
          "examples": [
            194
          ],
          "pattern": "^([0-9]+?)$",
          "title": "The Victim_Z Schema",
          "type": "number"
        }
      },
      "required": [
        "mission_timer",
        "elapsed_milliseconds",
        "participant_id",
        "victim_x",
        "victim_y",
        "victim_z",
        "type",
        "victim_id"
      ],
      "title": "The Victim Placed Data Schema",
      "type": "object"
    },
    "header": {
      "$id": "http://asist.aptima.com/schemas/common_header.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "message_type": {
          "$id": "#/properties/message_type",
          "const": "event",
          "enum": [
            "control",
            "observation",
            "chat",
            "status",
            "trial",
            "event",
            "groundtruth",
            "experiment",
            "metadata",
            "agent"
          ],
          "examples": [
            "observation"
          ],
          "pattern": "^([a-z_]*?)$",
          "title": "The Message_type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "examples": [
            "2019-12-26T12:47:23.1234Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "examples": [
            "1.0",
            "2.3.1"
          ],
          "pattern": "^([0-9]+\\.)?([0-9]+\\.)?([0-9]+)$",
          "title": "The message format version",
          "type": "string"
        }
      },
      "required": [
        "timestamp",
        "message_type",
        "version"
      ],
      "title": "ASIST message common header Schema",
      "type": "object",
      "version": "0.3"
    },
    "msg": {
      "$id": "http://asist.aptima.com/schemas/event_message.json",
      "$schema": "http://json-schema.org/draft-07/schema#",
      "definitions": {},
      "properties": {
        "experiment_id": {
          "$id": "#/properties/experiment_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|Null|null)",
          "title": "The Experiment Id Schema",
          "type": "string"
        },
        "replay_id": {
          "$id": "#/properties/replay_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_id": {
          "$id": "#/properties/replay_parent_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Replay Parent Id Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "replay_parent_type": {
          "$id": "#/properties/replay_parent_type",
          "enum": [
            "TRIAL",
            "REPLAY",
            null
          ],
          "title": "The Replay Parent Type Schema",
          "type": [
            "string",
            "null"
          ]
        },
        "source": {
          "$id": "#/properties/source",
          "default": "",
          "examples": [
            "simulator"
          ],
          "pattern": "^(.*)$",
          "title": "The Source Schema",
          "type": "string"
        },
        "sub_type": {
          "$id": "#/properties/sub_type",
          "const": "Event:VictimPlaced",
          "default": "",
          "examples": [
            "equip",
            "triage"
          ],
          "pattern": "^([a-zA-Z0-9_:]*?)$",
          "title": "The Sub Type Schema",
          "type": "string"
        },
        "timestamp": {
          "$id": "#/properties/timestamp",
          "default": "",
          "examples": [
            "2019-12-26T14:05:02.3412Z"
          ],
          "pattern": "[0-9]{4}-[0-9]{2}-[0-9]{2}T[0-9]{2}:[0-9]{2}:[0-9]{2}[.]?[0-9]{0,}?Z",
          "title": "The Timestamp Schema",
          "type": "string"
        },
        "trial_id": {
          "$id": "#/properties/trial_id",
          "default": "",
          "examples": [
            "123e4567-e89b-12d3-a456-426655440000"
          ],
          "pattern": "(([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12})|Not Set|null|Null)",
          "title": "The Trial Id Schema",
          "type": "string"
        },
        "version": {
          "$id": "#/properties/version",
          "default": "",
          "examples": [
            "0.1",
            "1.0.1"
          ],
          "pattern": "^([.]*)|(0|[1-9]\\d*)\\.(0|[1-9]\\d*)\\.(0|[1-9]\\d*)(?:-((?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\\.(?:0|[1-9]\\d*|\\d*[a-zA-Z-][0-9a-zA-Z-]*))*))?(?:\\+([0-9a-zA-Z-]+(?:\\.[0-9a-zA-Z-]+)*))?$",
          "title": "The Version Schema",
          "type": "string"
        }
      },
      "required": [
        "experiment_id",
        "timestamp",
        "source",
        "sub_type",
        "version"
      ],
      "title": "The Event Message Schema",
      "type": "object",
      "version": "0.5"
    }
  },
  "required": [
    "header",
    "msg",
    "data"
  ],
  "title": "The Victim Placed Event Schema",
  "type": "object",
  "version": "2.1"
}
Upstream spec documentation

Data Subtype: Event Message Format

This data message subtype is used to communicate event data for both the world and the player.

TOPIC

observations/events/player/victim_placed

Message Fields

Field Name Type Description
header object From Common Message Format section
msg object From the Common Event Message Format section
data.mission_timer string the mission time of the event
data.elapsed_milliseconds number the number of elapsed milliseconds since mission start
data.participant_id string the participant id for the player being reported
data.playername string [Deprecated]The name of the entity that changed state
data.victim_x integer the x location of the victim
data.victim_x integer the y location of the victim
data.victim_x integer the z location of the victim
data.type string the type of the victim being triaged [victim_a,victim_b,victim_c,victim_safe_a,victim_safe_b,victim_safe_c]
data.victim_id integer the unique id identifying the victim

Message Example

{"header": {
    "timestamp": "2019-12-26T12:47:23.1234Z",
    "message_type": "event",
    "version": "0.6"
    },
"msg": {
    "experiment_id": "123e4567-e89b-12d3-a456-426655440000", 
    "trial_id": "123e4567-e89b-12d3-a456-426655440000",
    "timestamp": "2019-12-26T14:05:02.1412Z",
    "source": "simulator",
    "sub_type": "Event:VictimPlaced",
    "version": "2.1"},
"data": {
    "mission_timer":"8 : 36",
    "elapsed_milliseconds": 15113,
    "participant_id": "E000321",
    "type":"victim_c",  
    "victim_x": -2185,
    "victim_y":28,
    "victim_z":198,
    "victim_id":33
    }
}

CHANGE HISTORY

VERSION | DATE | DETAILS | --- | --- | --- | 2.1 | 11/11/2021 | changed victim_safe_a/b/c to victim_saved_a/b/c as in the mod [victim_a,victim_b,victim_c,victim_saved_a,victim_saved_b,victim_saved_c] 2.0 | 11/1/2021 | change victim type identifier in data.type key to [victim_a,victim_b,victim_c,victim_safe_a,victim_safe_b,victim_safe_c] 1.3 | 8/13/2021 | deprecated playername and added participant_id 1.2 | 4/27/2021 | Added victim_id field 1.1 | 4/12/2021 | data.color changed to data.type with types [REGULAR,CRITICAL] 1.0 | 3/10/2021 | data.color is now upper case with only GREEN and YELLOW as options