@tlua/gmod 1.0.1

package/angle.d.tlua

@@ -0,0 +1,197 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * List of all possible functions to manipulate angles. Created by Global.Angle.
+ *
+ * Arithmetic operators are typed as metamethod members, which tlua dispatches
+ * ambiently on the declared type. The `number * Angle` form (scalar on the
+ * left) is a reverse overload the LuaLS `@operator` form could not express.
+ */
+interface Angle {
+    p: number;
+    y: number;
+    r: number;
+    pitch: number;
+    yaw: number;
+    roll: number;
+    x: number;
+    z: number;
+    [index: number]: number;
+    __add(l: Angle, r: Angle): Angle;
+    __sub(l: Angle, r: Angle): Angle;
+    __mul(l: Angle, r: number): Angle;
+    __mul(l: number, r: Angle): Angle;
+    __div(l: Angle, r: number): Angle;
+    __unm(a: Angle): Angle;
+}
+
+interface Angle {
+    /**
+     * Adds the values of the argument angle to the orignal angle.
+     *
+     * This functions the same as angle1 + angle2 without creating a new angle object, skipping object construction and garbage collection.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Add
+     */
+    Add(self: Angle, angle: Angle): void;
+}
+
+interface Angle {
+    /**
+     * Divides all values of the original angle by a scalar. This functions the same as angle1 / num without creating a new angle object, skipping object construction and garbage collection.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Div
+     */
+    Div(self: Angle, scalar: number): void;
+}
+
+interface Angle {
+    /**
+     * Returns a normal vector facing in the direction that the angle points.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Forward
+     */
+    Forward(self: Angle): Vector;
+}
+
+interface Angle {
+    /**
+     * Returns if the angle is equal to another angle with the given tolerance.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:IsEqualTol
+     */
+    IsEqualTol(self: Angle, compare: Angle, tolerance: number): boolean;
+}
+
+interface Angle {
+    /**
+     * Returns whether the pitch, yaw and roll are 0 or not.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:IsZero
+     */
+    IsZero(self: Angle): boolean;
+}
+
+interface Angle {
+    /**
+     * Multiplies a scalar to all the values of the orignal angle. This functions the same as num * angle without creating a new angle object, skipping object construction and garbage collection.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Mul
+     */
+    Mul(self: Angle, scalar: number): void;
+}
+
+interface Angle {
+    /**
+     * Normalizes the angles by applying a modulo with 360 to pitch, yaw and roll.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Normalize
+     */
+    Normalize(self: Angle): void;
+}
+
+interface Angle {
+    /**
+     * Randomizes each element of this Angle object.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Random
+     */
+    Random(self: Angle, min?: number, max?: number): void;
+}
+
+interface Angle {
+    /**
+     * Returns a normal vector facing in the direction that points right relative to the angle's direction.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Right
+     */
+    Right(self: Angle): Vector;
+}
+
+interface Angle {
+    /**
+     * Rotates the angle around the specified axis by the specified degrees.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:RotateAroundAxis
+     */
+    RotateAroundAxis(self: Angle, axis: Vector, rotation: number): void;
+}
+
+interface Angle {
+    /**
+     * Copies pitch, yaw and roll from the second angle to the first.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Set
+     */
+    Set(self: Angle, originalAngle: Angle): void;
+}
+
+interface Angle {
+    /**
+     * Sets the p, y, and r of the angle.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:SetUnpacked
+     */
+    SetUnpacked(self: Angle, p: number, y: number, r: number): void;
+}
+
+interface Angle {
+    /**
+     * Snaps the angle to nearest interval of degrees.
+     *
+     * **NOTE**: This will modify the original angle too!
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/Angle:SnapTo
+     */
+    SnapTo(self: Angle, axis: string, target: number): Angle;
+}
+
+interface Angle {
+    /**
+     * Subtracts the values of the argument angle to the orignal angle. This functions the same as angle1 - angle2 without creating a new angle object, skipping object construction and garbage collection.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Sub
+     */
+    Sub(self: Angle, angle: Angle): void;
+}
+
+interface Angle {
+    /**
+     * Returns the angle as a table with three elements.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:ToTable
+     */
+    ToTable(self: Angle): table;
+}
+
+interface Angle {
+    /**
+     * Returns the pitch, yaw, and roll components of the angle.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Unpack
+     */
+    Unpack(self: Angle): (number, number, number);
+}
+
+interface Angle {
+    /**
+     * Returns a normal vector facing in the direction that points up relative to the angle's direction.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Up
+     */
+    Up(self: Angle): Vector;
+}
+
+interface Angle {
+    /**
+     * Sets pitch, yaw and roll to 0.
+     * This function is faster than doing it manually.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/Angle:Zero
+     */
+    Zero(self: Angle): void;
+}
+

package/avatarimage.d.tlua

@@ -0,0 +1,10 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		Used to show a player's Steam avatar. You are recommended but not limited to pick one of the following sizes: 16, 32, 64, 84, 128, 184.
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/AvatarImage
+ */
+interface AvatarImage extends Panel {}
+

package/awesomium.d.tlua

@@ -0,0 +1,14 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		Base panel for elements using the [Awesomium](http://www.awesomium.com) UI engine.
+ *
+ * 		**NOTE**: On the `x86-64` beta this panel isn't actually Awesomium, its the same as `HTML` (`HtmlPanel`)
+ *
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/Awesomium
+ * @deprecated You should be using HTML panel, which this is an alias of.
+ */
+interface Awesomium extends Panel {}
+

package/baseclass.d.tlua

@@ -0,0 +1,42 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The baseclass library. Used to lookup a field from a metatable.
+ * @source https://wiki.facepunch.com/gmod/baseclass
+ */
+declare baseclass: BaseclassLib;
+
+interface BaseclassLib {
+    /**
+     * Gets the base class of an object. Used not just by entities, but also by
+     * widgets, panels, drive modes, weapons and gamemodes (with "gamemode_"
+     * prefix). The keyword `DEFINE_BASECLASS` translates into a call to this
+     * function.
+     *
+     * NOTE: You should prefer using this instead of `self.BaseClass` to avoid
+     * infinite recursion.
+     * @realm shared
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/baseclass.Get
+     */
+    Get<T>(name: T): T;
+}
+
+
+interface BaseclassLib {
+    /**
+     * Add a new base class that can be derived by others. This is done automatically for:
+     * * [panels](https://wiki.facepunch.com/gmod/vgui.Register)
+     * * [drive modes](https://wiki.facepunch.com/gmod/drive.Register)
+     * * [entities and widgets](https://wiki.facepunch.com/gmod/scripted_ents.Register)
+     * * [weapons](https://wiki.facepunch.com/gmod/weapons.Register)
+     * * [gamemodes](https://wiki.facepunch.com/gmod/gamemode.Register) (with prefix "gamemode_")
+     *
+     * For more information, including usage examples, see the [BaseClasses](https://wiki.facepunch.com/gmod/BaseClasses) reference page.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/baseclass.Set
+     */
+    Set(name: string, tab: table): void;
+}
+

package/bf_read.d.tlua

@@ -0,0 +1,110 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * This is the object passed to [usermessage.Hook](https://wiki.facepunch.com/gmod/usermessage.Hook) when a message is received. It contains each value stored in the message in sequential order. You should read values from it in the order you wrote them.
+ *
+ *
+ * @source https://wiki.facepunch.com/gmod/bf_read
+ * @deprecated You should be using net instead
+ */
+interface bf_read {}
+
+interface bf_read {
+    /**
+     * Reads and returns an angle object from the bitstream.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadAngle
+     */
+    ReadAngle(self: bf_read): Angle;
+}
+
+interface bf_read {
+    /**
+     * Reads 1 bit and returns a bool representing the bit.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadBool
+     */
+    ReadBool(self: bf_read): boolean;
+}
+
+interface bf_read {
+    /**
+     * Reads a signed char and returns a number from -127 to 127 representing the ascii value of that char.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadChar
+     */
+    ReadChar(self: bf_read): number;
+}
+
+interface bf_read {
+    /**
+     * Reads a short representing an entity index and returns the matching entity handle.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadEntity
+     */
+    ReadEntity(self: bf_read): Entity;
+}
+
+interface bf_read {
+    /**
+     * Reads a 4 byte float from the bitstream and returns it.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadFloat
+     */
+    ReadFloat(self: bf_read): number;
+}
+
+interface bf_read {
+    /**
+     * Reads a 4 byte long from the bitstream and returns it.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadLong
+     */
+    ReadLong(self: bf_read): number;
+}
+
+interface bf_read {
+    /**
+     * Reads a 2 byte short from the bitstream and returns it.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadShort
+     */
+    ReadShort(self: bf_read): number;
+}
+
+interface bf_read {
+    /**
+     * Reads a null terminated string from the bitstream.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadString
+     */
+    ReadString(self: bf_read): string;
+}
+
+interface bf_read {
+    /**
+     * Reads a special encoded vector from the bitstream and returns it, this function is not suitable to send normals.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadVector
+     */
+    ReadVector(self: bf_read): Vector;
+}
+
+interface bf_read {
+    /**
+     * Reads a special encoded vector normal from the bitstream and returns it, this function is not suitable to send vectors that represent a position.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:ReadVectorNormal
+     */
+    ReadVectorNormal(self: bf_read): Vector;
+}
+
+interface bf_read {
+    /**
+     * Rewinds the bitstream so it can be read again.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/bf_read:Reset
+     */
+    Reset(self: bf_read): void;
+}
+

package/bit.d.tlua

@@ -0,0 +1,121 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The bitwise library contains useful functions for bitwise operations.
+ * Make sure you're familiar with [Bitwise Operators](https://code.tutsplus.com/articles/understanding-bitwise-operators--active-11301)
+ * @source https://wiki.facepunch.com/gmod/bit
+ */
+interface BitLib {
+    /**
+     * Returns the arithmetically shifted value.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.arshift
+     */
+    arshift(value: number, shiftCount: number): number;
+}
+
+interface BitLib {
+    /**
+     * Performs the bitwise `and` for all values specified.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.band
+     */
+    band(value: number, ...: any): number;
+}
+
+interface BitLib {
+    /**
+     * Returns the bitwise not of the value. Inverts every bit of the 32bit integer.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.bnot
+     */
+    bnot(value: number): number;
+}
+
+interface BitLib {
+    /**
+     * Returns the bitwise OR of all values specified.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.bor
+     */
+    bor(value1: number, ...: any): number;
+}
+
+interface BitLib {
+    /**
+     * Swaps the byte order.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.bswap
+     */
+    bswap(value: number): number;
+}
+
+interface BitLib {
+    /**
+     * Returns the bitwise xor of all values specified.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.bxor
+     */
+    bxor(value: number, otherValues?: number): number;
+}
+
+interface BitLib {
+    /**
+     * 		Returns the result of shifting given value left bitwise by given number of bits. See [this wiki article](https://en.wikipedia.org/wiki/Bitwise_operation#Bit_shifts) for more details.
+     * 		**NOTE**: The returned value will be clamped to a signed 32-bit integer, even on 64-bit builds.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.lshift
+     */
+    lshift(value: number, shiftCount: number): number;
+}
+
+interface BitLib {
+    /**
+     * Returns the left rotated value.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.rol
+     */
+    rol(value: number, shiftCount: number): number;
+}
+
+interface BitLib {
+    /**
+     * Returns the right rotated value.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.ror
+     */
+    ror(value: number, shiftCount: number): number;
+}
+
+interface BitLib {
+    /**
+     * 		Returns the right shifted value.
+     * 		**NOTE**: The returned value will be clamped to a signed 32-bit integer, even on 64-bit builds.
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.rshift
+     */
+    rshift(value: number, shiftCount: number): number;
+}
+
+interface BitLib {
+    /**
+     * Normalizes the specified value and clamps it in the range of a signed 32bit integer.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.tobit
+     */
+    tobit(value: number): number;
+}
+
+interface BitLib {
+    /**
+     * Returns the hexadecimal representation of the number with the specified number of characters.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/bit.tohex
+     */
+    tohex(value: number, characters?: number): string;
+}
+

package/button.d.tlua

@@ -0,0 +1,13 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		Creates a button that players can click on.
+ * 	[View source](https://github.com/Facepunch/garrysmod/blob/dfdafba0f04e75be122961291a56d9c1714a3d8a/garrysmod/lua/vgui/dbutton.lua#L181-L193)
+ *
+ *
+ * @realm client and menu
+ * @source https://wiki.facepunch.com/gmod/Button
+ * @deprecated Only exists for backwards compatibility with Panel:SetActionFunction. Use DButton instead.
+ */
+interface Button extends DButton {}
+