@tlua/gmod 1.0.1

package/game.d.tlua

@@ -0,0 +1,482 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The game library provides functions to access various features in the game's engine, most of it's functions are related to controlling the map.
+ * @source https://wiki.facepunch.com/gmod/game
+ */
+declare game: GameLib;
+
+interface GameLib {
+    /**
+     * Adds a new ammo type to the game.
+     *
+     * You can find a list of default ammo types [here](https://wiki.facepunch.com/gmod/Default_Ammo_Types).
+     *
+     * **WARNING**: This function **must** be called on both the client and server in [GM:Initialize](https://wiki.facepunch.com/gmod/GM:Initialize) or you will have unexpected problems.
+     *
+     * **NOTE**: There is a limit of 256 ammo types, including the default ones.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.AddAmmoType
+     */
+    AddAmmoType(ammoData: AmmoData): void;
+}
+
+interface GameLib {
+    /**
+     * Registers a new decal.
+     *
+     * **WARNING**: There's a rather low limit of around 256 for decal materials that may be registered and they are not cleared on map load.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.AddDecal
+     */
+    AddDecal(decalName: string, materialName: string): void;
+}
+
+interface GameLib {
+    /**
+     * Loads a particle file. Individual particle systems will still need to be precached with [Global.PrecacheParticleSystem](https://wiki.facepunch.com/gmod/Global.PrecacheParticleSystem).
+     *
+     * **NOTE**: You will still need to call this function clientside regardless if you create the particle effects serverside.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.AddParticles
+     */
+    AddParticles(particleFileName: string): void;
+}
+
+interface GameLib {
+    /**
+     * **INTERNAL**: Consider using [game.GetAmmoTypes](https://wiki.facepunch.com/gmod/game.GetAmmoTypes) and [game.GetAmmoData](https://wiki.facepunch.com/gmod/game.GetAmmoData) instead.
+     *
+     * Called by the engine to retrieve the ammo types.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.BuildAmmoTypes
+     */
+    BuildAmmoTypes(): table;
+}
+
+interface GameLib {
+    /**
+     * Removes most entities, and then respawns entities created by the map, as if the map was just loaded.
+     *
+     * There are certain exclusions, such as players or weapons held by players, soundscapes and others.
+     * [EFL_KEEP_ON_RECREATE_ENTITIES](https://wiki.facepunch.com/gmod/enums/EFL) can be set on entities to preserve them through a map cleanup.
+     *
+     * On the client it will remove decals, sounds, gibs, dead NPCs, and entities created via [ents.CreateClientProp](https://wiki.facepunch.com/gmod/ents.CreateClientProp). This function is ran on all clients from server automatically, when it is called on the server.
+     *
+     * This function calls [GM:PreCleanupMap](https://wiki.facepunch.com/gmod/GM:PreCleanupMap) before cleaning up the map and [GM:PostCleanupMap](https://wiki.facepunch.com/gmod/GM:PostCleanupMap) after cleaning up the map.
+     *
+     * Beware of calling this function in hooks that may be called on map clean up (such as [ENTITY:StartTouch](https://wiki.facepunch.com/gmod/ENTITY:StartTouch)) to avoid infinite loops.
+     *
+     * Calling this destroys all BASS streams.
+     * The EFL_KEEP_ON_RECREATE_ENTITIES flag doesn't prevent an entity from being recreated, which means flagged entities will be duplicated since they are both kept and recreated.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.CleanUpMap
+     */
+    CleanUpMap(dontSendToClients?: boolean, extraFilters?: table, callback?: function): void;
+}
+
+interface GameLib {
+    /**
+     * Runs a console command.
+     * Make sure to add a newline ("\n") at the end of the command.
+     *
+     * **WARNING**: If you use data that were received from a client, you should avoid using this function because newline and semicolon (at least) allow the client to run arbitrary commands!
+     *
+     * For safety, you are urged to prefer using [Global.RunConsoleCommand](https://wiki.facepunch.com/gmod/Global.RunConsoleCommand) in this case.
+     *
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.ConsoleCommand
+     */
+    ConsoleCommand(stringCommand: string): void;
+}
+
+interface GameLib {
+    /**
+     * 		Returns information about the currently active 3D skybox.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.Get3DSkyboxInfo
+     */
+    Get3DSkyboxInfo(): Sky3DParams[];
+}
+
+interface GameLib {
+    /**
+     * Returns the damage type of given ammo type.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoDamageType
+     */
+    GetAmmoDamageType(id: number): number;
+}
+
+interface GameLib {
+    /**
+     * Returns the [Structures/AmmoData](https://wiki.facepunch.com/gmod/Structures/AmmoData) for given ID.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoData
+     */
+    GetAmmoData(id: number): AmmoData;
+}
+
+interface GameLib {
+    /**
+     * Returns the ammo bullet force that is applied when an entity is hit by a bullet of given ammo type.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoForce
+     */
+    GetAmmoForce(id: number): number;
+}
+
+interface GameLib {
+    /**
+     * Returns the ammo type ID for given ammo type name.
+     *
+     * See [game.GetAmmoName](https://wiki.facepunch.com/gmod/game.GetAmmoName) for reverse.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoID
+     */
+    GetAmmoID(name: string): number;
+}
+
+interface GameLib {
+    /**
+     * Returns the real maximum amount of ammo of given ammo ID, regardless of the setting of `gmod_maxammo` convar.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoMax
+     */
+    GetAmmoMax(id: number): number;
+}
+
+interface GameLib {
+    /**
+     * Returns the damage given ammo type should do to NPCs.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoNPCDamage
+     */
+    GetAmmoNPCDamage(id: number): number;
+}
+
+interface GameLib {
+    /**
+     * Returns the ammo name for given ammo type ID.
+     *
+     * See [game.GetAmmoID](https://wiki.facepunch.com/gmod/game.GetAmmoID) for reverse.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoName
+     */
+    GetAmmoName(id: number): string;
+}
+
+interface GameLib {
+    /**
+     * Returns the damage given ammo type should do to players.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoPlayerDamage
+     */
+    GetAmmoPlayerDamage(id: number): number;
+}
+
+interface GameLib {
+    /**
+     * Returns a list of all ammo types currently registered.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetAmmoTypes
+     */
+    GetAmmoTypes(): Table<number, string>;
+}
+
+interface GameLib {
+    /**
+     * Returns the counter of a Global State.
+     *
+     * See [Global States](https://wiki.facepunch.com/gmod/Global_States) for more information.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.GetGlobalCounter
+     */
+    GetGlobalCounter(name: string): number;
+}
+
+interface GameLib {
+    /**
+     * Returns whether a Global State is off, active or dead ( inactive ).
+     *
+     * See [Global States](https://wiki.facepunch.com/gmod/Global_States) for more information.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.GetGlobalState
+     */
+    GetGlobalState(name: string): number;
+}
+
+interface GameLib {
+    /**
+     * Returns the public IP address and port of the current server. This will return the IP/port that you are connecting through when ran clientside.
+     * **NOTE**: Returns "loopback" in singleplayer.
+     *
+     *
+     * Returns "0.0.0.0:`port`" on the server when called too early, including in [GM:Initialize](https://wiki.facepunch.com/gmod/GM:Initialize) and [GM:InitPostEntity](https://wiki.facepunch.com/gmod/GM:InitPostEntity). This bug seems to only happen the first time a server is launched, and will return the correct value after switching maps.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetIPAddress
+     */
+    GetIPAddress(): string;
+}
+
+interface GameLib {
+    /**
+     * Returns the name of the current map, without a file extension.
+     * On the menu state, returns "menu".
+     * **WARNING**: In Multiplayer this does not return the current map in the CLIENT realm before [GM:Initialize](https://wiki.facepunch.com/gmod/GM:Initialize).
+     *
+     *
+     * @realm shared and menu
+     * @source https://wiki.facepunch.com/gmod/game.GetMap
+     */
+    GetMap(): string;
+}
+
+interface GameLib {
+    /**
+     * Returns the current map change count for the server.
+     *
+     * This is useful to determine whether the current map is the initial map, or whether a `changelevel` (using `map` command is also detected) has occurred at any point in the server's session.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.GetMapChangeCount
+     */
+    GetMapChangeCount(): number;
+}
+
+interface GameLib {
+    /**
+     * Returns the next map that would be loaded according to the file that is set by the mapcyclefile convar.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.GetMapNext
+     */
+    GetMapNext(): string;
+}
+
+interface GameLib {
+    /**
+     * Returns the revision (Not to be confused with [VBSP Version](https://developer.valvesoftware.com/wiki/Source_BSP_File_Format#Versions)) and BSP version of the current map.
+     *
+     * Map revision is the amount of times the map file was saved in Hammer at the time of the map being compiled. This is useful to detect when a map has changed.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.GetMapVersion
+     */
+    GetMapVersion(): (number, number);
+}
+
+interface GameLib {
+    /**
+     * Returns the difficulty level of the game.
+     *
+     * **TIP:** You can use this function in your scripted NPCs or Nextbots to make them stronger, however, it is a good idea to lock powerful attacks behind the highest difficulty instead of just increasing the health.
+     *
+     * **NOTE**: Internally this is tied to the gamerules entity, so you'll have to wait until [GM:InitPostEntity](https://wiki.facepunch.com/gmod/GM:InitPostEntity) is called to return the skill level.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetSkillLevel
+     */
+    GetSkillLevel(): number;
+}
+
+interface GameLib {
+    /**
+     * 		Returns the time scale set with [game.SetTimeScale](https://wiki.facepunch.com/gmod/game.SetTimeScale).
+     *
+     * 		If you want to get the value of `host_timescale`, use:
+     * 		```lua
+     * local timescale = GetConVar( "host_timescale" ):GetFloat()
+     * 		```
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetTimeScale
+     */
+    GetTimeScale(): number;
+}
+
+interface GameLib {
+    /**
+     * Returns the wind's velocity at a given position, as influenced by current map's [env_wind](https://developer.valvesoftware.com/wiki/Env_wind) entities.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetWindSpeed
+     */
+    GetWindSpeed(pos?: Vector): Vector;
+}
+
+interface GameLib {
+    /**
+     * Returns the worldspawn entity.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.GetWorld
+     */
+    GetWorld(): Entity;
+}
+
+interface GameLib {
+    /**
+     * Returns true if the server is a dedicated server, false if it is a listen server or a singleplayer game.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.IsDedicated
+     */
+    IsDedicated(): boolean;
+}
+
+interface GameLib {
+    /**
+     * Kicks a player from the server. This can be ran before the player has spawned.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.KickID
+     */
+    KickID(id: string, reason?: string): void;
+}
+
+interface GameLib {
+    /**
+     * Loads the next map according to the `nextlevel` convar, or from the current `mapcyclefile` set by the respective convar.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.LoadNextMap
+     */
+    LoadNextMap(): void;
+}
+
+interface GameLib {
+    /**
+     * Returns the map load type of the current map.
+     *
+     * After changing the map with the console command `changelevel`, "newgame" is returned. With `changelevel2` (single player only), "transition" is returned.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.MapLoadType
+     */
+    MapLoadType(): string;
+}
+
+interface GameLib {
+    /**
+     * Returns the maximum amount of players (including bots) that the server can have.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.MaxPlayers
+     */
+    MaxPlayers(): number;
+}
+
+interface GameLib {
+    /**
+     * Mounts a GMA addon from the disk.
+     * Can be used with [steamworks.DownloadUGC](https://wiki.facepunch.com/gmod/steamworks.DownloadUGC).
+     *
+     * **NOTE**: Any error models currently loaded that the mounted addon provides will be reloaded.
+     *
+     *
+     * Any error materials currently loaded that the mounted addon provides will NOT be reloaded. That means that this cannot be used to fix missing map materials, as the map materials are loaded before you are able to call this.
+     *
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.MountGMA
+     */
+    MountGMA(path: string): (boolean, table);
+}
+
+interface GameLib {
+    /**
+     * Removes all the clientside ragdolls. On server, it will remove all `prop_ragdolls` that have the `SF_RAGDOLLPROP_USE_LRU_RETIREMENT` (4096) spawnflag.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.RemoveRagdolls
+     */
+    RemoveRagdolls(): void;
+}
+
+interface GameLib {
+    /**
+     * Sets the counter of a Global State.
+     *
+     * See [Global States](https://wiki.facepunch.com/gmod/Global_States) for more information.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.SetGlobalCounter
+     */
+    SetGlobalCounter(name: string, count: number): void;
+}
+
+interface GameLib {
+    /**
+     * Sets whether a Global State is off, active or dead ( inactive ).
+     *
+     * See [Global States](https://wiki.facepunch.com/gmod/Global_States) for more information.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.SetGlobalState
+     */
+    SetGlobalState(name: string, state: number): void;
+}
+
+interface GameLib {
+    /**
+     * Sets the difficulty level of the game, can be retrieved with [game.GetSkillLevel](https://wiki.facepunch.com/gmod/game.GetSkillLevel).
+     *
+     * This will automatically change whenever the "skill" convar is modified serverside.
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.SetSkillLevel
+     */
+    SetSkillLevel(level: number): void;
+}
+
+interface GameLib {
+    /**
+     * Sets the time scale of the game logic.
+     *
+     * To slow down or speed up the movement of a specific player, use [Player:SetLaggedMovementValue](https://wiki.facepunch.com/gmod/Player:SetLaggedMovementValue) instead.
+     *
+     * See [physenv.SetTimeScale](https://wiki.facepunch.com/gmod/physenv.SetTimeScale) if you wish to only scale the physics timescale.
+     *
+     * This function is meant to remove the need of using the `host_timescale` convar, which is cheat protected.
+     * The true timescale will be `host_timescale` multiplied by [game.GetTimeScale](https://wiki.facepunch.com/gmod/game.GetTimeScale).
+     *
+     * Like `host_timescale`, this method does not affect sounds, if you wish to change that, look into [GM:EntityEmitSound](https://wiki.facepunch.com/gmod/GM:EntityEmitSound).
+     *
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.SetTimeScale
+     */
+    SetTimeScale(timeScale: number): void;
+}
+
+interface GameLib {
+    /**
+     * Returns whether the current session is a single player game.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/game.SinglePlayer
+     */
+    SinglePlayer(): boolean;
+}
+
+interface GameLib {
+    /**
+     * Returns the name of the entity that should be used as player start position.
+     *
+     * This is not the same thing as spawn points (See [GM:PlayerSelectSpawn](https://wiki.facepunch.com/gmod/GM:PlayerSelectSpawn) for that), this is used to properly transit the player between maps, and therefore will only be set after a level change via `trigger_changelevel` entity in singleplayer.
+     * @realm server
+     * @source https://wiki.facepunch.com/gmod/game.StartSpot
+     */
+    StartSpot(): string;
+}
+