@tlua/gmod 1.0.5 → 1.0.6

package/types/input.d.tlua

@@ -13,12 +13,14 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.CheckKeyTrapping
      */
     CheckKeyTrapping(): number;
+
     /**
      * 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;
+
     /**
      * 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.
@@ -27,12 +29,14 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.GetCursorPos
      */
     GetCursorPos(): (number, number);
+
     /**
      * 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;
+
     /**
      * Gets the button name from a numeric button code. The name needs to be
      * translated with language.GetPhrase before being displayed.
@@ -44,6 +48,7 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.GetKeyName
      */
     GetKeyName(button: BUTTON_CODE | number): string;
+
     /**
      * Gets whether the specified button code is down.
      *
@@ -54,72 +59,84 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.IsButtonDown
      */
     IsButtonDown(button: BUTTON_CODE | number): boolean;
+
     /**
      * Returns whether a control key is being pressed.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/input.IsControlDown
      */
     IsControlDown(): boolean;
+
     /**
      * Gets whether a key is down.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/input.IsKeyDown
      */
     IsKeyDown(key: number): boolean;
+
     /**
      * 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;
+
     /**
      * Gets whether a mouse button is down.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/input.IsMouseDown
      */
     IsMouseDown(mouseKey: number): boolean;
+
     /**
      * Gets whether a shift key is being pressed
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/input.IsShiftDown
      */
     IsShiftDown(): boolean;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * Returns whether a key was initially pressed in the same frame this function was called.
      *
@@ -129,6 +146,7 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.WasKeyPressed
      */
     WasKeyPressed(key: number): boolean;
+
     /**
      * Returns whether a key was released in the same frame this function was called.
      *
@@ -138,6 +156,7 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.WasKeyReleased
      */
     WasKeyReleased(key: number): boolean;
+
     /**
      * Returns whether the key is being held down or not.
      *
@@ -147,6 +166,7 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.WasKeyTyped
      */
     WasKeyTyped(key: number): boolean;
+
     /**
      * Returns whether a mouse key was double pressed in the same frame this function was called.
      *
@@ -159,6 +179,7 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.WasMouseDoublePressed
      */
     WasMouseDoublePressed(button: number): boolean;
+
     /**
      * Returns whether a mouse key was initially pressed in the same frame this function was called.
      *
@@ -171,6 +192,7 @@ interface InputLib {
      * @source https://wiki.facepunch.com/gmod/input.WasMousePressed
      */
     WasMousePressed(key: number): boolean;
+
     /**
      * Returns whether a mouse key was released in the same frame this function was called.
      *
@@ -181,28 +203,3 @@ interface InputLib {
      */
     WasMouseReleased(key: number): boolean;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/invalidateinternalentitycache.d.tlua

@@ -10,4 +10,3 @@
  * @source https://wiki.facepunch.com/gmod/InvalidateInternalEntityCache
  */
 declare function InvalidateInternalEntityCache(isPly: boolean): void;
-

package/types/irestore.d.tlua

@@ -16,48 +16,56 @@ interface IRestore {
      * @source https://wiki.facepunch.com/gmod/IRestore:EndBlock
      */
     EndBlock(self: IRestore): void;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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
@@ -65,13 +73,3 @@ interface IRestore {
      */
     StartBlock(self: IRestore): string;
 }
-
-
-
-
-
-
-
-
-
-

package/types/isave.d.tlua

@@ -16,48 +16,56 @@ interface ISave {
      * @source https://wiki.facepunch.com/gmod/ISave:EndBlock
      */
     EndBlock(self: ISave): void;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * Writes a [Vector](https://wiki.facepunch.com/gmod/Vector) to the save object.
      * @realm shared
@@ -65,13 +73,3 @@ interface ISave {
      */
     WriteVector(self: ISave, vec: Vector): void;
 }
-
-
-
-
-
-
-
-
-
-

package/types/itexture.d.tlua

@@ -16,6 +16,7 @@ interface ITexture {
      * @source https://wiki.facepunch.com/gmod/ITexture:Download
      */
     Download(self: ITexture): void;
+
     /**
      * Returns the color of the specified pixel, only works for textures created from PNG files.
      *
@@ -23,36 +24,42 @@ interface ITexture {
      * @source https://wiki.facepunch.com/gmod/ITexture:GetColor
      */
     GetColor(self: ITexture, x: number, y: number): Color;
+
     /**
      * Returns the true unmodified height of the texture.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ITexture:GetMappingHeight
      */
     GetMappingHeight(self: ITexture): number;
+
     /**
      * Returns the true unmodified width of the texture.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/ITexture:GetMappingWidth
      */
     GetMappingWidth(self: ITexture): number;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * Returns whenever the texture is valid. (i.e. was loaded successfully or not)
      *
@@ -63,12 +70,14 @@ interface ITexture {
      * @source https://wiki.facepunch.com/gmod/ITexture:IsError
      */
     IsError(self: ITexture): boolean;
+
     /**
      * 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;
+
     /**
      * Returns the modified width of the texture, this value may be affected by mipmapping and other factors.
      * @realm shared and menu
@@ -76,14 +85,3 @@ interface ITexture {
      */
     Width(self: ITexture): number;
 }
-
-
-
-
-
-
-
-
-
-
-

package/types/ivideowriter.d.tlua

@@ -11,24 +11,28 @@ interface IVideoWriter {
      * @source https://wiki.facepunch.com/gmod/IVideoWriter:AddFrame
      */
     AddFrame(self: IVideoWriter, frameTime: number, downsample: boolean): void;
+
     /**
      * 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;
+
     /**
      * Returns the height of the video stream.
      * @realm client and menu
      * @source https://wiki.facepunch.com/gmod/IVideoWriter:Height
      */
     Height(self: IVideoWriter): number;
+
     /**
      * 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;
+
     /**
      * Returns the width of the video stream.
      * @realm client and menu
@@ -36,9 +40,3 @@ interface IVideoWriter {
      */
     Width(self: IVideoWriter): number;
 }
-
-
-
-
-
-

package/types/jit.d.tlua

@@ -25,38 +25,40 @@ interface JitLib {
      * @deprecated This function was disabled due to security concerns.
      */
     attach(callback: function, event: string): void;
+
     /**
      * Flushes the whole cache of compiled code.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/jit.flush
      */
     flush(): void;
+
     /**
      * Disables LuaJIT Lua compilation.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/jit.off
      */
     off(): void;
+
     /**
      * Enables LuaJIT Lua compilation.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/jit.on
      */
     on(): void;
+
     opt: JitoptLib;
+
     /**
      * Returns the status of the JIT compiler and the current optimizations enabled.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/jit.status
      */
     status(): (boolean, any);
+
     util: JitutilLib;
 }
 
-
-
-
-
 interface JitoptLib {
     /**
      * JIT compiler optimization control. The opt sub-module provides the backend for the -O command line LuaJIT option.
@@ -78,8 +80,6 @@ interface JitoptLib {
     start(...: any): void;
 }
 
-
-
 interface JitutilLib {
     /**
      * Returns bytecode of a function at a position.
@@ -90,6 +90,7 @@ interface JitutilLib {
      * @source https://wiki.facepunch.com/gmod/jit.util.funcbc
      */
     funcbc(func: function, pos: number): (number, number);
+
     /**
      * Retrieves LuaJIT information about a given function, similarly to [debug.getinfo](https://wiki.facepunch.com/gmod/debug.getinfo). Possible table fields:
      * * linedefined: as for [debug.getinfo](https://wiki.facepunch.com/gmod/debug.getinfo)
@@ -112,6 +113,7 @@ interface JitutilLib {
      * @source https://wiki.facepunch.com/gmod/jit.util.funcinfo
      */
     funcinfo(func: function, pos?: number): table;
+
     /**
      * Gets a constant at a certain index in a function.
      *
@@ -128,6 +130,7 @@ interface JitutilLib {
      * @deprecated This function was disabled due to security concerns.
      */
     funck(func: function, index: number): any;
+
     /**
      * Does the exact same thing as [debug.getupvalue](https://wiki.facepunch.com/gmod/debug.getupvalue) except it only returns the name, not the name and the object. The upvalue indexes also start at 0 rather than 1, so doing `jit.util.funcuvname(func, 0)` will get you the same name as `debug.getupvalue(func, 1)`
      * **WARNING**: This function isn't officially documented on LuaJIT wiki, use it at your own risk.
@@ -138,6 +141,7 @@ interface JitutilLib {
      * @deprecated This function was disabled due to security concerns.
      */
     funcuvname(func: function, index: number): string;
+
     /**
      * 	Previously got the address of a function from a set list of functions, but now always returns `0` as it is deprecated.
      *
@@ -146,6 +150,7 @@ interface JitutilLib {
      * @deprecated This function was disabled due to security concerns.
      */
     ircalladdr(index: number): number;
+
     /**
      * 		Grabs the address of a function based on it's trace exit number. Grabbed via [jit.attach](https://wiki.facepunch.com/gmod/jit.attach) (with the texit event).
      *
@@ -154,6 +159,7 @@ interface JitutilLib {
      * @deprecated This function was disabled due to security concerns. It will always return 0.
      */
     traceexitstub(exitno: number): number;
+
     /**
      * Return table fields:
      * * link (number): the linked trace (0 for link types: none, return, interpreter)
@@ -167,24 +173,28 @@ interface JitutilLib {
      * @deprecated This function was disabled due to security concerns.
      */
     traceinfo(trace: number): table;
+
     /**
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/jit.util.traceir
      * @deprecated This function was disabled due to security concerns.
      */
     traceir(tr: number, index: number): (number, number, number, number, number);
+
     /**
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/jit.util.tracek
      * @deprecated This function was disabled due to security concerns.
      */
     tracek(tr: number, index: number): (any, number, number);
+
     /**
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/jit.util.tracemc
      * @deprecated This function was disabled due to security concerns. It will always return 3 `0`s.
      */
     tracemc(tr: number): (string, number, number);
+
     /**
      * Return table fields:
      * * 0 (ref) (number): first IR ref for the snapshot
@@ -198,14 +208,3 @@ interface JitutilLib {
      */
     tracesnap(tr: number, sn: number): table;
 }
-
-
-
-
-
-
-
-
-
-
-

package/types/killicon.d.tlua

@@ -13,24 +13,28 @@ interface KilliconLib {
      * @source https://wiki.facepunch.com/gmod/killicon.Add
      */
     Add(_class: string, texture: string, color: Color): void;
+
     /**
      * Creates kill icon from existing one.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/killicon.AddAlias
      */
     AddAlias(new_class: string, existing_class: string): void;
+
     /**
      * Adds kill icon for given weapon/entity class using special font.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/killicon.AddFont
      */
     AddFont(_class: string, font: string, symbol: string, color: Color, heightScale?: number): void;
+
     /**
      * Creates new kill icon using a sub-rectangle of a texture.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/killicon.AddTexCoord
      */
     AddTexCoord(_class: string, texture: string, color: Color, x: number, y: number, w: number, h: number): void;
+
     /**
      * Draws a kill icon.
      *
@@ -41,18 +45,21 @@ interface KilliconLib {
      * @deprecated This function applies unpredictable vertical offsets, you should use killicon.Render instead, which does not suffer from this issue.
      */
     Draw(x: number, y: number, name: string, alpha?: number): void;
+
     /**
      * Checks if kill icon exists for given class.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/killicon.Exists
      */
     Exists(_class: string): boolean;
+
     /**
      * Returns the size of a kill icon.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/killicon.GetSize
      */
     GetSize(name: string, dontEqualizeHeight?: boolean): (number, number);
+
     /**
      * Renders a kill icon.
      * @realm client
@@ -60,11 +67,3 @@ interface KilliconLib {
      */
     Render(x: number, y: number, name: string, alpha?: number, dontEqualizeHeight?: number): void;
 }
-
-
-
-
-
-
-
-

package/types/label.d.tlua

@@ -17,4 +17,3 @@ interface Label extends Panel {
      */
     SetTextColor(self: Label, color: Color): void;
 }
-

package/types/language.d.tlua

@@ -13,6 +13,7 @@ interface LanguageLib {
      * @source https://wiki.facepunch.com/gmod/language.Add
      */
     Add(placeholder: string, fulltext: string): void;
+
     /**
      * Retrieves the translated version of inputted string. Useful for concentrating multiple translated strings.
      * @realm client and menu
@@ -20,5 +21,3 @@ interface LanguageLib {
      */
     GetPhrase(phrase: string): string;
 }
-
-