@tlua/gmod 1.0.1

package/file.d.tlua

@@ -0,0 +1,419 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The file library provides functions for finding, reading and writing to files.
+ * The following path values are most commonly used:
+ * * `LUA` searches the lua files (in /lua/, in your gamemodes, in all the addons).
+ * * `GAME` searches all the mounted content (main folder, addons, mounted games etc).
+ * * `MOD` searches only the garrysmod folder.
+ * * `DATA` searches in the data folder.
+ *
+ * See [File Search Paths](https://wiki.facepunch.com/gmod/File_Search_Paths) for the descriptive list of path values.
+ * For the full list of path values, type `path` in the console.
+ * @source https://wiki.facepunch.com/gmod/file
+ */
+declare file: FileLib;
+
+interface File {
+    /**
+     * Dumps the file changes to disk and closes the file handle which makes the handle useless.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:Close
+     */
+    Close(self: File): void;
+}
+
+interface File {
+    /**
+     * Returns whether the [File](https://wiki.facepunch.com/gmod/File) object has reached the end of file or not.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:EndOfFile
+     */
+    EndOfFile(self: File): boolean;
+}
+
+interface File {
+    /**
+     * Dumps the file changes to disk and saves the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:Flush
+     */
+    Flush(self: File): void;
+}
+
+interface File {
+    /**
+     * Reads the specified amount of chars and returns them as a binary string.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:Read
+     */
+    Read(self: File, length?: number): string;
+}
+
+interface File {
+    /**
+     * Reads one byte of the file and returns whether that byte was not 0.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadBool
+     */
+    ReadBool(self: File): boolean;
+}
+
+interface File {
+    /**
+     * Reads one unsigned 8-bit integer from the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadByte
+     */
+    ReadByte(self: File): number;
+}
+
+interface File {
+    /**
+     * Reads an 8-byte little-endian IEEE-754 floating point double from the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadDouble
+     */
+    ReadDouble(self: File): number;
+}
+
+interface File {
+    /**
+     * Reads an IEEE 754 little-endian 4-byte float from the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadFloat
+     */
+    ReadFloat(self: File): number;
+}
+
+interface File {
+    /**
+     * Returns the contents of the file from the current position up until the end of the current line.
+     *
+     * **NOTE**: This function will look specifically for `Line Feed` characters `\n` and will **completely ignore `Carriage Return` characters** `\r`.
+     *
+     * It will also stop at a `\0` or `NULL` character, but will add a new line instead.
+     *
+     * This function will not return more than 8192 characters. The return value will include the `\n` character.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadLine
+     */
+    ReadLine(self: File): string;
+}
+
+interface File {
+    /**
+     * Reads a signed little-endian 32-bit integer from the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadLong
+     */
+    ReadLong(self: File): number;
+}
+
+interface File {
+    /**
+     * Reads a signed little-endian 16-bit integer from the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadShort
+     */
+    ReadShort(self: File): number;
+}
+
+interface File {
+    /**
+     * Reads an unsigned 64-bit integer from the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadUInt64
+     */
+    ReadUInt64(self: File): string;
+}
+
+interface File {
+    /**
+     * Reads an unsigned little-endian 32-bit integer from the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadULong
+     */
+    ReadULong(self: File): number;
+}
+
+interface File {
+    /**
+     * Reads an unsigned little-endian 16-bit integer from the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:ReadUShort
+     */
+    ReadUShort(self: File): number;
+}
+
+interface File {
+    /**
+     * Sets the file pointer to the specified position.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:Seek
+     */
+    Seek(self: File, pos: number): void;
+}
+
+interface File {
+    /**
+     * Returns the size of the file in bytes.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:Size
+     */
+    Size(self: File): number;
+}
+
+interface File {
+    /**
+     * Moves the file pointer by the specified amount of chars.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:Skip
+     */
+    Skip(self: File, amount: number): number;
+}
+
+interface File {
+    /**
+     * Returns the current position of the file pointer.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:Tell
+     */
+    Tell(self: File): number;
+}
+
+interface File {
+    /**
+     * Writes the given string into the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:Write
+     */
+    Write(self: File, data: string): void;
+}
+
+interface File {
+    /**
+     * Writes a boolean value to the file as one **byte**.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteBool
+     */
+    WriteBool(self: File, bool: boolean): void;
+}
+
+interface File {
+    /**
+     * Write an 8-bit unsigned integer to the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteByte
+     */
+    WriteByte(self: File, uint8: number): void;
+}
+
+interface File {
+    /**
+     * Writes an 8-byte little-endian IEEE-754 floating point double to the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteDouble
+     */
+    WriteDouble(self: File, double: number): void;
+}
+
+interface File {
+    /**
+     * Writes an IEEE 754 little-endian 4-byte float to the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteFloat
+     */
+    WriteFloat(self: File, float: number): void;
+}
+
+interface File {
+    /**
+     * Writes a signed little-endian 32-bit integer to the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteLong
+     */
+    WriteLong(self: File, int32: number): void;
+}
+
+interface File {
+    /**
+     * Writes a signed little-endian 16-bit integer to the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteShort
+     */
+    WriteShort(self: File, int16: number): void;
+}
+
+interface File {
+    /**
+     * Writes an unsigned 64-bit integer to the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteUInt64
+     */
+    WriteUInt64(self: File, uint64: string): void;
+}
+
+interface File {
+    /**
+     * Writes an unsigned little-endian 32-bit integer to the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteULong
+     */
+    WriteULong(self: File, uint32: number): void;
+}
+
+interface File {
+    /**
+     * Writes an unsigned little-endian 16-bit integer to the file.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/File:WriteUShort
+     */
+    WriteUShort(self: File, uint16: number): void;
+}
+
+interface FileLib {
+    /**
+     * Appends data to a file in the `data/` folder.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Append
+     */
+    Append(name: string, content: string): boolean;
+}
+
+interface FileLib {
+    /**
+     * Returns the content of a file asynchronously.
+     *
+     * All limitations of [file.Read](https://wiki.facepunch.com/gmod/file.Read) also apply.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/file.AsyncRead
+     */
+    AsyncRead(fileName: string, gamePath: string, callback: (fileName: string, gamePath: string, status: number, data: string) => void, sync?: boolean): FSASYNC;
+}
+
+interface FileLib {
+    /**
+     * Creates a directory that is relative to the `data` folder.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.CreateDir
+     */
+    CreateDir(name: string): void;
+}
+
+interface FileLib {
+    /**
+     * Deletes a file or `empty` folder that is relative to the **data** folder. You can't remove any files outside of **data** folder.
+     * **NOTE**: You are able to delete **any** file in the Menu state.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Delete
+     */
+    Delete(name: string, path?: string): boolean;
+}
+
+interface FileLib {
+    /**
+     * 		Returns a boolean of whether the file or directory exists or not.
+     * 		If you want to check for a directory, [file.IsDir](https://wiki.facepunch.com/gmod/file.IsDir) will be faster since it won't check for files.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Exists
+     */
+    Exists(name: string, gamePath: string): boolean;
+}
+
+interface FileLib {
+    /**
+     * 		Returns a list of files and directories inside a single folder.
+     * 		**WARNING**: It seems that paths with capital letters (e.g. lua/MyFolder/*) don't work as expected on Linux.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Find
+     */
+    Find(name: string, path: string, sorting?: string): (table, table);
+}
+
+interface FileLib {
+    /**
+     * Returns whether the given file is a directory or not.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.IsDir
+     */
+    IsDir(fileName: string, gamePath: string): boolean;
+}
+
+interface FileLib {
+    /**
+     * Attempts to open a file with the given mode.
+     * 		**WARNING**: When trying to open files with the following characteristics, it returns nil:
+     *
+     * the file extension is ".db; .mdmp; .dmp" or
+     * the file is "server.cfg; autoexec.cfg; config.cfg; listenserver.cfg; mount.cfg"
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Open
+     */
+    Open(fileName: string, fileMode: string, gamePath: string): file_class;
+}
+
+interface FileLib {
+    /**
+     * Returns the content of a file.
+     *
+     * **WARNING**: Beware of casing -- some filesystems are case-sensitive. SRCDS on Linux seems to force file/directory creation to lowercase, but will not modify read operations.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Read
+     */
+    Read(fileName: string, gamePath?: string): string;
+}
+
+interface FileLib {
+    /**
+     * Attempts to rename a file with the given name to another given name.
+     *
+     * This function is constrained to the `data/` folder.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Rename
+     */
+    Rename(orignalFileName: string, targetFileName: string): boolean;
+}
+
+interface FileLib {
+    /**
+     * Returns the file's size in bytes.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Size
+     */
+    Size(fileName: string, gamePath: string): number;
+}
+
+interface FileLib {
+    /**
+     * Returns when the file or folder was last modified in Unix time.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Time
+     */
+    Time(path: string, gamePath: string): number;
+}
+
+interface FileLib {
+    /**
+     * Writes the given string to a file. Erases all previous data in the file. To add data without deleting previous data, use [file.Append](https://wiki.facepunch.com/gmod/file.Append).
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/file.Write
+     */
+    Write(fileName: string, content: string): boolean;
+}
+

package/file_class.d.tlua

@@ -0,0 +1,7 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+interface File {}
+
+// The `file_class` value-side type inherits the File methods.
+interface file_class extends File {}
+

package/fingerposer.d.tlua

@@ -0,0 +1,12 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		**INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+ *
+ * 		A panel used by Sandbox's Finger Poser tool.
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/fingerposer
+ */
+interface fingerposer extends ContextBase {}
+

package/fingervar.d.tlua

@@ -0,0 +1,13 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		**INTERNAL**: Used by the [fingerposer](https://wiki.facepunch.com/gmod/fingerposer) panel.
+ *
+ *
+ * 		A panel used by Sandbox's Finger Poser tool.
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/FingerVar
+ */
+interface FingerVar extends Panel {}
+

package/frame.d.tlua

@@ -0,0 +1,11 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		A window that in which you can place just about every other component and even another frame.
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/Frame
+ * @deprecated You should use DFrame instead.
+ */
+interface Frame extends Panel {}
+

package/frame_blend.d.tlua

@@ -0,0 +1,105 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The frame blending library.
+ * @source https://wiki.facepunch.com/gmod/frame_blend
+ */
+declare frame_blend: Frame_blendLib;
+
+interface Frame_blendLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Adds a frame to the blend. Calls [frame_blend.CompleteFrame](https://wiki.facepunch.com/gmod/frame_blend.CompleteFrame) once enough frames have passed since last [frame_blend.CompleteFrame](https://wiki.facepunch.com/gmod/frame_blend.CompleteFrame) call.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/frame_blend.AddFrame
+     */
+    AddFrame(): void;
+}
+
+interface Frame_blendLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Blends the frame(s).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/frame_blend.BlendFrame
+     */
+    BlendFrame(): void;
+}
+
+interface Frame_blendLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Renders the frame onto internal render target.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/frame_blend.CompleteFrame
+     */
+    CompleteFrame(): void;
+}
+
+interface Frame_blendLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Actually draws the frame blend effect.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/frame_blend.DrawPreview
+     */
+    DrawPreview(): void;
+}
+
+interface Frame_blendLib {
+    /**
+     * Returns whether frame blend post processing effect is enabled or not.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/frame_blend.IsActive
+     */
+    IsActive(): boolean;
+}
+
+interface Frame_blendLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     *
+     * Returns whether the current frame is the last frame?
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/frame_blend.IsLastFrame
+     */
+    IsLastFrame(): boolean;
+}
+
+interface Frame_blendLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Returns amount of frames needed to render?
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/frame_blend.RenderableFrames
+     */
+    RenderableFrames(): number;
+}
+
+interface Frame_blendLib {
+    /**
+     * Returns whether we should skip frame or not.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/frame_blend.ShouldSkipFrame
+     */
+    ShouldSkipFrame(): boolean;
+}
+