Update docs

Author: Plextora

definitions/feature/manager/screenmgr.d.ts

@@ -0,0 +1,7 @@
+declare class ScreenManager{
+    /**
+     * Adds a screen into the client.
+     * @param cmd The screen toadd
+     */
+    registerScreen(screen: Screen): void;
+}

definitions/feature/screen.d.ts

@@ -0,0 +1,77 @@
+interface ScreenEvents {
+    /**
+     * Calls on the screen being enabled.
+     * @param ignoreAnimations If the screen should not have an opening animation.
+     */
+    "enable": (ignoreAnimations: boolean) => void,
+
+    /**
+    * Called on the screen being disabled.
+    */
+    "disable": () => void,
+
+    /**
+    * Called on every frame; use this to render something arbitrary.
+    * @note This gets called whether the screen is on or off - this may be useful for animations.
+    */
+    "render": () => void,
+
+    /**
+     * Calls when the screen receives a key event.
+     * @param key The key code
+     * @param state The key's state. (true = down, false = up)
+     * @returns Return `true` to cancel, `false` to pass through
+     */
+    "key": (key: KeyCode, state: boolean) => boolean | void;
+
+    /**
+     * Calls when the screen receives a mouse event.
+     * @param button The mouse button
+     * @param wheelDelta Scrolling direction and magnitude if it's a scroll event (positive = scroll up, negative = scroll down)
+     * @param state The mouse's state (true = down, false = up)
+     * @returns Return `true` to cancel, `false` to pass through
+     */
+    "mouse": (button: MouseButton, wheelDelta: number, state: boolean) => boolean | void;
+}
+
+declare class Screen {
+    /**
+     * Creates a screen. Must be registered, otherwise leaks may happen.
+     * @param name The internal screen name.
+     */
+    constructor(name: string, key: KeyCode);
+
+    /**
+     * The name of the screen
+     */
+    readonly name: string;
+
+    /**
+     * Check if a certain point is hovered (usually by the mouse cursor).
+     * @note Use this instead of doing your own bounds check, because this may prevent clicking through layered UIs.
+     * @param rect The rectangle to check bounds
+     * @param point The point to check (by default, mouse position.)
+     */
+    isHover(rect: Rect, point?: Vector2): boolean;
+
+    /**
+     * If the screen is currently on or off
+     */
+    isActive(): boolean;
+
+    /**
+     * Get the key used to activate the screen.
+     */
+    getKey(): KeyCode;
+
+    /**
+     * Set the key used to activate the screen.
+     * @param key The key code to set to
+     */
+    setKey(key: KeyCode): void;
+
+    on: <K extends keyof ScreenEvents>(eventName: K, handler: ScreenEvents[K]) => void;
+
+    
+    toString(): string;
+}

definitions/index.d.ts

@@ -29,7 +29,10 @@
 /// <reference path="./feature/module.d.ts" />
 /// <reference path="./feature/setting.d.ts" />
 /// <reference path="./feature/hudmodule.d.ts" />
+/// <reference path="./feature/screen.d.ts" />
+
 /// <reference path="./feature/manager/mmgr.d.ts" />
 /// <reference path="./feature/manager/commandmgr.d.ts" />
+/// <reference path="./feature/manager/screenmgr.d.ts" />
 
 /// <reference path="./api/TextColor.d.ts" />

definitions/latite.d.ts

@@ -278,6 +278,11 @@ interface Latite {
      */
     getCommandManager(): CommandManager;
 
+    /**
+     * Gets the screen manager. Use this to register screens.
+     */
+    getScreenManager(): ScreenManager;
+
     /**
     * The Latite Client version. Example: "v2.0.0"
     */

definitions/lib/filesystem.d.ts

@@ -57,5 +57,12 @@ declare namespace include {
          * @param path The path to the directory.
          */
         readDirectory(path: string): string[];
+
+        /**
+         * Moves (or renames) files and directories.
+         * @param from Source path
+         * @param to Destination path
+         */
+        move(from: string, to: string): void;
     }
 }

definitions/world/item.d.ts

@@ -10,6 +10,11 @@ declare class Item {
      * The translate name of the item (e.g. `item.stone`)
      */
     public readonly translateName: string; 
+
+    /**
+     * Maximum damage of the item type.
+     */
+    public readonly maxDamage: number;
 }
 
 /**

docs-markdown/exports.md

@@ -13,7 +13,9 @@
 - [feature/hudmodule](module.feature_hudmodule/index.md)
 - [feature/manager/commandmgr](module.feature_manager_commandmgr/index.md)
 - [feature/manager/mmgr](module.feature_manager_mmgr/index.md)
+- [feature/manager/screenmgr](module.feature_manager_screenmgr/index.md)
 - [feature/module](module.feature_module/index.md)
+- [feature/screen](module.feature_screen/index.md)
 - [feature/setting](module.feature_setting/index.md)
 - [game](module.game/index.md)
 - [gfx/Texture](module.gfx_Texture/index.md)