warscript 0.0.1-dev.3324599 → 0.0.1-dev.33b52d0

package/engine/buff.d.ts

@@ -14,6 +14,7 @@ import type { Widget } from "../core/types/widget";
 import { Destructor } from "../destroyable";
 import { Event } from "../event";
 import { AbilityBehavior } from "./behaviour/ability";
+import { SoundPresetId } from "./object-data/entry/sound-preset";
 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;
@@ -23,6 +24,13 @@ export type BuffPolarityParameterType = EnumParameterValueType<BuffPolarity>;
 export type BuffResistanceTypeParameterType = EnumParameterValueType<BuffResistanceType>;
 export declare class BuffUniqueGroup {
 }
+export type BuffAbilityParameters = {
+    readonly fields?: [AbilityNumberField | AbilityNumberLevelField, NumberParameterValueType][];
+    /** Default `true`. */
+    readonly isButtonVisible?: boolean;
+    /** Default is the level of the source ability or 0 if it is absent. */
+    readonly level?: number;
+};
 export type BuffParameters<T extends Buff<any> = Buff> = Buff extends T ? {
     spellStealPriority?: number;
     level?: number;
@@ -30,16 +38,7 @@ export type BuffParameters<T extends Buff<any> = Buff> = Buff extends T ? {
     learnLevelMinimum?: number;
     source?: Unit;
     behaviorConstructors?: (new (unit: Unit) => UnitBehavior)[];
-    abilityTypeIds?: Record<AbilityTypeId, {
-        readonly fields?: [
-            AbilityNumberField | AbilityNumberLevelField,
-            NumberParameterValueType
-        ][];
-        /** Default `true`. */
-        readonly isButtonVisible?: boolean;
-        /** Default is the level of the source ability or 0 if it is absent. */
-        readonly level?: number;
-    }>;
+    abilityTypeIds?: Partial<Record<AbilityTypeId, BuffAbilityParameters>>;
     damageUponDeathAllowedTargetCombatClassifications?: CombatClassifications | AbilityCombatClassificationsLevelField;
     damageUponDeath?: NumberParameterValueType;
     damageUponDeathRange?: NumberParameterValueType;
@@ -65,6 +64,8 @@ export type BuffParameters<T extends Buff<any> = Buff> = Buff extends T ? {
     missProbability?: NumberParameterValueType;
     damageFactor?: NumberParameterValueType;
     receivedDamageFactor?: NumberParameterValueType;
+    /** The factor of melee attack damage returned to the attacker, as Spiked Carapace. */
+    returnedMeleeDamageFactor?: NumberParameterValueType;
     receivedMagicDamageFactor?: NumberParameterValueType;
     durationIncreaseOnAutoAttack?: NumberParameterValueType;
     maximumRemainingDuration?: NumberParameterValueType;
@@ -89,6 +90,8 @@ export type BuffParameters<T extends Buff<any> = Buff> = Buff extends T ? {
     explodesOnExpiration?: BooleanParameterValueType;
     abilityCooldownFactor?: NumberParameterValueType;
     uniqueGroup?: BuffUniqueGroup;
+    /** Played on the unit whenever the buff is destroyed, whatever the reason. */
+    destructionSoundPresetId?: SoundPresetId;
 } : BuffParameters & (T extends Buff<infer AdditionalParameters> ? AdditionalParameters : object);
 declare const enum BuffPropertyKey {
     STATE = 100,
@@ -96,50 +99,51 @@ declare const enum BuffPropertyKey {
     SOURCE = 102,
     DURATION = 103,
     UNIQUE_GROUP = 104,
-    EFFECT_MODEL_PATH = 105,
-    SPECIAL_EFFECT_MODEL_PATH = 106,
-    DURATION_INCREASE_ON_AUTO_ATTACK = 107,
-    MAXIMUM_DURATION = 108,
-    MAXIMUM_REMAINING_DURATION = 109,
-    DAMAGE_OVER_DURATION = 110,
-    DAMAGE_PER_INTERVAL = 111,
-    DAMAGE_INTERVAL = 112,
-    REMAINING_DAMAGE_OVER_DURATION = 113,
-    DAMAGE_INTERVAL_TIMER = 114,
-    HEALING_OVER_DURATION = 115,
-    HEALING_PER_INTERVAL = 116,
-    HEALING_INTERVAL = 117,
-    REMAINING_HEALING_OVER_DURATION = 118,
-    HEALING_INTERVAL_TIMER = 119,
-    DAMAGE_ON_EXPIRATION = 120,
-    HEALING_ON_EXPIRATION = 121,
-    DAMAGE_UPON_DEATH_ALLOWED_TARGET_CLASSIFICATIONS = 122,
-    DAMAGE_UPON_DEATH = 123,
-    DAMAGE_UPON_DEATH_RANGE = 124,
-    MEDIUM_DAMAGE_UPON_DEATH = 125,
-    MEDIUM_DAMAGE_UPON_DEATH_RANGE = 126,
-    SMALL_DAMAGE_UPON_DEATH = 127,
-    SMALL_DAMAGE_UPON_DEATH_RANGE = 128,
-    AUTO_ATTACK_COUNT = 129,
-    MAXIMUM_AUTO_ATTACK_COUNT = 130,
-    DAMAGE_DEALT_EVENT_COUNT = 131,
-    MAXIMUM_DAMAGE_DEALT_EVENT_COUNT = 132,
-    DAMAGE_RECEIVED_EVENT_COUNT = 133,
-    MAXIMUM_DAMAGE_RECEIVED_EVENT_COUNT = 134,
-    ABSORBED_DAMAGE_FACTOR = 135,
-    MAXIMUM_DAMAGE_ABSORBED = 136,
-    DAMAGE_ABSORBED = 137,
-    DESTROYS_ON_MAXIMUM_DAMAGE_ABSORBED = 138,
-    TURNS_INTO_GHOST = 139,
-    STUNS = 140,
-    IGNORES_STUN_IMMUNITY = 141,
-    DISABLES_AUTO_ATTACK = 142,
-    PROVIDES_INVULNERABILITY = 143,
-    KILLS_ON_EXPIRATION = 144,
-    EXPLODES_ON_EXPIRATION = 145,
-    MISS_PROBABILITY = 146,
-    ABILITY_COOLDOWN_FACTOR = 147,
-    ABILITY_COOLDOWN_MODIFIER = 148
+    DESTRUCTION_SOUND_PRESET_ID = 105,
+    EFFECT_MODEL_PATH = 106,
+    SPECIAL_EFFECT_MODEL_PATH = 107,
+    DURATION_INCREASE_ON_AUTO_ATTACK = 108,
+    MAXIMUM_DURATION = 109,
+    MAXIMUM_REMAINING_DURATION = 110,
+    DAMAGE_OVER_DURATION = 111,
+    DAMAGE_PER_INTERVAL = 112,
+    DAMAGE_INTERVAL = 113,
+    REMAINING_DAMAGE_OVER_DURATION = 114,
+    DAMAGE_INTERVAL_TIMER = 115,
+    HEALING_OVER_DURATION = 116,
+    HEALING_PER_INTERVAL = 117,
+    HEALING_INTERVAL = 118,
+    REMAINING_HEALING_OVER_DURATION = 119,
+    HEALING_INTERVAL_TIMER = 120,
+    DAMAGE_ON_EXPIRATION = 121,
+    HEALING_ON_EXPIRATION = 122,
+    DAMAGE_UPON_DEATH_ALLOWED_TARGET_CLASSIFICATIONS = 123,
+    DAMAGE_UPON_DEATH = 124,
+    DAMAGE_UPON_DEATH_RANGE = 125,
+    MEDIUM_DAMAGE_UPON_DEATH = 126,
+    MEDIUM_DAMAGE_UPON_DEATH_RANGE = 127,
+    SMALL_DAMAGE_UPON_DEATH = 128,
+    SMALL_DAMAGE_UPON_DEATH_RANGE = 129,
+    AUTO_ATTACK_COUNT = 130,
+    MAXIMUM_AUTO_ATTACK_COUNT = 131,
+    DAMAGE_DEALT_EVENT_COUNT = 132,
+    MAXIMUM_DAMAGE_DEALT_EVENT_COUNT = 133,
+    DAMAGE_RECEIVED_EVENT_COUNT = 134,
+    MAXIMUM_DAMAGE_RECEIVED_EVENT_COUNT = 135,
+    ABSORBED_DAMAGE_FACTOR = 136,
+    MAXIMUM_DAMAGE_ABSORBED = 137,
+    DAMAGE_ABSORBED = 138,
+    DESTROYS_ON_MAXIMUM_DAMAGE_ABSORBED = 139,
+    TURNS_INTO_GHOST = 140,
+    STUNS = 141,
+    IGNORES_STUN_IMMUNITY = 142,
+    DISABLES_AUTO_ATTACK = 143,
+    PROVIDES_INVULNERABILITY = 144,
+    KILLS_ON_EXPIRATION = 145,
+    EXPLODES_ON_EXPIRATION = 146,
+    MISS_PROBABILITY = 147,
+    ABILITY_COOLDOWN_FACTOR = 148,
+    ABILITY_COOLDOWN_MODIFIER = 149
 }
 export declare const enum BuffTypeIdSelectionPolicy {
     LEAST_DURATION = 0
@@ -167,6 +171,7 @@ export declare class Buff<AdditionalParameters extends Prohibit<Record<string, a
     private [BuffPropertyKey.SOURCE]?;
     private [BuffPropertyKey.DURATION];
     private [BuffPropertyKey.UNIQUE_GROUP]?;
+    private [BuffPropertyKey.DESTRUCTION_SOUND_PRESET_ID]?;
     private [BuffPropertyKey.EFFECT_MODEL_PATH];
     private [BuffPropertyKey.SPECIAL_EFFECT_MODEL_PATH];
     private [BuffPropertyKey.DURATION_INCREASE_ON_AUTO_ATTACK]?;
@@ -253,6 +258,8 @@ export declare class Buff<AdditionalParameters extends Prohibit<Record<string, a
     set damageFactor(damageFactor: number);
     get receivedDamageFactor(): number;
     set receivedDamageFactor(receivedDamageFactor: number);
+    get returnedMeleeDamageFactor(): number;
+    set returnedMeleeDamageFactor(returnedMeleeDamageFactor: number);
     get armorIncrease(): number;
     set armorIncrease(armorIncrease: number);
     get maxHealthIncrease(): number;
@@ -314,10 +321,14 @@ export declare class Buff<AdditionalParameters extends Prohibit<Record<string, a
     ]): void;
     private flash;
     expire(): void;
+    /** Dispels this buff, invoking onDispel before removing it. */
+    dispel(source?: Unit): 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;
+    /** Called for dispelling, never for a direct destroy() or replacement. */
+    onDispel(source: Unit | undefined): void;
     onExpiration(): void;
     onDeath(source: Unit | undefined): void;
     onDamageDealt(target: Unit, event: DamageEvent): void;