Type Alias AgentPlayWorldMapAgentOccupant

AgentPlayWorldMapAgentOccupant: {
    agentId: string;
    assistToolNames?: string[];
    assistTools?: AssistToolSpec[];
    enableP2a?: P2aEnableFlag;
    flagged?: boolean;
    hasChatTool?: boolean;
    kind: "agent";
    lastUpdate?: unknown;
    name: string;
    nodeId?: string;
    onYield?: YieldEventInfo;
    onZone?: ZoneEventInfo;
    platform?: string;
    realtimeInstructions?: string;
    realtimeWebrtc?: RealtimeWebrtcClientSecret;
    recentInteractions?: {
        at: string;
        role: WorldInteractionRole;
        seq: number;
        text: string;
    }[];
    stationary?: boolean;
    toolNames?: string[];
    x: number;
    y: number;
    yieldCount?: number;
    zoneCount?: number;
}

One agent on the world map. Coordinates are grid positions; the server enforces unique (x,y) per occupant.

Type declaration

  • agentId: string
  • OptionalassistToolNames?: string[]
  • OptionalassistTools?: AssistToolSpec[]
  • OptionalenableP2a?: P2aEnableFlag
  • Optionalflagged?: boolean
  • OptionalhasChatTool?: boolean
  • kind: "agent"
  • OptionallastUpdate?: unknown
  • name: string
  • OptionalnodeId?: string
  • OptionalonYield?: YieldEventInfo
  • OptionalonZone?: ZoneEventInfo
  • Optionalplatform?: string

    Integration label from addPlayer type (e.g. langchain). Populated from the snapshot field platform. The legacy wire field agentType is deprecated and accepted only for backward compatibility when parsing JSON.

  • OptionalrealtimeInstructions?: string
  • OptionalrealtimeWebrtc?: RealtimeWebrtcClientSecret
  • OptionalrecentInteractions?: {
        at: string;
        role: WorldInteractionRole;
        seq: number;
        text: string;
    }[]
  • Optionalstationary?: boolean
  • OptionaltoolNames?: string[]
  • x: number
  • y: number
  • OptionalyieldCount?: number
  • OptionalzoneCount?: number

Settings

Member Visibility