warscript 0.0.1-dev.d18f377 → 0.0.1-dev.d1b563b

package/attributes.d.ts

@@ -1,8 +1,12 @@
 /** @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>;
 }
@@ -10,3 +14,4 @@ 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">;
 }
+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()

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/types/effect.d.ts

@@ -8,6 +8,7 @@ declare const enum EffectPropertyKey {
     ROLL = 102
 }
 export type EffectParameters = {
+    readonly delay?: number;
     readonly scale?: number;
     readonly color?: PlayerColor;
     readonly pitch?: number;
@@ -29,12 +30,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")
@@ -119,10 +119,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 +139,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 +178,44 @@ 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))
-end
-function Effect.createTarget(self, model, target, attachPoint)
-    return self:of(addSpecialEffectTarget(model, target.handle, attachPoint))
+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)
-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)
-        end
-    end
+    flash(
+        modelPath,
+        xOrWidget,
+        yOrOrAttachmentPoint,
+        parametersOrDuration,
+        parameters
+    )
 end
 __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 +265,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.lua

@@ -15,13 +15,20 @@ local Event = ____event.Event
 local TriggerEvent = ____event.TriggerEvent
 local ____timer = require("core.types.timer")
 local Timer = ____timer.Timer
+local ____frame_2Dcoordinates = require("engine.internal.misc.frame-coordinates")
+local FRAME_MAX_Y = ____frame_2Dcoordinates.FRAME_MAX_Y
+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 frameClick = BlzFrameClick
 local frameGetEnable = BlzFrameGetEnable
 local frameIsVisible = BlzFrameIsVisible
 local frameSetEnable = BlzFrameSetEnable
 local frameSetScale = BlzFrameSetScale
-local getCameraTargetPositionX = GetCameraTargetPositionX
-local getCameraTargetPositionY = GetCameraTargetPositionY
 local ____rawget = _G.rawget
 local rawset = _G.rawset
 local invoke = Event.invoke
@@ -344,27 +351,21 @@ __TS__ObjectDefineProperty(
     Frame,
     "minX",
     {get = function(self)
-        local w = BlzGetLocalClientWidth()
-        local h = BlzGetLocalClientHeight()
-        local width4by3 = (w - h / 600 * 800) / 2
-        local pxtodpi = 0.6 / h
-        return -width4by3 * pxtodpi
+        local minX = getFrameMinXMaxX()
+        return minX
     end}
 )
 __TS__ObjectDefineProperty(
     Frame,
     "maxX",
     {get = function(self)
-        local w = BlzGetLocalClientWidth()
-        local h = BlzGetLocalClientHeight()
-        local width4by3 = (w - h / 600 * 800) / 2
-        local pxtodpi = 0.6 / h
-        return (-width4by3 + w) * pxtodpi
+        local ____, maxX = getFrameMinXMaxX()
+        return maxX
     end}
 )
 Frame.centerX = 0.4
-Frame.minY = 0
-Frame.maxY = 0.6
+Frame.minY = FRAME_MIN_Y
+Frame.maxY = FRAME_MAX_Y
 Frame.centerY = 0.3
 __TS__SetDescriptor(
     Frame.prototype,
@@ -938,16 +939,19 @@ __TS__ObjectDefineProperty(
         local event = __TS__New(Event)
         local syncX = 0
         local syncY = 0
-        local syncCamX = getCameraTargetPositionX()
-        local syncCamY = getCameraTargetPositionY()
+        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
-                syncCamX = getCameraTargetPositionX()
-                syncCamY = getCameraTargetPositionY()
+                syncFrameX, syncFrameY = worldCoordinatesToFrame(
+                    x,
+                    y,
+                    getTerrainZ(x, y)
+                )
                 lastX = x
                 lastY = y
                 invoke(event, x, y)
@@ -957,9 +961,8 @@ __TS__ObjectDefineProperty(
             if syncX == 0 and syncY == 0 then
                 return
             end
-            local x = syncX + (getCameraTargetPositionX() - syncCamX)
-            local y = syncY + (getCameraTargetPositionY() - syncCamY)
-            if x ~= lastX or y ~= lastY then
+            local x, y, ____, isDefinite = frameCoordinatesToWorld(syncFrameX, syncFrameY)
+            if isDefinite and (x ~= lastX or y ~= lastY) then
                 lastX = x
                 lastY = y
                 invoke(event, x, y)

package/core/types/player.lua

@@ -21,6 +21,8 @@ local ____exception = require("exception")
 local IllegalStateException = ____exception.IllegalStateException
 local ____math = require("math")
 local MAXIMUM_INTEGER = ____math.MAXIMUM_INTEGER
+local ____player_2Dlocal_2Dhandle = require("engine.internal.misc.player-local-handle")
+local PLAYER_LOCAL_HANDLE = ____player_2Dlocal_2Dhandle.PLAYER_LOCAL_HANDLE
 local getPlayerColor = GetPlayerColor
 local getPlayerName = GetPlayerName
 local getPlayerTechCount = GetPlayerTechCount
@@ -249,7 +251,7 @@ Player.all = (function()
     end
     return all
 end)()
-Player["local"] = ____exports.Player:of(GetLocalPlayer())
+Player["local"] = ____exports.Player:of(PLAYER_LOCAL_HANDLE)
 Player.neutralPassive = ____exports.Player.all[PLAYER_NEUTRAL_PASSIVE + 1]
 Player.neutralAggressive = ____exports.Player.all[PLAYER_NEUTRAL_AGGRESSIVE + 1]
 Player.neutralVictim = ____exports.Player.all[bj_PLAYER_NEUTRAL_VICTIM + 1]

package/core/types/playerCamera.d.ts

@@ -1,4 +1,5 @@
 /** @noSelfInFile */
+import type { Unit } from "../../engine/internal/unit";
 export declare class PlayerCamera {
     private readonly player;
     private readonly isLocal;
@@ -28,5 +29,6 @@ export declare class PlayerCamera {
     get roll(): number;
     set roll(v: number);
     reset(): void;
+    static isUnitInView(unit: Unit): boolean;
     static of(player: jplayer): PlayerCamera;
 }

package/core/types/playerCamera.lua

@@ -3,33 +3,52 @@ local __TS__Class = ____lualib.__TS__Class
 local __TS__New = ____lualib.__TS__New
 local __TS__SetDescriptor = ____lualib.__TS__SetDescriptor
 local ____exports = {}
+local ____timer = require("core.types.timer")
+local Timer = ____timer.Timer
+local ____player_2Dlocal_2Dhandle = require("engine.internal.misc.player-local-handle")
+local PLAYER_LOCAL_HANDLE = ____player_2Dlocal_2Dhandle.PLAYER_LOCAL_HANDLE
+local ____preconditions = require("utility.preconditions")
+local check = ____preconditions.check
+local ____frame_2Dcoordinates = require("engine.internal.misc.frame-coordinates")
+local FRAME_MAX_Y = ____frame_2Dcoordinates.FRAME_MAX_Y
+local FRAME_MIN_Y = ____frame_2Dcoordinates.FRAME_MIN_Y
+local getFrameMinXMaxX = ____frame_2Dcoordinates.getFrameMinXMaxX
+local ____get_2Dterrain_2Dz = require("engine.internal.misc.get-terrain-z")
+local getTerrainZ = ____get_2Dterrain_2Dz.getTerrainZ
 local getHandleId = GetHandleId
 local setCameraField = SetCameraField
 local getCameraField = GetCameraField
 local setCameraPosition = SetCameraPosition
+local getCameraEyePositionX = GetCameraEyePositionX
+local getCameraEyePositionY = GetCameraEyePositionY
+local getCameraEyePositionZ = GetCameraEyePositionZ
 local getCameraTargetPositionX = GetCameraTargetPositionX
 local getCameraTargetPositionY = GetCameraTargetPositionY
 local resetToGameCamera = ResetToGameCamera
+local cos = math.cos
 local deg = math.deg
-local localPlayer = GetLocalPlayer()
+local sin = math.sin
+local sqrt = math.sqrt
 local memoized = {}
 ____exports.PlayerCamera = __TS__Class()
 local PlayerCamera = ____exports.PlayerCamera
 PlayerCamera.name = "PlayerCamera"
 function PlayerCamera.prototype.____constructor(self, player)
     local id = getHandleId(player)
-    if memoized[id] then
-        error("Double-constructor run player camera!")
-    end
+    check(memoized[id] == nil)
     memoized[id] = self
     self.player = player
-    self.isLocal = player == localPlayer
+    self.isLocal = player == PLAYER_LOCAL_HANDLE
 end
 function PlayerCamera.prototype.reset(self)
     if self.isLocal then
         resetToGameCamera(0)
     end
 end
+function PlayerCamera.isUnitInView(self, unit)
+    local ____, ____, isInView = ____exports.worldCoordinatesToFrame(unit.x, unit.y, unit.z)
+    return isInView
+end
 function PlayerCamera.of(self, player)
     return memoized[getHandleId(player)] or __TS__New(____exports.PlayerCamera, player)
 end
@@ -159,4 +178,103 @@ __TS__SetDescriptor(
     },
     true
 )
+local cameraEyeX = 0
+local cameraEyeY = 0
+local cameraEyeZ = 0
+local cameraAngleOfAttack = 0
+local cameraAngleOfAttackCos = 0
+local cameraAngleOfAttackSin = 0
+local cameraRotation = 0
+local cameraRotationCos = 0
+local cameraRotationSin = 0
+local cameraAngleOfAttackCosRotationCos = 0
+local cameraAngleOfAttackCosRotationSin = 0
+local cameraAngleOfAttackSinRotationCos = 0
+local cameraAngleOfAttackSinRotationSin = 0
+local yCenterScreenShift = 0
+local scaleFactor = 0
+local frameMinX = 0
+local frameMaxX = 0
+local isCameraViewPrecalculated = false
+local function precalculateCameraView()
+    cameraEyeX = getCameraEyePositionX()
+    cameraEyeY = getCameraEyePositionY()
+    cameraEyeZ = getCameraEyePositionZ()
+    cameraAngleOfAttack = getCameraField(CAMERA_FIELD_ANGLE_OF_ATTACK)
+    cameraAngleOfAttackCos = cos(cameraAngleOfAttack)
+    cameraAngleOfAttackSin = sin(cameraAngleOfAttack)
+    cameraRotation = getCameraField(CAMERA_FIELD_ROTATION)
+    cameraRotationCos = cos(cameraRotation)
+    cameraRotationSin = sin(cameraRotation)
+    cameraAngleOfAttackCosRotationCos = cameraAngleOfAttackCos * cameraRotationCos
+    cameraAngleOfAttackCosRotationSin = cameraAngleOfAttackCos * cameraRotationSin
+    cameraAngleOfAttackSinRotationCos = cameraAngleOfAttackSin * cameraRotationCos
+    cameraAngleOfAttackSinRotationSin = cameraAngleOfAttackSin * cameraRotationSin
+    yCenterScreenShift = 0.1284 * cameraAngleOfAttackCos
+    local cameraFieldOfView = getCameraField(CAMERA_FIELD_FIELD_OF_VIEW)
+    scaleFactor = 0.0524 * cameraFieldOfView ^ 3 - 0.0283 * cameraFieldOfView ^ 2 + 1.061 * cameraFieldOfView
+    frameMinX, frameMaxX = getFrameMinXMaxX()
+    isCameraViewPrecalculated = true
+end
+Timer.onPeriod[1 / 64]:addListener(
+    4,
+    function()
+        isCameraViewPrecalculated = false
+    end
+)
+---
+-- @internal For use by internal systems only.
+____exports.worldCoordinatesToFrame = function(x, y, z)
+    if not isCameraViewPrecalculated then
+        precalculateCameraView()
+    end
+    local dx = x - cameraEyeX
+    local dy = y - cameraEyeY
+    local dz = z - cameraEyeZ
+    local xPrime = scaleFactor * (-cameraAngleOfAttackCosRotationCos * dx - cameraAngleOfAttackCosRotationSin * dy - cameraAngleOfAttackSin * dz)
+    local frameX = 0.4 + (cameraRotationCos * dy - cameraRotationSin * dx) / xPrime
+    local frameY = 0.42625 - yCenterScreenShift + (cameraAngleOfAttackSinRotationCos * dx + cameraAngleOfAttackSinRotationSin * dy - cameraAngleOfAttackCos * dz) / xPrime
+    return frameX, frameY, xPrime < 0 and frameX >= frameMinX and frameX <= frameMaxX and frameY >= FRAME_MIN_Y and frameY <= FRAME_MAX_Y
+end
+---
+-- @internal For use by internal systems only.
+____exports.frameCoordinatesToWorld = function(x, y)
+    if not isCameraViewPrecalculated then
+        precalculateCameraView()
+    end
+    local a = (x - 0.4) * scaleFactor
+    local b = (0.42625 - yCenterScreenShift - y) * scaleFactor
+    local nx = 1 / sqrt(1 + a * a + b * b)
+    local ny = sqrt(1 - (1 + b * b) * nx * nx)
+    local nz = sqrt(1 - nx * nx - ny * ny)
+    if a > 0 then
+        ny = -ny
+    end
+    if b < 0 then
+        nz = -nz
+    end
+    local nxPrime = cameraAngleOfAttackCosRotationCos * nx - cameraRotationSin * ny + cameraAngleOfAttackSinRotationCos * nz
+    local nyPrime = cameraAngleOfAttackCosRotationSin * nx + cameraRotationCos * ny + cameraAngleOfAttackSinRotationSin * nz
+    local nzPrime = -cameraAngleOfAttackSin * nx + cameraAngleOfAttackCos * nz
+    local zGuess = getTerrainZ(cameraEyeX, cameraEyeY)
+    local xGuess = cameraEyeX + nxPrime * (cameraEyeZ - zGuess) / nzPrime
+    local yGuess = cameraEyeY + nyPrime * (cameraEyeZ - zGuess) / nzPrime
+    local zWorld = getTerrainZ(xGuess, yGuess)
+    local deltaZ = zWorld - zGuess
+    zGuess = zWorld
+    local zWorldOld = zWorld
+    local deltaZOld = deltaZ
+    local i = 0
+    while (deltaZ > 1 or deltaZ < -1) and i < 50 do
+        xGuess = cameraEyeX + nxPrime * (cameraEyeZ - zGuess) / nzPrime
+        yGuess = cameraEyeY + nyPrime * (cameraEyeZ - zGuess) / nzPrime
+        zWorld = getTerrainZ(xGuess, yGuess)
+        deltaZ = zWorld - zGuess
+        zGuess = (deltaZOld * zWorld - deltaZ * zWorldOld) / (deltaZOld - deltaZ)
+        zWorldOld = zWorld
+        deltaZOld = deltaZ
+        i = i + 1
+    end
+    return xGuess, yGuess, zWorld, i < 50
+end
 return ____exports

package/core/types/sound.d.ts

@@ -1,6 +1,7 @@
 /** @noSelfInFile */
 import { Handle, HandleDestructor } from "./handle";
 import { Unit } from "./unit";
+import { SoundEax } from "../../engine/object-data/auxiliary/sound-eax";
 export declare enum SoundChannel {
     General = 0,
     UnitSelection = 1,
@@ -18,16 +19,7 @@ export declare enum SoundChannel {
     Birth = 13,
     Fire = 14
 }
-export declare enum SoundEax {
-    Default = "DefaultEAXON",
-    Acknowledgements = "HeroAcksEAX",
-    Environment = "DoodadsEAX",
-    Drums = "KotoDrumsEAX",
-    Attacks = "CombatSoundsEAX",
-    Abilities = "SpellsEAX",
-    Missiles = "MissilesEAX"
-}
-export type SoundPreset = Readonly<{
+export type SoundSettings = Readonly<{
     channel?: SoundChannel;
     eax?: SoundEax;
     fadeInRate?: number;
@@ -36,19 +28,19 @@ export type SoundPreset = Readonly<{
     volume?: number;
     pitch?: number;
 }>;
-export type Sound3DPreset = SoundPreset & Readonly<{
+export type Sound3DSettings = SoundSettings & Readonly<{
     stopWhenOutOfRange?: boolean;
     minDistance?: number;
     maxDistance?: number;
     distanceCutoff?: number;
 }>;
-export declare namespace SoundPreset {
-    const UI: SoundPreset;
-    const Music: SoundPreset;
-    const Attack: Sound3DPreset;
-    const Ability: Sound3DPreset;
-    const AbilityLooping: Sound3DPreset;
-    const Missile: Sound3DPreset;
+export declare namespace SoundSettings {
+    const UI: SoundSettings;
+    const Music: SoundSettings;
+    const Attack: Sound3DSettings;
+    const Ability: Sound3DSettings;
+    const AbilityLooping: Sound3DSettings;
+    const Missile: Sound3DSettings;
 }
 export declare class Sound extends Handle<jsound, [fadeOut?: boolean]> {
     private _volume?;
@@ -58,12 +50,13 @@ export declare class Sound extends Handle<jsound, [fadeOut?: boolean]> {
     start(milliseconds?: number): void;
     stop(fadeOut?: boolean): void;
     restart(milliseconds?: number): void;
-    static play(fileName: string, preset: SoundPreset): void;
-    static create(fileName: string, preset: SoundPreset): Sound;
+    static play(fileName: string, preset: SoundSettings): void;
+    static create(fileName: string, preset: SoundSettings): Sound;
 }
 export declare class Sound3D extends Sound {
-    static playAtPosition(fileName: string, preset: Sound3DPreset, x?: number, y?: number, z?: number): void;
-    static playOnUnit(fileName: string, preset: Sound3DPreset, unit: Unit): void;
-    static createAtPosition(fileName: string, preset: Sound3DPreset, x?: number, y?: number, z?: number): Sound3D;
-    static createOnUnit(fileName: string, preset: Sound3DPreset, unit: Unit): Sound3D;
+    static playAtPosition(fileName: string, preset: Sound3DSettings, x?: number, y?: number, z?: number): void;
+    static playOnUnit(fileName: string, preset: Sound3DSettings, unit: Unit): void;
+    static playFromLabel(label: string, preset: Sound3DSettings, ...positionOrUnit: [Unit] | [number, number, number?]): void;
+    static createAtPosition(fileName: string, preset: Sound3DSettings, x?: number, y?: number, z?: number): Sound3D;
+    static createOnUnit(fileName: string, preset: Sound3DSettings, unit: Unit): Sound3D;
 }