Updated documentation (Beta 5)

Author: Plextora

definitions/feature/command.d.ts

@@ -3,9 +3,10 @@ interface CommandEvents {
      * Called on any command being used.
      * @param label The beginning of the command line (for example, `'test'` in '.test 123')
      * @param args The list of arguments of the command line (for example, `['123']` in '.test 123')
+     * @param commandLine The command line (for example, `'.test 123 test'` in '.test 123 test')
      * @returns Whether the command usage is successful or not (return `false` if the user misused the command)
      */
-    "execute" : (label: string, args: string[]) => boolean;
+    "execute" : (label: string, args: string[], commandLine: string) => boolean;
 }
 
 // A class representing a Latite Client command.

definitions/feature/module.d.ts

@@ -87,8 +87,9 @@ declare class Module {
      * @param name The internal name
      * @param displayName The name that shows in the menu
      * @param description A short description of what the setting does
+     * @param defVal The default value
      */
-    addBoolSetting(name: string, displayName: string, description: string): Setting;
+    addBoolSetting(name: string, displayName: string, description: string, defVal: boolean): Setting;
 
     /**
      * Adds a setting.
@@ -98,6 +99,25 @@ declare class Module {
      * @param min The minimum value
      * @param max The maximum value
      * @param interval The precision of the setting
+     * @param defVal The default value
      */
-    addNumberSetting(name: string, displayName: string, description: string, min: number, max: number, interval: number): Setting;
+    addNumberSetting(name: string, displayName: string, description: string, min: number, max: number, interval: number, defVal: number): Setting;
+
+    /**
+     Adds a setting.
+     * @param name The internal name
+     * @param displayName The name that shows in the menu
+     * @param description A short description of what the setting does
+     * @param defVal The default value
+     */
+    addKeySetting(name: string, displayName: string, description: string, defVal: KeyCode): Setting;
+
+    /**
+     Adds a setting.
+     * @param name The internal name
+     * @param displayName The name that shows in the menu
+     * @param description A short description of what the setting does
+     * @param defVal The default value
+     */
+    addTextSetting(name: string, displayName: string, description: string, defVal: string): Setting;
 }

definitions/feature/setting.d.ts

@@ -17,4 +17,11 @@ declare class Setting {
      * Gets the value of the setting. Could be null.
      */
     getValue(): any;
+
+    /**
+     * Set that this setting will only show when another setting is on or off.
+     * @param settingName The setting that this setting will depend on (internal name).
+     * @param value The value the other setting needs to be for this setting to show
+     */
+    setCondition(settingName: string, value?: boolean): void;
 }

definitions/gfx/graphics.d.ts

@@ -103,9 +103,40 @@ declare const enum VerticalAlignment {
     Center
 }
 
-declare interface DXGraphics {
+type BackendType 
+    = 
+    /**
+     *  */
+    "dx";
+
+declare interface Graphics {
+    /**
+     * 
+     * @param renderer `"dx"`: uses Direct2D/DirectWrite, `"minecraft":` use the Minecraft renderer
+     */
+    use(renderer: "dx" | "minecraft"): void;
     drawRect(rect: Rect, color: Color, thickness: number): void;
     fillRect(rect: Rect, color: Color): void;
+
+    /**
+     * Draws text on the position specified
+     * @param pos The position to draw the text
+     * @param text The text to draw
+     * @param size The size of the text in pixels
+     * @param color The color of the text
+     */
+    drawText(pos: Vector2, text: string, size: number, color: Color): void;
+
+    /**
+     * A full verison of drawText, where you can specify the bounds of the text and the alignment
+     * @param area The place to render the text 
+     * @param text The text to render
+     * @param size The size of the text
+     * @param color The color of the text
+     * @param alignment The horizontal alignment
+     * @param verticalAlignment The vertical alignment
+     */
+    drawTextFull(area: Rect, text: string, size: number, color: Color, alignment: TextAlignment, verticalAlignment: VerticalAlignment): void;
 }
 
-declare const dx: DXGraphics;
+declare const graphics: Graphics;

definitions/index.d.ts

@@ -0,0 +1,27 @@
+/// <reference path="./script.d.ts" />
+/// <reference path="./game.d.ts" />
+/// <reference path="./latite.d.ts" />
+
+/// <reference path="./world/world.d.ts" />
+/// <reference path="./world/item.d.ts" />
+/// <reference path="./world/entity.d.ts" />
+
+/// <reference path="./util/util.d.ts" />
+/// <reference path="./util/buffer.d.ts" />
+
+/// <reference path="./lib/clipboard.d.ts" />
+/// <reference path="./lib/filesystem.d.ts" />
+/// <reference path="./lib/network.d.ts" />
+
+/// <reference path="./gfx/graphics.d.ts" />
+/// <reference path="./gfx/graphics3.d.ts" />
+
+
+/// <reference path="./feature/command.d.ts" />
+/// <reference path="./feature/module.d.ts" />
+/// <reference path="./feature/setting.d.ts" />
+/// <reference path="./feature/hudmodule.d.ts" />
+/// <reference path="./feature/manager/mmgr.d.ts" />
+/// <reference path="./feature/manager/commandmgr.d.ts" />
+
+/// <reference path="./api/TextColor.d.ts" />

definitions/lib/clipboard.d.ts

@@ -0,0 +1,20 @@
+declare namespace include {
+    export interface Clipboard {
+        /**
+         * Gets the current clipboard text
+         */
+        get(): string;
+
+        /**
+         * Sets the clipboard text
+         * @param str The text to set the clipboard to
+         */
+        set(str: string): void;
+
+
+        /**
+         * Gets the copied bitmap. If the clipboard is unable to be opened, it will return null
+         */
+        getBitmap(): Buffer | null;
+    }
+}

definitions/script.d.ts

@@ -15,6 +15,7 @@ declare var script: Script;
 interface EngineLibraries {
     "filesystem": include.Filesystem
     "network": include.Network
+    "clipboard": include.Clipboard
 }
 
 /**

definitions/util/buffer.d.ts

@@ -1,4 +1,5 @@
 declare interface Uint8Array {
+    readInt16(idx: number): number;
     readInt32(idx: number): number;
     readInt64AsFloat(idx: number): number;
 

docs-markdown/exports.md

@@ -18,8 +18,10 @@
 - [game](module.game/index.md)
 - [gfx/graphics](module.gfx_graphics/index.md)
 - [gfx/graphics3](module.gfx_graphics3/index.md)
+- [index](module.index/index.md)
 - [key](module.key/index.md)
 - [latite](module.latite/index.md)
+- [lib/clipboard](module.lib_clipboard/index.md)
 - [lib/filesystem](module.lib_filesystem/index.md)
 - [lib/network](module.lib_network/index.md)
 - [script](module.script/index.md)