@tlua/gmod 1.0.1

package/input.d.tlua

@@ -0,0 +1,252 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The input library allows you to gather information about the clients input devices (mouse & keyboard), such as the cursor position and whether a key is pressed or not.
+ * @source https://wiki.facepunch.com/gmod/input
+ */
+declare input: InputLib;
+
+interface InputLib {
+    /**
+     * Returns the last key captured by key trapping.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.CheckKeyTrapping
+     */
+    CheckKeyTrapping(): number;
+}
+
+interface InputLib {
+    /**
+     * Returns the digital value of an analog stick on the current (set up via convars) controller.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.GetAnalogValue
+     */
+    GetAnalogValue(axis: ANALOG): number;
+}
+
+interface InputLib {
+    /**
+     * Returns the cursor's position on the screen.
+     * On macOS, the cursor isn't locked on the middle of the screen which causes a significant offset of the positions returned by this function.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.GetCursorPos
+     */
+    GetCursorPos(): (number, number);
+}
+
+interface InputLib {
+    /**
+     * Gets the button code from a button name. This is opposite of [input.GetKeyName](https://wiki.facepunch.com/gmod/input.GetKeyName).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.GetKeyCode
+     */
+    GetKeyCode(button: string): BUTTON_CODE;
+}
+
+interface InputLib {
+    /**
+     * Gets the button name from a numeric button code. The name needs to be
+     * translated with language.GetPhrase before being displayed.
+     *
+     * NOTE: Despite the name of the function, this also works for the full range
+     * of keys in Enums/BUTTON_CODE.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/input.GetKeyName
+     */
+    GetKeyName(button: BUTTON_CODE | number): string;
+}
+
+
+interface InputLib {
+    /**
+     * Gets whether the specified button code is down.
+     *
+     * Unlike input.IsKeyDown this can also detect joystick presses from
+     * Enums/JOYSTICK.
+     * @realm client
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/input.IsButtonDown
+     */
+    IsButtonDown(button: BUTTON_CODE | number): boolean;
+}
+
+
+interface InputLib {
+    /**
+     * Returns whether a control key is being pressed.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.IsControlDown
+     */
+    IsControlDown(): boolean;
+}
+
+interface InputLib {
+    /**
+     * Gets whether a key is down.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.IsKeyDown
+     */
+    IsKeyDown(key: number): boolean;
+}
+
+interface InputLib {
+    /**
+     * Returns whether key trapping is activate and the next key press will be captured.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.IsKeyTrapping
+     */
+    IsKeyTrapping(): boolean;
+}
+
+interface InputLib {
+    /**
+     * Gets whether a mouse button is down.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.IsMouseDown
+     */
+    IsMouseDown(mouseKey: number): boolean;
+}
+
+interface InputLib {
+    /**
+     * Gets whether a shift key is being pressed
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.IsShiftDown
+     */
+    IsShiftDown(): boolean;
+}
+
+interface InputLib {
+    /**
+     * Returns the client's bound key for the specified console command. If the player has multiple keys bound to a single command, then the key with the lowest [Enums/BUTTON_CODE](https://wiki.facepunch.com/gmod/Enums/BUTTON_CODE) will be returned.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.LookupBinding
+     */
+    LookupBinding(binding: string, exact?: boolean): string;
+}
+
+interface InputLib {
+    /**
+     * Returns the bind string that the given key is bound to.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.LookupKeyBinding
+     */
+    LookupKeyBinding(key: BUTTON_CODE): string;
+}
+
+interface InputLib {
+    /**
+     * Switches to the provided weapon on the next CUserCmd generation/CreateMove call. Direct binding to [CInput::MakeWeaponSelection](https://github.com/ValveSoftware/source-sdk-2013/blob/39f6dde8fbc238727c020d13b05ecadd31bda4c0/src/game/client/in_main.cpp#L989-L992).
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/input.SelectWeapon
+     */
+    SelectWeapon(weapon: Weapon): void;
+}
+
+interface InputLib {
+    /**
+     * Sets the cursor's position on the screen, relative to the topleft corner of the window
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.SetCursorPos
+     */
+    SetCursorPos(mouseX: number, mouseY: number): void;
+}
+
+interface InputLib {
+    /**
+     * Begins waiting for a key to be pressed so we can save it for [input.CheckKeyTrapping](https://wiki.facepunch.com/gmod/input.CheckKeyTrapping). Used by the [DBinder](https://wiki.facepunch.com/gmod/DBinder).
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.StartKeyTrapping
+     */
+    StartKeyTrapping(): void;
+}
+
+interface InputLib {
+    /**
+     * Translates a console command alias, basically reverse of the `alias` console command.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.TranslateAlias
+     */
+    TranslateAlias(command: string): string;
+}
+
+interface InputLib {
+    /**
+     * Returns whether a key was initially pressed in the same frame this function was called.
+     *
+     * This function only works in Move hooks, and will detect key presses even in main menu or when a typing in a text field.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.WasKeyPressed
+     */
+    WasKeyPressed(key: number): boolean;
+}
+
+interface InputLib {
+    /**
+     * Returns whether a key was released in the same frame this function was called.
+     *
+     * This function only works in Move hooks, and will detect key releases even in main menu or when a typing in a text field.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.WasKeyReleased
+     */
+    WasKeyReleased(key: number): boolean;
+}
+
+interface InputLib {
+    /**
+     * Returns whether the key is being held down or not.
+     *
+     * This function only works in Move hooks, and will detect key events even in main menu or when a typing in a text field.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.WasKeyTyped
+     */
+    WasKeyTyped(key: number): boolean;
+}
+
+interface InputLib {
+    /**
+     * Returns whether a mouse key was double pressed in the same frame this function was called.
+     *
+     *
+     * If this function returns true, [input.WasMousePressed](https://wiki.facepunch.com/gmod/input.WasMousePressed) will return false.
+     *
+     * This function only works in Move hooks, and will detect mouse events even in main menu or when a typing in a text field.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.WasMouseDoublePressed
+     */
+    WasMouseDoublePressed(button: number): boolean;
+}
+
+interface InputLib {
+    /**
+     * Returns whether a mouse key was initially pressed in the same frame this function was called.
+     *
+     *
+     * If [input.WasMouseDoublePressed](https://wiki.facepunch.com/gmod/input.WasMouseDoublePressed) returns true, this function will return false.
+     *
+     * This function only works in Move hooks, and will detect mouse events even in main menu or when a typing in a text field.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.WasMousePressed
+     */
+    WasMousePressed(key: number): boolean;
+}
+
+interface InputLib {
+    /**
+     * Returns whether a mouse key was released in the same frame this function was called.
+     *
+     * This function only works in Move hooks, and will detect mouse events even in main menu or when a typing in a text field.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/input.WasMouseReleased
+     */
+    WasMouseReleased(key: number): boolean;
+}
+

package/invalidateinternalentitycache.d.tlua

@@ -0,0 +1,13 @@
+// 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.
+ *
+ * Called by the engine before [GM:OnEntityCreated](https://wiki.facepunch.com/gmod/GM:OnEntityCreated) and after [GM:EntityRemoved](https://wiki.facepunch.com/gmod/GM:EntityRemoved) hooks are called.
+ * Internally used to clear the [player.Iterator](https://wiki.facepunch.com/gmod/player.Iterator) or [ents.Iterator](https://wiki.facepunch.com/gmod/ents.Iterator) cache
+ *
+ * @realm shared
+ * @source https://wiki.facepunch.com/gmod/InvalidateInternalEntityCache
+ */
+declare function InvalidateInternalEntityCache(isPly: boolean): void;
+

package/irestore.d.tlua

@@ -0,0 +1,94 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The object used in the [saverestore](https://wiki.facepunch.com/gmod/saverestore), mainly in [saverestore.AddRestoreHook](https://wiki.facepunch.com/gmod/saverestore.AddRestoreHook).
+ *
+ * It allows you to read blocks directly from the save game files used by Half-Life 2 save system when such save is loaded.
+ * @source https://wiki.facepunch.com/gmod/IRestore
+ */
+interface IRestore {}
+
+interface IRestore {
+    /**
+     * Ends current data block started with [IRestore:StartBlock](https://wiki.facepunch.com/gmod/IRestore:StartBlock) and returns to the parent block.
+     *
+     * To avoid all sorts of errors, you **must** end all blocks you start.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:EndBlock
+     */
+    EndBlock(self: IRestore): void;
+}
+
+interface IRestore {
+    /**
+     * Reads next bytes from the restore object as an [Angle](https://wiki.facepunch.com/gmod/Angle).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:ReadAngle
+     */
+    ReadAngle(self: IRestore): Angle;
+}
+
+interface IRestore {
+    /**
+     * Reads next bytes from the restore object as a [boolean](https://wiki.facepunch.com/gmod/boolean).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:ReadBool
+     */
+    ReadBool(self: IRestore): boolean;
+}
+
+interface IRestore {
+    /**
+     * Reads next bytes from the restore object as an [Entity](https://wiki.facepunch.com/gmod/Entity).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:ReadEntity
+     */
+    ReadEntity(self: IRestore): Entity;
+}
+
+interface IRestore {
+    /**
+     * Reads next bytes from the restore object as a floating point [number](https://wiki.facepunch.com/gmod/number).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:ReadFloat
+     */
+    ReadFloat(self: IRestore): number;
+}
+
+interface IRestore {
+    /**
+     * Reads next bytes from the restore object as an integer [number](https://wiki.facepunch.com/gmod/number).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:ReadInt
+     */
+    ReadInt(self: IRestore): number;
+}
+
+interface IRestore {
+    /**
+     * Reads next bytes from the restore object as a [string](https://wiki.facepunch.com/gmod/string).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:ReadString
+     */
+    ReadString(self: IRestore): string;
+}
+
+interface IRestore {
+    /**
+     * Reads next bytes from the restore object as a [Vector](https://wiki.facepunch.com/gmod/Vector).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:ReadVector
+     */
+    ReadVector(self: IRestore): Vector;
+}
+
+interface IRestore {
+    /**
+     * Loads next block of data to be read inside current block. Blocks **must** be ended with [IRestore:EndBlock](https://wiki.facepunch.com/gmod/IRestore:EndBlock).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/IRestore:StartBlock
+     */
+    StartBlock(self: IRestore): string;
+}
+

package/isave.d.tlua

@@ -0,0 +1,94 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The object used in the [saverestore](https://wiki.facepunch.com/gmod/saverestore), mainly in [saverestore.AddSaveHook](https://wiki.facepunch.com/gmod/saverestore.AddSaveHook).
+ *
+ * It allows you to write blocks directly into the save game files used by Half-Life 2 save system when such save is being saved.
+ * @source https://wiki.facepunch.com/gmod/ISave
+ */
+interface ISave {}
+
+interface ISave {
+    /**
+     * Ends current data block started with [ISave:StartBlock](https://wiki.facepunch.com/gmod/ISave:StartBlock) and returns to the parent block.
+     *
+     * To avoid all sorts of errors, you **must** end all blocks you start.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:EndBlock
+     */
+    EndBlock(self: ISave): void;
+}
+
+interface ISave {
+    /**
+     * Starts a new block of data that you can write to inside current block. Blocks **must** be ended with [ISave:EndBlock](https://wiki.facepunch.com/gmod/ISave:EndBlock).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:StartBlock
+     */
+    StartBlock(self: ISave, name: string): void;
+}
+
+interface ISave {
+    /**
+     * Writes an [Angle](https://wiki.facepunch.com/gmod/Angle) to the save object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:WriteAngle
+     */
+    WriteAngle(self: ISave, ang: Angle): void;
+}
+
+interface ISave {
+    /**
+     * Writes a [boolean](https://wiki.facepunch.com/gmod/boolean) to the save object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:WriteBool
+     */
+    WriteBool(self: ISave, bool: boolean): void;
+}
+
+interface ISave {
+    /**
+     * Writes an [Entity](https://wiki.facepunch.com/gmod/Entity) to the save object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:WriteEntity
+     */
+    WriteEntity(self: ISave, ent: Entity): void;
+}
+
+interface ISave {
+    /**
+     * Writes a floating point [number](https://wiki.facepunch.com/gmod/number) to the save object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:WriteFloat
+     */
+    WriteFloat(self: ISave, float: number): void;
+}
+
+interface ISave {
+    /**
+     * Writes an integer [number](https://wiki.facepunch.com/gmod/number) to the save object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:WriteInt
+     */
+    WriteInt(self: ISave, int: number): void;
+}
+
+interface ISave {
+    /**
+     * Writes a **null terminated** [string](https://wiki.facepunch.com/gmod/string) to the save object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:WriteString
+     */
+    WriteString(self: ISave, str: string): void;
+}
+
+interface ISave {
+    /**
+     * Writes a [Vector](https://wiki.facepunch.com/gmod/Vector) to the save object.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/ISave:WriteVector
+     */
+    WriteVector(self: ISave, vec: Vector): void;
+}
+

package/itexture.d.tlua

@@ -0,0 +1,108 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * An object representing game texture, such as those loaded from a `.vtf` file.
+ *
+ * Do not confuse with [IMaterial](https://wiki.facepunch.com/gmod/IMaterial). Materials use textures. Game uses materials.
+ *
+ * Returned by [IMaterial:GetTexture](https://wiki.facepunch.com/gmod/IMaterial:GetTexture)
+ *
+ * @source https://wiki.facepunch.com/gmod/ITexture
+ */
+interface ITexture {}
+
+interface ITexture {
+    /**
+     * Invokes the generator of the texture. Reloads file based textures from disk and clears render target textures.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:Download
+     */
+    Download(self: ITexture): void;
+}
+
+interface ITexture {
+    /**
+     * Returns the color of the specified pixel, only works for textures created from PNG files.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:GetColor
+     */
+    GetColor(self: ITexture, x: number, y: number): Color;
+}
+
+interface ITexture {
+    /**
+     * Returns the true unmodified height of the texture.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:GetMappingHeight
+     */
+    GetMappingHeight(self: ITexture): number;
+}
+
+interface ITexture {
+    /**
+     * Returns the true unmodified width of the texture.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:GetMappingWidth
+     */
+    GetMappingWidth(self: ITexture): number;
+}
+
+interface ITexture {
+    /**
+     * Returns the name of the texture, in most cases the path.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:GetName
+     */
+    GetName(self: ITexture): string;
+}
+
+interface ITexture {
+    /**
+     * Returns the number of animation frames in this texture.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:GetNumAnimationFrames
+     */
+    GetNumAnimationFrames(self: ITexture): number;
+}
+
+interface ITexture {
+    /**
+     * Returns the modified height of the texture, this value may be affected by mipmapping and other factors.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:Height
+     */
+    Height(self: ITexture): number;
+}
+
+interface ITexture {
+    /**
+     * Returns whenever the texture is valid. (i.e. was loaded successfully or not)
+     *
+     * **NOTE**: The "error" texture is a valid texture, and therefore this function will return false when used on it. Use [ITexture:IsErrorTexture](https://wiki.facepunch.com/gmod/ITexture:IsErrorTexture), instead.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:IsError
+     */
+    IsError(self: ITexture): boolean;
+}
+
+interface ITexture {
+    /**
+     * Returns whenever the texture is the error texture (pink and black checkerboard pattern).
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:IsErrorTexture
+     */
+    IsErrorTexture(self: ITexture): boolean;
+}
+
+interface ITexture {
+    /**
+     * Returns the modified width of the texture, this value may be affected by mipmapping and other factors.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/ITexture:Width
+     */
+    Width(self: ITexture): number;
+}
+

package/ivideowriter.d.tlua

@@ -0,0 +1,53 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * This is returned from [video.Record](https://wiki.facepunch.com/gmod/video.Record).
+ * @source https://wiki.facepunch.com/gmod/IVideoWriter
+ */
+interface IVideoWriter {}
+
+interface IVideoWriter {
+    /**
+     * Adds the current framebuffer to the video stream.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/IVideoWriter:AddFrame
+     */
+    AddFrame(self: IVideoWriter, frameTime: number, downsample: boolean): void;
+}
+
+interface IVideoWriter {
+    /**
+     * Ends the video recording and dumps it to disk.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/IVideoWriter:Finish
+     */
+    Finish(self: IVideoWriter): void;
+}
+
+interface IVideoWriter {
+    /**
+     * Returns the height of the video stream.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/IVideoWriter:Height
+     */
+    Height(self: IVideoWriter): number;
+}
+
+interface IVideoWriter {
+    /**
+     * Sets whether to record sound or not.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/IVideoWriter:SetRecordSound
+     */
+    SetRecordSound(self: IVideoWriter, record: boolean): void;
+}
+
+interface IVideoWriter {
+    /**
+     * Returns the width of the video stream.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/IVideoWriter:Width
+     */
+    Width(self: IVideoWriter): number;
+}
+