Add battle object types

Author: masked-rpgmaker

lib/rmmz_managers/AudioManager.d.ts

@@ -13,63 +13,85 @@ declare class AudioManager {
     private static _bgsVolume: number;
     private static _meVolume: number;
     private static _seVolume: number;
+    
     private static _currentBgm: CurrentAudio;
     private static _currentBgs: CurrentAudio;
+
     private static _bgmBuffer: WebAudio;
     private static _bgsBuffer: WebAudio;
     private static _meBuffer: WebAudio;
     private static _seBuffer: WebAudio;
+
     private static _staticBuffers: WebAudio[];
+
     private static _replayFadeTime: number;
     private static _path: string;
 
-    public static get bgmVolume(): number;
-    public static set bgmVolume(value: number);
-
-    public static get bgsVolume(): number;
-    public static set bgsVolume(value: number);
-
-    public static get meVolume(): number;
-    public static set meVolume(value: number);
-
-    public static get seVolume(): number;
-    public static set seVolume(value: number);
+    public static bgmVolume: number;
+    public static bgsVolume: number;
+    public static meVolume: number;
+    public static seVolume: number;
 
     public static playBgm(bgm: CurrentAudio, pos: number): void;
     public static replayBgm(bgm: CurrentAudio): void;
+
     public static isCurrentBgm(bgm: CurrentAudio): boolean;
+
     public static updateBgmParameters(bgm: CurrentAudio): void;
     public static updateCurrentBgm(bgm: CurrentAudio, pos: number): void;
+
     public static stopBgm(): void;
+
     public static fadeOutBgm(duration: number): void;
     public static fadeInBgm(duration: number): void;
+
     public static playBgs(bgs: CurrentAudio, pos: number): void;
     public static replayBgs(bgs: CurrentAudio): void;
+
     public static isCurrentBgs(bgs: CurrentAudio): boolean;
+
     public static updateBgsParameters(bgs: CurrentAudio): void;
+
     public static stopBgs(): void;
+
     public static fadeOutBgs(duration: number): void;
     public static fadeInBgs(duration: number): void;
+
     public static playMe(me: CurrentAudio): void;
+
     public static updateMeParameters(me: CurrentAudio): void;
+
     public static fadeOutMe(duration: number): void;
+
     public static stopMe(): void;
+
     public static playSe(se: CurrentAudio): void;
+
     public static updateSeParameters(buffer: WebAudio, se: CurrentAudio): void;
+
     public static cleanupSe(): void;
+
     public static stopSe(): void;
+
     public static playStaticSe(se: CurrentAudio): void;
     public static loadStaticSe(se: CurrentAudio): void;
+
     public static isStaticSe(se: CurrentAudio): boolean;
+
     public static stopAll(): void;
+
     public static saveBgm(): CurrentAudio;
     public static saveBgs(): CurrentAudio;
+
     public static makeEmptyAudioObject(): CurrentAudio;
+
     public static createBuffer(folder: string, name: string): WebAudio;
-    public static updateufferParameters(buffer: WebAudio, configVolume: number, audio: CurrentAudio): void;
+    public static updateBufferParameters(buffer: WebAudio, configVolume: number, audio: CurrentAudio): void;
+
     public static audioFileExt(): string;
+
     public static checkErrors(): void;
     public static throwLoadError(webAudio: WebAudio): void;
 }
 
-export { AudioManager, CurrentAudio}
+export { AudioManager, CurrentAudio };

lib/rmmz_managers/BattleManager.d.ts

@@ -1,4 +1,11 @@
-import {CurrentAudio} from "./AudioManager";
+import { CurrentAudio } from "./AudioManager";
+
+import { Game_Actor } from '../rmmz_objects/Game_Actor';
+import { Game_Action } from '../rmmz_objects/Game_Action';
+
+import { Spriteset_Battle } from "../rmmz_sprites/Spriteset_Battle";
+
+import { Window_BattleLog } from '../rmmz_windows/Window_BattleLog';
 
 declare class BattleManager {
 
@@ -10,19 +17,23 @@ declare class BattleManager {
     private static _eventCallback: boolean;
     private static _preemptive: boolean;
     private static _surprise: boolean;
-    private static _currentActor: unknown // TODO fix the typing.
-    private static _actionForceBattler: unknown // TODO fix typing.
+    private static _currentActor: Game_Actor;
+    private static _actionForceBattler: Game_Action;
     private static _mapBgm: CurrentAudio;
     private static _mapBgs: CurrentAudio;
-    private static _actionBattlers: unknown[];
-    private static _subject: unknown;
-    private static _action: unknown;
-    private static _targets: unknown[];
-    private static _logWindow: unknown;
-    private static _spriteset;
+
+    private static _actionBattlers: Game_Battler[];
+
+    private static _subject: Game_Battler;
+    private static _action: Game_Action;
+
+    private static _targets: Game_Battler[];
+    private static _logWindow: Window_BattleLog;
+    
+    private static _spriteset: Spriteset_Battle;
     private static _escapeRatio: number;
     private static _escaped: boolean;
     private static _rewards: Record<string, unknown>;
     private static _tpbNeedsPartyCommand: boolean;
-    
+
 }

lib/rmmz_managers/ColorManager.d.ts

@@ -36,6 +36,7 @@ declare class ColorManager {
     public static dimColor2(): string;
     public static itemBackColor1(): string;
     public static itemBackColor2(): string;
+
 }
 
-export { ColorManager }
+export { ColorManager };

lib/rmmz_managers/DataManager.d.ts

@@ -1,9 +1,4 @@
-//-----------------------------------------------------------------------------
-// DataManager
-//
-// The static class that manages the database and game objects.
-// @TODO : this class still need fix.
-//mport { RPG } from "./RPG";
+import { RPG } from "./RPG";
 
 
 /**
@@ -68,10 +63,10 @@ declare class DataManager {
     public static setupEventTest(): void;
     public static isEventTest(): boolean;
 
-    public static isSkill(item: Record<string, unknown>): boolean;
-    public static isItem(item: Record<string, unknown>): boolean;
-    public static isWeapon(item: Record<string, unknown>): boolean;
-    public static isArmor(item: Record<string, unknown>): boolean;
+    public static isSkill(item: unknown): item is RPG.DataSkill;
+    public static isItem(item: unknown): item is RPG.DataItem;
+    public static isWeapon(item: unknown): item is RPG.DataWeapon;
+    public static isArmor(item: unknown): item is RPG.DataArmor;
 
     public static setupNewGame(): void;
     public static createGameObjects(): void;

lib/rmmz_managers/RPG.d.ts

@@ -1,108 +1,86 @@
 declare namespace RPG {
 
-    export interface DataActor {
+    export interface Data {
         id: number;
+        name: string;
+        note: string;
+    }
+
+    export interface DataActor extends Data {
         battlerName: string;
         characterIndex: number;
         characterName: string;
         classId: number;
         equips: number[];
         faceIndex: number;
         faceName: string;
-        traits: Trait[]; // TODO : define the trait
+        traits: Trait[];
         initialLevel: number;
         maxLevel: number;
-        name: string;
         nickname: string;
-        note: string;
         profile: string;
     }
 
-    export interface DataSkill {
-        id: number;
-        animationId: number;
-        damage: Damage;
+    export interface DataItemBase extends Data {
         description: string;
-        effects: Effect[];
-        hitType: number;
         iconIndex: number;
-        message1: string;
-        message2: string;
-        messageType: number;
-        mpCost: number;
-        name: string;
-        note: string;
-        occasion: number;
-        repeats: number;
-        requiredWtypeId1: number;
-        requiredWtypeId2: number;
-        scope: number;
-        speed: number;
-        stypeId: number;
-        successRate: number;
-        tpCost: number;
-        tpGain: number;
     }
 
-    export interface DataClass {
-        id: number;
-        expParams: number[];
+    export interface DataEquipItem extends DataItemBase {
+        etypeId: number;
         traits: Trait[];
-        learnings: Learning[];
-        name: string;
-        note: string;
-        params: Array<number[]>;
+        params: number[];
+        price: number;
     }
 
-    export interface DataItem {
-        id: number;
+    export interface DataWeapon extends DataEquipItem {
+        animationId: number;
+        wtypeId: number;
+        etypeId: 1;
+    }
+
+    export interface DataArmor {
+        atypeId: number;
+        etypeId: 2 | 3 | 4 | 5;
+    }
+
+    export interface DataConsumable extends DataItemBase {
         animationId: number;
-        consumable: boolean;
         damage: Damage;
-        description: string;
         effects: Effect[];
         hitType: number;
-        iconIndex: number;
-        itypeId: number;
-        name: string;
-        note: string;
         occasion: number;
-        price: number;
         repeats: number;
         scope: number;
         speed: number;
         successRate: number;
         tpGain: number;
     }
 
-    export interface DataWeapon {
-        id: number;
-        animationId: number;
-        description: string;
-        etypeId: number;
-        traits: Trait[];
-        iconIndex: number;
-        name: string;
-        note: string;
-        params: number[];
+    export interface DataSkill extends Data {
+        message1: string;
+        message2: string;
+        messageType: number;
+        mpCost: number;
+        requiredWtypeId1: number;
+        requiredWtypeId2: number;
+        stypeId: number;
+        tpCost: number;
+    }
+
+    export interface DataItem extends Data {
+        itypeId: number;
         price: number;
-        wtypeId: number;
     }
 
-    export interface DataArmor {
-        id: number;
-        atypeId: number;
-        description: string;
-        etypeId: number;
+    export interface DataClass extends Data {
+        expParams: number[];
         traits: Trait[];
-        iconIndex: number;
-        name: string;
-        note: string;
-        params: number[];
-        price: number;
+        learnings: Learning[];
+        params: Array<number[]>;
     }
 
-    export interface DataEnemy {
+    export interface DataEnemy extends Data {
         id: number;
         actions: Action[];
         battlerHue: number;
@@ -116,14 +94,14 @@ declare namespace RPG {
         params: number[];
     }
 
-    export interface DataTroop {
+    export interface DataTroop extends Data {
         id: number;
         members: Member[];
         name: string;
         pages: Page[];
     }
 
-    export interface DataState {
+    export interface DataState extends Data {
         id: number;
         autoRemovalTiming: number;
         chanceByDamage: number;
@@ -164,7 +142,7 @@ declare namespace RPG {
         speed: number;
     }
 
-    export interface DataTileset {
+    export interface DataTileset extends Data {
         id: number;
         flags: number[];
         mode: number;
@@ -287,10 +265,7 @@ declare namespace RPG {
         volume: number;
     }
 
-    export interface Event {
-        id: number;
-        name: string;
-        note: string;
+    export interface Event extends Data {
         pages: Page[];
         x: number;
         y: number;