warscript 0.0.1-dev.09d09c4 → 0.0.1-dev.0aa6f08

package/core/types/frame.d.ts

@@ -137,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;

package/core/types/frame.lua

@@ -21,9 +21,6 @@ local FRAME_MIN_Y = ____frame_2Dcoordinates.FRAME_MIN_Y
 local getFrameMinXMaxX = ____frame_2Dcoordinates.getFrameMinXMaxX
 local ____playerCamera = require("core.types.playerCamera")
 local frameCoordinatesToWorld = ____playerCamera.frameCoordinatesToWorld
-local worldCoordinatesToFrame = ____playerCamera.worldCoordinatesToFrame
-local ____get_2Dterrain_2Dz = require("engine.internal.misc.get-terrain-z")
-local getTerrainZ = ____get_2Dterrain_2Dz.getTerrainZ
 local ____lua_2Dsets = require("utility.lua-sets")
 local mutableLuaSet = ____lua_2Dsets.mutableLuaSet
 local ____socket = require("net.socket")
@@ -39,8 +36,13 @@ local frameIsVisible = BlzFrameIsVisible
 local frameSetEnable = BlzFrameSetEnable
 local frameSetScale = BlzFrameSetScale
 local getHandleId = GetHandleId
+local getLocalClientHeight = BlzGetLocalClientHeight
+local getMouseScreenPosX = BlzGetMouseScreenPosX
+local getMouseScreenPosY = BlzGetMouseScreenPosY
 local getOriginFrame = BlzGetOriginFrame
 local location = Location
+local pixelToFrameX = BlzPixelToFrameX
+local pixelToFrameY = BlzPixelToFrameY
 local ____rawget = _G.rawget
 local rawset = _G.rawset
 local invoke = Event.invoke
@@ -988,7 +990,7 @@ __TS__ObjectDefineProperty(
 )
 __TS__ObjectDefineProperty(
     Frame,
-    "onMouseMove",
+    "mouseMoveEvent",
     {get = function(self)
         local event = __TS__New(
             TriggerEvent,
@@ -1002,48 +1004,32 @@ __TS__ObjectDefineProperty(
             ) end,
             function() return Player:of(GetTriggerPlayer()), BlzGetTriggerPlayerMouseX(), BlzGetTriggerPlayerMouseY() end
         )
-        rawset(____exports.Frame, "onMouseMove", event)
+        rawset(____exports.Frame, "mouseMoveEvent", event)
         return event
     end}
 )
 __TS__ObjectDefineProperty(
     Frame,
-    "onMouseMoveLocal",
+    "mouseMoveLocalEvent",
     {get = function(self)
-        local invoke = Event.invoke
         local event = __TS__New(Event)
-        local syncX = 0
-        local syncY = 0
-        local syncFrameX = 0
-        local syncFrameY = 0
-        local lastX = syncX
-        local lastY = syncY
-        self.onMouseMove:addListener(function(player, x, y)
-            if player.isLocal then
-                syncX = x
-                syncY = y
-                syncFrameX, syncFrameY = worldCoordinatesToFrame(
-                    x,
-                    y,
-                    getTerrainZ(x, y)
-                )
-                lastX = x
-                lastY = y
-                invoke(event, x, y)
-            end
-        end)
+        local lastX = 0
+        local lastY = 0
         Timer.onPeriod[1 / 64]:addListener(function()
-            if syncX == 0 and syncY == 0 then
+            if getLocalClientHeight() == 0 then
                 return
             end
-            local x, y, ____, isDefinite = frameCoordinatesToWorld(syncFrameX, syncFrameY)
+            local x, y, ____, isDefinite = frameCoordinatesToWorld(
+                pixelToFrameX(getMouseScreenPosX()),
+                pixelToFrameY(getMouseScreenPosY())
+            )
             if isDefinite and (x ~= lastX or y ~= lastY) then
                 lastX = x
                 lastY = y
                 invoke(event, x, y)
             end
         end)
-        rawset(____exports.Frame, "onMouseMoveLocal", event)
+        rawset(____exports.Frame, "mouseMoveLocalEvent", event)
         return event
     end}
 )

package/core/types/tileCell.d.ts

@@ -1,11 +1,14 @@
 /** @noSelfInFile */
 import { AttributesHolder } from "../../attributes";
 export declare class TileCell extends AttributesHolder implements Readonly<Vec2> {
-    private readonly id;
+    /** Identifies the cell the same way on every client; see {@link TileCell.getById}. */
+    readonly id: number;
     readonly x: number;
     readonly y: number;
     readonly z: undefined;
-    protected constructor(id: number, x: number, y: number, z: undefined);
+    protected constructor(
+    /** Identifies the cell the same way on every client; see {@link TileCell.getById}. */
+    id: number, x: number, y: number, z: undefined);
     get up(): TileCell;
     get down(): TileCell;
     get left(): TileCell;
@@ -20,4 +23,6 @@ export declare class TileCell extends AttributesHolder implements Readonly<Vec2>
     static getInRect(minX: number, minY: number, maxX: number, maxY: number): TileCell[];
     static getInRange(x: number, y: number, range: number): TileCell[];
     static of(this: void, x: number, y: number): TileCell;
+    /** The cell with the given {@link id}, e.g. one received over the network. */
+    static getById(this: void, id: number): TileCell;
 }

package/core/types/tileCell.lua

@@ -118,6 +118,17 @@ function TileCell.of(x, y)
         nil
     )
 end
+function TileCell.getById(id)
+    local yId = (id + 16384) // 32768
+    local xId = id - yId * 32768
+    return tileCellById[id] or __TS__New(
+        ____exports.TileCell,
+        id,
+        xId * 128,
+        yId * 128,
+        nil
+    )
+end
 __TS__SetDescriptor(
     TileCell.prototype,
     "up",

package/engine/object-data/entry/ability-type/blank-passive.d.ts

@@ -1,6 +1,10 @@
 /** @noSelfInFile */
 import { DiseaseCloudAbilityType } from "./disease-cloud";
+import { CombatClassifications } from "../../auxiliary/combat-classification";
+import { ObjectDataEntryLevelFieldValueSupplier } from "../../entry";
 export declare class BlankPassiveAbilityType extends DiseaseCloudAbilityType {
     static readonly IS_SYNTHETIC = true;
     constructor(object: WarObject);
+    get allowedTargetCombatClassifications(): CombatClassifications[];
+    set allowedTargetCombatClassifications(allowedTargetCombatClassifications: ObjectDataEntryLevelFieldValueSupplier<CombatClassifications>);
 }

package/engine/object-data/entry/ability-type/blank-passive.lua

@@ -1,11 +1,18 @@
 local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
 local __TS__ClassExtends = ____lualib.__TS__ClassExtends
+local __TS__SetDescriptor = ____lualib.__TS__SetDescriptor
 local ____exports = {}
 local ____disease_2Dcloud = require("engine.object-data.entry.ability-type.disease-cloud")
 local DiseaseCloudAbilityType = ____disease_2Dcloud.DiseaseCloudAbilityType
 local ____combat_2Dclassification = require("engine.object-data.auxiliary.combat-classification")
 local combatClassificationsOf = ____combat_2Dclassification.combatClassificationsOf
+local combatClassificationsToStringArray = ____combat_2Dclassification.combatClassificationsToStringArray
+local ____ability = require("engine.standard.fields.ability")
+local ALLOWED_TARGETS_ABILITY_COMBAT_CLASSIFICATIONS_LEVEL_FIELD = ____ability.ALLOWED_TARGETS_ABILITY_COMBAT_CLASSIFICATIONS_LEVEL_FIELD
+local function noneCombatClassificationStrings()
+    return combatClassificationsToStringArray(combatClassificationsOf(1))
+end
 ____exports.BlankPassiveAbilityType = __TS__Class()
 local BlankPassiveAbilityType = ____exports.BlankPassiveAbilityType
 BlankPassiveAbilityType.name = "BlankPassiveAbilityType"
@@ -15,14 +22,27 @@ function BlankPassiveAbilityType.prototype.____constructor(self, object)
     self.levelCount = 1
     self.iconPath = ""
     self.targetEffectPresets = {}
-    self.diseaseDuration = 0
-    self.damagePerSecond = 0
-    self.plagueWardDuration = 0
-    self.plagueWardUnitTypeId = 0
-    self.allowedTargetCombatClassifications = combatClassificationsOf(1)
-    self.areaOfEffect = 0
-    self.buffTypeIds = {}
+    self.diseaseDuration = function() return 0 end
+    self.damagePerSecond = function() return 0 end
+    self.plagueWardDuration = function() return 0 end
+    self.plagueWardUnitTypeId = function() return 0 end
+    self:setStringsLevelField("atar", noneCombatClassificationStrings)
+    self.areaOfEffect = function() return 0 end
+    self.buffTypeIds = function() return {} end
     self.techTreeDependencies = {}
 end
 BlankPassiveAbilityType.IS_SYNTHETIC = true
+__TS__SetDescriptor(
+    BlankPassiveAbilityType.prototype,
+    "allowedTargetCombatClassifications",
+    {
+        get = function(self)
+            return ALLOWED_TARGETS_ABILITY_COMBAT_CLASSIFICATIONS_LEVEL_FIELD:getValue(self)
+        end,
+        set = function(self, allowedTargetCombatClassifications)
+            ALLOWED_TARGETS_ABILITY_COMBAT_CLASSIFICATIONS_LEVEL_FIELD:setValue(self, allowedTargetCombatClassifications)
+        end
+    },
+    true
+)
 return ____exports

package/package.json

@@ -1,7 +1,7 @@
 {
     "$schema": "https://json.schemastore.org/package",
     "name": "warscript",
-    "version": "0.0.1-dev.09d09c4",
+    "version": "0.0.1-dev.0aa6f08",
     "description": "A typescript library for Warcraft III using Warpack.",
     "keywords": [
         "warcraft",

package/utility/arrays.d.ts

@@ -1,6 +1,11 @@
 /** @noSelfInFile */
-import { TupleOf } from "./types";
+import { NonEmptyArray, ReadonlyNonEmptyArray, TupleOf } from "./types";
 export declare const emptyArray: <T>() => readonly T[];
+/** Checks for any element with `next` instead of computing the length. */
+export declare const isNonEmptyArray: {
+    <T>(array: T[]): array is NonEmptyArray<T>;
+    <T>(array: readonly T[]): array is ReadonlyNonEmptyArray<T>;
+};
 export declare const joinToString: <T>(array: readonly T[], separator: string, transform?: (element: T) => string) => string;
 export declare const arrayOfNotNull: <T>(...elements: readonly (T | undefined | null)[]) => T[];
 export declare const array: <T, N extends number>(length: N, initialize: (index: number) => T) => TupleOf<T, N>;

package/utility/arrays.lua

@@ -7,6 +7,7 @@ local ____functions = require("utility.functions")
 local identity = ____functions.identity
 local mathMax = math.max
 local mathMin = math.min
+local next = _G.next
 local select = _G.select
 local tableConcat = table.concat
 local tableSort = table.sort
@@ -14,6 +15,10 @@ local EMPTY_ARRAY = {}
 ____exports.emptyArray = function()
     return EMPTY_ARRAY
 end
+--- Checks for any element with `next` instead of computing the length.
+____exports.isNonEmptyArray = function(array)
+    return (next(array)) ~= nil
+end
 ____exports.joinToString = function(array, separator, transform)
     if transform == nil then
         transform = tostring