@tlua/gmod 1.0.1

package/gamemode.d.tlua

@@ -0,0 +1,48 @@
+// AUTO-GENERATED tlua declarations. Do not edit by hand.
+
+/**
+ * The gamemode library provides functions relating to the gamemode system in Garry's Mod. This entire library also passes through the C -> Lua bridge.
+ * @source https://wiki.facepunch.com/gmod/gamemode
+ */
+declare gamemode: GamemodeLib;
+
+interface GamemodeLib {
+    /**
+     * Called by the engine to call a hook within the loaded gamemode.
+     *
+     * The supplied event 'name' must be defined in the active gamemode. Otherwise, nothing will happen - not even hooks added with [hook.Add](https://wiki.facepunch.com/gmod/hook.Add) will be called.
+     *
+     * This is similar to [hook.Run](https://wiki.facepunch.com/gmod/hook.Run) and [hook.Call](https://wiki.facepunch.com/gmod/hook.Call), except the hook library will call hooks created with hook.Add even if there is no corresponding gamemode function.
+     *
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/gamemode.Call
+     */
+    Call(name: string, ...: any): any;
+}
+
+interface GamemodeLib {
+    /**
+     * INTERNAL: This is used internally - although you're able to use it you
+     * probably shouldn't. This returns the internally stored gamemode table.
+     *
+     * NOTE: the wiki maps the name string to a concrete gamemode table via a
+     * class-string generic; tlua cannot map a string literal to a nominal type,
+     * so this returns the base GM.
+     * @realm shared
+     * @realm menu
+     * @source https://wiki.facepunch.com/gmod/gamemode.Get
+     */
+    Get(name: string): GM;
+}
+
+
+interface GamemodeLib {
+    /**
+     * **INTERNAL**: This is used internally - although you're able to use it you probably shouldn't.
+     * Called by the engine when a gamemode is being loaded.
+     * @realm shared
+     * @source https://wiki.facepunch.com/gmod/gamemode.Register
+     */
+    Register(gm: table, name: string, derived: string): void;
+}
+