Adjust typings and formatting on rpg_core

Author: masked-rpgmaker

lib/rpg_core/Bitmap.d.ts

@@ -1,119 +1,69 @@
 import * as PIXI from "pixi.js";
+
 import { Rectangle } from "./Rectangle";
 import { Stage } from "./Stage";
 
-
-// TODO : document the class?
-
-/**
- * The basic object that rpresents an image.
- *
- * @class Bitmap
- */
 declare class Bitmap {
 
-    /**
-     * The base texture that holds the image.
-     *
-     * @type {PIXI.BaseTexture}
-     * @memberof Bitmap
-     */
-
+    constructor(width: number, height: number);
 
+    public readonly url: string;
     public readonly baseTexture : PIXI.BaseTexture;
-
-    /**
-     * The bitmap canvas.
-     *
-     * @type {HTMLCanvasElement}
-     * @memberof Bitmap
-     */
+    public readonly image: HTMLImageElement;
     public readonly canvas: HTMLCanvasElement;
-
-    /**
-     * The 2d context of the bitmap canvas.
-     *
-     * @type {CanvasRenderingContext2D}
-     * @memberof Bitmap
-     */
     public readonly context: CanvasRenderingContext2D;
 
-    public fontBold: boolean;
+    public readonly width: number;
+    public readonly height: number;
+    public readonly rect: Rectangle
 
-    public fontFace: string;
+    public smooth: boolean;
 
-    public fontItalic: boolean;
+    public paintOpacity: number;
 
+    public fontFace: string;
     public fontSize: number;
+    public fontBold: boolean;
+    public fontItalic: boolean;
 
-    public readonly image: HTMLImageElement;
+    public textColor: string;
 
     public outlineColor: string;
-
     public outlineWidth: number;
 
-    public paintOpacity: number;
-
-    public readonly rect: Rectangle
-
-    public smooth: boolean;
-    
-    public textColor: string;
-
-    public readonly url: string;
-
-    public readonly width: number;
-
-    public readonly height: number;
-
-    /**
-     * Creates an instance of Bitmap.
-     * @param {number} width The width of the bitmap.
-     * @param {number} height The height of the bitmap.
-     * @memberof Bitmap
-     */
-    constructor(width: number, height: number);
-
     public static load(url: string): Bitmap;
-
     public static snap(stage: Stage): Bitmap;
 
-    // eslint-disable-next-line @typescript-eslint/ban-types
-    public addLoadListener(listner: Function): void;
+    public isError(): boolean;
+    public isReady(): boolean;
 
-    public blt(source: Bitmap,sx: number,sy: number,sw: number,sh: number, dx: number,dy: number, dw: number, dh: number): void;
+    public retry(): void;
 
-    public clear(): void;
+    public addLoadListener(listener: (self: Bitmap) => void): void;
 
+    public blt(source: Bitmap, sx: number, sy: number, sw: number, sh: number, dx: number,dy: number, dw: number, dh: number): void;
+
+    public clear(): void;
     public clearRect(x: number, y: number, width: number, height: number): void;
 
     public destroy(): void;
 
     public drawCircle(x: number, y: number, radius: number, color: number): void;
-
-    public drawText(text: string | number,x: number,y: number, maxWidth: number, lineHeight:number, align: string): void;
+    public drawText(text: string | number, x: number, y: number, maxWidth: number, lineHeight:number, align: string): void;
 
     public fillAll(color: string): void;
+    public fillRect(x: number, y:number, width: number, height: number, color: string): void;
+    public gradientFillRect(x: number, y: number, width: number, height: number, color1: string, color2: string, vertical: boolean): void;
 
-    public fillRect(x: number,y:number,width: number, height: number, color: string): void;
-    
     public getAlphaPixel(x:number, y: number): string;
-
     public getPixel(x: number, y: number): string;
 
-    public gradientFillRect(x: number, y: number, width: number, height: number, color1: string, color2: string, vertical: boolean): void;
-
-    public isError(): boolean;
-
-    public isReady(): boolean;
-
-    public measureTextwidth(text: string): number;
-
-    public retry(): void;
+    public measureTextWidth(text: string): number;
 
     public strokeRect(x: number, y: number, width: number, height: number, color: string): void;
 
-    public resize(width: number, height: number)
+    public resize(width: number, height: number): void;
+
 }
 
-export {Bitmap}
+export { Bitmap };

lib/rpg_core/ColorFilter.d.ts

@@ -1,6 +1,6 @@
 import * as PIXI from "pixi.js";
 
-type ColorTone = [number,number,number,number];
+type ColorTone = [number, number, number, number];
 
 declare class ColorFilter extends PIXI.Filter {
 
@@ -12,12 +12,11 @@ declare class ColorFilter extends PIXI.Filter {
 
     public setColorTone(tone: ColorTone): void;
 
-    public setHue(hue: number);
+    public setHue(hue: number): void;
 
 }
 
 export {
     ColorFilter,
     ColorTone
-    
-}
+};

lib/rpg_core/Graphics.d.ts

@@ -1,35 +1,49 @@
 import * as PIXI from "pixi.js";
+
 import { EffekseerContext } from "effekseer";
 import { Stage } from "./Stage";
 
-declare class Graphics {
-
-    public static app: PIXI.Application;
-    public static boxHeight: number;
-    public static boxWidth: number;
-    public static defaultScale: number;
-    public static effekseer: EffekseerContext;
-    public static frameCount: number;
-    public static height: number;
-    public static width: number;
-
-    public static endLoading(): boolean;
-    public static eraseError(): void;
-    public static hideScreen(): void;
-    public static initialize(): boolean;
-    public static isInsideCanvas(x: number, y: number): boolean;
-    public static pageToCanvasX(x: number): number;
-    public static pageToCanvasY(y: number): number;
-    public static printError(name: string, message: string, error: Error): void;
-    public static resize(width: number, height: number): void;
-    public static setStage(stage: Stage): void;
-    public static setTickHandler(handler: Function): void;
-    public static showRetryButton(retry: Function): void;
-    public static showScreen(): void;
-    public static startGameLoop(): void;
-    public static startLoading(): void;
-    public static stopGameLoop(): void;
+declare namespace Graphics {
+
+    export const app: PIXI.Application;
+    
+    export let boxHeight: number;
+    export let boxWidth: number;
+    export let defaultScale: number;
+
+    export const effekseer: EffekseerContext;
+
+    export let frameCount: number;
+    export let height: number;
+    export let width: number;
+
+    export function initialize(): boolean;
+
+    export function endLoading(): boolean;
+
+    export function eraseError(): void;
+    export function hideScreen(): void;
+
+    export function isInsideCanvas(x: number, y: number): boolean;
+
+    export function pageToCanvasX(x: number): number;
+    export function pageToCanvasY(y: number): number;
+
+    export function printError(name: string, message: string, error: Error): void;
+
+    export function resize(width: number, height: number): void;
+
+    export function setStage(stage: Stage): void;
+
+    export function setTickHandler(handler: (delta: number) => void): void;
+
+    export function showRetryButton(retry: () => void): void;
+    export function showScreen(): void;
+    
+    export function startGameLoop(): void;
+    export function startLoading(): void;
+    export function stopGameLoop(): void;
+
 }
-export {
-    Graphics
-}
+
+export { Graphics };

lib/rpg_core/Input.d.ts

@@ -1,24 +1,24 @@
-import {RPG} from "./RPG";
-declare class Input {
+import { RPG } from "./RPG";
 
-    public static readonly date: number;
-    public static readonly dir4: number;
-    public static readonly dir8: number;
-    public static gamepadMapper: RPG.InputGamepad;
-    public static keyMapper: RPG.InputKey;
-    public static keyRepeatInterval: number;
-    public static keyRepeatWait: number;
+declare namespace Input {
 
-    public static clear(): void;
-    public static initialize(): void;
-    public static isLongPressed(keyname: string): boolean;
-    public static isPressed(keyName: string): boolean;
-    public static isRepeated(keyName: string): boolean;
-    public static isTriggered(keyName: string): boolean;
-    public static update(): void;
+    export const date: number;
+    export const dir4: number;
+    export const dir8: number;
+    
+    export let gamepadMapper: RPG.InputGamepad;
+    export let keyMapper: RPG.InputKey;
+    export let keyRepeatInterval: number;
+    export let keyRepeatWait: number;
 
-}
+    export function clear(): void;
+    export function initialize(): void;
+    export function isLongPressed(keyname: string): boolean;
+    export function isPressed(keyName: string): boolean;
+    export function isRepeated(keyName: string): boolean;
+    export function isTriggered(keyName: string): boolean;
+    export function update(): void;
 
-export {
-    Input
 }
+
+export { Input };

lib/rpg_core/JsonEx.d.ts

@@ -1,16 +1,10 @@
-
-declare class JsonEx {
-
-    public static maxDepth: number;
+declare namespace JsonEx {
+    export let maxDepth: number;
 
-    public static makeDeepCopy<T>(object : Object): T;
-
-    public static parse<T>(json: string): T;
-
-    public static stringify(object: Object): string;
+    export function makeDeepCopy<T>(object: T): T;
 
+    export function parse<T>(json: string): T;
+    export function stringify(object: unknown): string;
 }
 
-export {
-    JsonEx
-}
+export { JsonEx };

lib/rpg_core/Point.d.ts

@@ -1,11 +1,7 @@
 import * as PIXI from "pixi.js";
 
-
 declare class Point extends PIXI.Point {
-
     constructor(x: number, y: number);
 }
 
-export {
-    Point
-}
+export { Point };

lib/rpg_core/RPG.d.ts

@@ -14,6 +14,7 @@ export namespace RPG {
         14: "left"; // D-pad left
         15: "right"; // D-pad right
     }
+    
     export interface InputKey {
         9: "tab"; // tab
         13: "ok"; // enter

lib/rpg_core/Rectangle.d.ts

@@ -1,22 +1,7 @@
 import * as PIXI from "pixi.js";
 
-/**
- *The rectangle class
- *
- * @class Rectangle
- * @extends {PIXI.Rectangle}
- */
-class Rectangle extends PIXI.Rectangle {
-
-    /**
-     * Creates an instance of Rectangle.
-     * @param {number} x The x coordinate for the upper-left corner.
-     * @param {number} y The y coordinate for the upper-left corner.
-     * @param {number} width The width of the rectangle.
-     * @param {number} height The height of the rectangle.
-     * @memberof Rectangle
-     */
+declare class Rectangle extends PIXI.Rectangle {
     constructor(x: number, y: number, width: number, height: number);
 }
 
-export {Rectangle}
+export { Rectangle };

lib/rpg_core/ScreenSprite.d.ts

@@ -8,11 +8,10 @@ declare class ScreenSprite extends PIXI.Container {
 
     public destroy(): void;
 
-    public setBlack(): void;
-
     public setColor(r: number,g: number,b: number): void;
-
+    public setBlack(): void;
     public setWhite(): void;
+
 }
 
-export {ScreenSprite}
+export { ScreenSprite };