@tlua/gmod 1.0.1

package/editablepanel.d.tlua

@@ -0,0 +1,10 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * 		Base panel used by [DFrame](https://wiki.facepunch.com/gmod/DFrame), this panel is needed so that elements such as the [TextEntry](https://wiki.facepunch.com/gmod/TextEntry) can obtain focus.
+ *
+ * @realm client
+ * @source https://wiki.facepunch.com/gmod/EditablePanel
+ */
+interface EditablePanel extends Panel {}
+

package/effect.d.tlua

@@ -0,0 +1,121 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * These hooks are used inside of a Lua effect. Lua effects are stored in either the `/lua/effects` directory or in a gamemode in `/gamemodes//entities/effects`.
+ *
+ * Effects are entities with the classname `class CLuaEffect`, and as such, [Entity](https://wiki.facepunch.com/gmod/Entity) functions are usable on them (using the `self` argument).
+ *
+ * An `EFFECT` is made using either a combination of the [EFFECT:Init](https://wiki.facepunch.com/gmod/EFFECT:Init), [EFFECT:Render](https://wiki.facepunch.com/gmod/EFFECT:Render) and optionally the [EFFECT:Think](https://wiki.facepunch.com/gmod/EFFECT:Think) hook. Another way is to create all particles in one go in the `Init` hook and don't use the other hooks at all.
+ *
+ * 	Creates a particle effect using a combination of the Init and the Think hooks.
+ *
+ * function EFFECT:Init( data )
+ * 	-- Because CEffectData is a shared object, we can't just store it and use its' properties later
+ * 	-- Instead, we store the properties themselves
+ * 	self.offset = data:GetOrigin() + Vector( 0, 0, 0.2 )
+ * 	self.angles = data:GetAngles()
+ * 	self.particles = 4
+ * end
+ *
+ * function EFFECT:Think()
+ * 	return true
+ * end
+ *
+ * function EFFECT:Render()
+ * 	local emitter = ParticleEmitter( self.offset, false )
+ * 		for i=0, self.particles do
+ * 			local particle = emitter:Add( "effects/softglow", self.offset )
+ * 			if particle then
+ * 				particle:SetAngles( self.angles )
+ * 				particle:SetVelocity( Vector( 0, 0, 15 ) )
+ * 				particle:SetColor( 255, 102, 0 )
+ * 				particle:SetLifeTime( 0 )
+ * 				particle:SetDieTime( 0.2 )
+ * 				particle:SetStartAlpha( 255 )
+ * 				particle:SetEndAlpha( 0 )
+ * 				particle:SetStartSize( 1.6 )
+ * 				particle:SetStartLength( 1 )
+ * 				particle:SetEndSize( 1.2 )
+ * 				particle:SetEndLength( 4 )
+ * 			end
+ * 		end
+ * 	emitter:Finish()
+ * end
+ *
+ *
+ *
+ *
+ *
+ *
+ * 	Creates a particle effect using only the Init hook. To use this effect in a loop one needs to create a new instance of this effect every drawn frame.
+ *
+ * function EFFECT:Init( data )
+ * 	local vOffset = data:GetOrigin() + Vector( 0, 0, 0.2 )
+ * 	local vAngle = data:GetAngles()
+ * 	local emitter = ParticleEmitter( vOffset, false )
+ * 		for i=0,4 do
+ * 			local particle = emitter:Add( "effects/softglow", vOffset )
+ * 			if particle then
+ * 				particle:SetAngles( vAngle )
+ * 				particle:SetVelocity( Vector( 0, 0, 15 ) )
+ * 				particle:SetColor( 255, 102, 0 )
+ * 				particle:SetLifeTime( 0 )
+ * 				particle:SetDieTime( 0.2 )
+ * 				particle:SetStartAlpha( 255 )
+ * 				particle:SetEndAlpha( 0 )
+ * 				particle:SetStartSize( 1.6 )
+ * 				particle:SetStartLength( 1 )
+ * 				particle:SetEndSize( 1.2 )
+ * 				particle:SetEndLength( 4 )
+ * 			end
+ * 		end
+ * 	emitter:Finish()
+ * end
+ *
+ * function EFFECT:Think()
+ * 	return false
+ * end
+ *
+ * function EFFECT:Render()
+ * end
+ *
+ *
+ *
+ *
+ * @source https://wiki.facepunch.com/gmod/EFFECT_Hooks
+ */
+interface EFFECT extends Entity {}
+
+interface EFFECT {
+    /**
+     * Used to get the "real" start position of a trace, for weapon tracer effects.
+     *
+     * "real" meaning in 3rd person, the 3rd person position will be used, in first person the first person position will be used.
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/EFFECT:GetTracerShootPos
+     */
+    GetTracerShootPos(self: EFFECT, pos: Vector, ent: Weapon, attachment: number): Vector;
+}
+
+interface EFFECT {
+    /**
+     * Called when the effect is created.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/EFFECT:Init
+     */
+    Init(self: EFFECT, effectData: CEffectData): void;
+}
+
+interface EFFECT {
+    /**
+     * Called when the effect should be rendered.
+     *
+     * 	When not overridden, it will perform default action, which is [Entity:DrawModel](https://wiki.facepunch.com/gmod/Entity:DrawModel).
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/EFFECT:Render
+     */
+    Render(self: EFFECT): void;
+}
+

package/effects.d.tlua

@@ -0,0 +1,77 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The effects library allows you to manually add scripted effects.
+ * @source https://wiki.facepunch.com/gmod/Effects
+ */
+declare effects: EffectsLib;
+
+interface EffectsLib {
+    /**
+     * Creates a "beam ring point" effect.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/effects.BeamRingPoint
+     */
+    BeamRingPoint(pos: Vector, lifetime: number, startRad: number, endRad: number, width: number, amplitude: number, color: Color, extra: table): void;
+}
+
+interface EffectsLib {
+    /**
+     * Creates a bubble trail effect, the very same you get when shooting underwater.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/effects.BubbleTrail
+     */
+    BubbleTrail(startPos: Vector, endPos: Vector, count: number, height: number, speed?: number, delay?: number): void;
+}
+
+interface EffectsLib {
+    /**
+     * Creates a bunch of bubbles inside a defined box.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/effects.Bubbles
+     */
+    Bubbles(mins: Vector, maxs: Vector, count: number, height: number, speed?: number, delay?: number): void;
+}
+
+interface EffectsLib {
+    /**
+     * **INTERNAL**: You are looking for [util.Effect](https://wiki.facepunch.com/gmod/util.Effect).
+     * Returns the table of the effect specified.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/effects.Create
+     */
+    Create(name: string): table;
+}
+
+interface EffectsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Returns a list of all Lua-defined effects.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/effects.GetList
+     */
+    GetList(): table;
+}
+
+interface EffectsLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Registers a new effect.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/effects.Register
+     */
+    Register(effect_table: table, name: string): void;
+}
+
+interface EffectsLib {
+    /**
+     * Imitates the "near miss" tracer sound, with the ability to override the sound played.
+     *
+     * The frequency of the sound is limited internally, as to not overwhelm the player. (same as normal tracers)
+     *
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/effects.TracerSound
+     */
+    TracerSound(start: Vector, endpos: Vector, tracerType?: number, soundOverride?: string): void;
+}
+

package/engine.d.tlua

@@ -0,0 +1,248 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The engine library provides functions to access various features in the game's engine, most are related to the demo and save systems.
+ * @source https://wiki.facepunch.com/gmod/engine
+ */
+declare engine: EngineLib;
+
+interface EngineLib {
+    /**
+     * Returns non paused [Global.FrameTime](https://wiki.facepunch.com/gmod/Global.FrameTime).
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/engine.AbsoluteFrameTime
+     */
+    AbsoluteFrameTime(): number;
+}
+
+interface EngineLib {
+    /**
+     * Returns the name of the currently running gamemode.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/engine.ActiveGamemode
+     */
+    ActiveGamemode(): string;
+}
+
+interface EngineLib {
+    /**
+     * Closes the server and completely exits.
+     *
+     * To enable this function for use on your server, add `-allowquit` to your commandline, which will make this function run `quit keep_players` when executed, this also does not forcibly disconnect players.
+     *
+     * This is also available when running in server test mode (launch option `-systemtest`). Server test mode is used internally at Facepunch as part of the build process to make sure that the dedicated servers aren't crashing on startup.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/engine.CloseServer
+     */
+    CloseServer(): void;
+}
+
+interface EngineLib {
+    /**
+     * Returns a list of addons the player have subscribed to on the workshop.
+     *
+     * This list will also include "Floating" .gma addons that are mounted by the game, but not the folder addons.
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/engine.GetAddons
+     */
+    GetAddons(): table;
+}
+
+interface EngineLib {
+    /**
+     * When starting playing a demo, [engine.GetDemoPlaybackTick](https://wiki.facepunch.com/gmod/engine.GetDemoPlaybackTick) will be reset and its old value will be added to this functions return value.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/engine.GetDemoPlaybackStartTick
+     */
+    GetDemoPlaybackStartTick(): number;
+}
+
+interface EngineLib {
+    /**
+     * Current tick of currently loaded demo.
+     *
+     * If not playing a demo, it will return amount of ticks since last demo playback.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/engine.GetDemoPlaybackTick
+     */
+    GetDemoPlaybackTick(): number;
+}
+
+interface EngineLib {
+    /**
+     * Returns time scale of demo playback.
+     *
+     * If not during demo playback, returns 1.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/engine.GetDemoPlaybackTimeScale
+     */
+    GetDemoPlaybackTimeScale(): number;
+}
+
+interface EngineLib {
+    /**
+     * Returns total amount of ticks of currently loaded demo.
+     *
+     * If not playing a demo, returns 0 or the value of last played demo.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/engine.GetDemoPlaybackTotalTicks
+     */
+    GetDemoPlaybackTotalTicks(): number;
+}
+
+interface EngineLib {
+    /**
+     * Returns a table containing info for all installed gamemodes.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/engine.GetGamemodes
+     */
+    GetGamemodes(): table;
+}
+
+interface EngineLib {
+    /**
+     * Returns an array of tables corresponding to all games from which Garry's Mod supports mounting content.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/engine.GetGames
+     */
+    GetGames(): table;
+}
+
+interface EngineLib {
+    /**
+     * Returns the UGC (demos, saves and dupes) the player have subscribed to on the workshop.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/engine.GetUserContent
+     * @deprecated Used internally for in-game menus, may be merged in the future into engine.GetAddons.
+     */
+    GetUserContent(): table;
+}
+
+interface EngineLib {
+    /**
+     * Returns true if we're currently playing a demo.
+     *
+     * You will notice that there's no server-side version of this. That's because there is no server when playing a demo. Demos are both recorded and played back purely clientside.
+     *
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/engine.IsPlayingDemo
+     */
+    IsPlayingDemo(): boolean;
+}
+
+interface EngineLib {
+    /**
+     * Returns true if the game is currently recording a demo file (.dem) using gm_demo.
+     * @realm client and menu
+     * @source https://wiki.facepunch.com/gmod/engine.IsRecordingDemo
+     */
+    IsRecordingDemo(): boolean;
+}
+
+interface EngineLib {
+    /**
+     * This is a direct binding to the function `engine->LightStyle`. This function allows you to change the default light style of the map - so you can make lighting lighter or darker. You’ll need to call [render.RedownloadAllLightmaps](https://wiki.facepunch.com/gmod/render.RedownloadAllLightmaps) clientside to refresh the lightmaps to this new color.
+     *
+     * Calling this function with arguments 0 and "a" will cause dynamic lights such as those produced by the Light tool to stop working.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/engine.LightStyle
+     */
+    LightStyle(lightstyle: number, pattern: string): void;
+}
+
+interface EngineLib {
+    /**
+     * Loads a duplication from the local filesystem.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/engine.OpenDupe
+     */
+    OpenDupe(dupeName: string): table;
+}
+
+interface EngineLib {
+    /**
+     * Returns an estimate of the server's performance. Equivalent to calling [Global.FrameTime](https://wiki.facepunch.com/gmod/Global.FrameTime) from the server, according to source code.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/engine.ServerFrameTime
+     */
+    ServerFrameTime(): (number, number);
+}
+
+interface EngineLib {
+    /**
+     * Sets the mounting options for mountable content.
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/engine.SetMounted
+     */
+    SetMounted(depotID: string, doMount: boolean): void;
+}
+
+interface EngineLib {
+    /**
+     * Returns the number of ticks since the game server started.
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/engine.TickCount
+     */
+    TickCount(): number;
+}
+
+interface EngineLib {
+    /**
+     * Returns the time interval between each game tick in seconds.
+     *
+     * This function is useful for making animations (usually serverside, such as doors rotating) and similar things to be independent of the tickrate in hooks that run at the tick rate, such as [GM:Tick](https://wiki.facepunch.com/gmod/GM:Tick).
+     *
+     * Clientside you'd want to use [Global.FrameTime](https://wiki.facepunch.com/gmod/Global.FrameTime) for this purpose in hooks that run every frame.
+     *
+     * The default tickrate is `66.6666`, aka `15` milliseconds interval between each game tick.
+     * The tickrate can be adjusted via the `-tickrate` [command line option](https://wiki.facepunch.com/gmod/Command_Line_Parameters).
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/engine.TickInterval
+     */
+    TickInterval(): number;
+}
+
+interface EngineLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     *
+     *
+     * Returns video recording settings set by [video.Record](https://wiki.facepunch.com/gmod/video.Record). Used by Demo-To-Video feature.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/engine.VideoSettings
+     */
+    VideoSettings(): table;
+}
+
+interface EngineLib {
+    /**
+     * **INTERNAL**: Do not use.
+     *
+     *
+     * Saves a duplication as a file.
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/engine.WriteDupe
+     */
+    WriteDupe(dupe: string, jpeg: string): void;
+}
+
+interface EngineLib {
+    /**
+     * **INTERNAL**: Do not use.
+     *
+     * Stores savedata into the game. (can be loaded using the LoadGame menu)
+     * @realm client
+     * @source https://wiki.facepunch.com/gmod/engine.WriteSave
+     */
+    WriteSave(saveData: string, name: string): void;
+}
+