@tlua/gmod 1.0.1

package/net.d.tlua

@@ -0,0 +1,639 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The net library is one of a number of ways to send data between the client and server.
+ *
+ * The major advantages of the net library are the large size limit (64kb/message) and the ability to send data backwards - from the client to the server.
+ *
+ * Refer to [Net Library Usage](https://wiki.facepunch.com/gmod/Net_Library_Usage) for a short introduction.
+ * @source https://wiki.facepunch.com/gmod/net
+ */
+declare net: NetLib;
+
+interface NetLib {
+    /**
+     * Cancels a net message started by [net.Start](https://wiki.facepunch.com/gmod/net.Start), so you can immediately start a new one without any errors.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.Abort
+     */
+    Abort(): void;
+}
+
+interface NetLib {
+    /**
+     * Sends the currently built net message (see [net.Start](https://wiki.facepunch.com/gmod/net.Start)) to all connected players.
+     * More information can be found in [Net Library Usage](https://wiki.facepunch.com/gmod/Net_Library_Usage).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/net.Broadcast
+     */
+    Broadcast(): void;
+}
+
+interface NetLib {
+    /**
+     * 		Returns the amount of data left to read in the current message. Does nothing when sending data.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.BytesLeft
+     */
+    BytesLeft(): (number, number);
+}
+
+interface NetLib {
+    /**
+     * Returns the size of the current message.
+     *
+     * **NOTE**: This will include 3 extra bytes (24 bits) used by the engine internally to send the data over the network.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.BytesWritten
+     */
+    BytesWritten(): (number, number);
+}
+
+interface NetLib {
+    /**
+     * **INTERNAL**: You may be looking for [net.Receive](https://wiki.facepunch.com/gmod/net.Receive).
+     *
+     *
+     * Function called by the engine to tell the Lua state a message arrived.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.Incoming
+     */
+    Incoming(length: number, client: Player): void;
+}
+
+interface NetLib {
+    /**
+     * Reads an angle from the received net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadAngle
+     */
+    ReadAngle(): Angle;
+}
+
+interface NetLib {
+    /**
+     * Reads a bit from the received net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadBit
+     */
+    ReadBit(): number;
+}
+
+interface NetLib {
+    /**
+     * Reads a boolean from the received net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadBool
+     */
+    ReadBool(): boolean;
+}
+
+interface NetLib {
+    /**
+     * Reads a [Color](https://wiki.facepunch.com/gmod/Color) from the current net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadColor
+     */
+    ReadColor(hasAlpha?: boolean): Color;
+}
+
+interface NetLib {
+    /**
+     * Reads pure binary data from the message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadData
+     */
+    ReadData(length: number): string;
+}
+
+interface NetLib {
+    /**
+     * Reads a double-precision number from the received net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadDouble
+     */
+    ReadDouble(): number;
+}
+
+interface NetLib {
+    /**
+     * Reads an entity from the received net message. You should always check if the specified entity exists as it may have been removed and therefore `NULL` if it is outside of the players [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community") or was already removed.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadEntity
+     */
+    ReadEntity(): Entity;
+}
+
+interface NetLib {
+    /**
+     * Reads a floating point number from the received net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadFloat
+     */
+    ReadFloat(): number;
+}
+
+interface NetLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Reads a word, basically unsigned short. This is used internally to read the "header" of the message which is an unsigned short which can be converted to the corresponding message name via [util.NetworkIDToString](https://wiki.facepunch.com/gmod/util.NetworkIDToString).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadHeader
+     */
+    ReadHeader(): number;
+}
+
+interface NetLib {
+    /**
+     * Reads an integer from the received net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadInt
+     */
+    ReadInt(bitCount: number): number;
+}
+
+interface NetLib {
+    /**
+     * Reads a [VMatrix](https://wiki.facepunch.com/gmod/VMatrix) from the received net message.
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadMatrix
+     */
+    ReadMatrix(): VMatrix;
+}
+
+interface NetLib {
+    /**
+     * Reads a normal vector from the net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadNormal
+     */
+    ReadNormal(): Vector;
+}
+
+interface NetLib {
+    /**
+     * Reads a player entity that was written with [net.WritePlayer](https://wiki.facepunch.com/gmod/net.WritePlayer) from the received net message.
+     *
+     * You should always check if the specified entity exists as it may have been removed and therefore `NULL` if it is outside of the local players [PVS](https://developer.valvesoftware.com/wiki/PVS) or was already removed.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadPlayer
+     */
+    ReadPlayer(): Player;
+}
+
+interface NetLib {
+    /**
+     * Reads a [null-terminated string](https://en.wikipedia.org/wiki/Null-terminated_string) from the net stream. The size of the string is 8 bits plus 8 bits for every ASCII character in the string.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadString
+     */
+    ReadString(): string;
+}
+
+interface NetLib {
+    /**
+     * Reads a table from the received net message. See net.WriteTable for extra
+     * info.
+     *
+     * NOTE: Sometimes when sending a table through the net library, the order of
+     * the keys may be switched.
+     *
+     * WARNING: You must read information in the same order as you write it.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadTable
+     */
+    ReadTable(sequential?: boolean): Table<any, any>;
+}
+
+
+interface NetLib {
+    /**
+     * **INTERNAL**: Used internally by [net.ReadTable](https://wiki.facepunch.com/gmod/net.ReadTable).
+     *
+     *
+     * Reads a value from the net message with the specified type, written by [net.WriteType](https://wiki.facepunch.com/gmod/net.WriteType).
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadType
+     */
+    ReadType(typeID?: number): any;
+}
+
+interface NetLib {
+    /**
+     * Reads an unsigned integer with the specified number of bits from the received net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadUInt
+     */
+    ReadUInt(bitCount: number): number;
+}
+
+interface NetLib {
+    /**
+     * Reads a unsigned integer with 64 bits from the received net message.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadUInt64
+     */
+    ReadUInt64(): string;
+}
+
+interface NetLib {
+    /**
+     * Reads a vector from the received net message. Vectors sent by this function are **compressed**, which may result in precision loss. See [net.WriteVector](https://wiki.facepunch.com/gmod/net.WriteVector) for more information.
+     *
+     * **WARNING**: You **must** read information in same order as you write it.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.ReadVector
+     */
+    ReadVector(): Vector;
+}
+
+interface NetLib {
+    /**
+     * Adds a net message handler. Only one receiver can be used to receive the net message.
+     *
+     * You can use the `net.Read*` functions within the message handler callback.
+     *
+     * **WARNING**: You **should** put this function **outside** of any other function or hook for it to work properly unless you know what you are doing!
+     *
+     * You **must** read information in the same order as you write it.
+     *
+     * Each net message has a length limit of **64KB**!
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.Receive
+     */
+    Receive(messageName: string, callback: (len: number, ply: Player) => void): void;
+}
+
+interface NetLib {
+    /**
+     * Sends the current net message to the specified player(s)
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/net.Send
+     */
+    Send(ply: Player): void;
+}
+
+interface NetLib {
+    Send(plys: Player[]): void;
+}
+
+interface NetLib {
+    Send(filter: CRecipientFilter): void;
+}
+
+interface NetLib {
+    /**
+     * 		Sends the current message (see [net.Start](https://wiki.facepunch.com/gmod/net.Start)) to all except the player or players specified.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/net.SendOmit
+     */
+    SendOmit(ply: Player): void;
+}
+
+interface NetLib {
+    SendOmit(plys: Player[]): void;
+}
+
+interface NetLib {
+    /**
+     * Sends current net message (see [net.Start](https://wiki.facepunch.com/gmod/net.Start)) to all players that are in the same [Potentially Audible Set (PAS)](https://developer.valvesoftware.com/wiki/PAS) as the position, or simply said, it adds all players that can potentially hear sounds from this position.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/net.SendPAS
+     */
+    SendPAS(position: Vector): void;
+}
+
+interface NetLib {
+    /**
+     * Sends current net message (see [net.Start](https://wiki.facepunch.com/gmod/net.Start)) to all players in the [PVS (Potential Visibility Set)](https://developer.valvesoftware.com/wiki/PVS "PVS - Valve Developer Community") of the position, or, more simply said, sends the message to players that can potentially see this position.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/net.SendPVS
+     */
+    SendPVS(position: Vector): void;
+}
+
+interface NetLib {
+    /**
+     * Sends the current net message (see [net.Start](https://wiki.facepunch.com/gmod/net.Start)) to the server. The player object must exist on the server for the net message to be received successfully by the server.
+     *
+     * **WARNING**: Each net message has a length limit of 65,533 bytes (approximately 64 KiB) and your net message will error and fail to send if it is larger than this.
+     *
+     * The message name must be pooled with [util.AddNetworkString](https://wiki.facepunch.com/gmod/util.AddNetworkString) beforehand!
+     *
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/net.SendToServer
+     */
+    SendToServer(): void;
+}
+
+interface NetLib {
+    /**
+     * Begins a new net message. If another net message is already started and hasn't been sent yet, it will be discarded.
+     *
+     * After calling this function, you will want to call `net.Write` functions to write your data, if any, and then finish with a call to one of the following functions:
+     * * [net.Send](https://wiki.facepunch.com/gmod/net.Send)
+     * * [net.SendOmit](https://wiki.facepunch.com/gmod/net.SendOmit)
+     * * [net.SendPAS](https://wiki.facepunch.com/gmod/net.SendPAS)
+     * * [net.SendPVS](https://wiki.facepunch.com/gmod/net.SendPVS)
+     * * [net.Broadcast](https://wiki.facepunch.com/gmod/net.Broadcast)
+     * * [net.SendToServer](https://wiki.facepunch.com/gmod/net.SendToServer)
+     *
+     *
+     * **WARNING**: Each net message has a length limit of 65,533 bytes (approximately 64 KiB) and your net message will error and fail to send if it is larger than this.
+     *
+     * The net library has an internal buffer that sent messages are added to that is capable of holding roughly 256 kb at a time. Trying to send more will lead to the client being kicked because of a buffer overflow. [More information on net library limits can be found here.](https://wiki.facepunch.com/gmod/Networking_Usage#netlimits)
+     *
+     * The message name must be pooled with [util.AddNetworkString](https://wiki.facepunch.com/gmod/util.AddNetworkString) beforehand!
+     *
+     * Net messages will not reliably reach the client until the client's [GM:InitPostEntity](https://wiki.facepunch.com/gmod/GM:InitPostEntity) hook is called.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.Start
+     */
+    Start(messageName: string, unreliable?: boolean): boolean;
+}
+
+interface NetLib {
+    /**
+     * Writes an angle to the current net message.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteAngle
+     */
+    WriteAngle(angle: Angle): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a boolean (as `1` or `0`) to the current net message.
+     *
+     * Please note that the bit is written here from a [boolean](https://wiki.facepunch.com/gmod/boolean) (`true/false`) but [net.ReadBit](https://wiki.facepunch.com/gmod/net.ReadBit) returns a number.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteBit
+     */
+    WriteBit(boolean: boolean): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a boolean to the current net message. Alias of [net.WriteBit](https://wiki.facepunch.com/gmod/net.WriteBit).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteBool
+     */
+    WriteBool(boolean: boolean): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a [Color](https://wiki.facepunch.com/gmod/Color) to the current net message.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteColor
+     */
+    WriteColor(Color: Color, writeAlpha?: boolean): void;
+}
+
+interface NetLib {
+    /**
+     * Writes a chunk of binary data to the message.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteData
+     */
+    WriteData(binaryData: string, length?: number): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a double-precision number to the current net message.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteDouble
+     */
+    WriteDouble(double: number): void;
+}
+
+interface NetLib {
+    /**
+     * Appends an entity to the current net message using its [Entity:EntIndex](https://wiki.facepunch.com/gmod/Entity:EntIndex).
+     *
+     * See [net.ReadEntity](https://wiki.facepunch.com/gmod/net.ReadEntity) for the function to read the entity.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteEntity
+     */
+    WriteEntity(entity: Entity): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a float (number with decimals) to the current net message.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteFloat
+     */
+    WriteFloat(float: number): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a signed integer - a whole number, positive/negative - to the current net message. Can be read back with [net.ReadInt](https://wiki.facepunch.com/gmod/net.ReadInt) on the receiving end.
+     *
+     * Use [net.WriteUInt](https://wiki.facepunch.com/gmod/net.WriteUInt) to send an unsigned number (that you know will **never** be negative). Use [net.WriteFloat](https://wiki.facepunch.com/gmod/net.WriteFloat) for a non-whole number (e.g. `2.25`).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteInt
+     */
+    WriteInt(integer: number, bitCount: number): void;
+}
+
+interface NetLib {
+    /**
+     * Writes a [VMatrix](https://wiki.facepunch.com/gmod/VMatrix) to the current net message.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteMatrix
+     */
+    WriteMatrix(matrix: VMatrix): void;
+}
+
+interface NetLib {
+    /**
+     * Writes a normalized/direction vector ( Vector with length of 1 ) to the net message.
+     *
+     * This function uses less bandwidth compared to [net.WriteVector](https://wiki.facepunch.com/gmod/net.WriteVector) and will not send vectors with length of > 1 properly.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteNormal
+     */
+    WriteNormal(normal: Vector): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a player entity to the current net message using its [Entity:EntIndex](https://wiki.facepunch.com/gmod/Entity:EntIndex). This saves a small amount of network bandwidth over [net.WriteEntity](https://wiki.facepunch.com/gmod/net.WriteEntity).
+     *
+     * See [net.ReadPlayer](https://wiki.facepunch.com/gmod/net.ReadPlayer) for the function to read the entity.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WritePlayer
+     */
+    WritePlayer(ply: Player): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a string to the current net message. The size of the written data is 8 bits for every ASCII character in the string + 8 bits for the null terminator.
+     *
+     * The maximum allowed length of a single written string is **65532 characters**. (aka the limit of the net message itself)
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteString
+     */
+    WriteString(string: string): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a table to the current net message. Adds **16 extra bits** per key/value pair, so you're better off writing each individual key/value as the exact type if possible.
+     *
+     * **WARNING**: All net messages have a **64kb** buffer. This function will not check or error when that buffer is overflown. You might want to consider using [util.TableToJSON](https://wiki.facepunch.com/gmod/util.TableToJSON) and [util.Compress](https://wiki.facepunch.com/gmod/util.Compress) and send the resulting string in **60kb** chunks, doing the opposite on the receiving end.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteTable
+     */
+    WriteTable(table: table, sequential?: boolean): void;
+}
+
+interface NetLib {
+    /**
+     * **INTERNAL**: Used internally by [net.WriteTable](https://wiki.facepunch.com/gmod/net.WriteTable).
+     *
+     *
+     * Appends any type of value to the current net message.
+     *
+     * **NOTE**: An additional 8-bit unsigned integer indicating the type will automatically be written to the packet before the value, in order to facilitate reading with [net.ReadType](https://wiki.facepunch.com/gmod/net.ReadType). If you know the data type you are writing, use a function meant for that specific data type to reduce amount of data sent.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteType
+     */
+    WriteType(Data: any): void;
+}
+
+interface NetLib {
+    /**
+     * Appends an unsigned integer with the specified number of bits to the current net message.
+     *
+     * Use [net.WriteInt](https://wiki.facepunch.com/gmod/net.WriteInt) if you want to send negative and positive numbers. Use [net.WriteFloat](https://wiki.facepunch.com/gmod/net.WriteFloat) for a non-whole number (e.g. `2.25`).
+     *
+     * **NOTE**: Unsigned numbers **do not** support negative numbers.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteUInt
+     */
+    WriteUInt(unsignedInteger: number, bitCount: number): void;
+}
+
+interface NetLib {
+    /**
+     * 		Appends an unsigned integer with 64 bits to the current net message.
+     *
+     * 		The limit for an uint64 is 18'446'744'073'709'551'615.
+     * 		Everything above the limit will be set to the limit.
+     *
+     * 		Unsigned numbers **do not** support negative numbers.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteUInt64
+     */
+    WriteUInt64(uint64: string): void;
+}
+
+interface NetLib {
+    /**
+     * Appends a vector to the current net message.
+     * Vectors sent by this function are compressed, which may result in precision loss. XYZ components greater than `16384` or less than `-16384` are irrecoverably altered (most significant bits are trimmed) and precision after the decimal point is 1 digit (5 bits).
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/net.WriteVector
+     */
+    WriteVector(vector: Vector): void;
+}
+