warscript 0.0.1-dev.e7b1f67 → 0.0.1-dev.ea10f2b

package/binaryreader.d.ts

@@ -3,6 +3,7 @@ export declare class BinaryReader {
     private readonly s;
     private i;
     constructor(data: string);
+    toString(): string;
     read(fmt: string): any;
     readBytes(size: number): string;
     readDouble(): number;

package/binaryreader.lua

@@ -9,6 +9,9 @@ function BinaryReader.prototype.____constructor(self, data)
     self.i = 1
     self.s = data
 end
+function BinaryReader.prototype.__tostring(self)
+    return self.s
+end
 function BinaryReader.prototype.read(self, fmt)
     local value, pos = ____unpack(">" .. fmt, self.s, self.i)
     self.i = pos

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

@@ -4,15 +4,23 @@ import { Widget } from "./widget";
 import { PlayerColor } from "./playerColor";
 declare const enum EffectPropertyKey {
     COLOR = 100,
-    PITCH = 101
+    PITCH = 101,
+    ROLL = 102
 }
 export type EffectParameters = {
+    readonly delay?: number;
     readonly scale?: number;
     readonly color?: PlayerColor;
+    readonly pitch?: number;
+    readonly roll?: number;
+    readonly detached?: boolean;
+    readonly zOffset?: number;
+    readonly scaleZOffset?: boolean;
 };
 export declare class Effect extends Handle<jeffect> {
     private [EffectPropertyKey.COLOR]?;
     private [EffectPropertyKey.PITCH]?;
+    private [EffectPropertyKey.ROLL]?;
     protected onDestroy(): HandleDestructor;
     get color(): PlayerColor;
     set color(color: PlayerColor);
@@ -20,11 +28,13 @@ export declare class Effect extends Handle<jeffect> {
     set scale(scale: number);
     get pitch(): number;
     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 flash(modelPath: string, ...args: [
-        ...pointOrWidget: [x: number, y: number] | [widget: Widget, attachmentPoint: string],
-        ...parametersOrDuration: [parameters?: EffectParameters] | [duration?: number, parameters?: EffectParameters]
+        ...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;
 }

package/core/types/effect.lua

@@ -2,8 +2,9 @@ local ____lualib = require("lualib_bundle")
 local __TS__Class = ____lualib.__TS__Class
 local __TS__ClassExtends = ____lualib.__TS__ClassExtends
 local __TS__SetDescriptor = ____lualib.__TS__SetDescriptor
+local __TS__InstanceOf = ____lualib.__TS__InstanceOf
 local ____exports = {}
-local dummyPlayer
+local dummyPlayer, flash
 local ____handle = require("core.types.handle")
 local Handle = ____handle.Handle
 local ____playerColor = require("core.types.playerColor")
@@ -12,6 +13,8 @@ local ____player = require("core.types.player")
 local Player = ____player.Player
 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
@@ -22,10 +25,28 @@ local getSpecialEffectScale = BlzGetSpecialEffectScale
 local playSpecialEffect = BlzPlaySpecialEffect
 local setSpecialEffectScale = BlzSetSpecialEffectScale
 local setSpecialEffectPitch = BlzSetSpecialEffectPitch
+local setSpecialEffectRoll = BlzSetSpecialEffectRoll
 local setSpecialEffectColorByPlayer = BlzSetSpecialEffectColorByPlayer
 local specialEffectAddSubAnimation = BlzSpecialEffectAddSubAnimation
 local specialEffectClearSubAnimations = BlzSpecialEffectClearSubAnimations
 local specialEffectRemoveSubAnimation = BlzSpecialEffectRemoveSubAnimation
+local setSpecialEffectZ = BlzSetSpecialEffectZ
+local getLocationZ = GetLocationZ
+local getUnitZ = BlzGetUnitZ
+local moveLocation = MoveLocation
+local location = Location(0, 0)
+local function setSpecialEffectPitchDegrees(effect, pitch)
+    setSpecialEffectPitch(
+        effect,
+        -mathRad(pitch)
+    )
+end
+local function setSpecialEffectRollDegrees(effect, roll)
+    setSpecialEffectRoll(
+        effect,
+        -mathRad(roll)
+    )
+end
 local animTypeByAnimationName = {
     attack = ANIM_TYPE_ATTACK,
     birth = ANIM_TYPE_BIRTH,
@@ -97,11 +118,18 @@ local function setSpecialEffectColor(effect, color)
     setSpecialEffectColorByPlayer(effect, dummyPlayer.handle)
     dummyPlayer.color = dummyColor
 end
-local setters = {scale = setSpecialEffectScale, color = setSpecialEffectColor}
+local setters = {scale = setSpecialEffectScale, color = setSpecialEffectColor, pitch = setSpecialEffectPitchDegrees, roll = setSpecialEffectRollDegrees}
 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
@@ -110,12 +138,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
@@ -136,19 +188,23 @@ function Effect.flash(self, modelPath, xOrWidget, yOrOrAttachmentPoint, paramete
         parameters = parametersOrDuration
         parametersOrDuration = nil
     end
-    local effect = type(xOrWidget) == "number" and addSpecialEffect(modelPath, xOrWidget, yOrOrAttachmentPoint) or addSpecialEffectTarget(modelPath, xOrWidget.handle, yOrOrAttachmentPoint)
-    if parameters ~= nil then
-        for key, value in ____pairs(parameters) do
-            setters[key](effect, value)
-        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)
@@ -197,13 +253,56 @@ __TS__SetDescriptor(
             return self[101] or 0
         end,
         set = function(self, pitch)
-            setSpecialEffectPitch(
-                self.handle,
-                -mathRad(pitch)
-            )
+            setSpecialEffectPitchDegrees(self.handle, pitch)
             self[101] = pitch
         end
     },
     true
 )
+__TS__SetDescriptor(
+    Effect.prototype,
+    "roll",
+    {
+        get = function(self)
+            return self[102] or 0
+        end,
+        set = function(self, roll)
+            setSpecialEffectRollDegrees(self.handle, roll)
+            self[102] = roll
+        end
+    },
+    true
+)
+flash = function(modelPath, xOrWidget, yOrOrAttachmentPoint, duration, 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 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" and key ~= "delay" 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 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

@@ -25,9 +25,14 @@ export declare class Frame extends Handle<jframehandle> {
     static readonly GAME_UI: Frame;
     static readonly CONSOLE_UI: Frame;
     static readonly CONSOLE_UI_BACKDROP: Frame;
+    private static readonly CONSOLE_UI_BACKDROP_UI_SCALE_HELPER_CHILD;
+    static readonly CONSOLE_TOP_BAR: Frame;
+    static readonly CONSOLE_BOTTOM_BAR: Frame;
     static readonly WORLD: Frame;
     static readonly CHAT: Frame;
     static readonly TIME_OF_DAY_CLOCK: Frame;
+    private static readonly SIMPLE_FRAME_TEST_CHILD;
+    static get uiScale(): number;
     static get leftBorder(): Frame;
     static get rightBorder(): Frame;
     static get minX(): number;
@@ -75,6 +80,8 @@ export declare class Frame extends Handle<jframehandle> {
     get onMouseLeave(): FrameEvent;
     get onMouseUp(): FrameEvent;
     get onMouseWheel(): FrameEvent<[number]>;
+    get mouseEnterLocalEvent(): Event;
+    get mouseLeaveLocalEvent(): Event;
     get popupMenuItemChangeEvent(): FrameEvent<[
         popupMenu: Frame,
         previousValue: number,
@@ -104,6 +111,7 @@ export declare class Frame extends Handle<jframehandle> {
     enable(): void;
     addText(text: string): void;
     clearAllPoints(): void;
+    get children(): Frame[];
     getChild(index: number): Frame;
     getChildrenCount(): number;
     setSize(width: number, height: number): void;

package/core/types/frame.lua

@@ -62,8 +62,10 @@ local function updateBorders()
     local width4by3 = (w - h / 600 * 800) / 2
     local pxtodpi = 0.6 / h
     BlzFrameSetAbsPoint(leftBorder, FRAMEPOINT_TOPLEFT, -width4by3 * pxtodpi, 0.6)
+    BlzFrameSetScale(leftBorder, 1)
     BlzFrameSetSize(leftBorder, 0.001, 0.6)
     BlzFrameSetAbsPoint(rightBorder, FRAMEPOINT_TOPRIGHT, (-width4by3 + w) * pxtodpi, 0.6)
+    BlzFrameSetScale(rightBorder, 1)
     BlzFrameSetSize(rightBorder, 0.001, 0.6)
 end
 local worldFrame = BlzGetOriginFrame(ORIGIN_FRAME_WORLD_FRAME, 0)
@@ -120,6 +122,7 @@ do
     FramePoint.BOTTOM = FRAMEPOINT_BOTTOM
     FramePoint.BOTTOM_RIGHT = FRAMEPOINT_BOTTOMRIGHT
 end
+local tooltipByFrame = setmetatable({}, {__mode = "k"})
 ____exports.Frame = __TS__Class()
 local Frame = ____exports.Frame
 Frame.name = "Frame"
@@ -240,6 +243,7 @@ function Frame.prototype.setTextColor(self, color)
 end
 function Frame.prototype.setTooltip(self, tooltip)
     BlzFrameSetTooltip(self.handle, tooltip.handle)
+    tooltipByFrame[self] = tooltip
 end
 function Frame.prototype.setMinMaxValue(self, minValue, maxValue)
     BlzFrameSetMinMaxValue(self.handle, minValue, maxValue)
@@ -267,7 +271,16 @@ function Frame.createSimple(self, name, parent, createContext)
     ))
 end
 function Frame.create(self, name, parent, priority, createContext)
-    return self:of(BlzCreateFrame(name, parent.handle, priority or 0, createContext or 0))
+    if parent == ____exports.Frame.CONSOLE_UI_BACKDROP then
+        local helper = ____exports.Frame.CONSOLE_UI_BACKDROP_UI_SCALE_HELPER_CHILD.handle
+        BlzFrameSetScale(helper, 1)
+        local frame = BlzCreateFrame(name, helper, priority or 0, createContext or 0)
+        BlzFrameSetScale(helper, ____exports.Frame.uiScale)
+        BlzFrameSetParent(frame, ____exports.Frame.CONSOLE_UI_BACKDROP.handle)
+        return self:of(frame)
+    else
+        return self:of(BlzCreateFrame(name, parent.handle, priority or 0, createContext or 0))
+    end
 end
 function Frame.createByType(self, typeName, name, parent, inherits, createContext)
     return self:of(BlzCreateFrameByType(
@@ -293,9 +306,20 @@ end
 Frame.GAME_UI = ____exports.Frame:byOrigin(ORIGIN_FRAME_GAME_UI)
 Frame.CONSOLE_UI = ____exports.Frame:byOrigin(ORIGIN_FRAME_SIMPLE_UI_PARENT)
 Frame.CONSOLE_UI_BACKDROP = ____exports.Frame:byName("ConsoleUIBackdrop")
+Frame.CONSOLE_UI_BACKDROP_UI_SCALE_HELPER_CHILD = ____exports.Frame:createByType("FRAME", "ConsoleUIBackdropUIScaleHelperChild", ____exports.Frame.CONSOLE_UI_BACKDROP)
+Frame.CONSOLE_TOP_BAR = ____exports.Frame:byName("ConsoleTopBar")
+Frame.CONSOLE_BOTTOM_BAR = ____exports.Frame:byName("ConsoleBottomBar")
 Frame.WORLD = ____exports.Frame:byOrigin(ORIGIN_FRAME_WORLD_FRAME)
 Frame.CHAT = ____exports.Frame:byOrigin(ORIGIN_FRAME_CHAT_MSG)
 Frame.TIME_OF_DAY_CLOCK = ____exports.Frame.GAME_UI:getChild(5):getChild(0)
+Frame.SIMPLE_FRAME_TEST_CHILD = ____exports.Frame:createByType("SIMPLEFRAME", "SimpleFrameTestParent", ____exports.Frame.CONSOLE_UI)
+__TS__ObjectDefineProperty(
+    Frame,
+    "uiScale",
+    {get = function(self)
+        return ____exports.Frame.CONSOLE_BOTTOM_BAR.width / 0.8
+    end}
+)
 __TS__ObjectDefineProperty(
     Frame,
     "leftBorder",
@@ -597,6 +621,62 @@ __TS__SetDescriptor(
     end},
     true
 )
+__TS__SetDescriptor(
+    Frame.prototype,
+    "mouseEnterLocalEvent",
+    {get = function(self)
+        local event = __TS__New(Event)
+        if not (tooltipByFrame[self] ~= nil) then
+            ____exports.Frame.SIMPLE_FRAME_TEST_CHILD.parent = self
+            local tooltip = ____exports.Frame.SIMPLE_FRAME_TEST_CHILD.parent == self and ____exports.Frame:createByType("SIMPLEFRAME", "", ____exports.Frame.CONSOLE_UI) or ____exports.Frame:createByType("FRAME", "", ____exports.Frame.GAME_UI)
+            ____exports.Frame.SIMPLE_FRAME_TEST_CHILD.parent = ____exports.Frame.CONSOLE_UI
+            self:setTooltip(tooltip)
+        end
+        local isMouseInside = false
+        Timer.onPeriod[1 / 64]:addListener(function()
+            local tooltip = tooltipByFrame[self]
+            if tooltip and tooltip.visible then
+                if not isMouseInside then
+                    isMouseInside = true
+                    Event.invoke(event)
+                end
+            else
+                isMouseInside = false
+            end
+        end)
+        rawset(self, "mouseEnterLocalEvent", event)
+        return event
+    end},
+    true
+)
+__TS__SetDescriptor(
+    Frame.prototype,
+    "mouseLeaveLocalEvent",
+    {get = function(self)
+        local event = __TS__New(Event)
+        if not (tooltipByFrame[self] ~= nil) then
+            ____exports.Frame.SIMPLE_FRAME_TEST_CHILD.parent = self
+            local tooltip = ____exports.Frame.SIMPLE_FRAME_TEST_CHILD.parent == self and ____exports.Frame:createByType("SIMPLEFRAME", "", ____exports.Frame.CONSOLE_UI) or ____exports.Frame:createByType("FRAME", "", ____exports.Frame.GAME_UI)
+            ____exports.Frame.SIMPLE_FRAME_TEST_CHILD.parent = ____exports.Frame.CONSOLE_UI
+            self:setTooltip(tooltip)
+        end
+        local isMouseInside = false
+        Timer.onPeriod[1 / 64]:addListener(function()
+            local tooltip = tooltipByFrame[self]
+            if tooltip and tooltip.visible then
+                isMouseInside = true
+            else
+                if isMouseInside then
+                    isMouseInside = false
+                    Event.invoke(event)
+                end
+            end
+        end)
+        rawset(self, "mouseLeaveLocalEvent", event)
+        return event
+    end},
+    true
+)
 __TS__SetDescriptor(
     Frame.prototype,
     "popupMenuItemChangeEvent",
@@ -699,6 +779,18 @@ __TS__SetDescriptor(
     end},
     true
 )
+__TS__SetDescriptor(
+    Frame.prototype,
+    "children",
+    {get = function(self)
+        local children = {}
+        for i = 0, self:getChildrenCount() - 1 do
+            children[i + 1] = self:getChild(i)
+        end
+        return children
+    end},
+    true
+)
 __TS__ObjectDefineProperty(
     Frame,
     "onKeyPress",

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;
 }