SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias BotWorldMapRequest

    BotWorldMapRequest: Message<"soulfire.v1.BotWorldMapRequest"> & {
        botId: string;
        centerX?: number;
        centerZ?: number;
        includeEntities: boolean;
        instanceId: string;
        radius: number;
        sampleStep: number;
    }

    Request for bounded, top-down world data suitable for map viewers.

    Type Declaration

    • botId: string

      from field: string bot_id = 2;

    • OptionalcenterX?: number

      Center coordinates. Each defaults to the bot's current block position.

      from field: optional int32 center_x = 3;

    • OptionalcenterZ?: number

      from field: optional int32 center_z = 4;

    • includeEntities: boolean

      Include nearby entity overlays in the returned snapshot.

      from field: bool include_entities = 7;

    • instanceId: string

      from field: string instance_id = 1;

    • radius: number

      Radius in blocks. Defaults to 64 and is clamped to 1-256.

      from field: int32 radius = 5;

    • sampleStep: number

      Distance between sampled columns. Defaults to 1 and is clamped to 1-16.

      from field: int32 sample_step = 6;

    from message soulfire.v1.BotWorldMapRequest