SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias ListNearbyEntitiesRequest

    ListNearbyEntitiesRequest: Message<"soulfire.v1.ListNearbyEntitiesRequest"> & {
        botId: string;
        entityTypes: string[];
        includePlayers: boolean;
        instanceId: string;
        radius: number;
    }

    Type Declaration

    • botId: string

      from field: string bot_id = 2;

    • entityTypes: string[]

      Optional filter: if non-empty, only entities whose namespaced type is in this list are returned.

      from field: repeated string entity_types = 4;

    • includePlayers: boolean

      If true, include players in the result. Defaults to true.

      from field: bool include_players = 5;

    • instanceId: string

      from field: string instance_id = 1;

    • radius: number

      Maximum radius in blocks from the bot. Server clamps to an implementation-defined maximum.

      from field: float radius = 3;

    from message soulfire.v1.ListNearbyEntitiesRequest