@tlua/gmod 1.0.5 → 1.0.6

package/types/timer.d.tlua

@@ -13,6 +13,7 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.Adjust
      */
     Adjust(identifier: any, delay: number, repetitions?: number, func?: function): boolean;
+
     /**
      *  This function does nothing.
      * @realm shared and menu
@@ -20,6 +21,7 @@ interface TimerLib {
      * @deprecated If you want to check if whether or not a timer exists, use timer.Exists.
      */
     Check(): void;
+
     /**
      * Creates a new timer that will repeat its function given amount of times.
      * This function also requires the timer to be named, which allows you to control it after it was created via the [timer](https://wiki.facepunch.com/gmod/timer).
@@ -33,6 +35,7 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.Create
      */
     Create(identifier: string, delay: number, repetitions: number, func: function): void;
+
     /**
      *  Stops and destroys the given timer. Alias of [timer.Remove](https://wiki.facepunch.com/gmod/timer.Remove).
      * @realm shared and menu
@@ -40,6 +43,7 @@ interface TimerLib {
      * @deprecated You should be using timer.Remove instead.
      */
     Destroy(identifier: string): void;
+
     /**
      * Returns whenever the given timer exists or not.
      *
@@ -54,6 +58,7 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.Exists
      */
     Exists(identifier: string): boolean;
+
     /**
      * Returns whenever the given timer is paused or not. ([timer.Pause](https://wiki.facepunch.com/gmod/timer.Pause))
      *
@@ -62,12 +67,14 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.IsPaused
      */
     IsPaused(identifier: string): boolean;
+
     /**
      * Pauses the given timer.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/timer.Pause
      */
     Pause(identifier: any): void;
+
     /**
      * Stops and removes a timer created by [timer.Create](https://wiki.facepunch.com/gmod/timer.Create).
      * **WARNING**: The timers are removed in the next frame! Keep this in mind when storing identifiers in variables.
@@ -77,6 +84,7 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.Remove
      */
     Remove(identifier: string): void;
+
     /**
      * 		Returns amount of repetitions/executions left before the timer destroys itself.
      *
@@ -84,6 +92,7 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.RepsLeft
      */
     RepsLeft(identifier: any): number;
+
     /**
      * Creates a simple timer that runs the given function after a specified delay.
      *
@@ -114,6 +123,7 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.Simple
      */
     Simple(delay: number, func: function): void;
+
     /**
      * Restarts the given timer.
      *
@@ -124,12 +134,14 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.Start
      */
     Start(identifier: any): void;
+
     /**
      * Stops the given timer and rewinds it.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/timer.Stop
      */
     Stop(identifier: any): void;
+
     /**
      * Returns amount of time left (in seconds) before the timer executes its function.
      *
@@ -140,12 +152,14 @@ interface TimerLib {
      * @source https://wiki.facepunch.com/gmod/timer.TimeLeft
      */
     TimeLeft(identifier: any): number;
+
     /**
      * Runs either [timer.Pause](https://wiki.facepunch.com/gmod/timer.Pause) or [timer.UnPause](https://wiki.facepunch.com/gmod/timer.UnPause) based on the timer's current status.
      * @realm shared and menu
      * @source https://wiki.facepunch.com/gmod/timer.Toggle
      */
     Toggle(identifier: any): void;
+
     /**
      * Unpauses the timer.
      * @realm shared and menu
@@ -153,18 +167,3 @@ interface TimerLib {
      */
     UnPause(identifier: any): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/tool.d.tlua

@@ -15,12 +15,14 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/TOOL:Deploy
      */
     Deploy(self: Tool): boolean;
+
     /**
      * Called when [WEAPON:DrawHUD](https://wiki.facepunch.com/gmod/WEAPON:DrawHUD) of the toolgun is called, only when the user has this tool selected.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/TOOL:DrawHUD
      */
     DrawHUD(self: Tool): void;
+
     /**
      * Called after the default tool screen has been drawn from [WEAPON:RenderScreen](https://wiki.facepunch.com/gmod/WEAPON:RenderScreen).
      *
@@ -33,42 +35,49 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/TOOL:DrawToolScreen
      */
     DrawToolScreen(self: Tool, width: number, height: number): void;
+
     /**
      * Called when [WEAPON:Think](https://wiki.facepunch.com/gmod/WEAPON:Think) of the toolgun is called, only when the user has this tool selected.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/TOOL:FreezeMovement
      */
     FreezeMovement(self: Tool): boolean;
+
     /**
      * Called when [WEAPON:Holster](https://wiki.facepunch.com/gmod/WEAPON:Holster) of the toolgun is called, when switching between different toolguns.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/TOOL:Holster
      */
     Holster(self: Tool): void;
+
     /**
      * Called when the user left clicks with the tool.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/TOOL:LeftClick
      */
     LeftClick(self: Tool, tr: TraceResult): boolean;
+
     /**
      * Called when the user presses the reload key with the tool out.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/TOOL:Reload
      */
     Reload(self: Tool, tr: TraceResult): boolean;
+
     /**
      * Called when the user right clicks with the tool.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/TOOL:RightClick
      */
     RightClick(self: Tool, tr: TraceResult): boolean;
+
     /**
      * Called when [WEAPON:Think](https://wiki.facepunch.com/gmod/WEAPON:Think) of the toolgun is called. This only happens when the tool gun is currently equipped/selected by the player and the selected tool is this tool.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/TOOL:Think
      */
     Think(self: Tool): void;
+
     /**
      * Called when the tool's control panel needs to be rebuilt.
      *
@@ -78,6 +87,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/TOOL.BuildCPanel
      */
     BuildCPanel(panel: ControlPanel): void;
+
     /**
      * Returns whether the tool is allowed to be used or not. This function ignores the [SANDBOX:CanTool](https://wiki.facepunch.com/gmod/SANDBOX:CanTool) hook.
      *
@@ -87,12 +97,14 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:Allowed
      */
     Allowed(self: Tool): boolean;
+
     /**
      * Builds a list of all ConVars set via the ClientConVar variable on the [Structures/TOOL](https://wiki.facepunch.com/gmod/Structures/TOOL) and their default values. This is used for the preset system.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:BuildConVarList
      */
     BuildConVarList(self: Tool): table;
+
     /**
      * **INTERNAL**: This is called automatically for most toolgun actions so you shouldn't need to use it.
      *
@@ -103,12 +115,14 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:CheckObjects
      */
     CheckObjects(self: Tool): void;
+
     /**
      * Clears all objects previously set with [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:ClearObjects
      */
     ClearObjects(self: Tool): void;
+
     /**
      * **INTERNAL**: This is called automatically for all tools.
      *
@@ -118,6 +132,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:Create
      */
     Create(self: Tool): Tool;
+
     /**
      * **INTERNAL**: This is called automatically for all tools.
      *
@@ -128,42 +143,49 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:CreateConVars
      */
     CreateConVars(self: Tool): void;
+
     /**
      * Retrieves a physics bone number previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetBone
      */
     GetBone(self: Tool, id: number): number;
+
     /**
      * Attempts to grab a clientside tool [ConVar](https://wiki.facepunch.com/gmod/ConVar) value as a [boolean](https://wiki.facepunch.com/gmod/boolean).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetClientBool
      */
     GetClientBool(self: Tool, name: string, _default?: boolean): number;
+
     /**
      * Attempts to grab a clientside tool [ConVar](https://wiki.facepunch.com/gmod/ConVar) as a [string](https://wiki.facepunch.com/gmod/string).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetClientInfo
      */
     GetClientInfo(self: Tool, name: string): string;
+
     /**
      * Attempts to grab a clientside tool [ConVar](https://wiki.facepunch.com/gmod/ConVar)'s value as a [number](https://wiki.facepunch.com/gmod/number).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetClientNumber
      */
     GetClientNumber(self: Tool, name: string, _default?: number): number;
+
     /**
      * Retrieves an Entity previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetEnt
      */
     GetEnt(self: Tool, id: number): Entity;
+
     /**
      * Returns a language key based on this tool's name and the current stage it is on.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetHelpText
      */
     GetHelpText(self: Tool): string;
+
     /**
      * Retrieves an local vector previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
      * See also [Tool:GetPos](https://wiki.facepunch.com/gmod/Tool:GetPos).
@@ -172,30 +194,35 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:GetLocalPos
      */
     GetLocalPos(self: Tool, id: number): Vector;
+
     /**
      * Returns the name of the current tool mode.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetMode
      */
     GetMode(self: Tool): string;
+
     /**
      * Retrieves an normal vector previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetNormal
      */
     GetNormal(self: Tool, id: number): Vector;
+
     /**
      * Returns the current operation of the tool set by [Tool:SetOperation](https://wiki.facepunch.com/gmod/Tool:SetOperation).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetOperation
      */
     GetOperation(self: Tool): number;
+
     /**
      * Returns the owner of this tool.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetOwner
      */
     GetOwner(self: Tool): Player;
+
     /**
      * Retrieves an [PhysObj](https://wiki.facepunch.com/gmod/PhysObj) previously stored using [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
      * See also [Tool:GetEnt](https://wiki.facepunch.com/gmod/Tool:GetEnt).
@@ -204,6 +231,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:GetPhys
      */
     GetPhys(self: Tool, id: number): PhysObj;
+
     /**
      * Retrieves a vector previously stored using Tool:SetObject. See also
      * Tool:GetLocalPos.
@@ -211,6 +239,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:GetPos
      */
     GetPos(self: Tool, id?: number): Vector;
+
     /**
      * Returns the Tool Gun (`gmod_tool`) Scripted [Weapon](https://wiki.facepunch.com/gmod/Weapon).
      * @realm shared
@@ -218,6 +247,7 @@ interface Tool {
      * @deprecated Use Tool:GetWeapon instead.
      */
     GetSWEP(self: Tool): Weapon;
+
     /**
      * Attempts to grab a serverside tool [ConVar](https://wiki.facepunch.com/gmod/ConVar).
      * This will not do anything on client, despite the function being defined shared.
@@ -226,18 +256,21 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:GetServerInfo
      */
     GetServerInfo(self: Tool, name: string): string;
+
     /**
      * Returns the current stage of the tool set by [Tool:SetStage](https://wiki.facepunch.com/gmod/Tool:SetStage).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetStage
      */
     GetStage(self: Tool): number;
+
     /**
      * Returns the Tool Gun (`gmod_tool`) Scripted [Weapon](https://wiki.facepunch.com/gmod/Weapon).
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:GetWeapon
      */
     GetWeapon(self: Tool): Weapon;
+
     /**
      * Initializes the ghost entity with the given model. Removes any old ghost entity if called multiple times.
      *
@@ -247,6 +280,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:MakeGhostEntity
      */
     MakeGhostEntity(self: Tool, model: string, pos: Vector, angle: Angle): void;
+
     /**
      * Returns the amount of stored objects ( [Entity](https://wiki.facepunch.com/gmod/Entity)s ) the tool has.
      * Are TOOLs limited to 4 entities?
@@ -255,12 +289,14 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:NumObjects
      */
     NumObjects(self: Tool): number;
+
     /**
      * Automatically forces the tool's control panel to be rebuilt.
      * @realm client
      * @source https://wiki.facepunch.com/gmod/Tool:RebuildControlPanel
      */
     RebuildControlPanel(self: Tool, ...: any): void;
+
     /**
      * Removes any ghost entity created for this tool.
      *
@@ -269,6 +305,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:ReleaseGhostEntity
      */
     ReleaseGhostEntity(self: Tool): void;
+
     /**
      * Stores an [Entity](https://wiki.facepunch.com/gmod/Entity) for later use in the tool.
      *
@@ -278,6 +315,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:SetObject
      */
     SetObject(self: Tool, id: number, ent: Entity, pos: Vector, phys: PhysObj, bone: number, normal: Vector): void;
+
     /**
      * Sets the current operation of the tool. Does nothing clientside. See also [Tool:SetStage](https://wiki.facepunch.com/gmod/Tool:SetStage).
      *
@@ -295,6 +333,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:SetOperation
      */
     SetOperation(self: Tool, operation: number): void;
+
     /**
      * Sets the current stage of the tool. Does nothing clientside.
      *
@@ -304,12 +343,14 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:SetStage
      */
     SetStage(self: Tool, stage: number): void;
+
     /**
      * Initializes the ghost entity based on the supplied entity.
      * @realm shared
      * @source https://wiki.facepunch.com/gmod/Tool:StartGhostEntity
      */
     StartGhostEntity(self: Tool, ent: Entity): void;
+
     /**
      * **INTERNAL**: Called on deploy automatically
      *
@@ -320,6 +361,7 @@ interface Tool {
      * @source https://wiki.facepunch.com/gmod/Tool:UpdateData
      */
     UpdateData(self: Tool): void;
+
     /**
      * Updates the position and orientation of the ghost entity based on where the toolgun owner is looking along with data from object with id 1 set by [Tool:SetObject](https://wiki.facepunch.com/gmod/Tool:SetObject).
      *
@@ -333,49 +375,3 @@ interface Tool {
     UpdateGhostEntity(self: Tool): void;
 }
 interface TOOL extends Tool {}
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-

package/types/ugcpublishwindow.d.tlua

@@ -14,42 +14,49 @@ interface UGCPublishWindow extends DFrame {
      * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:CheckInput
      */
     CheckInput(self: UGCPublishWindow): void;
+
     /**
      * Displays the given error message.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:DisplayError
      */
     DisplayError(self: UGCPublishWindow, err: string): void;
+
     /**
      * Publishes the Item or throws an error if the Title or Tags are invalid
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:DoPublish
      */
     DoPublish(self: UGCPublishWindow, wsid: string, err: string): void;
+
     /**
      * Rezises the panel to nicely fit all children
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:FitContents
      */
     FitContents(self: UGCPublishWindow): void;
+
     /**
      * Returns the name of the current selected tag.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:GetChosenTag
      */
     GetChosenTag(self: UGCPublishWindow): string;
+
     /**
      * Called when the Item was published or if any error occurred while publishing
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:OnPublishFinished
      */
     OnPublishFinished(self: UGCPublishWindow, wsid: string, err: string): void;
+
     /**
      * updated the Workshop items list.
      * @realm menu
      * @source https://wiki.facepunch.com/gmod/UGCPublishWindow:Setup
      */
     Setup(self: UGCPublishWindow, ugcType: string, file: string, imageFile: string, handler: WorkshopFileBase): void;
+
     /**
      * updated the Workshop items list.
      * @realm menu
@@ -57,12 +64,3 @@ interface UGCPublishWindow extends DFrame {
      */
     UpdateWorkshopItems(self: UGCPublishWindow): void;
 }
-
-
-
-
-
-
-
-
-

package/types/umsg.d.tlua

@@ -18,6 +18,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     Angle(angle: Angle): void;
+
     /**
      * Writes a bool to the usermessage.
      * @realm server
@@ -25,6 +26,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     Bool(bool: boolean): void;
+
     /**
      * Writes a signed char to the usermessage.
      * @realm server
@@ -32,6 +34,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     Char(char: number): void;
+
     /**
      * Dispatches the usermessage to the client(s).
      * @realm server
@@ -39,6 +42,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     End(): void;
+
     /**
      * Writes an entity object to the usermessage. (As an entity handle, which means the entity index + its serial number)
      * @realm server
@@ -46,6 +50,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     Entity(entity: Entity): void;
+
     /**
      * Writes a float to the usermessage.
      * @realm server
@@ -53,6 +58,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     Float(float: number): void;
+
     /**
      * Writes a signed int (32 bit) to the usermessage.
      * @realm server
@@ -60,6 +66,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     Long(int: number): void;
+
     /**
      * The string specified will be networked to the client and receive a identifying number, which will be sent instead of the string to optimize networking.
      *
@@ -68,6 +75,7 @@ interface UmsgLib {
      * @deprecated Inferior version of util.AddNetworkString
      */
     PoolString(string: string): void;
+
     /**
      * Writes a signed short (16 bit) to the usermessage.
      * @realm server
@@ -75,6 +83,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     Short(short: number): void;
+
     /**
      * Starts a new usermessage.
      *
@@ -86,6 +95,7 @@ interface UmsgLib {
      * @deprecated You should be using net instead
      */
     Start(name: string, filter?: Player): void;
+
     /**
      * Writes a null terminated string to the usermessage.
      * @realm server
@@ -93,6 +103,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     String(string: string): void;
+
     /**
      * Writes a Vector to the usermessage.
      * @realm server
@@ -100,6 +111,7 @@ interface UmsgLib {
      * @deprecated You should be using the net instead
      */
     Vector(vector: Vector): void;
+
     /**
      * Writes a vector normal to the usermessage.
      * @realm server
@@ -108,16 +120,3 @@ interface UmsgLib {
      */
     VectorNormal(normal: Vector): void;
 }
-
-
-
-
-
-
-
-
-
-
-
-
-