SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias NearbyEntity

    NearbyEntity: Message<"soulfire.v1.NearbyEntity"> & {
        displayName?: string;
        distance: number;
        entityId: number;
        entityType: string;
        health?: number;
        isPlayer: boolean;
        position?: WorldPosition;
    }

    A brief summary of an entity in the bot's world view. Intended for use as a repeated item in list responses and streaming events.

    Type Declaration

    • OptionaldisplayName?: string

      Display name if the entity has one. For players this is the username.

      from field: optional string display_name = 5;

    • distance: number

      Straight-line distance from the bot, in blocks.

      from field: float distance = 4;

    • entityId: number

      The numeric network entity id assigned by the server. Use this to target the entity in AttackEntity / InteractEntity.

      from field: int32 entity_id = 1;

    • entityType: string

      The namespaced entity type (e.g. "minecraft:zombie", "minecraft:player").

      from field: string entity_type = 2;

    • Optionalhealth?: number

      Current health, if known. Not populated for entities without a health attribute or when the bot cannot observe it.

      from field: optional float health = 7;

    • isPlayer: boolean

      True if this entity is a player.

      from field: bool is_player = 6;

    • Optionalposition?: WorldPosition

      Current world position of the entity.

      from field: soulfire.v1.WorldPosition position = 3;

    from message soulfire.v1.NearbyEntity

    Settings
    Member Visibility