refactor: addStat --> addPlayerStat

IsaacScript · Sep 4, 2023 · af9ebb6 · af9ebb6
1 parent 3ab6cdb
commit af9ebb6
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 5 deletions.
diff --git a/packages/docs/docs/main/change-log.md b/packages/docs/docs/main/change-log.md
@@ -9,6 +9,11 @@ This page lists the changes to the IsaacScript framework.
 
 <br />
 
+## September 11th, 2023 (Unreleased)
+
+- Renamed the following helper functions:
+  - `addStat` --> `addPlayerStat`
+
 ## September 4th, 2023
 
 - Added the following helper functions:

diff --git a/packages/isaacscript-common/src/classes/features/other/CharacterStats.ts b/packages/isaacscript-common/src/classes/features/other/CharacterStats.ts
@@ -1,7 +1,7 @@
 import type { CacheFlag, PlayerType } from "isaac-typescript-definitions";
 import { ModCallback } from "isaac-typescript-definitions";
 import { Exported } from "../../../decorators";
-import { addStat, getDefaultPlayerStat } from "../../../functions/stats";
+import { addPlayerStat, getDefaultPlayerStat } from "../../../functions/stats";
 import { Feature } from "../../private/Feature";
 
 type StatMap = Map<CacheFlag, number> | ReadonlyMap<CacheFlag, number>;
@@ -38,7 +38,7 @@ export class CharacterStats extends Feature {
     }
     const delta = stat - defaultStat;
 
-    addStat(player, cacheFlag, delta);
+    addPlayerStat(player, cacheFlag, delta);
   };
 
   /**

diff --git a/packages/isaacscript-common/src/classes/features/other/EdenStartingStats.ts b/packages/isaacscript-common/src/classes/features/other/EdenStartingStats.ts
@@ -5,8 +5,8 @@ import {
   mapGetPlayer,
   mapSetPlayer,
 } from "../../../functions/playerDataStructures";
-import { getPlayerStats } from "../../../functions/playerStats";
 import { isEden } from "../../../functions/players";
+import { getPlayerStats } from "../../../functions/stats";
 import type { PlayerStats } from "../../../interfaces/PlayerStats";
 import type { PlayerIndex } from "../../../types/PlayerIndex";
 import { Feature } from "../../private/Feature";

diff --git a/packages/isaacscript-common/src/functions/stats.ts b/packages/isaacscript-common/src/functions/stats.ts
@@ -29,7 +29,7 @@ const STAT_CACHE_FLAGS_SET = new ReadonlySet<CacheFlag>([
  * - CacheFlag.SPEED (1 << 4)
  * - CacheFlag.LUCK (1 << 10)
  */
-export function addStat(
+export function addPlayerStat(
   player: EntityPlayer,
   cacheFlag: CacheFlag,
   amount: number,

diff --git a/packages/isaacscript-common/src/index.ts b/packages/isaacscript-common/src/index.ts
@@ -87,7 +87,6 @@ export * from "./functions/playerCenter";
 export * from "./functions/playerDataStructures";
 export * from "./functions/playerHealth";
 export * from "./functions/playerIndex";
-export * from "./functions/playerStats";
 export * from "./functions/players";
 export * from "./functions/pocketItems";
 export * from "./functions/positionVelocity";