warscript 0.0.1-dev.724bf08 → 0.0.1-dev.72620d4

package/attributes.d.ts

@@ -1,12 +1,18 @@
 /** @noSelfInFile */
+declare const marker: {};
 export type Attribute<T> = {
     readonly __attribute: unique symbol;
     readonly __type: T;
+    readonly __marker: typeof marker;
 } & symbol;
+export declare const attribute: <T>() => Attribute<T>;
+export declare const isAttribute: (value: unknown) => value is Attribute<unknown>;
 export declare namespace Attribute {
     const create: <T>() => Attribute<T>;
 }
 export declare class AttributesHolder {
     readonly get: (<T>(attribute: Attribute<T>) => T | undefined) & LuaExtension<"TableGetMethod">;
     readonly set: (<T>(attribute: Attribute<T>, value: T | undefined) => void) & LuaExtension<"TableSetMethod">;
+    getOrPut<T>(attribute: Attribute<T>, defaultValue: () => T): T;
 }
+export {};

package/attributes.lua

@@ -1,11 +1,18 @@
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
 local ____exports = {}
+local marker = {}
+____exports.attribute = function()
+    return {__marker = marker}
+end
+____exports.isAttribute = function(value)
+    return type(value) == "table" and rawget(value, "__marker") == marker
+end
 ____exports.Attribute = {}
 local Attribute = ____exports.Attribute
 do
     Attribute.create = function()
-        return {}
+        return {__marker = marker}
     end
 end
 ____exports.AttributesHolder = __TS__Class()
@@ -13,4 +20,13 @@ local AttributesHolder = ____exports.AttributesHolder
 AttributesHolder.name = "AttributesHolder"
 function AttributesHolder.prototype.____constructor(self)
 end
+function AttributesHolder.prototype.getOrPut(self, attribute, defaultValue)
+    local value = self[attribute]
+    if value ~= nil then
+        return value
+    end
+    value = defaultValue()
+    self[attribute] = value
+    return value
+end
 return ____exports

package/config.d.ts

@@ -0,0 +1,5 @@
+/** @noSelfInFile */
+export declare class WarscriptConfig {
+    private constructor();
+    static AUTOMATICALLY_SET_UNIT_TYPE_PORTRAIT_MODEL_PATH: boolean;
+}

package/config.lua

@@ -0,0 +1,10 @@
+local ____lualib = require("lualib_bundle")
+local __TS__Class = ____lualib.__TS__Class
+local ____exports = {}
+____exports.WarscriptConfig = __TS__Class()
+local WarscriptConfig = ____exports.WarscriptConfig
+WarscriptConfig.name = "WarscriptConfig"
+function WarscriptConfig.prototype.____constructor(self)
+end
+WarscriptConfig.AUTOMATICALLY_SET_UNIT_TYPE_PORTRAIT_MODEL_PATH = true
+return ____exports

package/core/dummy.lua

@@ -15,6 +15,8 @@ local ____preconditions = require("utility.preconditions")
 local checkNotNull = ____preconditions.checkNotNull
 local ____ability = require("engine.internal.ability")
 local getOrderIdByAbilityTypeId = ____ability.getOrderIdByAbilityTypeId
+local ____unit_2Dability_2Dlevel_2Dnatives = require("engine.internal.misc.unit-ability-level-natives")
+local rawSetUnitAbilityLevel = ____unit_2Dability_2Dlevel_2Dnatives.rawSetUnitAbilityLevel
 local neutralVictim = Player.neutralVictim.handle
 ____exports.InstantDummyCaster = __TS__Class()
 local InstantDummyCaster = ____exports.InstantDummyCaster
@@ -42,7 +44,7 @@ function InstantDummyCaster.prototype.prepare(self, owner, abilityId, level)
     if type(abilityId) == "number" then
         UnitAddAbility(dummy, abilityId)
         if type(level) == "number" then
-            SetUnitAbilityLevel(dummy, abilityId, level + 1)
+            rawSetUnitAbilityLevel(dummy, abilityId, level + 1)
         else
             level(UnitAbility:of(
                 checkNotNull(BlzGetUnitAbility(dummy, abilityId)),
@@ -56,7 +58,7 @@ function InstantDummyCaster.prototype.prepare(self, owner, abilityId, level)
         end
         if __TS__ArrayIsArray(level) then
             for i = 1, #abilityId do
-                SetUnitAbilityLevel(dummy, abilityId[i], level[i] + 1)
+                rawSetUnitAbilityLevel(dummy, abilityId[i], level[i] + 1)
             end
         else
             local abilities = {}

package/core/types/effect.d.ts

@@ -5,9 +5,12 @@ import { PlayerColor } from "./playerColor";
 declare const enum EffectPropertyKey {
     COLOR = 100,
     PITCH = 101,
-    ROLL = 102
+    ROLL = 102,
+    BLEND_TIME = 103,
+    TIME_SCALE = 104
 }
 export type EffectParameters = {
+    readonly delay?: number;
     readonly scale?: number;
     readonly color?: PlayerColor;
     readonly pitch?: number;
@@ -20,7 +23,15 @@ export declare class Effect extends Handle<jeffect> {
     private [EffectPropertyKey.COLOR]?;
     private [EffectPropertyKey.PITCH]?;
     private [EffectPropertyKey.ROLL]?;
+    private [EffectPropertyKey.BLEND_TIME]?;
+    private [EffectPropertyKey.TIME_SCALE]?;
     protected onDestroy(): HandleDestructor;
+    setAnimation(animation: string): void;
+    queueAnimation(animation: string): void;
+    get blendTime(): number;
+    set blendTime(blendTime: number);
+    get timeScale(): number;
+    set timeScale(timeScale: number);
     get color(): PlayerColor;
     set color(color: PlayerColor);
     get scale(): number;
@@ -29,12 +40,10 @@ export declare class Effect extends Handle<jeffect> {
     set pitch(pitch: number);
     get roll(): number;
     set roll(roll: number);
-    static create<T extends Effect>(this: typeof Effect & (new (handle: jeffect) => T), model: string, pos: Vec2): T;
-    static createTarget<T extends Effect>(this: typeof Effect & (new (handle: jeffect) => T), model: string, target: Widget, attachPoint: string): T;
+    static create<T extends Effect>(this: typeof Effect & (new (handle: jeffect) => T), modelPath: string, xOrWidget: number | Widget, yOrAttachmentPoint?: number | string, parameters?: EffectParameters): T;
     static flash(modelPath: string, ...args: [
         ...pointOrWidget: [x: number, y: number] | [widget: Widget, attachmentPoint?: string],
         ...parametersOrDuration: [parametersOrDuration?: EffectParameters | number] | [duration?: number, parameters?: EffectParameters]
     ]): void;
-    static flashTarget(model: string, target: Widget, attachPoint: string, duration?: number): void;
 }
 export {};

package/core/types/effect.lua

@@ -1,10 +1,10 @@
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
 local __TS__ClassExtends = ____lualib.__TS__ClassExtends
-local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 local __TS__SetDescriptor = ____lualib.__TS__SetDescriptor
+local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 local ____exports = {}
-local dummyPlayer
+local dummyPlayer, addSpecialEffectInternal, flash
 local ____handle = require("core.types.handle")
 local Handle = ____handle.Handle
 local ____playerColor = require("core.types.playerColor")
@@ -15,25 +15,22 @@ local ____timer = require("core.types.timer")
 local Timer = ____timer.Timer
 local ____unit = require("engine.internal.unit")
 local Unit = ____unit.Unit
-local ____pairs = _G.pairs
-local select = _G.select
-local mathRad = math.rad
 local addSpecialEffect = AddSpecialEffect
 local addSpecialEffectTarget = AddSpecialEffectTarget
 local destroyEffect = DestroyEffect
+local getLocationZ = GetLocationZ
 local getSpecialEffectScale = BlzGetSpecialEffectScale
-local playSpecialEffect = BlzPlaySpecialEffect
-local setSpecialEffectScale = BlzSetSpecialEffectScale
+local moveLocation = MoveLocation
+local queueSpecialEffectAnimation = BlzQueueSpecialEffectAnimation
+local setSpecialEffectAnimation = BlzSetSpecialEffectAnimation
+local setSpecialEffectAnimationBlendTime = BlzSetSpecialEffectAnimationBlendTime
+local setSpecialEffectTimeScale = BlzSetSpecialEffectTimeScale
+local setSpecialEffectColorByPlayer = BlzSetSpecialEffectColorByPlayer
 local setSpecialEffectPitch = BlzSetSpecialEffectPitch
 local setSpecialEffectRoll = BlzSetSpecialEffectRoll
-local setSpecialEffectColorByPlayer = BlzSetSpecialEffectColorByPlayer
-local specialEffectAddSubAnimation = BlzSpecialEffectAddSubAnimation
-local specialEffectClearSubAnimations = BlzSpecialEffectClearSubAnimations
-local specialEffectRemoveSubAnimation = BlzSpecialEffectRemoveSubAnimation
+local setSpecialEffectScale = BlzSetSpecialEffectScale
 local setSpecialEffectZ = BlzSetSpecialEffectZ
-local getLocationZ = GetLocationZ
-local getUnitZ = BlzGetUnitZ
-local moveLocation = MoveLocation
+local mathRad = math.rad
 local location = Location(0, 0)
 local function setSpecialEffectPitchDegrees(effect, pitch)
     setSpecialEffectPitch(
@@ -47,71 +44,6 @@ local function setSpecialEffectRollDegrees(effect, roll)
         -mathRad(roll)
     )
 end
-local animTypeByAnimationName = {
-    attack = ANIM_TYPE_ATTACK,
-    birth = ANIM_TYPE_BIRTH,
-    death = ANIM_TYPE_DEATH,
-    decay = ANIM_TYPE_DECAY,
-    dissipate = ANIM_TYPE_DISSIPATE,
-    morph = ANIM_TYPE_MORPH,
-    portrait = ANIM_TYPE_PORTRAIT,
-    sleep = ANIM_TYPE_SLEEP,
-    spell = ANIM_TYPE_SPELL,
-    stand = ANIM_TYPE_STAND,
-    walk = ANIM_TYPE_WALK
-}
-local subAnimTypeByAnimationQualifier = {
-    alternate = SUBANIM_TYPE_ROOTED,
-    alternateex = SUBANIM_TYPE_ALTERNATE_EX,
-    chain = SUBANIM_TYPE_CHAINLIGHTNING,
-    channel = SUBANIM_TYPE_CHANNEL,
-    complete = SUBANIM_TYPE_COMPLETE,
-    critical = SUBANIM_TYPE_CRITICAL,
-    defend = SUBANIM_TYPE_DEFEND,
-    drain = SUBANIM_TYPE_DRAIN,
-    eattree = SUBANIM_TYPE_EATTREE,
-    fast = SUBANIM_TYPE_FAST,
-    fill = SUBANIM_TYPE_FILL,
-    flail = SUBANIM_TYPE_FLAIL,
-    flesh = SUBANIM_TYPE_FLESH,
-    fifth = SUBANIM_TYPE_FIFTH,
-    fire = SUBANIM_TYPE_FIRE,
-    first = SUBANIM_TYPE_FIRST,
-    five = SUBANIM_TYPE_FIVE,
-    four = SUBANIM_TYPE_FOUR,
-    fourth = SUBANIM_TYPE_FOURTH,
-    gold = SUBANIM_TYPE_GOLD,
-    hit = SUBANIM_TYPE_HIT,
-    large = SUBANIM_TYPE_LARGE,
-    left = SUBANIM_TYPE_LEFT,
-    light = SUBANIM_TYPE_LIGHT,
-    looping = SUBANIM_TYPE_LOOPING,
-    lumber = SUBANIM_TYPE_LUMBER,
-    medium = SUBANIM_TYPE_MEDIUM,
-    moderate = SUBANIM_TYPE_MODERATE,
-    off = SUBANIM_TYPE_OFF,
-    one = SUBANIM_TYPE_ONE,
-    puke = SUBANIM_TYPE_PUKE,
-    ready = SUBANIM_TYPE_READY,
-    right = SUBANIM_TYPE_RIGHT,
-    second = SUBANIM_TYPE_SECOND,
-    severe = SUBANIM_TYPE_SEVERE,
-    slam = SUBANIM_TYPE_SLAM,
-    small = SUBANIM_TYPE_SMALL,
-    spiked = SUBANIM_TYPE_SPIKED,
-    spin = SUBANIM_TYPE_SPIN,
-    swim = SUBANIM_TYPE_SWIM,
-    talk = SUBANIM_TYPE_TALK,
-    third = SUBANIM_TYPE_THIRD,
-    three = SUBANIM_TYPE_THREE,
-    throw = SUBANIM_TYPE_THROW,
-    two = SUBANIM_TYPE_TWO,
-    turn = SUBANIM_TYPE_TURN,
-    victory = SUBANIM_TYPE_VICTORY,
-    work = SUBANIM_TYPE_WORK,
-    wounded = SUBANIM_TYPE_WOUNDED,
-    upgrade = SUBANIM_TYPE_UPGRADE
-}
 local function setSpecialEffectColor(effect, color)
     local dummyColor = dummyPlayer.color
     dummyPlayer.color = color
@@ -119,10 +51,18 @@ local function setSpecialEffectColor(effect, color)
     dummyPlayer.color = dummyColor
 end
 local setters = {scale = setSpecialEffectScale, color = setSpecialEffectColor, pitch = setSpecialEffectPitchDegrees, roll = setSpecialEffectRollDegrees}
+local setterProperties = {"scale", "color", "pitch", "roll"}
 dummyPlayer = Player.neutralExtra
 local temporaryEffects = {}
 local temporaryEffectsDurations = {}
 local temporaryEffectsCount = 0
+local delayedEffectsModelPath = {}
+local delayedEffectsXOrWidget = {}
+local delayedEffectsYOrAttachmentPoint = {}
+local delayedEffectsDuration = {}
+local delayedEffectsParameters = {}
+local delayedEffectsDelay = {}
+local delayedEffectsCount = 0
 local period = 1 / 32
 Timer.onPeriod[period]:addListener(function()
     local i = 1
@@ -131,12 +71,36 @@ Timer.onPeriod[period]:addListener(function()
         if duration <= 0 then
             destroyEffect(temporaryEffects[i])
             temporaryEffects[i] = temporaryEffects[temporaryEffectsCount]
+            temporaryEffectsDurations[i] = temporaryEffectsDurations[temporaryEffectsCount]
             temporaryEffectsCount = temporaryEffectsCount - 1
         else
             temporaryEffectsDurations[i] = duration - period
             i = i + 1
         end
     end
+    i = 1
+    while i <= delayedEffectsCount do
+        local delay = delayedEffectsDelay[i]
+        if delay <= 0 then
+            flash(
+                delayedEffectsModelPath[i],
+                delayedEffectsXOrWidget[i],
+                delayedEffectsYOrAttachmentPoint[i],
+                delayedEffectsDuration[i],
+                delayedEffectsParameters[i]
+            )
+            delayedEffectsModelPath[i] = delayedEffectsModelPath[delayedEffectsCount]
+            delayedEffectsXOrWidget[i] = delayedEffectsXOrWidget[delayedEffectsCount]
+            delayedEffectsYOrAttachmentPoint[i] = delayedEffectsYOrAttachmentPoint[delayedEffectsCount]
+            delayedEffectsDuration[i] = delayedEffectsDuration[delayedEffectsCount]
+            delayedEffectsParameters[i] = delayedEffectsParameters[delayedEffectsCount]
+            delayedEffectsDelay[i] = delayedEffectsDelay[delayedEffectsCount]
+            delayedEffectsCount = delayedEffectsCount - 1
+        else
+            delayedEffectsDelay[i] = delay - period
+            i = i + 1
+        end
+    end
 end)
 ____exports.Effect = __TS__Class()
 local Effect = ____exports.Effect
@@ -146,66 +110,78 @@ function Effect.prototype.onDestroy(self)
     destroyEffect(self.handle)
     return Handle.prototype.onDestroy(self)
 end
-function Effect.create(self, model, pos)
-    return self:of(addSpecialEffect(model, pos.x, pos.y))
+function Effect.prototype.setAnimation(self, animation)
+    setSpecialEffectAnimation(self.handle, animation)
 end
-function Effect.createTarget(self, model, target, attachPoint)
-    return self:of(addSpecialEffectTarget(model, target.handle, attachPoint))
+function Effect.prototype.queueAnimation(self, animation)
+    queueSpecialEffectAnimation(self.handle, animation)
+end
+function Effect.create(self, modelPath, xOrWidget, yOrAttachmentPoint, parameters)
+    local effect = self:of(addSpecialEffectInternal(modelPath, xOrWidget, yOrAttachmentPoint, parameters))
+    if parameters ~= nil then
+        effect[100] = parameters.color
+        effect[101] = parameters.pitch
+        effect[102] = parameters.roll
+    end
+    return effect
 end
 function Effect.flash(self, modelPath, xOrWidget, yOrOrAttachmentPoint, parametersOrDuration, parameters)
     if type(parametersOrDuration) ~= "number" then
         parameters = parametersOrDuration
         parametersOrDuration = nil
     end
-    local coordinatesProvided = type(xOrWidget) == "number"
-    local isPositional = coordinatesProvided or (parameters and parameters.detached) == true
-    local x = not isPositional and 0 or (coordinatesProvided and xOrWidget or xOrWidget.x)
-    local y = not isPositional and 0 or (coordinatesProvided and yOrOrAttachmentPoint or xOrWidget.y)
-    local effect = isPositional and addSpecialEffect(modelPath, x, y) or addSpecialEffectTarget(modelPath, xOrWidget.handle, yOrOrAttachmentPoint or "origin")
-    if isPositional and not coordinatesProvided and (parameters and parameters.scale) == nil and __TS__InstanceOf(xOrWidget, Unit) then
-        setSpecialEffectScale(effect, xOrWidget.scale)
-    end
-    if parameters ~= nil then
-        for key, value in ____pairs(parameters) do
-            if key ~= "zOffset" and key ~= "detached" and key ~= "scaleZOffset" then
-                setters[key](effect, value)
-            end
-        end
-        if isPositional and parameters.zOffset ~= nil then
-            moveLocation(location, x, y)
-            local z = __TS__InstanceOf(xOrWidget, Unit) and getLocationZ(location) + xOrWidget.flyHeight or getLocationZ(location)
-            BlzSetSpecialEffectZ(
-                effect,
-                z + parameters.zOffset * (parameters.scaleZOffset and getSpecialEffectScale(effect) or 1)
-            )
-        end
-    end
-    if parametersOrDuration ~= nil and parametersOrDuration > 0 then
-        temporaryEffectsCount = temporaryEffectsCount + 1
-        temporaryEffects[temporaryEffectsCount] = effect
-        temporaryEffectsDurations[temporaryEffectsCount] = parametersOrDuration
+    if parameters and (parameters.delay or 0) > 0 then
+        delayedEffectsCount = delayedEffectsCount + 1
+        delayedEffectsModelPath[delayedEffectsCount] = modelPath
+        delayedEffectsXOrWidget[delayedEffectsCount] = xOrWidget
+        delayedEffectsYOrAttachmentPoint[delayedEffectsCount] = yOrOrAttachmentPoint
+        delayedEffectsDuration[delayedEffectsCount] = parametersOrDuration
+        delayedEffectsParameters[delayedEffectsCount] = parameters
+        delayedEffectsDelay[delayedEffectsCount] = parameters.delay
         return
     end
-    destroyEffect(effect)
+    flash(
+        modelPath,
+        xOrWidget,
+        yOrOrAttachmentPoint,
+        parametersOrDuration,
+        parameters
+    )
 end
-function Effect.flashTarget(self, model, target, attachPoint, duration)
-    local effect = addSpecialEffectTarget(model, target.handle, attachPoint)
-    if effect ~= nil then
-        if duration and duration > 0 then
-            temporaryEffectsCount = temporaryEffectsCount + 1
-            temporaryEffects[temporaryEffectsCount] = effect
-            temporaryEffectsDurations[temporaryEffectsCount] = duration
-        else
-            destroyEffect(effect)
+__TS__SetDescriptor(
+    Effect.prototype,
+    "blendTime",
+    {
+        get = function(self)
+            return self[103] or 0
+        end,
+        set = function(self, blendTime)
+            setSpecialEffectAnimationBlendTime(self.handle, blendTime)
+            self[103] = blendTime
         end
-    end
-end
+    },
+    true
+)
+__TS__SetDescriptor(
+    Effect.prototype,
+    "timeScale",
+    {
+        get = function(self)
+            return self[104] or 1
+        end,
+        set = function(self, timeScale)
+            setSpecialEffectTimeScale(self.handle, timeScale)
+            self[104] = timeScale
+        end
+    },
+    true
+)
 __TS__SetDescriptor(
     Effect.prototype,
     "color",
     {
         get = function(self)
-            return self[100] or PlayerColor.black
+            return self[100] or PlayerColor.red
         end,
         set = function(self, color)
             setSpecialEffectColor(self.handle, color)
@@ -255,4 +231,41 @@ __TS__SetDescriptor(
     },
     true
 )
+addSpecialEffectInternal = function(modelPath, xOrWidget, yOrAttachmentPoint, parameters)
+    local coordinatesProvided = type(xOrWidget) == "number"
+    local isPositional = coordinatesProvided or (parameters and parameters.detached) == true
+    local x = not isPositional and 0 or (coordinatesProvided and xOrWidget or xOrWidget.x)
+    local y = not isPositional and 0 or (coordinatesProvided and yOrAttachmentPoint or xOrWidget.y)
+    local effect = isPositional and addSpecialEffect(modelPath, x, y) or addSpecialEffectTarget(modelPath, xOrWidget.handle, yOrAttachmentPoint or "origin")
+    if parameters ~= nil then
+        if isPositional and parameters.scale == nil and __TS__InstanceOf(xOrWidget, Unit) then
+            setSpecialEffectScale(effect, xOrWidget.scale)
+        end
+        for ____, property in ipairs(setterProperties) do
+            local value = parameters[property]
+            if value ~= nil then
+                setters[property](effect, value)
+            end
+        end
+        if isPositional and parameters.zOffset ~= nil then
+            moveLocation(location, x, y)
+            local z = __TS__InstanceOf(xOrWidget, Unit) and getLocationZ(location) + xOrWidget.flyHeight or getLocationZ(location)
+            setSpecialEffectZ(
+                effect,
+                z + parameters.zOffset * (parameters.scaleZOffset and getSpecialEffectScale(effect) or 1)
+            )
+        end
+    end
+    return effect
+end
+flash = function(modelPath, xOrWidget, yOrAttachmentPoint, duration, parameters)
+    local effect = addSpecialEffectInternal(modelPath, xOrWidget, yOrAttachmentPoint, parameters)
+    if duration ~= nil and duration > 0 then
+        temporaryEffectsCount = temporaryEffectsCount + 1
+        temporaryEffects[temporaryEffectsCount] = effect
+        temporaryEffectsDurations[temporaryEffectsCount] = duration
+        return
+    end
+    destroyEffect(effect)
+end
 return ____exports

package/core/types/frame.d.ts

@@ -80,6 +80,7 @@ export declare class Frame extends Handle<jframehandle> {
     get onMouseLeave(): FrameEvent;
     get onMouseUp(): FrameEvent;
     get onMouseWheel(): FrameEvent<[number]>;
+    private trackMouseLocally;
     get mouseEnterLocalEvent(): Event;
     get mouseLeaveLocalEvent(): Event;
     get popupMenuItemChangeEvent(): FrameEvent<[
@@ -136,8 +137,21 @@ export declare class Frame extends Handle<jframehandle> {
     static get onMouseUp(): Event<[Player, jmousebuttontype, number, number]>;
     private static onMouseDownEvent?;
     static get onMouseDown(): Event<[Player, jmousebuttontype, number, number]>;
-    static get onMouseMove(): Event<[player: Player, x: number, y: number]>;
-    static get onMouseMoveLocal(): Event<[x: number, y: number]>;
+    /**
+     * Synchronized native mouse movement of every player. Each movement of every player's
+     * cursor is sent over the network, so with several players moving their mice this floods
+     * the network and raises the latency for everyone. Prefer {@link mouseMoveLocalEvent} and
+     * synchronize the needed coordinates explicitly, only when they matter (e.g. on a click).
+     */
+    static get mouseMoveEvent(): Event<[player: Player, x: number, y: number]>;
+    /**
+     * Fires on the local client when the world point under the cursor changes, whether the
+     * cursor or the camera moved. Polls the local cursor position every 1/64 second and sends
+     * nothing over the network. The point is the camera ray's intersection with the terrain,
+     * so it ignores units and doodads under the cursor. It is also computed while the cursor
+     * is over the UI; check {@link isMouseOnWorld} where that matters.
+     */
+    static get mouseMoveLocalEvent(): Event<[x: number, y: number]>;
     static createSimple<T extends Frame>(this: FrameSubclass<T>, name: string, parent?: Frame, createContext?: number): T;
     static create<T extends Frame>(this: FrameSubclass<T>, name: string, parent: Frame, priority?: number, createContext?: number): T;
     static createByType<T extends Frame>(this: FrameSubclass<T>, typeName: "BACKDROP" | "BUTTON" | "CHATDISPLAY" | "CHECKBOX" | "CONTROL" | "DIALOG" | "EDITBOX" | "FRAME" | "GLUEBUTTON" | "GLUECHECKBOX" | "GLUETEXTBUTTON" | "HIGHLIGHT" | "LISTBOX" | "MENU" | "POPUPMENU" | "SCROLLBAR" | "SLIDER" | "TEXT" | "TEXTAREA" | "TEXTBUTTON", name: string, parent: Frame, inherits?: string, createContext?: number): T;