warscript 0.0.1-dev.959b9a7 → 0.0.1-dev.971c803

package/engine/buff.d.ts

@@ -5,16 +5,21 @@ import { Ability } from "./internal/ability";
 import { AbilityTypeId } from "./object-data/entry/ability-type";
 import { BuffPolarity } from "./object-data/auxiliary/buff-polarity";
 import { BuffResistanceType } from "./object-data/auxiliary/buff-resistance-type";
-import { AbilityBooleanField, AbilityBooleanLevelField, AbilityCombatClassificationsLevelField, AbilityDependentValue, AbilityIntegerField, AbilityIntegerLevelField, AbilityNumberField, AbilityNumberLevelField } from "./object-field/ability";
+import { AbilityBooleanField, AbilityBooleanLevelField, AbilityCombatClassificationsLevelField, AbilityDependentValue, AbilityEnumLevelField, AbilityIntegerField, AbilityIntegerLevelField, AbilityNumberField, AbilityNumberLevelField } from "./object-field/ability";
 import { CombatClassifications } from "./object-data/auxiliary/combat-classification";
-import { IsExactlyAny, NonEmptyArray, Prohibit } from "../utility/types";
+import { IsExactlyAny, Prohibit, ReadonlyNonEmptyArray } from "../utility/types";
+import { EffectParameters } from "../core/types/effect";
 import { UnitBehavior } from "./behaviour/unit";
 import type { Widget } from "../core/types/widget";
 import { Destructor } from "../destroyable";
+import { Event } from "../event";
 export type BuffConstructor<T extends Buff<any> = Buff<any>, Args extends any[] = any> = OmitConstructor<typeof Buff<any>> & (new (...args: Args) => T);
+type EnumParameterValueType<T extends number> = T | AbilityEnumLevelField<T>;
 type NumberParameterValueType = number | AbilityNumberField | AbilityNumberLevelField;
 type IntegerParameterValueType = number | AbilityIntegerField | AbilityIntegerLevelField;
 type BooleanParameterValueType = boolean | AbilityBooleanField | AbilityBooleanLevelField;
+export type BuffPolarityParameterType = EnumParameterValueType<BuffPolarity>;
+export type BuffResistanceTypeParameterType = EnumParameterValueType<BuffResistanceType>;
 export declare class BuffUniqueGroup {
 }
 export type BuffParameters<T extends Buff<any> = Buff> = Buff extends T ? {
@@ -51,6 +56,8 @@ export type BuffParameters<T extends Buff<any> = Buff> = Buff extends T ? {
     armorIncreaseFactor?: NumberParameterValueType;
     attackSpeedIncreaseFactor?: NumberParameterValueType;
     movementSpeedIncreaseFactor?: NumberParameterValueType;
+    evasionProbability?: NumberParameterValueType;
+    damageFactor?: NumberParameterValueType;
     receivedDamageFactor?: NumberParameterValueType;
     receivedMagicDamageFactor?: NumberParameterValueType;
     durationIncreaseOnAutoAttack?: NumberParameterValueType;
@@ -64,8 +71,14 @@ export type BuffParameters<T extends Buff<any> = Buff> = Buff extends T ? {
     disablesAutoAttack?: BooleanParameterValueType;
     destroysOnDamage?: BooleanParameterValueType;
     maximumAutoAttackCount?: IntegerParameterValueType;
+    maximumDamageDealtEventCount?: IntegerParameterValueType;
+    maximumDamageReceivedEventCount?: IntegerParameterValueType;
+    damageOnExpiration?: NumberParameterValueType;
+    healingOnExpiration?: NumberParameterValueType;
+    killsOnExpiration?: BooleanParameterValueType;
+    explodesOnExpiration?: BooleanParameterValueType;
     uniqueGroup?: BuffUniqueGroup;
-} : BuffParameters & (T extends Buff<infer AdditionalParameters> ? AdditionalParameters : {});
+} : BuffParameters & (T extends Buff<infer AdditionalParameters> ? AdditionalParameters : object);
 declare const enum BuffPropertyKey {
     UNIT = 100,
     SOURCE = 101,
@@ -86,19 +99,27 @@ declare const enum BuffPropertyKey {
     HEALING_INTERVAL = 116,
     REMAINING_HEALING_OVER_DURATION = 117,
     HEALING_INTERVAL_TIMER = 118,
-    DAMAGE_UPON_DEATH_ALLOWED_TARGET_CLASSIFICATIONS = 119,
-    DAMAGE_UPON_DEATH = 120,
-    DAMAGE_UPON_DEATH_RANGE = 121,
-    MEDIUM_DAMAGE_UPON_DEATH = 122,
-    MEDIUM_DAMAGE_UPON_DEATH_RANGE = 123,
-    SMALL_DAMAGE_UPON_DEATH = 124,
-    SMALL_DAMAGE_UPON_DEATH_RANGE = 125,
-    AUTO_ATTACK_COUNT = 126,
-    MAXIMUM_AUTO_ATTACK_COUNT = 127,
-    STUNS = 128,
-    IGNORES_STUN_IMMUNITY = 129,
-    DISABLES_AUTO_ATTACK = 130,
-    PROVIDES_INVULNERABILITY = 131
+    DAMAGE_ON_EXPIRATION = 119,
+    HEALING_ON_EXPIRATION = 120,
+    DAMAGE_UPON_DEATH_ALLOWED_TARGET_CLASSIFICATIONS = 121,
+    DAMAGE_UPON_DEATH = 122,
+    DAMAGE_UPON_DEATH_RANGE = 123,
+    MEDIUM_DAMAGE_UPON_DEATH = 124,
+    MEDIUM_DAMAGE_UPON_DEATH_RANGE = 125,
+    SMALL_DAMAGE_UPON_DEATH = 126,
+    SMALL_DAMAGE_UPON_DEATH_RANGE = 127,
+    AUTO_ATTACK_COUNT = 128,
+    MAXIMUM_AUTO_ATTACK_COUNT = 129,
+    DAMAGE_DEALT_EVENT_COUNT = 130,
+    MAXIMUM_DAMAGE_DEALT_EVENT_COUNT = 131,
+    DAMAGE_RECEIVED_EVENT_COUNT = 132,
+    MAXIMUM_DAMAGE_RECEIVED_EVENT_COUNT = 133,
+    STUNS = 134,
+    IGNORES_STUN_IMMUNITY = 135,
+    DISABLES_AUTO_ATTACK = 136,
+    PROVIDES_INVULNERABILITY = 137,
+    KILLS_ON_EXPIRATION = 138,
+    EXPLODES_ON_EXPIRATION = 139
 }
 export declare const enum BuffTypeIdSelectionPolicy {
     LEAST_DURATION = 0
@@ -106,17 +127,17 @@ export declare const enum BuffTypeIdSelectionPolicy {
 export type BuffAdditionalParameters = Prohibit<Record<string, any>, keyof BuffParameters>;
 export type BuffConstructorParameters<AdditionalParameters extends BuffAdditionalParameters> = [
     ...typeId: [ApplicableBuffTypeId] | [
-        typeIds: NonEmptyArray<ApplicableBuffTypeId>,
+        typeIds: ReadonlyNonEmptyArray<ApplicableBuffTypeId>,
         typeIdSelectionPolicy: BuffTypeIdSelectionPolicy
     ],
-    polarity: BuffPolarity,
-    resistanceType: BuffResistanceType,
+    polarity: BuffPolarityParameterType,
+    resistanceType: BuffResistanceTypeParameterType,
     ...abilityOrParameters: [
         ability: Ability,
         parameters?: BuffParameters & Omit<AdditionalParameters, keyof BuffParameters>
     ] | [parameters?: BuffParameters & Omit<AdditionalParameters, keyof BuffParameters>]
 ];
-export declare class Buff<AdditionalParameters extends Prohibit<Record<string, any>, keyof BuffParameters> = {}> extends UnitBehavior {
+export declare class Buff<AdditionalParameters extends Prohibit<Record<string, any>, keyof BuffParameters> = object> extends UnitBehavior {
     private _unit;
     protected readonly __additionalParametersBrand?: AdditionalParameters;
     private [BuffPropertyKey.UNIT];
@@ -138,6 +159,8 @@ export declare class Buff<AdditionalParameters extends Prohibit<Record<string, a
     private [BuffPropertyKey.HEALING_INTERVAL]?;
     private [BuffPropertyKey.REMAINING_HEALING_OVER_DURATION]?;
     private [BuffPropertyKey.HEALING_INTERVAL_TIMER]?;
+    private [BuffPropertyKey.DAMAGE_ON_EXPIRATION]?;
+    private [BuffPropertyKey.HEALING_ON_EXPIRATION]?;
     private [BuffPropertyKey.DAMAGE_UPON_DEATH_ALLOWED_TARGET_CLASSIFICATIONS]?;
     private [BuffPropertyKey.DAMAGE_UPON_DEATH]?;
     private [BuffPropertyKey.DAMAGE_UPON_DEATH_RANGE]?;
@@ -147,10 +170,16 @@ export declare class Buff<AdditionalParameters extends Prohibit<Record<string, a
     private [BuffPropertyKey.SMALL_DAMAGE_UPON_DEATH_RANGE]?;
     private [BuffPropertyKey.MAXIMUM_AUTO_ATTACK_COUNT]?;
     private [BuffPropertyKey.AUTO_ATTACK_COUNT]?;
+    private [BuffPropertyKey.MAXIMUM_DAMAGE_DEALT_EVENT_COUNT]?;
+    private [BuffPropertyKey.DAMAGE_DEALT_EVENT_COUNT]?;
+    private [BuffPropertyKey.MAXIMUM_DAMAGE_RECEIVED_EVENT_COUNT]?;
+    private [BuffPropertyKey.DAMAGE_RECEIVED_EVENT_COUNT]?;
     private [BuffPropertyKey.STUNS]?;
     private [BuffPropertyKey.IGNORES_STUN_IMMUNITY]?;
     private [BuffPropertyKey.DISABLES_AUTO_ATTACK]?;
     private [BuffPropertyKey.PROVIDES_INVULNERABILITY]?;
+    private [BuffPropertyKey.KILLS_ON_EXPIRATION]?;
+    private [BuffPropertyKey.EXPLODES_ON_EXPIRATION]?;
     protected static readonly defaultParameters: BuffParameters;
     get source(): Unit;
     readonly typeId: ApplicableBuffTypeId;
@@ -187,6 +216,12 @@ export declare class Buff<AdditionalParameters extends Prohibit<Record<string, a
     set healingPerInterval(healingPerInterval: number);
     get healingInterval(): number;
     set healingInterval(healingInterval: number);
+    get damageOnExpiration(): number;
+    set damageOnExpiration(damageOnExpiration: number);
+    get healingOnExpiration(): number;
+    set healingOnExpiration(healingOnExpiration: number);
+    get damageFactor(): number;
+    set damageFactor(damageFactor: number);
     get receivedDamageFactor(): number;
     set receivedDamageFactor(receivedDamageFactor: number);
     get armorIncrease(): number;
@@ -199,6 +234,14 @@ export declare class Buff<AdditionalParameters extends Prohibit<Record<string, a
     set disablesAutoAttack(disablesAutoAttack: boolean);
     get providesInvulnerability(): boolean;
     set providesInvulnerability(providesInvulnerability: boolean);
+    get killsOnExpiration(): boolean;
+    set killsOnExpiration(killsOnExpiration: boolean);
+    get explodesOnExpiration(): boolean;
+    set explodesOnExpiration(killsOnExpiration: boolean);
+    get maximumDamageDealtEventCount(): number;
+    set maximumDamageDealtEventCount(maximumDamageDealtEventCount: number);
+    get maximumDamageReceivedEventCount(): number;
+    set maximumDamageReceivedEventCount(maximumDamageReceivedEventCount: number);
     get maximumAutoAttackCount(): number;
     set maximumAutoAttackCount(maximumAutoAttackCount: number);
     get durationIncreaseOnAutoAttack(): number;
@@ -207,15 +250,24 @@ export declare class Buff<AdditionalParameters extends Prohibit<Record<string, a
     set attackSpeedIncreaseFactor(attackSpeedIncreaseFactor: number);
     get movementSpeedIncreaseFactor(): number;
     set movementSpeedIncreaseFactor(movementSpeedIncreaseFactor: number);
+    get evasionProbability(): number;
+    set evasionProbability(evasionProbability: number);
     get duration(): number;
     get remainingDuration(): number;
     set remainingDuration(remainingDuration: number);
-    flashEffect(...parameters: [...widget: [] | [Widget], ...duration: [] | [number]]): void;
+    flashEffect(...parameters: [
+        ...widgetOrXY: [] | [Widget] | [x: number, x: number],
+        ...parametersOrDuration: [] | [EffectParameters] | [number]
+    ]): void;
     flashSpecialEffect(...parameters: [...widget: [] | [Widget], ...duration: [] | [number]]): void;
+    protected onCreate(): void;
     protected onDestroy(): Destructor;
     static apply<T extends Buff<any>, Args extends any[]>(this: BuffConstructor<T, Args>, ...args: Args): T | undefined;
     static getByTypeId<T extends Buff<any>, Args extends any[]>(this: BuffConstructor<T, Args>, unit: Unit, typeId: ApplicableBuffTypeId): T | undefined;
+    onExpiration(): void;
     onDeath(source: Unit | undefined): void;
     onDamageDealt(target: Unit, event: DamageEvent): void;
+    onDamageReceived(source: Unit | undefined, event: DamageEvent): void;
+    static readonly destroyEvent: Event<[Buff<object>]>;
 }
 export {};