warscript 0.0.1-dev.ee2345e → 0.0.1-dev.ef189a5

package/engine/internal/unit.d.ts

@@ -1,4 +1,3 @@
-/// <reference types="@typescript-to-lua/language-extensions" />
 /** @noSelfInFile */
 import { Handle, HandleDestructor } from "../../core/types/handle";
 import { Player } from "../../core/types/player";
@@ -12,6 +11,10 @@ import { Ability, UnitAbility } from "./ability";
 import { Widget } from "../../core/types/widget";
 import type { UnitTypeId } from "../object-data/entry/unit-type";
 import { CombatClassification, CombatClassifications } from "../object-data/auxiliary/combat-classification";
+import { MovementType } from "../object-data/auxiliary/movement-type";
+import { UnitAttribute } from "../object-data/auxiliary/unit-attribute";
+import { AttackType } from "../object-data/auxiliary/attack-type";
+import { AttributesHolder } from "../../attributes";
 export type UnitClassification = junittype;
 export declare namespace UnitClassification {
     const STRUCTURE: junittype;
@@ -20,6 +23,7 @@ export declare namespace UnitClassification {
     const GROUND: junittype;
     const SUMMONED: junittype;
     const MECHANICAL: junittype;
+    const WORKER: junittype;
     const ANCIENT: junittype;
     const SUICIDAL: junittype;
     const TAUREN: junittype;
@@ -37,14 +41,18 @@ type AbilityDispatcherTable<T extends any[] = []> = {
     readonly [id: number]: Event<[Unit, Ability, ...T]>;
 };
 type AbilityEventDispatcher<T extends any[] = []> = Event<[Unit, Ability, ...T]> & AbilityDispatcherTable<T>;
-export interface DamagingEvent {
+export interface DamagingEvent extends AttributesHolder {
     amount: number;
-    attackType: jattacktype;
+    attackType: AttackType;
     damageType: jdamagetype;
     weaponType: jweapontype;
+    metadata: unknown;
     readonly isAttack: boolean;
+    readonly originalAmount: number;
+    readonly originalMetadata: unknown;
+    preventRetaliation(this: DamagingEvent): void;
 }
-export type DamageEvent = DamagingEvent & {
+export type DamageEvent = Omit<DamagingEvent, "preventRetaliation"> & {
     preventDeath<P extends any[]>(this: DamageEvent, callback: (this: void, ...parameters: P) => any, ...parameters: P): void;
 };
 export type AttackDamageEvent = DamagingEvent & {
@@ -68,25 +76,61 @@ declare const modifiers: {
     speed: (unit: junit, value: number) => void;
     armor: (unit: junit, value: number) => void;
 };
-interface UnitWeapon {
+export declare class UnitWeapon {
+    readonly unit: Unit;
     readonly index: 0 | 1;
-    cooldown: number;
-    projectileArc: number;
-    projectileArt: string;
-    projectileSpeed: number;
-    attackPoint: number;
+    constructor(unit: Unit, index: 0 | 1);
+    get isEnabled(): boolean;
+    set isEnabled(isEnabled: boolean);
+    get cooldown(): number;
+    set cooldown(cooldown: number);
+    get damage(): [minimumDamage: number, maximumDamage: number];
+    set damage([minimumDamage, maximumDamage]: [number, number]);
+    get allowedTargetCombatClassifications(): CombatClassifications;
+    set allowedTargetCombatClassifications(allowedTargetCombatClassifications: CombatClassifications);
+    get damageBase(): number;
+    set damageBase(damageBase: number);
+    get damageDiceCount(): number;
+    set damageDiceCount(damageDiceCount: number);
+    get damageDiceSideCount(): number;
+    set damageDiceSideCount(damageDiceSideCount: number);
+    get range(): number;
+    set range(range: number);
+    get impactDelay(): number;
+    set impactDelay(impactDelay: number);
+    get missileArc(): number;
+    set missileArc(missileArc: number);
+    get missileModelPath(): string;
+    set missileModelPath(missileModelPath: string);
+    get missileSpeed(): number;
+    set missileSpeed(missileSpeed: number);
 }
 declare const enum UnitPropertyKey {
-    IS_PAUSED = 100,
-    STUN_COUNTER = 101,
-    PREVENT_DEATH_HEALTH_BONUS = 102,
-    IS_TEAM_GLOW_HIDDEN = 103
+    SYNC_ID = 100,
+    IS_PAUSED = 101,
+    STUN_COUNTER = 102,
+    FORCE_STUN_COUNTER = 103,
+    DELAY_HEALTH_CHECKS_COUNTER = 104,
+    DELAY_HEALTH_CHECKS_HEALTH_BONUS = 105,
+    PREVENT_DEATH_HEALTH_BONUS = 106,
+    IS_TEAM_GLOW_HIDDEN = 107,
+    LAST_X = 108,
+    LAST_Y = 109
 }
+export type UnitSyncId = number & {
+    readonly __unitSyncId: unique symbol;
+};
 export declare class Unit extends Handle<junit> {
+    readonly syncId: UnitSyncId;
     private [UnitPropertyKey.IS_PAUSED]?;
     private [UnitPropertyKey.STUN_COUNTER]?;
+    private [UnitPropertyKey.FORCE_STUN_COUNTER]?;
+    private [UnitPropertyKey.DELAY_HEALTH_CHECKS_COUNTER]?;
+    private [UnitPropertyKey.DELAY_HEALTH_CHECKS_HEALTH_BONUS]?;
     private [UnitPropertyKey.PREVENT_DEATH_HEALTH_BONUS]?;
     private [UnitPropertyKey.IS_TEAM_GLOW_HIDDEN]?;
+    private [UnitPropertyKey.LAST_X]?;
+    private [UnitPropertyKey.LAST_Y]?;
     private _owner?;
     private _timeScale?;
     private events?;
@@ -107,6 +151,7 @@ export declare class Unit extends Handle<junit> {
     get isAlive(): boolean;
     get isDead(): boolean;
     get isIllusion(): boolean;
+    get isStunned(): boolean;
     get combatClassifications(): CombatClassifications;
     set combatClassifications(combatClassifications: CombatClassifications);
     hasCombatClassification(combatClassification: CombatClassification): boolean;
@@ -119,14 +164,19 @@ export declare class Unit extends Handle<junit> {
     isInRangeOf(unit: Unit, range: number): boolean;
     isAllyOf(unit: Unit): boolean;
     isEnemyOf(unit: Unit): boolean;
-    playAnimation(animation: string, rarity?: jraritycontrol): void;
-    playAnimation(animation: number): void;
+    playAnimation(...parameters: [animation: number] | [animation: string, rarity?: jraritycontrol]): void;
+    resetAnimation(): void;
     queueAnimation(animation: string): void;
     get weapons(): [UnitWeapon, UnitWeapon];
+    get firstWeapon(): UnitWeapon;
+    get secondWeapon(): UnitWeapon;
+    chooseWeapon(target: Unit): UnitWeapon | undefined;
     get level(): number;
     set level(v: number);
     get xp(): number;
     set xp(v: number);
+    get primaryAttribute(): UnitAttribute;
+    set primaryAttribute(primaryAttribute: UnitAttribute);
     get strengthBase(): number;
     set strengthBase(strengthBase: number);
     get strengthBonus(): number;
@@ -148,6 +198,10 @@ export declare class Unit extends Handle<junit> {
     set color(color: PlayerColor);
     get acquisitionRange(): number;
     set acquisitionRange(v: number);
+    /**
+     * Keeps this unit alive even if its health becomes negative until the current game thread yields.
+     */
+    delayHealthChecks(): void;
     get maxHealth(): number;
     set maxHealth(maxHealth: number);
     get healthRegenerationRate(): number;
@@ -166,8 +220,6 @@ export declare class Unit extends Handle<junit> {
     set facing(v: number);
     get speed(): number;
     set speed(v: number);
-    get flyHeight(): number;
-    set flyHeight(v: number);
     get x(): number;
     set x(v: number);
     get y(): number;
@@ -191,17 +243,17 @@ export declare class Unit extends Handle<junit> {
     get isInvulnerable(): boolean;
     get vertexColor(): Color;
     set vertexColor(v: Color);
-    get scale(): number;
-    set scale(v: number);
     get timeScale(): number;
     set timeScale(v: number);
     get collisionSize(): number;
     get pathingCollisionRange(): number;
+    get movementType(): MovementType;
+    set movementType(movementType: MovementType);
     set pathing(v: boolean);
     isSelected(player: Player): boolean;
     explode(): void;
     kill(): void;
-    revive(pos: Vec2, doEffect: boolean): void;
+    revive(x: number, y: number, doEffect?: boolean): void;
     healTarget(target: Widget, amount: number): void;
     useItem(item: Item): boolean;
     issueImmediateOrder(order: number): boolean;
@@ -214,16 +266,18 @@ export declare class Unit extends Handle<junit> {
     dropItemTarget(item: Item, target: Widget): boolean;
     dropItemSlot(item: Item, slot: number): boolean;
     itemInSlot(slot: number): Item | null;
-    addAbility(abilityId: number): UnitAbility | null;
+    addAbility(abilityId: number): UnitAbility | undefined;
     makeAbilityPermanent(abilityId: number, permanent: true): boolean;
     setAbilityLevel(abilityId: number, level: number): number;
     getAbilityLevel(abilityId: number): number;
     hasAbility(abilityId: number): boolean;
-    getAbilityById(abilityId: number): UnitAbility | undefined;
-    removeAbility(abilityId: number): boolean;
+    getAbility(abilityId: number): UnitAbility | undefined;
+    removeAbility(abilityTypeId: number): boolean;
     hideAbility(abilityId: number, flag: boolean): void;
+    getAbilityRemainingCooldown(abilityId: number): number;
     startAbilityCooldown(abilityId: number, cooldown: number): void;
     endAbilityCooldown(abilityId: number): void;
+    interruptMovement(): void;
     interruptAttack(): void;
     interruptCast(abilityId: number): void;
     getDistanceTo(target: Unit | Vec2): number;
@@ -238,6 +292,8 @@ export declare class Unit extends Handle<junit> {
     unpauseEx(): void;
     incrementStunCounter(): void;
     decrementStunCounter(): void;
+    incrementForceStunCounter(): void;
+    decrementForceStunCounter(): void;
     set waygateActive(v: boolean);
     get waygateActive(): boolean;
     set waygateDestination(v: Vec2);
@@ -246,6 +302,7 @@ export declare class Unit extends Handle<junit> {
     get onUnitInRange(): Record<number, Event<[Unit]>>;
     get onManaEqual(): Record<number, Event<[Unit, number]>>;
     get manaEvent(): Record<Operator, Record<number, Event<[Unit]>>>;
+    get targetAcquiredEvent(): Event;
     get onSelect(): Event;
     get onDeselect(): Event;
     get onImmediateOrder(): Event<[number]>;
@@ -260,7 +317,7 @@ export declare class Unit extends Handle<junit> {
     static getInRange(x: number, y: number, range: number, predicate?: (unit: Unit) => boolean): Unit[];
     static getInCollisionRange(x: number, y: number, range: number, predicate?: (unit: Unit) => boolean): Unit[];
     static getInSector(pos: Vec2, range: number, offsetAngle: number, centralAngle: number): Unit[];
-    static getSelectionOf(player: Player): Unit[];
+    static getSelectionOf(player: Player, target?: Unit[]): Unit[];
     static readonly deathEvent: UnitTriggerEvent<[Unit]>;
     static readonly onDecay: UnitTriggerEvent<[]>;
     static readonly onResurrect: InitializingEvent<[Unit], void>;
@@ -295,9 +352,18 @@ export declare class Unit extends Handle<junit> {
     static readonly autoAttackStartEvent: UnitTriggerEvent<[Unit]>;
     static readonly onDamaging: Event<[source: Unit | undefined, target: Unit, event: DamagingEvent]>;
     static readonly onDamage: InitializingEvent<[source: Unit | undefined, target: Unit, event: DamageEvent], jtrigger>;
-    static onItemDrop: UnitTriggerEvent<[Item]>;
-    static onItemPickup: UnitTriggerEvent<[Item]>;
-    static onItemUse: UnitTriggerEvent<[Item]>;
+    static itemDroppedEvent: UnitTriggerEvent<[Item]>;
+    static itemPickedUpEvent: UnitTriggerEvent<[Item]>;
+    static itemUsedEvent: UnitTriggerEvent<[Item]>;
+    static itemStackedEvent: UnitTriggerEvent<[target: Item, source: Item]>;
+    static get itemChargesChangedEvent(): Event<[unit: Unit, item: Item]>;
+    static get itemUseOrderEvent(): Event<[unit: Unit, item: Item]>;
+    static get itemMoveOrderEvent(): Event<[
+        unit: Unit,
+        item: Item,
+        slotFrom: 0 | 1 | 2 | 3 | 4 | 5,
+        slotTo: 0 | 1 | 2 | 3 | 4 | 5
+    ]>;
     static get onCreate(): EventDispatcher<[Unit], [Unit]>;
     static get destroyEvent(): EventDispatcher<[Unit], [Unit]>;
     getField(field: junitintegerfield | junitrealfield): number;
@@ -308,5 +374,7 @@ export declare class Unit extends Handle<junit> {
     setField(field: junitbooleanfield, value: boolean): boolean;
     setField(field: junitstringfield, value: string): boolean;
     toString(): string;
+    static getBySyncId(syncId: UnitSyncId): Unit | undefined;
+    static synchronize: (player: Player, object: Unit | undefined) => Promise<Unit | undefined>;
 }
 export {};