warcraft-3-w3ts-utils 0.1.13 → 0.1.15

package/src/utils/physics.ts

@@ -1,295 +0,0 @@
-// import { WTS_Units } from "src/enums/WTS_Enums";
-// import { PlayerIndex } from "src/player/player-data";
-import { Effect, Timer, Unit } from "w3ts";
-import { OrderId, Players } from "w3ts/globals";
-
-interface ApplyForceConfig {
-  /**
-   * Default: 0
-   */
-  sustainedForceDuration?: number;
-  /**
-   * Default: -2400 units per second
-   */
-  frictionConstant?: number;
-  /**
-   * The unit will not phase through unpathable areas
-   */
-  obeyPathing?: boolean;
-  whileActive?: (currentSpeed?: number, timeElapsed?: number) => void;
-  onStart?: (currentSpeed?: number, timeElapsed?: number) => void;
-  onEnd?: (currentSpeed?: number, timeElapsed?: number) => void;
-  /**
-   *
-   */
-  targetSpeed?: number;
-  /**
-   * In seconds
-   */
-  accelerationTime?: number;
-  /**
-   * This will be used to decide if the unit the force is applied on is allowed to deviate from their current path.
-   */
-  strictPathing?: boolean;
-  animationIndexNumber?: number;
-  dummyUnitPlayerIndex: number;
-  dummyUnitFourCC: number;
-}
-
-/**
- * @param angle degrees
- * @param unit
- * @param initialSpeed meters per second
- * @param affectHeight determines whether or not to change unit height whilst force is applied
- */
-export function applyForce(
-  angle: number,
-  unit: Unit,
-  initialSpeed: number,
-  config: ApplyForceConfig
-) {
-  const timer = Timer.create();
-  const refreshInterval = 0.01;
-  const updatesPerSecond = 1 / refreshInterval;
-  const frictionConstant = 4800; //meters per second friction decay
-  let currentSpeed = initialSpeed;
-  let timeElapsed = 0;
-
-  const clickMoveOrder = 851971;
-  const moveOrders = [
-    OrderId.Move,
-    OrderId.Attackground,
-    OrderId.Patrol,
-    OrderId.Attack,
-    clickMoveOrder,
-  ];
-
-  let forceDummyUnit: Unit | undefined = undefined;
-  const defaultX = 11800;
-  const defaultY = -5700;
-
-  //Cancel unit commands - if a unit already has a move command and are applied a force, they will bug out sometimes and walk in the opposite direction
-  // unit.issueImmediateOrder(OrderId.Stop);
-
-  /**
-   * Prematurely end the force effect
-   */
-  function destroyForceEffect(runOnEnd: boolean = false) {
-    if (runOnEnd && config?.onEnd) {
-      config.onEnd();
-    }
-
-    ResetUnitAnimation(unit.handle);
-    forceDummyUnit?.destroy();
-    timer.destroy();
-  }
-
-  /**
-   * These are the positions the unit would be if there were no minor disturbances
-   */
-  let theoreticalX = unit.x;
-  let theoreticalY = unit.y;
-
-  /**
-   * The distance the true unit position can be from the theoretical position. Helps stop sliding against walls, etc.
-   */
-  // const BREAK_DISTANCE = 100;
-
-  if (!forceDummyUnit) {
-    forceDummyUnit = Unit.create(
-      Players[config.dummyUnitPlayerIndex],
-      config.dummyUnitPlayerIndex,
-      defaultX,
-      defaultY
-    );
-  }
-
-  // unit.issueImmediateOrder(OrderId.Stop);
-
-  if (config?.animationIndexNumber) {
-    ResetUnitAnimation(unit.handle);
-    SetUnitAnimationByIndex(unit.handle, config.animationIndexNumber);
-  }
-
-  timer.start(refreshInterval, true, () => {
-    //If for whatever reason the unit no longer exists.
-    if (!unit) {
-      destroyForceEffect();
-      return destroyForceEffect;
-    }
-
-    // if (distanceBetweenPoints(unit.x, unit.y, theoreticalX, theoreticalY) > BREAK_DISTANCE) {
-    //     print("unit was to far away from theoretical distance");
-    //     const e = Effect.create("Abilities\\Spells\\Other\\TalkToMe\\TalkToMe", theoreticalX, theoreticalY);
-    //     e?.setScaleMatrix(2, 2, 2);
-    //     unit.issueImmediateOrder(OrderId.Stop);
-
-    //     destroyForceEffect(true);
-    //     return;
-    // }
-
-    //if the unit's move speed vector is greater than the remaining applied force vector then we may stop the applied force function; should only run while the unit has the move order
-    // if (config?.obeyPathing && !config.strictPathing && currentSpeed > unit.moveSpeed) {
-    //     unit.issueImmediateOrder(OrderId.Stop);
-    // }
-
-    //should probably only do strict pathing so nothing else interfers with the unit moving
-    if (forceDummyUnit && config?.strictPathing) {
-      const isWindWalked = UnitHasBuffBJ(forceDummyUnit.handle, FourCC("BOwk"));
-
-      if (!isWindWalked) {
-        forceDummyUnit.issueImmediateOrder(OrderId.Windwalk);
-      }
-      // forceDummyUnit.issueImmediateOrder(OrderId.Stop);
-
-      //Move dummy to the position we want the unit to be in
-      forceDummyUnit.x = unit.x;
-      forceDummyUnit.y = unit.y;
-
-      forceDummyUnit.issueImmediateOrder(OrderId.Stop);
-
-      //flooring values since it can be off sometimes by a thousandth
-      if (
-        Math.floor(forceDummyUnit.x) !== Math.floor(unit.x) ||
-        Math.floor(forceDummyUnit.y) !== Math.floor(unit.y)
-      ) {
-        // print(`Collision detected! Dummy x: ${forceDummyUnit.x} y: ${forceDummyUnit.y} Unit x: ${unit.x} y: ${unit.y}`);
-        const e = Effect.create(
-          "Abilities\\Spells\\Other\\TalkToMe\\TalkToMe",
-          forceDummyUnit.x,
-          forceDummyUnit.y
-        );
-        e?.setScaleMatrix(2, 2, 2);
-        destroyForceEffect(true);
-        return;
-      }
-    }
-
-    const xVelocity =
-      (currentSpeed / updatesPerSecond) * Math.cos(Deg2Rad(angle));
-    const yVelocity =
-      (currentSpeed / updatesPerSecond) * Math.sin(Deg2Rad(angle));
-
-    //Complete execution when current speed of the initial force has decayed
-    if (currentSpeed <= 0) {
-      destroyForceEffect(true);
-      return;
-    }
-
-    //Runs when the force is first applied
-    if (config?.onStart && currentSpeed === initialSpeed) {
-      config.onStart(currentSpeed, timeElapsed);
-    }
-
-    //Runs at any point while the function is executing
-    if (config?.whileActive) {
-      config.whileActive(currentSpeed, timeElapsed);
-    }
-
-    theoreticalX += xVelocity;
-    theoreticalY += yVelocity;
-
-    //basically the same thing now since we are no longer issuing the stop command on the unit.
-    //also the moment another force is applied to the unit the previous force will stop being applied.
-    if (config?.strictPathing) {
-      unit.x = theoreticalX;
-      unit.y = theoreticalY;
-    } else {
-      unit.x += xVelocity;
-      unit.y += yVelocity;
-    }
-
-    timeElapsed += refreshInterval;
-
-    if (
-      config?.sustainedForceDuration &&
-      timeElapsed <= config.sustainedForceDuration
-    ) {
-      return;
-    }
-
-    currentSpeed -= frictionConstant / updatesPerSecond;
-  });
-
-  return { destroyForceEffect };
-}
-
-/**
- * @param angle degrees
- * @param effect
- * @param initialSpeed meters per second
- * @param affectHeight determines whether or not to change unit height whilst force is applied
- */
-export function applyForceForEffect(
-  angle: number,
-  effect: Effect,
-  initialSpeed: number,
-  config?: ApplyForceConfig
-) {
-  const timer = Timer.create();
-  const refreshInterval = 0.01;
-  const updatesPerSecond = 1 / refreshInterval;
-  const frictionConstant = 1200; //meters per second friction decay
-  let currentSpeed = initialSpeed;
-  let timeElapsed = 0;
-
-  //Cancel unit commands - if a unit already has a move command and are applied a force, they will bug out sometimes and walk in the opposite direction
-
-  timer.start(refreshInterval, true, () => {
-    //if the unit's move speed vector is greater than the remaining applied force vector then we may stop the applied force function; should only run while the unit has the move order
-    const xVelocity =
-      (currentSpeed / updatesPerSecond) * Math.cos(Deg2Rad(angle));
-    const yVelocity =
-      (currentSpeed / updatesPerSecond) * Math.sin(Deg2Rad(angle));
-
-    //On end hook runs before the timer is destroyed and the function ends
-    if (config?.onEnd && currentSpeed <= 0) {
-      config.onEnd(currentSpeed, timeElapsed);
-    }
-
-    //Complete execution when current speed of the initial force has decayed
-    if (currentSpeed <= 0) {
-      timer.destroy();
-      return;
-    }
-
-    //Runs when the force is first applied
-    if (config?.onStart && currentSpeed === initialSpeed) {
-      config.onStart(currentSpeed, timeElapsed);
-    }
-
-    //Runs at any point while the function is executing
-    if (config?.whileActive) {
-      config.whileActive(currentSpeed, timeElapsed);
-    }
-
-    effect.x += xVelocity;
-    effect.y += yVelocity;
-
-    timeElapsed += refreshInterval;
-
-    if (
-      config?.sustainedForceDuration &&
-      timeElapsed <= config.sustainedForceDuration
-    ) {
-      return;
-    }
-
-    currentSpeed -= frictionConstant / updatesPerSecond;
-  });
-
-  function destroyForceEffect() {
-    timer.destroy();
-  }
-
-  return { destroyForceEffect };
-}
-
-// const unitIsMovingVector_x = (unit.moveSpeed / updatesPerSecond) * Math.cos(Deg2Rad(unit.facing));
-// const unitIsMovingVector_y = (unit.moveSpeed / updatesPerSecond) * Math.sin(Deg2Rad(unit.facing));
-// if ((moveOrders.includes(unit.currentOrder) && unitIsMovingVector_x > xVelocity) || unitIsMovingVector_y > yVelocity) {
-//     print("moving velocity exceeded applied force velocity");
-//     timer.destroy();
-
-//     return;
-// }

package/src/utils/players.ts

@@ -1,213 +0,0 @@
-import { Group, MapPlayer, Rectangle, Trigger, Unit } from "w3ts";
-import { Players } from "w3ts/globals";
-
-/**
- * Does a callback for every unit of the player that has the ability
- * @param player
- * @param abilityId
- * @param cb
- */
-export function forEachUnitOfPlayerWithAbility(player: MapPlayer, abilityId: number, cb: (unit: Unit) => void) {
-    forEachUnitOfPlayer(player, (u) => {
-        for (let x = 0; x < 12; x++) {
-            const currentAbility = u.getAbilityByIndex(x);
-
-            if (currentAbility && currentAbility === u.getAbility(abilityId) && u.isAlive()) {
-                cb(u);
-            }
-        }
-    });
-}
-
-/**
- * Calls a function for each player playing and is an ally of red.
- * @warning specific to map
- */
-export function forEachAlliedPlayer(cb: (player: MapPlayer, index: number) => void) {
-    Players.forEach((player, index) => {
-        //For testing purposes, include player[9] (the human ally) so their units can also be included when iterating the units OR i should make a separate function for all units.
-        if (player.slotState === PLAYER_SLOT_STATE_PLAYING && player.isPlayerAlly(Players[0]) && player != Players[25] && player != Players[27]) {
-            cb(player, index);
-        }
-    });
-}
-
-export function forEachPlayer(cb: (player: MapPlayer, index: number) => void) {
-    Players.forEach((p, index) => {
-        cb(p, index);
-    });
-}
-
-/**
- * Executes the callback function for each unit matching the unit type for the player
- * @param unitType Unit Type Id or the Unit Type String "hcas", etc
- */
-export function forEachUnitTypeOfPlayer(unitType: number | string, player: MapPlayer, cb: (unit: Unit) => void) {
-    if (typeof unitType === "string") {
-        unitType = FourCC(unitType);
-    }
-
-    const g = Group.create();
-
-    g?.enumUnitsOfPlayer(player, () => {
-        const unit = Group.getFilterUnit();
-
-        if (unit && unit?.typeId === unitType) {
-            cb(unit);
-        }
-
-        return true;
-    });
-
-    g?.destroy();
-}
-
-/**
- * @broken
- * @param unitName
- * @param unitType
- * @param fn
- */
-export function forEachUnitOfType(unitName: string, unitType: number | string, fn: (unit: Unit) => void) {
-    if (typeof unitType === "string") {
-        unitType = FourCC(unitType);
-    }
-
-    print(unitName);
-
-    const g = Group.create();
-
-    g?.enumUnitsOfType(unitName, () => {
-        const unit = Group.getFilterUnit();
-
-        if (unit && unit?.typeId === unitType) {
-            fn(unit);
-        }
-
-        return true;
-    });
-
-    print(`Total units of name ${unitName} found: ${g?.size}`);
-
-    g?.destroy();
-}
-
-/**
- * @param unitType Unit Type Id or the Unit Type String "hcas", etc
- */
-export function forEachUnitOfPlayer(player: MapPlayer, cb: (unit: Unit) => void) {
-    const g = Group.create();
-
-    g?.enumUnitsOfPlayer(player, () => {
-        const unit = Group.getFilterUnit();
-
-        if (!unit) {
-            print("Enumerating over a unit that doesn't exist!");
-        }
-        if (unit) {
-            cb(unit);
-        }
-
-        return true;
-    });
-
-    g?.destroy();
-}
-
-/**
- * Executes the callback function for each unit matching the unit type for the player
- * @param unitType Unit Type Id or the Unit Type String "hcas", etc
- */
-export function forEachUnitInRectangle(rectangle: Rectangle, cb: (unit: Unit) => void) {
-    const g = Group.create();
-
-    g?.enumUnitsInRect(rectangle, () => {
-        const unit = Group.getFilterUnit();
-
-        if (unit) {
-            cb(unit);
-        }
-
-        return true;
-    });
-
-    g?.destroy();
-}
-
-export function isPlaying(player: MapPlayer | player) {
-    if (player instanceof MapPlayer) {
-        return player.slotState === PLAYER_SLOT_STATE_PLAYING;
-    }
-
-    return GetPlayerSlotState(player) === PLAYER_SLOT_STATE_PLAYING;
-}
-
-export function isUser(player: MapPlayer | player) {
-    if (player instanceof MapPlayer) {
-        return GetPlayerController(player.handle) === MAP_CONTROL_USER;
-    }
-
-    return GetPlayerController(player) === MAP_CONTROL_USER;
-}
-
-export function isComputer(player: MapPlayer) {
-    if (player instanceof MapPlayer) {
-        return GetPlayerController(player.handle) === MAP_CONTROL_COMPUTER;
-    }
-
-    return GetPlayerController(player) === MAP_CONTROL_COMPUTER;
-}
-
-export function isPlayingUser(player: MapPlayer | player) {
-    return isUser(player) && isPlaying(player);
-}
-
-export function adjustPlayerState(player: MapPlayer, whichState: playerstate, amount: number) {
-    player.setState(whichState, player.getState(whichState) + amount);
-}
-
-export function adjustGold(player: MapPlayer, amount: number) {
-    player.setState(PLAYER_STATE_RESOURCE_GOLD, player.getState(PLAYER_STATE_RESOURCE_GOLD) + amount);
-}
-
-export function adjustLumber(player: MapPlayer, amount: number) {
-    player.setState(PLAYER_STATE_RESOURCE_LUMBER, player.getState(PLAYER_STATE_RESOURCE_LUMBER) + amount);
-}
-
-export function adjustFoodCap(player: MapPlayer, amount: number) {
-    player.setState(PLAYER_STATE_RESOURCE_FOOD_CAP, player.getState(PLAYER_STATE_RESOURCE_FOOD_CAP) + amount);
-}
-
-export function adjustFoodUsed(player: MapPlayer, amount: number) {
-    player.setState(PLAYER_STATE_RESOURCE_FOOD_USED, player.getState(PLAYER_STATE_RESOURCE_FOOD_USED) + amount);
-}
-
-export function playerHasResources(player: MapPlayer, data: { gold?: number; lumber?: number }) {
-    let hasGold = true;
-    let hasLumber = true;
-
-    if (data.gold && data.gold != 0) {
-        hasGold = player.getState(PLAYER_STATE_RESOURCE_GOLD) >= data.gold;
-    }
-
-    if (data.lumber && data.lumber != 0) {
-        hasLumber = player.getState(PLAYER_STATE_RESOURCE_LUMBER) >= data.lumber;
-    }
-
-    return hasGold && hasLumber;
-}
-
-export function setPlayerName() {
-    const t = Trigger.create();
-    forEachPlayer((p) => {
-        t.registerPlayerChatEvent(p, "-playername ", false);
-
-        t.addAction(() => {
-            const str = GetEventPlayerChatString();
-            const newName = str?.replace("-playername", "");
-            if (newName) {
-                SetPlayerName(p.handle, newName);
-            }
-        });
-    });
-}

package/src/utils/point.ts

@@ -1,81 +0,0 @@
-import { Point, Rectangle } from "w3ts";
-const MAP_EDGE_BUFFER_DIST = 300;
-
-export function createValidPoint(maxAttempts: number, validatorFn: (p: Point) => {}) {
-    const MAX_ATTEMPTS = 65000; // 100 was about 10 seconds; 1000 gets good coverage
-    let currentAttempts = 0;
-    const worldBounds = Rectangle.fromHandle(GetWorldBounds());
-    if (!worldBounds) return;
-    const [maxX, maxY] = [GetCameraBoundMaxX(), GetCameraBoundMaxY()];
-
-    while (currentAttempts <= MAX_ATTEMPTS) {
-        const dirX = Math.floor(Math.random() * 100) >= 50 ? 1 : -1;
-        const dirY = Math.floor(Math.random() * 100) >= 50 ? 1 : -1;
-
-        //multiply dir by the buffer distance from max bounds since we can get a negative number
-        const randX = dirX * Math.ceil(Math.random() * maxX) - dirX * MAP_EDGE_BUFFER_DIST;
-        const randY = dirY * Math.ceil(Math.random() * maxY) - dirY * MAP_EDGE_BUFFER_DIST;
-
-        const p = Point.create(randX, randY);
-
-        const isValidPoint = validatorFn(p);
-
-        if (isValidPoint) {
-            // pointsChosen.push(p);
-            return p;
-        } else {
-            //well add it here later, just testing for now
-            currentAttempts++;
-        }
-    }
-}
-
-export function getRandomCoordinatesInCircularArea(relativeX: number, relativeY: number, radius: number) {
-    const randomTheta = Math.random() * 360;
-    const randomRadius = Math.random() * radius;
-
-    const randomX = relativeX + randomRadius * Cos(randomTheta);
-    const randomY = relativeY + randomRadius * Sin(randomTheta);
-
-    return {
-        x: randomX,
-        y: randomY,
-    };
-}
-
-export function getRandomCoordinatesOnCircle(relativeX: number, relativeY: number, radius: number) {
-    const randomTheta = Math.random() * 360;
-
-    const randomX = relativeX + radius * Cos(randomTheta);
-    const randomY = relativeY + radius * Sin(randomTheta);
-
-    return {
-        x: randomX,
-        y: randomY,
-    };
-}
-
-/**
- * Returns degrees or radians?
- */
-export function getAngleBetweenPoints(x1: number, y1: number, x2: number, y2: number) {
-    const locA = Location(x1, y1);
-    const locB = Location(x2, y2);
-
-    const angle = AngleBetweenPoints(locA, locB);
-    //arc tan
-    RemoveLocation(locA);
-    RemoveLocation(locB);
-
-    return angle;
-}
-
-export function distanceBetweenPoints(x1: number, y1: number, x2: number, y2: number) {
-    const deltaX = x1 - x2;
-    const deltaY = y1 - y2;
-    const squaredDist = deltaX * deltaX + deltaY * deltaY;
-    // const squaredDist = Math.pow(deltaX, 2) + Math.pow(deltaY, 2);
-    const dist = Math.sqrt(squaredDist);
-
-    return dist;
-}

package/src/utils/quests.ts

@@ -1,38 +0,0 @@
-import { Quest, Timer } from "w3ts";
-import { tColor } from "./misc";
-
-export function setup_quests() {
-    Timer.create().start(1, false, () => {
-        addQuest(
-            "Basic Game Info",
-            `\nA roguelite base assault game. \nChoose from a wide variety of units that are trained in various schools of magic and skills.\n Outsmart and counter your opponent..
-        `,
-            "ReplaceableTextures\\CommandButtons\\BTNPeasant.blp"
-        );
-
-        // \n${tColor("-fixSpawns", "goldenrod")}: Player 1 can only use this. This will fix add all player's spawn units to their corresponding spawn pool.
-        addQuest(
-            "Commands",
-            `
-            \n${tColor("-cam ####", "goldenrod")}: Sets the camera distance.
-            \n-playername xxxx   This will change your name.
-        `,
-            "ReplaceableTextures\\WorldEditUI\\Doodad-Cinematic.blp",
-            false
-        );
-
-        addQuest("|cffffcc00Evolution Castle Assault v0.01|r", "Created by JediMindTrix/NihilismIsDeath", "ReplaceableTextures\\CommandButtons\\BTNClayFigurine.blp", false);
-    });
-}
-
-export function addQuest(title: string, description: string, iconPath?: string, required: boolean = true) {
-    const q = Quest.create();
-    if (q) {
-        q.setTitle(title);
-        q.required = required;
-        q.setDescription(description);
-        if (iconPath) {
-            q.setIcon(iconPath);
-        }
-    }
-}

package/src/utils/textTag.ts

@@ -1,80 +0,0 @@
-import { TextTag, Trigger, Unit } from "w3ts";
-import { ptColor } from "./misc";
-import { delayedTimer } from "./timer";
-
-/**
- * https://www.hiveworkshop.com/threads/floating-text.149719/
- * 
- * function CreateFloatingText takes string text, real x, real y, real heightOffset, real duration, real size returns nothing
-    local texttag tt = CreateTextTag()
-    call SetTextTagText(tt, text, size)
-    call SetTextTagPos(tt, x, y, heightOffset)
-    call SetTextTagColor(tt, 255, 255, 255, 255) // RGBA format
-    call SetTextTagVisibility(tt, true)
-    call SetTextTagLifespan(tt, duration)
-    call SetTextTagPermanent(tt, false)
-endfunction
-
-function ExampleUsage takes nothing returns nothing
-    call CreateFloatingText("Hello World", 0.0, 0.0, 25.0, 5.0, 10.0)
-endfunction
- * @param unit 
- * @param text 
- * @param duration 
- */
-export function createFloatingTextTagOnUnit(unit: Unit, text: string, config?: { duration?: number; yVelocity?: number; xVelocity?: number; useFade?: boolean }) {
-    const tag = TextTag.create();
-    tag?.setVisible(true);
-
-    tag?.setText(text, 10, true);
-
-    tag?.setLifespan(config?.duration === undefined ? 2 : config.duration);
-
-    if (config?.useFade !== false) {
-        tag?.setFadepoint(0.01);
-    }
-
-    tag?.setVelocity(config?.xVelocity === undefined ? 0 : config.xVelocity, config?.yVelocity === undefined ? 0.025 : config.yVelocity);
-    tag?.setPermanent(false);
-
-    tag?.setPosUnit(unit, 10);
-
-    if (config && config.duration && config.duration === 0) {
-        return;
-    }
-
-    delayedTimer(config?.duration ?? 2, () => {
-        tag?.destroy();
-    });
-}
-
-export function createPermanentTextTagOnPoint(text: string, x: number, y: number) {
-    const tag = TextTag.create();
-    tag?.setVisible(true);
-
-    tag?.setText(text, 20, true);
-    tag?.setLifespan(2);
-
-    tag?.setVelocity(0, 0);
-    tag?.setPermanent(true);
-    tag?.setPos(x, y, 20);
-}
-
-export function setup_createTextForSpellCast() {
-    const t = Trigger.create();
-
-    t.registerAnyUnitEvent(EVENT_PLAYER_UNIT_SPELL_EFFECT);
-
-    t.addAction(() => {
-        const u = Unit.fromEvent();
-
-        if (u) {
-            const spellNumber = GetSpellAbilityId();
-            const spellName = GetAbilityName(spellNumber);
-            if (!spellName || spellName === "Default String") return;
-            //alt + 0164 ¤
-            //alt + 0149 •
-            createFloatingTextTagOnUnit(u, ptColor(u.owner, "¤  ") + spellName);
-        }
-    });
-}