Interface Unit

Generated

from protobuf message SC2APIProtocol.Unit

interface Unit {
    addOnTag?: bigint;
    alliance?: Alliance;
    armorUpgradeLevel?: number;
    assignedHarvesters?: number;
    attackUpgradeLevel?: number;
    buffDurationMax?: number;
    buffDurationRemain?: number;
    buffIds: number[];
    buildProgress?: number;
    cargoSpaceMax?: number;
    cargoSpaceTaken?: number;
    cloak?: CloakState;
    detectRange?: number;
    displayType?: DisplayType;
    energy?: number;
    energyMax?: number;
    engagedTargetTag?: bigint;
    facing?: number;
    health?: number;
    healthMax?: number;
    idealHarvesters?: number;
    isActive?: boolean;
    isBlip?: boolean;
    isBurrowed?: boolean;
    isFlying?: boolean;
    isHallucination?: boolean;
    isOnScreen?: boolean;
    isPowered?: boolean;
    isSelected?: boolean;
    mineralContents?: number;
    orders: UnitOrder[];
    owner?: number;
    passengers: PassengerUnit[];
    pos?: any;
    radarRange?: number;
    radius?: number;
    rallyTargets: RallyTarget[];
    shield?: number;
    shieldMax?: number;
    shieldUpgradeLevel?: number;
    tag?: bigint;
    unitType?: number;
    vespeneContents?: number;
    weaponCooldown?: number;
}

Properties

addOnTag? alliance? armorUpgradeLevel? assignedHarvesters? attackUpgradeLevel? buffDurationMax? buffDurationRemain? buffIds buildProgress? cargoSpaceMax? cargoSpaceTaken? cloak? detectRange? displayType? energy? energyMax? engagedTargetTag? facing? health? healthMax? idealHarvesters? isActive? isBlip? isBurrowed? isFlying? isHallucination? isOnScreen? isPowered? isSelected? mineralContents? orders owner? passengers pos? radarRange? radius? rallyTargets shield? shieldMax? shieldUpgradeLevel? tag? unitType? vespeneContents? weaponCooldown?

Properties

Optional addOnTag

addOnTag?: bigint

Generated

from protobuf field: optional uint64 add_on_tag = 23;

Optional alliance

alliance?: Alliance

Generated

from protobuf field: optional SC2APIProtocol.Alliance alliance = 2;

Optional armorUpgradeLevel

armorUpgradeLevel?: number

Generated

from protobuf field: optional int32 armor_upgrade_level = 41;

Optional assignedHarvesters

assignedHarvesters?: number

Generated

from protobuf field: optional int32 assigned_harvesters = 28;

Optional attackUpgradeLevel

attackUpgradeLevel?: number

Generated

from protobuf field: optional int32 attack_upgrade_level = 40;

Optional buffDurationMax

buffDurationMax?: number

Generated

from protobuf field: optional int32 buff_duration_max = 44;

Optional buffDurationRemain

buffDurationRemain?: number

Generated

from protobuf field: optional int32 buff_duration_remain = 43;

buffIds

buffIds: number[]

Generated

from protobuf field: repeated uint32 buff_ids = 27;

Optional buildProgress

buildProgress?: number

Generated

from protobuf field: optional float build_progress = 9;

Optional cargoSpaceMax

cargoSpaceMax?: number

Generated

from protobuf field: optional int32 cargo_space_max = 26;

Optional cargoSpaceTaken

cargoSpaceTaken?: number

Generated

from protobuf field: optional int32 cargo_space_taken = 25;

Optional cloak

cloak?: CloakState

Generated

from protobuf field: optional SC2APIProtocol.CloakState cloak = 10;

Optional detectRange

detectRange?: number

Generated

from protobuf field: optional float detect_range = 31;

Optional displayType

displayType?: DisplayType

Fields are populated based on type/alliance

Generated

from protobuf field: optional SC2APIProtocol.DisplayType display_type = 1;

Optional energy

energy?: number

Generated

from protobuf field: optional float energy = 17;

Optional energyMax

energyMax?: number

Generated

from protobuf field: optional float energy_max = 37;

Optional engagedTargetTag

engagedTargetTag?: bigint

Generated

from protobuf field: optional uint64 engaged_target_tag = 34;

Optional facing

facing?: number

Generated

from protobuf field: optional float facing = 7;

Optional health

health?: number

Not populated for snapshots

Generated

from protobuf field: optional float health = 14;

Optional healthMax

healthMax?: number

Generated

from protobuf field: optional float health_max = 15;

Optional idealHarvesters

idealHarvesters?: number

Generated

from protobuf field: optional int32 ideal_harvesters = 29;

Optional isActive

isActive?: boolean

Generated

from protobuf field: optional bool is_active = 39;

Optional isBlip

isBlip?: boolean

Generated

from protobuf field: optional bool is_blip = 13;

Optional isBurrowed

isBurrowed?: boolean

Generated

from protobuf field: optional bool is_burrowed = 21;

Optional isFlying

isFlying?: boolean

Generated

from protobuf field: optional bool is_flying = 20;

Optional isHallucination

isHallucination?: boolean

Generated

from protobuf field: optional bool is_hallucination = 38;

Optional isOnScreen

isOnScreen?: boolean

Generated

from protobuf field: optional bool is_on_screen = 12;

Optional isPowered

isPowered?: boolean

Generated

from protobuf field: optional bool is_powered = 35;

Optional isSelected

isSelected?: boolean

Generated

from protobuf field: optional bool is_selected = 11;

Optional mineralContents

mineralContents?: number

Generated

from protobuf field: optional int32 mineral_contents = 18;

orders

orders: UnitOrder[]

Not populated for enemies

Generated

from protobuf field: repeated SC2APIProtocol.UnitOrder orders = 22;

Optional owner

owner?: number

Generated

from protobuf field: optional int32 owner = 5;

passengers

passengers: PassengerUnit[]

Generated

from protobuf field: repeated SC2APIProtocol.PassengerUnit passengers = 24;

Optional pos

pos?: any

Generated

from protobuf field: optional SC2APIProtocol.Point pos = 6;

Optional radarRange

radarRange?: number

Generated

from protobuf field: optional float radar_range = 32;

Optional radius

radius?: number

Generated

from protobuf field: optional float radius = 8;

rallyTargets

rallyTargets: RallyTarget[]

Generated

from protobuf field: repeated SC2APIProtocol.RallyTarget rally_targets = 45;

Optional shield

shield?: number

Generated

from protobuf field: optional float shield = 16;

Optional shieldMax

shieldMax?: number

Generated

from protobuf field: optional float shield_max = 36;

Optional shieldUpgradeLevel

shieldUpgradeLevel?: number

Generated

from protobuf field: optional int32 shield_upgrade_level = 42;

Optional tag

tag?: bigint

Generated

from protobuf field: optional uint64 tag = 3;

Optional unitType

unitType?: number

Generated

from protobuf field: optional uint32 unit_type = 4;

Optional vespeneContents

vespeneContents?: number

Generated

from protobuf field: optional int32 vespene_contents = 19;

Optional weaponCooldown

weaponCooldown?: number

Generated

from protobuf field: optional float weapon_cooldown = 30;

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc