@tlua/gmod 1.0.5 → 1.0.6

package/types/net.d.tlua

@@ -18,6 +18,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.Abort
      */
     Abort(): void;
+
     /**
      * 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).
@@ -26,6 +27,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.Broadcast
      */
     Broadcast(): void;
+
     /**
      * 		Returns the amount of data left to read in the current message. Does nothing when sending data.
      *
@@ -33,6 +35,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.BytesLeft
      */
     BytesLeft(): (number, number);
+
     /**
      * Returns the size of the current message.
      *
@@ -43,6 +46,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.BytesWritten
      */
     BytesWritten(): (number, number);
+
     /**
      * **INTERNAL**: You may be looking for [net.Receive](https://wiki.facepunch.com/gmod/net.Receive).
      *
@@ -53,6 +57,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.Incoming
      */
     Incoming(length: number, client: Player): void;
+
     /**
      * Reads an angle from the received net message.
      *
@@ -63,6 +68,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadAngle
      */
     ReadAngle(): Angle;
+
     /**
      * Reads a bit from the received net message.
      *
@@ -73,6 +79,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadBit
      */
     ReadBit(): number;
+
     /**
      * Reads a boolean from the received net message.
      *
@@ -83,6 +90,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadBool
      */
     ReadBool(): boolean;
+
     /**
      * Reads a [Color](https://wiki.facepunch.com/gmod/Color) from the current net message.
      *
@@ -93,6 +101,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadColor
      */
     ReadColor(hasAlpha?: boolean): Color;
+
     /**
      * Reads pure binary data from the message.
      *
@@ -103,6 +112,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadData
      */
     ReadData(length: number): string;
+
     /**
      * Reads a double-precision number from the received net message.
      *
@@ -113,6 +123,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadDouble
      */
     ReadDouble(): number;
+
     /**
      * 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.
      *
@@ -123,6 +134,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadEntity
      */
     ReadEntity(): Entity;
+
     /**
      * Reads a floating point number from the received net message.
      *
@@ -133,6 +145,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadFloat
      */
     ReadFloat(): number;
+
     /**
      * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
      *
@@ -143,6 +156,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadHeader
      */
     ReadHeader(): number;
+
     /**
      * Reads an integer from the received net message.
      *
@@ -153,6 +167,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadInt
      */
     ReadInt(bitCount: number): number;
+
     /**
      * 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.
@@ -162,6 +177,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadMatrix
      */
     ReadMatrix(): VMatrix;
+
     /**
      * Reads a normal vector from the net message.
      *
@@ -172,6 +188,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadNormal
      */
     ReadNormal(): Vector;
+
     /**
      * Reads a player entity that was written with [net.WritePlayer](https://wiki.facepunch.com/gmod/net.WritePlayer) from the received net message.
      *
@@ -184,6 +201,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadPlayer
      */
     ReadPlayer(): Player;
+
     /**
      * 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.
      *
@@ -194,6 +212,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadString
      */
     ReadString(): string;
+
     /**
      * Reads a table from the received net message. See net.WriteTable for extra
      * info.
@@ -206,6 +225,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadTable
      */
     ReadTable(sequential?: boolean): Table<any, any>;
+
     /**
      * **INTERNAL**: Used internally by [net.ReadTable](https://wiki.facepunch.com/gmod/net.ReadTable).
      *
@@ -219,6 +239,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadType
      */
     ReadType(typeID?: number): any;
+
     /**
      * Reads an unsigned integer with the specified number of bits from the received net message.
      *
@@ -229,6 +250,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadUInt
      */
     ReadUInt(bitCount: number): number;
+
     /**
      * Reads a unsigned integer with 64 bits from the received net message.
      *
@@ -239,6 +261,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadUInt64
      */
     ReadUInt64(): string;
+
     /**
      * 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.
      *
@@ -249,6 +272,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.ReadVector
      */
     ReadVector(): Vector;
+
     /**
      * Adds a net message handler. Only one receiver can be used to receive the net message.
      *
@@ -265,14 +289,18 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.Receive
      */
     Receive(messageName: string, callback: (len: number, ply: Player) => void): void;
+
     /**
      * Sends the current net message to the specified player(s)
      * @realm server
      * @source https://wiki.facepunch.com/gmod/net.Send
      */
     Send(ply: Player): void;
+
     Send(plys: Player[]): void;
+
     Send(filter: CRecipientFilter): void;
+
     /**
      * 		Sends the current message (see [net.Start](https://wiki.facepunch.com/gmod/net.Start)) to all except the player or players specified.
      *
@@ -280,19 +308,23 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.SendOmit
      */
     SendOmit(ply: Player): void;
+
     SendOmit(plys: Player[]): void;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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.
      *
@@ -305,6 +337,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.SendToServer
      */
     SendToServer(): void;
+
     /**
      * Begins a new net message. If another net message is already started and hasn't been sent yet, it will be discarded.
      *
@@ -330,12 +363,14 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.Start
      */
     Start(messageName: string, unreliable?: boolean): boolean;
+
     /**
      * Writes an angle to the current net message.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/net.WriteAngle
      */
     WriteAngle(angle: Angle): void;
+
     /**
      * Appends a boolean (as `1` or `0`) to the current net message.
      *
@@ -345,30 +380,35 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteBit
      */
     WriteBit(boolean: boolean): void;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * 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;
+
     /**
      * Appends a double-precision number to the current net message.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/net.WriteDouble
      */
     WriteDouble(double: number): void;
+
     /**
      * Appends an entity to the current net message using its [Entity:EntIndex](https://wiki.facepunch.com/gmod/Entity:EntIndex).
      *
@@ -378,12 +418,14 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteEntity
      */
     WriteEntity(entity: Entity): void;
+
     /**
      * 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;
+
     /**
      * 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.
      *
@@ -393,12 +435,14 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteInt
      */
     WriteInt(integer: number, bitCount: number): void;
+
     /**
      * 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;
+
     /**
      * Writes a normalized/direction vector ( Vector with length of 1 ) to the net message.
      *
@@ -408,6 +452,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteNormal
      */
     WriteNormal(normal: Vector): void;
+
     /**
      * 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).
      *
@@ -416,6 +461,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WritePlayer
      */
     WritePlayer(ply: Player): void;
+
     /**
      * 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.
      *
@@ -425,6 +471,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteString
      */
     WriteString(string: string): void;
+
     /**
      * 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.
      *
@@ -435,6 +482,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteTable
      */
     WriteTable(table: table, sequential?: boolean): void;
+
     /**
      * **INTERNAL**: Used internally by [net.WriteTable](https://wiki.facepunch.com/gmod/net.WriteTable).
      *
@@ -448,6 +496,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteType
      */
     WriteType(Data: any): void;
+
     /**
      * Appends an unsigned integer with the specified number of bits to the current net message.
      *
@@ -460,6 +509,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteUInt
      */
     WriteUInt(unsignedInteger: number, bitCount: number): void;
+
     /**
      * 		Appends an unsigned integer with 64 bits to the current net message.
      *
@@ -473,6 +523,7 @@ interface NetLib {
      * @source https://wiki.facepunch.com/gmod/net.WriteUInt64
      */
     WriteUInt64(uint64: string): void;
+
     /**
      * 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).
@@ -482,56 +533,3 @@ interface NetLib {
      */
     WriteVector(vector: Vector): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-