warcraft-3-w3ts-utils 0.1.10 → 0.1.12

package/dist/index.d.ts

@@ -1 +1,2 @@
+/** @noSelfInFile */
 export * from "./utils/index";

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "warcraft-3-w3ts-utils",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "A library of utility functions for modding Warcraft 3 utilizing the W3TS template.",
   "main": "./src/index.ts",
   "keywords": [

package/dist/utils/abilities.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { Unit } from "w3ts";
 /**
  * Good for once a unit gets near you, but not good while they are near you since the event is only triggered on entry, not during

package/dist/utils/camera.d.ts

@@ -1 +1,2 @@
+/** @noSelfInFile */
 export declare function enableCameraZoom(): void;

package/dist/utils/chat-command.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { MapPlayer, Trigger } from "w3ts";
 /**
  * Setup trigger to listen for a chat command for the players specified in the array. Execute function when triggered

package/dist/utils/color.d.ts

@@ -1,109 +1,7 @@
+/** @noSelfInFile */
 export declare const playerRGBMap: Map<number, {
     r: number;
     g: number;
     b: number;
 }>;
 export declare const playerHexColorMap: Map<number, string>;
-/**
- *
- *
-PlayerStrings[0].colour = "|c00ff0303"
-        PlayerStrings[1].colour = "|c000042ff"
-        PlayerStrings[2].colour = "|c001ce6b9"
-        PlayerStrings[3].colour = "|c00540081"
-        PlayerStrings[4].colour = "|c00fffc00"
-        PlayerStrings[5].colour = "|c00fe8a0e"
-        PlayerStrings[6].colour = "|c0020c000"
-        PlayerStrings[7].colour = "|c00e55bb0"
-        PlayerStrings[8].colour = "|c00959697"
-        PlayerStrings[9].colour = "|c007ebff1"
-        PlayerStrings[10].colour = "|c00106246"
-        PlayerStrings[11].colour = "|c004e2a04"
-        PlayerStrings[12].colour = "|c009b0000"
-        PlayerStrings[13].colour = "|c000000c3"
-        PlayerStrings[14].colour = "|c0000eaff"
-        PlayerStrings[15].colour = "|c00be00fe"
-        PlayerStrings[16].colour = "|c00ebcd87"
-        PlayerStrings[17].colour = "|c00f8a48b"
-        PlayerStrings[18].colour = "|c00bfff80"
-        PlayerStrings[19].colour = "|c00dcb9eb"
-        PlayerStrings[20].colour = "|c00282828"
-        PlayerStrings[21].colour = "|c00ebf0ff"
-        PlayerStrings[22].colour = "|c0000781e"
-        PlayerStrings[23].colour = "|c00a46f33"
-        -- RGB
-        PlayerStrings[0].red = 255
-        PlayerStrings[0].green = 3
-        PlayerStrings[0].blue = 3
-        PlayerStrings[1].red = 0
-        PlayerStrings[1].green = 66
-        PlayerStrings[1].blue = 255
-        PlayerStrings[2].red = 28
-        PlayerStrings[2].green = 230
-        PlayerStrings[2].blue = 185
-        PlayerStrings[3].red = 84
-        PlayerStrings[3].green = 0
-        PlayerStrings[3].blue = 129
-        PlayerStrings[4].red = 255
-        PlayerStrings[4].green = 254
-        PlayerStrings[4].blue = 0
-        PlayerStrings[5].red = 254
-        PlayerStrings[5].green = 138
-        PlayerStrings[5].blue = 14
-        PlayerStrings[6].red = 32
-        PlayerStrings[6].green = 192
-        PlayerStrings[6].blue = 0
-        PlayerStrings[7].red = 229
-        PlayerStrings[7].green = 91
-        PlayerStrings[7].blue = 176
-        PlayerStrings[8].red = 149
-        PlayerStrings[8].green = 150
-        PlayerStrings[8].blue = 151
-        PlayerStrings[9].red = 126
-        PlayerStrings[9].green = 191
-        PlayerStrings[9].blue = 241
-        PlayerStrings[10].red = 16
-        PlayerStrings[10].green = 98
-        PlayerStrings[10].blue = 70
-        PlayerStrings[11].red = 78
-        PlayerStrings[11].green = 42
-        PlayerStrings[11].blue = 4
-        PlayerStrings[12].red = 155
-        PlayerStrings[12].green = 0
-        PlayerStrings[12].blue = 0
-        PlayerStrings[13].red = 0
-        PlayerStrings[13].green = 0
-        PlayerStrings[13].blue = 195
-        PlayerStrings[14].red = 155
-        PlayerStrings[14].green = 234
-        PlayerStrings[14].blue = 255
-        PlayerStrings[15].red = 190
-        PlayerStrings[15].green = 0
-        PlayerStrings[15].blue = 254
-        PlayerStrings[16].red = 235
-        PlayerStrings[16].green = 205
-        PlayerStrings[16].blue = 135
-        PlayerStrings[17].red = 248
-        PlayerStrings[17].green = 164
-        PlayerStrings[17].blue = 139
-        PlayerStrings[18].red = 191
-        PlayerStrings[18].green = 255
-        PlayerStrings[18].blue = 128
-        PlayerStrings[19].red = 220
-        PlayerStrings[19].green = 185
-        PlayerStrings[19].blue = 235
-        PlayerStrings[20].red = 40
-        PlayerStrings[20].green = 40
-        PlayerStrings[20].blue = 40
-        PlayerStrings[21].red = 235
-        PlayerStrings[21].green = 240
-        PlayerStrings[21].blue = 255
-        PlayerStrings[22].red = 0
-        PlayerStrings[22].green = 120
-        PlayerStrings[22].blue = 30
-        PlayerStrings[23].red = 164
-        PlayerStrings[23].green = 111
-        PlayerStrings[23].blue = 51
- *
- *
- */

package/dist/utils/index.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 export * from "./abilities";
 export * from "./camera";
 export * from "./chat-command";

package/dist/utils/item.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { Unit } from "w3ts";
 /**
  * Checks if the unit has an item in their item slots

package/dist/utils/math.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 /**
  * @deprecated
  * @param a

package/dist/utils/minimapIcons.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 export type MINIMAP_ICONS = "UI\\Minimap\\MiniMap-ControlPoint.mdl" | "UI\\Minimap\\MiniMap-QuestGiver.mdl" | "UI\\Minimap\\Minimap-QuestObjectiveBonus.mdl" | "UI\\Minimap\\Minimap-QuestObjectivePrimary.mdl" | "UI\\Minimap\\Minimap-QuestTurnIn.mdl" | "UI\\Minimap\\MiniMap-Hero.mdl" | "UI\\Minimap\\Minimap-Ping.mdl" | "UI\\Minimap\\MiniMap-Item.mdl" | "UI\\Minimap\\MiniMap-NeutralBuilding.mdl";
 export declare enum MinimapIconPath {
     controlPoint = "UI\\Minimap\\MiniMap-ControlPoint.mdl",

package/dist/utils/misc.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { Effect, MapPlayer, Unit } from "w3ts";
 type ProperColors = "goldenrod" | "magenta" | "green" | "yellow" | "red" | "player1-red" | "player2-blue" | "player3-teal" | "player4-purple" | "player5-yellow" | "player6-orange";
 export declare function tColor(text: string | number, color?: ProperColors | null, hex?: PlayerColorHex | string | null, alpha?: string): string;

package/dist/utils/physics.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { Effect, Unit } from "w3ts";
 interface ApplyForceConfig {
     /**

package/dist/utils/players.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { MapPlayer, Rectangle, Unit } from "w3ts";
 /**
  * Does a callback for every unit of the player that has the ability

package/dist/utils/point.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { Point } from "w3ts";
 export declare function createValidPoint(maxAttempts: number, validatorFn: (p: Point) => {}): Point | undefined;
 export declare function getRandomCoordinatesInCircularArea(relativeX: number, relativeY: number, radius: number): {

package/dist/utils/quests.d.ts

@@ -1,2 +1,3 @@
+/** @noSelfInFile */
 export declare function setup_quests(): void;
 export declare function addQuest(title: string, description: string, iconPath?: string, required?: boolean): void;

package/dist/utils/textTag.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { Unit } from "w3ts";
 /**
  * https://www.hiveworkshop.com/threads/floating-text.149719/

package/dist/utils/timer.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { Timer } from "w3ts";
 /**
  * @param duration milliseconds

package/dist/utils/units.d.ts

@@ -1,3 +1,4 @@
+/** @noSelfInFile */
 import { MapPlayer, Unit } from "w3ts";
 export declare function createUnits(quantity: number, useFood: boolean, ...args: Parameters<typeof Unit.create>): Unit[];
 /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "warcraft-3-w3ts-utils",
-  "version": "0.1.10",
+  "version": "0.1.12",
   "description": "A library of utility functions for modding Warcraft 3 utilizing the W3TS template.",
   "main": "./src/index.ts",
   "keywords": [

package/readme.md

@@ -0,0 +1,62 @@
+# WC3-W3TS-utils
+
+Small collection of utility helpers for projects using W3TS (Warcraft III TypeScript, v3.x). Designed to be lightweight and easy to drop into your WC3 TypeScript projects to simplify common tasks (tables, math, cloning, timers, safe wrappers, etc.).
+
+## Features
+- Safe wrappers for native WC3 APIs
+- Common math and clamp helpers
+- Table/object deep clone and merge
+- Timer helpers and simple schedulers
+- Small, dependency-free TypeScript utilities
+
+## Installation
+Copy the utils folder into your project or install via your package manager if published:
+
+npm
+```
+npm install wc3-w3ts-utils
+```
+
+yarn
+```
+yarn add wc3-w3ts-utils
+```
+
+Or add the files directly to your W3TS project (recommended for custom Warcraft builds).
+
+## Usage
+Import only what you need:
+
+```ts
+import { createTimer } from 'wc3-w3ts-utils';
+
+// timer example
+const t = createTimer(() => {
+    // do something each tick
+}, 1.0, true);
+```
+
+If copied directly into a W3TS project, adjust import paths accordingly:
+```ts
+import { clamp } from './utils/math';
+```
+
+## API (examples)
+- clamp(value: number, min: number, max: number): number
+- deepClone<T>(obj: T): T
+- merge<T>(target: T, source: Partial<T>): T
+- createTimer(callback: () => void, period: number, repeating?: boolean)
+- safeCall<T>(fn: () => T, fallback?: T): T
+
+(See source files for full signatures and docs.)
+
+## Contributing
+- Open an issue for bugs or enhancement requests.
+- Fork, create a feature branch, and submit a PR with tests/examples where applicable.
+- Keep changes small and well-documented.
+
+## License
+MIT — see LICENSE file.
+
+## Notes
+Built to be simple and compatible with W3TS v3.x and Warcraft III modding workflows. Adjust imports when integrating directly into your map project.