update docs

Author: Imrglop

definitions/feature/manager/commandmgr.d.ts

@@ -10,9 +10,5 @@ declare class CommandManager {
      */
     registerCommand(cmd: Command): void;
 
-    /**
-     * Removes a command from the client.
-     * @param mod The command to deregister. Must be a script command.
-     */
-    deregisterCommand(cmd: Command): void;
+    //deregisterCommand(cmd: Command): void;
 }

definitions/feature/manager/mmgr.d.ts

@@ -5,11 +5,7 @@ interface ModuleManager {
      */
     registerModule(mod: Module): void;
 
-    /**
-     * Removes a module from the client.
-     * @param mod The module to unregister. Must be a script module.
-     */
-    deregisterModule(mod: Module): void;
+    //deregisterModule(mod: Module): void;
 
     /**
      * Gets a module by the specified InternalName.

definitions/game.d.ts

@@ -41,6 +41,9 @@ interface Game {
      */
     getWorld() : World | null;
 
+    /**
+     * Get whether you are in a UI screen
+     */
     isInUI(): boolean;
 
     /**
@@ -52,6 +55,49 @@ interface Game {
      * Get the mouse position.
      */
     getMousePos(): Vector2;
+
+    /**
+     * Gets the user's input setting. Usually a key code; for example, `"forward"` returns `KeyCode.W` by default.
+     * 
+     * If this function returns 0, either the key is set to nothing or the specified name was not found.
+     */
+    getInputBinding(name: InputBinding): number;
 }
 
+type InputBinding =
+    "attack" |
+    "pickItem" |
+    "use" |
+    "drop" |
+    "hotbar.1" |
+    "hotbar.2" |
+    "hotbar.3" |
+    "hotbar.4" |
+    "hotbar.5" |
+    "hotbar.6" |
+    "hotbar.7" |
+    "hotbar.8" |
+    "hotbar.9" |
+    "inventory" |
+    "togglePerspective" |
+    "jump" |
+    "sneak" |
+    "sprint" |
+    "left" |
+    "right" |
+    "back" |
+    "forward" |
+    "mobEffects" |
+    "chat" |
+    "command" |
+    "copyCoordinates" |
+    "copyFacingCoordinates" |
+    "toggleControlTips" |
+    "codeBuilder" |
+    "immersivereader" |
+    "emote" |
+    "menuTabLeft" |
+    "menuTabRight" |
+    "menuCancel";
+
 declare const game: Game;

definitions/index.d.ts

@@ -1,4 +1,5 @@
 /// <reference path="./script.d.ts" />
+/// <reference path="./plugin.d.ts" />
 /// <reference path="./game.d.ts" />
 /// <reference path="./latite.d.ts" />
 
@@ -17,6 +18,10 @@
 /// <reference path="./gfx/graphics3.d.ts" />
 /// <reference path="./gfx/Texture.d.ts" />
 
+/// <reference path="./molang/Variable.d.ts" />
+/// <reference path="./molang/Variables.d.ts" />
+
+/// <reference path="./native/NativeModule.d.ts" />
 
 /// <reference path="./feature/command.d.ts" />
 /// <reference path="./feature/module.d.ts" />

definitions/latite.d.ts

@@ -6,7 +6,7 @@ interface CancellableEvent extends LatiteEvent {
 }
 
 interface SendChatEvent extends CancellableEvent {
-    message: string;
+    readonly message: string;
 }
 
 type MessageType = 
@@ -23,21 +23,21 @@ type MessageType =
     "object_whisper";
 
 interface MessageEvent extends CancellableEvent {
-    type: MessageType;
+    readonly type: MessageType;
     /**
      * Whether or not the message type is a chat message.
      */
-    isChat: boolean;
-    message: string;
+    readonly isChat: boolean;
+    readonly message: string;
 
     /**
      * The sender of the message (if applicable)
      */
-    sender: string;
+    readonly sender: string;
     /**
      * The Xbox User ID of the sender (if applicable)
      */
-    xuid: string;
+    readonly xuid: string;
 }
 
 declare const enum MouseButton {
@@ -48,22 +48,22 @@ declare const enum MouseButton {
 }
 
 interface ClickEvent extends CancellableEvent {
-    button: MouseButton;
-    isDown: boolean;
-    mouseX: number;
-    mouseY: number;
+    readonly button: MouseButton;
+    readonly isDown: boolean;
+    readonly mouseX: number;
+    readonly mouseY: number;
 }
 
 interface KeyEvent extends CancellableEvent {
-    isDown: boolean;
-    keyCode: KeyCode; // like 0x43
-    keyAsChar: string; // like 'C'
+    readonly isDown: boolean;
+    readonly keyCode: KeyCode; // like 0x43
+    readonly keyAsChar: string; // like 'C'
 }
 
 interface ScriptEvent extends LatiteEvent {
-    scriptName: string,
-    scriptVersion: string,
-    scriptAuthor: string
+    readonly scriptName: string,
+    readonly scriptVersion: string,
+    readonly scriptAuthor: string
 }
 
 type TitleType =
@@ -78,8 +78,12 @@ type TitleType =
     "times";
 
 interface TitleEvent extends CancellableEvent {
-    type: TitleType;
-    text: string;
+    readonly type: TitleType;
+    readonly text: string;
+}
+
+interface TextInputEvent extends CancellableEvent {
+    readonly characters: string;
 }
 
 interface ClientEvents {
@@ -207,6 +211,18 @@ interface ClientEvents {
     * ```
     */
     "title": TitleEvent;
+
+    /**
+     * Called whenever text input is received.
+     * 
+     * ```ts
+     * Listener:
+     * {
+     *   characters: string
+     * }
+     * ```
+     */
+    "text-input": TextInputEvent;
 }
 
 interface Latite {

definitions/lib/filesystem.d.ts

@@ -3,40 +3,47 @@ declare namespace include {
         /**
          * Reads a file asynchronously.
          * @param path The path to read from.
-         * @param callback 
+         * @param callback This will get called when the operation is finished
          */
-        read(path: string, callback: (err: number, content: Buffer) => void): void;
+        readAsync(path: string, callback: (err: number, content: Buffer) => void): void;
 
         /**
          * 
          * @param path The path to write to
          * @param data The data to write (see util.stringToBuffer to convert a string to a buffer)
-         * @param callback 
+         * @param callback This will get called when the operation is finished
          */
-        write(path: string, data: Buffer, callback: (err: number) => void): void;
+        writeAsync(path: string, data: Buffer, callback: (err: number) => void): void;
 
         /**
          * Reads a file from the path specified.
          * @param path The relative path from the script.
          */
-        readSync(path: string): Buffer;
+        read(path: string): Buffer;
         /**
          * Writes a file to the path specified.
          * @param path The relative path from the script.
-         * @param data The data to write.
+         * @param data The data to write. For example, `util.stringToBuffer("hello")`
          */
-        writeSync(path: string, data: Buffer): void;
+        write(path: string, data: Buffer): void;
 
         /**
          * Checks if a file or a directory exists
          * @param path The path to check if a file or directory exists
          */
-        existsSync(path: string): boolean;
+        exists(path: string): boolean;
 
         /**
          * Creates a folder/directory.
          * @param path The path to create a directory.
          */
-        createDirectorySync(path: string): void;
+        createDirectory(path: string): void;
+
+        /**
+         * 
+         * @param path The path to append to the file.
+         * @param data The data to append, for example, `util.bufferToString("hello")`
+         */
+        append(path: string, data: Buffer): void;
     }
 }

definitions/lib/network.d.ts

@@ -28,29 +28,29 @@ declare namespace include {
          * @param url The URL to send the request.
          * @param data 
          */
-        getSync(url: string, data?: GetData): HttpResponse;
+        get(url: string, data?: GetData): HttpResponse;
 
         /**
          * Sends an async GET request to a URL.
          * @param url The URL to send the request.
          * @param data 
          * @param callback 
          */
-        get(url: string, data: GetData, callback: (resp: HttpResponse) => void): void;
+        getAsync(url: string, data: GetData, callback: (resp: HttpResponse) => void): void;
 
         /**
          * Sends a basic POST request to a URL.
          * @param url The URL to send a POST request.
          * @param data 
          */
-        postSync(url: string, data?: PostData): HttpResponse;
+        post(url: string, data?: PostData): HttpResponse;
 
         /**
          * Sends an async POST request to a URL.
          * @param url The URL to send the request.
          * @param data 
          * @param callback 
          */
-        //post(url: string, data: GetData, callback: (err: number, resp: HttpResponse) => void): void;
+        //postAsync(url: string, data: GetData, callback: (err: number, resp: HttpResponse) => void): void;
     }
 }

definitions/native/NativeModule.d.ts

@@ -0,0 +1,31 @@
+type NativeType = "void" | "float32" | "float64" | "int32" | "int64";
+
+/**
+ * A class representing a native DLL.
+ */
+declare class NativeModule {
+    /**
+     * Gets a module that's currently loaded.
+     * 
+     * The plugin needs the permission `Permission.SystemAccess` to use this.
+     * 
+     * This method is restricted to prevent cheating.
+     * @param moduleName The module name, e.g. `"User32.dll"`
+     */
+    static get(moduleName: string): NativeModule | null;
+
+    /**
+     * The current handle of the module. Warning: will be truncated to Float64
+     */
+    readonly handle: number;
+
+    /**
+     * Calls a function.
+     * 
+     * This method is restricted to prevent cheating.
+     * @param functionName The procedure name.
+     * @param returnType The return type that is expected.
+     * @param args Arguments to pass to the function. The maximum arguments is 10.
+     */
+    public call(functionName: string, returnType: NativeType, ...args: any[]): number | undefined;
+}

definitions/plugin.d.ts

@@ -0,0 +1,19 @@
+declare const enum Permission {
+    SystemAccess = "permission.system_access",
+}
+
+interface IPlugin {
+    readonly name: string;
+    readonly author: string;
+    readonly version: string;
+    readonly description: string;
+
+    /**
+     * Requests a permission.
+     * @param permission The permissions to request.
+     * @returns Whether or not the permission was requested.
+     */
+    requestPermission(permission: Permission): boolean;    
+}
+
+declare const plugin: IPlugin;

definitions/script.d.ts

@@ -54,4 +54,28 @@ interface ScriptModule {
     exports: {}
 }
 
-declare const module: ScriptModule;
+interface IScript {
+    /**
+     * @deprecated
+     */
+    name: string;
+
+    /**
+     * @deprecated
+     */
+    author: string;
+
+    /**
+     * @deprecated
+     */
+    description: string;
+
+    /**
+     * @deprecated
+     * @param values 
+     * @returns 
+     */
+    log: (... values: any[]) => void 
+}
+
+declare var script: IScript;