SoulFire TypeScript SDK 2.10.3
    Preparing search index...

    Type Alias EntitySnapshot

    EntitySnapshot: Message<"soulfire.v1.EntitySnapshot"> & {
        ageTicks?: number;
        aggressive?: boolean;
        alive: boolean;
        attributes: AttributeSnapshot[];
        boundingBox?: BoundingBox;
        category: EntityCategory;
        displayName?: TextComponent;
        effects: EffectSnapshot[];
        entityType: string;
        equipment: { [key: string]: ItemStackSnapshot };
        health?: number;
        item?: ItemStackSnapshot;
        maxHealth?: number;
        metadata?: JsonObject;
        onGround: boolean;
        owner?: EntityReference;
        passengers: EntityReference[];
        playerName?: string;
        pose: string;
        position?: WorldPosition;
        reference?: EntityReference;
        rotation?: Rotation;
        tamed?: boolean;
        target?: EntityReference;
        vehicle?: EntityReference;
        velocity?: Vec3;
    }

    Type Declaration

    • OptionalageTicks?: number

      For ageable mobs, as the client sees it: -1 for a baby, 1 for an adult. The real age and the breeding cooldown are only known to the server.

      from field: optional int32 age_ticks = 24;

    • Optionalaggressive?: boolean

      Client-observable aggression state. This is true while a mob exposes an active attack posture or a synchronized neutral-mob anger state. It does not identify which entity the mob is attacking.

      from field: optional bool aggressive = 26;

    • alive: boolean

      from field: bool alive = 22;

    • attributes: AttributeSnapshot[]

      from field: repeated soulfire.v1.AttributeSnapshot attributes = 16;

    • OptionalboundingBox?: BoundingBox

      from field: soulfire.v1.BoundingBox bounding_box = 7;

    • category: EntityCategory

      from field: soulfire.v1.EntityCategory category = 3;

    • OptionaldisplayName?: TextComponent

      from field: optional soulfire.v1.TextComponent display_name = 10;

    • effects: EffectSnapshot[]

      from field: repeated soulfire.v1.EffectSnapshot effects = 15;

    • entityType: string

      from field: string entity_type = 2;

    • equipment: { [key: string]: ItemStackSnapshot }

      from field: map<string, soulfire.v1.ItemStackSnapshot> equipment = 14;

    • Optionalhealth?: number

      from field: optional float health = 12;

    • Optionalitem?: ItemStackSnapshot

      from field: optional soulfire.v1.ItemStackSnapshot item = 21;

    • OptionalmaxHealth?: number

      from field: optional float max_health = 13;

    • Optionalmetadata?: JsonObject

      from field: google.protobuf.Struct metadata = 23;

    • onGround: boolean

      from field: bool on_ground = 9;

    • Optionalowner?: EntityReference

      from field: optional soulfire.v1.EntityReference owner = 19;

    • passengers: EntityReference[]

      from field: repeated soulfire.v1.EntityReference passengers = 18;

    • OptionalplayerName?: string

      from field: optional string player_name = 11;

    • pose: string

      from field: string pose = 8;

    • Optionalposition?: WorldPosition

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

    • Optionalreference?: EntityReference

      from field: soulfire.v1.EntityReference reference = 1;

    • Optionalrotation?: Rotation

      from field: soulfire.v1.Rotation rotation = 6;

    • Optionaltamed?: boolean

      from field: optional bool tamed = 25;

    • Optionaltarget?: EntityReference

      from field: optional soulfire.v1.EntityReference target = 20;

    • Optionalvehicle?: EntityReference

      from field: optional soulfire.v1.EntityReference vehicle = 17;

    • Optionalvelocity?: Vec3

      from field: soulfire.v1.Vec3 velocity = 5;

    from message soulfire.v1.EntitySnapshot

    Settings
    Member Visibility