at.atpcraft.player.defs

atpcraft.at

Documentation

aspect object

One opaque player-data aspect. The payload is always uploaded as a blob; the record holds its reference.

Properties

blob blob Required

Aspect payload uploaded as a blob.

maxSize: 16.8 MB
name string Required

No description available.

maxLength: 64 bytes
Known values: core, advancements, stats, ops, scoreboard, team, inventory, ender_chest, equipment, effects, respawn, recipes
View raw schema 
{
  "type": "object",
  "required": [
    "name",
    "blob"
  ],
  "properties": {
    "blob": {
      "type": "blob",
      "accept": [
        "application/octet-stream"
      ],
      "maxSize": 16777216,
      "description": "Aspect payload uploaded as a blob."
    },
    "name": {
      "type": "string",
      "maxLength": 64,
      "knownValues": [
        "core",
        "advancements",
        "stats",
        "ops",
        "scoreboard",
        "team",
        "inventory",
        "ender_chest",
        "equipment",
        "effects",
        "respawn",
        "recipes"
      ]
    }
  },
  "description": "One opaque player-data aspect. The payload is always uploaded as a blob; the record holds its reference."
}
position object

Block coordinates (floored; the atproto data model has no floats).

Properties

x integer Required

No description available.

y integer Required

No description available.

z integer Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "x",
    "y",
    "z"
  ],
  "properties": {
    "x": {
      "type": "integer"
    },
    "y": {
      "type": "integer"
    },
    "z": {
      "type": "integer"
    }
  },
  "description": "Block coordinates (floored; the atproto data model has no floats)."
}
score object

No description available.

Properties

objective string Required

Scoreboard objective name.

maxLength: 256 bytes
value integer Required

No description available.

View raw schema 
{
  "type": "object",
  "required": [
    "objective",
    "value"
  ],
  "properties": {
    "value": {
      "type": "integer"
    },
    "objective": {
      "type": "string",
      "maxLength": 256,
      "description": "Scoreboard objective name."
    }
  }
}
summary object

Human-readable, server-signed summary of the player's state at snapshot time. Informative; the authoritative state is the opaque aspect payloads.

Properties

dimension string Required

Dimension identifier, e.g. minecraft:overworld.

maxLength: 256 bytes
food integer Required

Food level.

minimum: 0
gameMode string Required

Game mode.

maxLength: 32 bytes
Known values: survival, creative, adventure, spectator
health string Required

Current health as a decimal string (the atproto data model has no floats), e.g. "19.5".

maxLength: 32 bytes
position ref #position Required

No description available.

scores array of ref#score Optional

Scoreboard scores, sorted by objective name.

maxLength: 1024 items
username string Required

Minecraft username at snapshot time.

maxLength: 64 bytes
xpLevel integer Required

Experience level.

minimum: 0
View raw schema 
{
  "type": "object",
  "required": [
    "username",
    "dimension",
    "position",
    "health",
    "food",
    "xpLevel",
    "gameMode"
  ],
  "properties": {
    "food": {
      "type": "integer",
      "minimum": 0,
      "description": "Food level."
    },
    "team": {
      "ref": "#teamSummary",
      "type": "ref"
    },
    "health": {
      "type": "string",
      "maxLength": 32,
      "description": "Current health as a decimal string (the atproto data model has no floats), e.g. \"19.5\"."
    },
    "scores": {
      "type": "array",
      "items": {
        "ref": "#score",
        "type": "ref"
      },
      "maxLength": 1024,
      "description": "Scoreboard scores, sorted by objective name."
    },
    "xpLevel": {
      "type": "integer",
      "minimum": 0,
      "description": "Experience level."
    },
    "gameMode": {
      "type": "string",
      "maxLength": 32,
      "description": "Game mode.",
      "knownValues": [
        "survival",
        "creative",
        "adventure",
        "spectator"
      ]
    },
    "position": {
      "ref": "#position",
      "type": "ref"
    },
    "username": {
      "type": "string",
      "maxLength": 64,
      "description": "Minecraft username at snapshot time."
    },
    "dimension": {
      "type": "string",
      "maxLength": 256,
      "description": "Dimension identifier, e.g. minecraft:overworld."
    }
  },
  "description": "Human-readable, server-signed summary of the player's state at snapshot time. Informative; the authoritative state is the opaque aspect payloads."
}
teamSummary object

The player's team at snapshot time (informative; plain-text prefix/suffix).

Properties

name string Required

Team name.

maxLength: 256 bytes
prefix string Optional

Team prefix as plain text.

maxLength: 256 bytes
suffix string Optional

Team suffix as plain text.

maxLength: 256 bytes
View raw schema 
{
  "type": "object",
  "required": [
    "name"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 256,
      "description": "Team name."
    },
    "prefix": {
      "type": "string",
      "maxLength": 256,
      "description": "Team prefix as plain text."
    },
    "suffix": {
      "type": "string",
      "maxLength": 256,
      "description": "Team suffix as plain text."
    }
  },
  "description": "The player's team at snapshot time (informative; plain-text prefix/suffix)."
}

Lexicon Garden

@