world.ptah.location

ptah.world

Documentation

A place inside a world. Where things happen. Locations nest infinitely — a room inside a building inside a city inside a territory.

main record

A place inside a world. Where things happen. Locations nest infinitely — a room inside a building inside a city inside a territory.

Record Key tid Timestamp-based ID

Properties

canonicalStatus string Optional

The canonical standing of this location

Known values: world.ptah.defs#canonicalStatusOfficial, world.ptah.defs#canonicalStatusCommunity, world.ptah.defs#canonicalStatusApocryphal
createdAt string datetime Required

Timestamp when this location was created

creatorDID string did Required

The permanent identity of the location's creator

depthIndex integer Optional

Nesting depth — 0 for top-level, incrementing for each level down

minimum: 0
description string Optional

What this location is like

maxLength: 10240 bytesmaxGraphemes: 1024 graphemes
locationProperties ref #locationProperties Optional

Additional structured properties for this location

locationType string Optional

The type of location

Known values: territory, city, building, room, landmark, wilderness, vessel, virtual
name string Required

The name of the location

maxLength: 640 bytesmaxGraphemes: 64 graphemes
parentLocation string at-uri Optional

Reference to the parent location (if nested)

worldReference string at-uri Required

Reference to the world this location exists in

View raw schema 
{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "creatorDID",
      "worldReference",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 640,
        "description": "The name of the location",
        "maxGraphemes": 64
      },
      "createdAt": {
        "type": "string",
        "format": "datetime",
        "description": "Timestamp when this location was created"
      },
      "creatorDID": {
        "type": "string",
        "format": "did",
        "description": "The permanent identity of the location's creator"
      },
      "depthIndex": {
        "type": "integer",
        "minimum": 0,
        "description": "Nesting depth — 0 for top-level, incrementing for each level down"
      },
      "description": {
        "type": "string",
        "maxLength": 10240,
        "description": "What this location is like",
        "maxGraphemes": 1024
      },
      "locationType": {
        "type": "string",
        "description": "The type of location",
        "knownValues": [
          "territory",
          "city",
          "building",
          "room",
          "landmark",
          "wilderness",
          "vessel",
          "virtual"
        ]
      },
      "parentLocation": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference to the parent location (if nested)"
      },
      "worldReference": {
        "type": "string",
        "format": "at-uri",
        "description": "Reference to the world this location exists in"
      },
      "canonicalStatus": {
        "type": "string",
        "description": "The canonical standing of this location",
        "knownValues": [
          "world.ptah.defs#canonicalStatusOfficial",
          "world.ptah.defs#canonicalStatusCommunity",
          "world.ptah.defs#canonicalStatusApocryphal"
        ]
      },
      "locationProperties": {
        "ref": "#locationProperties",
        "type": "ref",
        "description": "Additional structured properties for this location"
      }
    }
  },
  "description": "A place inside a world. Where things happen. Locations nest infinitely — a room inside a building inside a city inside a territory."
}
locationProperties object

Structured metadata for locations

Properties

climate string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
controllingFaction string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
notableHistory string Optional

No description available.

maxLength: 2560 bytesmaxGraphemes: 256 graphemes
population string Optional

No description available.

maxLength: 640 bytesmaxGraphemes: 64 graphemes
View raw schema 
{
  "type": "object",
  "properties": {
    "climate": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    },
    "population": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    },
    "notableHistory": {
      "type": "string",
      "maxLength": 2560,
      "maxGraphemes": 256
    },
    "controllingFaction": {
      "type": "string",
      "maxLength": 640,
      "maxGraphemes": 64
    }
  },
  "description": "Structured metadata for locations"
}

Lexicon Garden

@