Garry's Mod Lua API

https://gmodwiki.com
Admin
This project provides comprehensive documentation for the Garry's Mod Lua API, detailing functions,...
Tokens:731,245
Snippets:9,396
Trust Score:4.8
Update:3 months ago
Show doc for...
Tokens:
Raw
### DColorButton Example

Source: https://gmodwiki.com/DColorButton

Example of how to create and configure a DColorButton.

```APIDOC
## Creating and Using DColorButton

### Description
This example demonstrates how to create a DColorButton, set its properties, and define a click behavior.

### Code
```lua
local frame = vgui.Create( "DFrame" )
frame:SetSize( 500, 500 )
frame:Center()
frame:MakePopup()

local DColorButton = vgui.Create( "DColorButton", frame )
DColorButton:SetPos( 1, 28 )
DColorButton:SetSize( 100, 30 )
DColorButton:Paint( 100, 30 ) -- Note: Paint is usually called internally, direct calls might not be intended for general use.
DColorButton:SetText( "DColorButton" )
DColorButton:SetColor( Color( 0, 110, 160 ) )

function DColorButton:DoClick()
  -- Callback inherited from DLabel, which is DColorButton's base
  print( "I am clicked! My color is ", self:GetColor() )
end
```
```

--------------------------------

### Creating and Using DPropertySheet

Source: https://gmodwiki.com/DPropertySheet

This example demonstrates how to create a DPropertySheet, add multiple tabs with custom panels and icons, and dock it within a DFrame. It shows the basic setup for organizing UI elements with tabs.

```lua
local frame = vgui.Create( "DFrame" )
frame:SetSize( 500, 300 )
frame:Center()
frame:MakePopup()

local sheet = vgui.Create( "DPropertySheet", frame )
sheet:Dock( FILL )

local panel1 = vgui.Create( "DPanel", sheet )
panel1.Paint = function( self, w, h )
    draw.RoundedBox( 4, 0, 0, w, h, Color( 0, 128, 255, self:GetAlpha() ) )
end
sheet:AddSheet( "test", panel1, "icon16/cross.png" )

local panel2 = vgui.Create( "DPanel", sheet )
panel2.Paint = function( self, w, h )
    draw.RoundedBox( 4, 0, 0, w, h, Color( 255, 128, 0, self:GetAlpha() ) )
end
sheet:AddSheet( "test 2", panel2, "icon16/tick.png" )
```

--------------------------------

### Example Usage

Source: https://gmodwiki.com/HTML

An example demonstrating how to create and display an HTML control within Garry's Mod.

```APIDOC
## Example Usage

### Description
This example shows how to create a simple HTML control that displays a specified URL.

### Code
```lua
__concommand.Add( "test_html", function() local frame = vgui.Create( "DFrame" ) -- The name of the panel we don't have to parent it. frame:SetPos( 100, 100 ) -- Set the position to 100x by 100y.  frame:SetSize( 500, 500 ) -- Set the size to 300x by 200y. frame:SetTitle( "HTML Test" ) -- Set the title in the top left to "Derma Frame". frame:MakePopup() -- Makes your mouse be able to move around. local HTMLTest = vgui.Create( "HTML", frame ) HTMLTest:Dock( FILL ) HTMLTest:OpenURL( "http://wiki.garrysmod.com" ) end )
```
```

--------------------------------

### Net Library: Hello World Example

Source: https://gmodwiki.com/Networking_Usage

Demonstrates sending a 'Hello World' string from server to client using the net library. Ensure 'Example' network string is registered server-side before use.

```lua
if SERVER then
    util.AddNetworkString( "Example" )
    net.Start( "Example" )
    net.WriteString( "Hello World" )
    net.Broadcast()
else
    net.Receive( "Example", function()
        print( net.ReadString() )
    end)
end
```

--------------------------------

### Example Dedicated Server Startup Command

Source: https://gmodwiki.com/Workshop_for_Dedicated_Servers

This example demonstrates a full startup command for a dedicated server. It sets the player count, specifies a Workshop collection to download addons from, sets the gamemode, and loads a specific map.

```bash
srcds.exe +maxplayers 20 -console +host_workshop_collection 157384458 +gamemode zombiesurvival +map zs_cleanoffice_v2
```

--------------------------------

### client_beginconnect Event Listener Example

Source: https://gmodwiki.com/gameevent/client_beginconnect

This example demonstrates how to listen for the client_beginconnect event and access its data. It requires the 'gameevent' Binary Module because the event is only available in the Menu state.

```lua
__require("gameevent") -- using a Binary Module because the Menu State doesn't has gameevent.Listen
gameevent.Listen( "client_beginconnect" )
hook.Add( "client_beginconnect", "client_beginconnect_example", function( data )
local address = data.address // The Server address.
local ip = data.ip // The Server IP. Use the address instead!
local port = data.port // The Server Port.
local source = data.source // The Source, why the client is connecting to the Server.
// Called when trying to connect to aServer.
end )
```

--------------------------------

### Localization .properties File Example

Source: https://gmodwiki.com/Addon_Localization

Example of a `.properties` file used for localization. Lines starting with '#' are comments. Keys and values are separated by '=', and the first line must be empty.

```properties
#spawnmenu.properties
spawnmenu.content_tab=Spawnlists
spawnmenu.category.npcs=NPCs
spawnmenu.category.addons=Addons
spawnmenu.category.weapons=Weapons
spawnmenu.category.postprocess=Post Process
spawnmenu.category.your_spawnlists=Your Spawnlists
spawnmenu.category.addon_spawnlists=Addon Spawnlists
spawnmenu.category.games=Games
spawnmenu.category.browse=Browse
spawnmenu.category.entities=Entities
spawnmenu.category.vehicles=Vehicles
spawnmenu.category.creations=Creations
spawnmenu.category.dupes=Dupes
spawnmenu.category.saves=Saves
```

--------------------------------

### Weapon Setup and Logic with Think Hook

Source: https://gmodwiki.com/Prediction

This example demonstrates how to set up network variables and implement weapon logic, such as primary attacks and idle animations, using the Think hook instead of timers. It ensures variables are correctly restored during prediction errors.

```lua
function SWEP:SetupDataTables()
    self:NetworkVar( "Float" , 0 , "NextIdle" )
end

function SWEP:Initialize()
    self:SetNextIdle( 0 )
end

function SWEP:PrimaryAttack()
    self:SetNextPrimaryFire( CurTime() + 1 )
    self:SendWeaponAnim( ACT_VM_PRIMARYATTACK )
    self:SetNextIdle( CurTime() + self:SequenceDuration() )
end

function SWEP:Think()
    if self:GetNextIdle() ~= 0 and self:GetNextIdle() < CurTime() then
        self:SendWeaponAnim( ACT_VM_IDLE )
        self:SetNextIdle( 0 )
    end
end
```

--------------------------------

### Basic OnRequestFullUpdate Example with All Arguments

Source: https://gmodwiki.com/gameevent/OnRequestFullUpdate

This example provides a template for the OnRequestFullUpdate event, showcasing how to access all available data fields: name, networkid, userid, and index. It serves as a starting point for understanding the data provided by the event.

```lua
gameevent.Listen( "OnRequestFullUpdate" )
hook.Add( "OnRequestFullUpdate", "OnRequestFullUpdate_example", function( data )
	local name = data.name // Same as Player:Nick()
	local steamid = data.networkid // Same as Player:SteamID()
	local id = data.userid // Same as Player:UserID()
	local index = data.index // Same as Entity:EntIndex() minus one

	-- Called when a player requests a full update from the server.
end )
```

--------------------------------

### Mount Configuration Example

Source: https://gmodwiki.com/Mounting_Content_on_a_Dedicated_Server

This is an example of a `mount.cfg` file, which instructs Garry's Mod to scan specified folders and mount their contents. It maps game identifiers to their respective directory paths.

```cfg
"mountcfg" { "cstrike" "C:\\steamcmd\\steamapps\\common\\Counter-Strike Source Dedicated Server\\cstrike" "tf" "C:/mytf2server/tf" }
```

--------------------------------

### Full Module Example with Lua Integration

Source: https://gmodwiki.com/Binary_Modules_Detouring_Functions

A complete example demonstrating function detouring and integrating with Lua to control the detour's behavior.

```cpp
#include <GarrysMod/FactoryLoader.hpp>
#include <scanning/symbolfinder.hpp>
#include <GarrysMod/Symbol.hpp>
#include <detouring/hook.hpp>

typedef bool (*ShouldHideServer)();
Detouring::Hook detour_ShouldHideServer;
const std::vector<Symbol> ShouldHideServerSyms = {
    Symbol::FromName("_ZN14CServerGameDLL16ShouldHideServerEv"), // Our signature for CServerGameDLL::ShouldHideServer
};

bool hide_server = true;

bool hook_ShouldHideServer() {
    if (hide_server) {
        return true;
    }
    // If we don't want to force the server hidden, we can fallback to the original function.
    return detour_ShouldHideServer.GetTrampoline<ShouldHideServer>()();
}

// A Lua function to hide the server.
LUA_FUNCTION(HideServer) {
    LUA->CheckType(1, Type::Bool);
    hide_server = LUA->GetBool(1);
    return 0;
}

GMOD_MODULE_OPEN() {
    LUA->PushSpecial(GarrysMod::Lua::SPECIAL_GLOB);
    LUA->GetField(-1, "game");
    LUA->PushCFunction(HideServer);
    LUA->SetField(-2, "HideServer");
    LUA->Pop(2);

    SourceSDK::ModuleLoader server_loader("server_srv");
    SymbolFinder symfinder;
    void* sv_shserver = nullptr;

    for (const auto& sym : ShouldHideServerSyms) {
        sv_shserver = symfinder.Resolve(server_loader.GetModule(), sym.name.c_str(), sym.length);
        if (sv_shserver) break;
    }

    if (sv_shserver == nullptr) {
        Msg("Could not locate CServerGameDLL::ShouldHideServer symbol!\n");
    } else {
        Msg("Located CServerGameDLL::ShouldHideServer\n");
    }

    detour_ShouldHideServer.Create(reinterpret_cast<void*>(sv_shserver), reinterpret_cast<void*>(&hook_ShouldHideServer));
    detour_ShouldHideServer.Enable();

    if (detour_ShouldHideServer.IsValid()) {
        Msg("Valid detour for CServerGameDLL::ShouldHideServer\n");
    } else {
        Msg("Invalid detour for CServerGameDLL::ShouldHideServer\n");
    }

    return 0;
}

GMOD_MODULE_CLOSE() {
    detour_ShouldHideServer.Destroy(); // We remove our detour.
    return 0;
}
```

--------------------------------

### PLAYER:SetupDataTables()

Source: https://gmodwiki.com/PLAYER_Hooks

Setup the network table accessors.

```APIDOC
## PLAYER:SetupDataTables()

### Description
Setup the network table accessors.

### Method
HOOK

### Parameters
- **Player** (Player) - The player for which a hook is called.
```

--------------------------------

### Default Game Depots Configuration

Source: https://gmodwiki.com/Mounting_Content_on_a_Dedicated_Server

This is an example of the default `mountdepots.txt` file. It specifies which installed games Garry's Mod should attempt to mount, regardless of whether they are currently present or not.

```cfg
"gamedepotsystem" { "cstrike" "1" "hl1" "1" "hl1_hd" "1" "hl2" "1" "hl2mp" "1" "episodic" "1" "ep2" "1" "lostcoast" "1" }
```

--------------------------------

### DNumSlider Example

Source: https://gmodwiki.com/DNumSlider

Example of how to create and configure a DNumSlider.

```APIDOC
## Example Usage

### Description
Attempts to create a DNumSlider.

### Code
```lua
local DermaPanel = vgui.Create( "DFrame" ) -- Create a panel to parent it to
DermaPanel:SetSize( 500, 200 ) -- Set the size
DermaPanel:Center() -- Center it
DermaPanel:MakePopup() -- Make it a popup

local DermaNumSlider = vgui.Create( "DNumSlider", DermaPanel )
DermaNumSlider:SetPos( 50, 50 ) -- Set the position
DermaNumSlider:SetSize( 300, 100 ) -- Set the size
DermaNumSlider:SetText( "Maximum props" ) -- Set the text above the slider
DermaNumSlider:SetMin( 0 ) -- Set the minimum number you can slide to
DermaNumSlider:SetMax( 256 ) -- Set the maximum number you can slide to
DermaNumSlider:SetDecimals( 0 ) -- Decimal places - zero for whole number
DermaNumSlider:SetConVar( "sbox_maxprops" ) -- Changes the ConVar when you slide

-- If not using convars, you can use this hook + Panel.SetValue()
DermaNumSlider.OnValueChanged = function( self, value )
    -- Called when the slider value changes
end
```
```

--------------------------------

### DIconLayout Example

Source: https://gmodwiki.com/DIconLayout

A practical example demonstrating how to create and use a DIconLayout with child panels and labels.

```APIDOC
## Example

```lua
local Frame = vgui.Create( "DFrame" ) -- Create a Frame to contain everything.
Frame:SetTitle( "DIconLayout Example" )
Frame:SetSize( 365, 240 )
Frame:Center()
Frame:MakePopup()

local Scroll = vgui.Create( "DScrollPanel", Frame ) -- Create the Scroll panel
Scroll:Dock( FILL )

local List = vgui.Create( "DIconLayout", Scroll )
List:Dock( FILL )
List:SetSpaceY( 5 ) -- Sets the space in between the panels on the Y Axis by 5
List:SetSpaceX( 5 ) -- Sets the space in between the panels on the X Axis by 5

for i = 1, 20 do -- Make a loop to create a bunch of panels inside of the DIconLayout
    local ListItem = List:Add( "DPanel" ) -- Add DPanel to the DIconLayout
    ListItem:SetSize( 80, 40 ) -- Set the size of it
    -- You don't need to set the position, that is done automatically.
end

local ListLabel = List:Add( "DLabel" ) -- Add a label that will be the only panel on its row
ListLabel.OwnLine = true -- The magic variable that specifies this item has its own line all for itself
ListLabel:SetText( "Hello World!" )

for i = 1, 5 do
    local ListItem = List:Add( "DPanel" )
    ListItem:SetSize( 80, 40 )
end
```
```

--------------------------------

### Client Connected Event Example

Source: https://gmodwiki.com/gameevent/client_connected

This example demonstrates how to listen for the client_connected event and access its data. It requires the 'gameevent' binary module because the 'gameevent.Listen' function is not available in the Menu State.

```lua
__require("gameevent") -- using a Binary Module because the Menu State doesn't has gameevent.Listen
gameevent.Listen( "client_connected" )
hook.Add( "client_connected", "client_beginconnect_example", function( data )
local address = data.address // The Server address.
local ip = data.ip // The Server IP. Use the address instead!
local port = data.port // The Server Port.
// Called when the connection to a Server has been established.
end )
```

--------------------------------

### Garry's Mod server_spawn Event Example

Source: https://gmodwiki.com/gameevent/server_spawn

This example demonstrates how to listen for the server_spawn event and access its data. It requires the 'gameevent' binary module because the event is only available in the Menu state.

```lua
__require("gameevent") -- using a Binary Module because the Menu State doesn't has gameevent.Listen
gameevent.Listen( "server_spawn" )
hook.Add( "server_spawn", "server_spawn_example", function( data )
local hostname = data.hostname -- The hostname of the Server.
local address = data.address -- The Server address.
local ip = data.ip -- The Server IP. Use the address instead!
local port = data.port -- The Server Port.
local game = data.game -- The Game the Server is hosting. Should always be garrysmod.
local mapname = data.mapname -- The Mapname the Server is currently on.
local maxplayers = data.maxplayers -- The amount of slots the Server has.
local os = data.os -- The os the Server is running on.
local dedicated = data.dedicated -- true if the Server is a dedicated Server.
local password = data.password -- true if the Server is password protected.
-- Called while connecting to the Server.
end )
```

--------------------------------

### Complete Derma UI Example

Source: https://gmodwiki.com/Introduction_To_Using_Derma

This comprehensive example combines the creation of a base panel, a label, and a button with its click functionality. It demonstrates a fully functional, albeit simple, UI element that can be displayed and interacted with.

```lua
-- Any functions explained in previous examples will not be commented for clarity
local myBasePanel = vgui.Create( "DPanel" )
myBasePanel:SetSize( 300, 150 )
myBasePanel:Center()
myBasePanel:SetPaintBackground( true )
myBasePanel:SetBackgroundColor( Color( 0, 0, 255, 255 ) )
myBasePanel:MakePopup()

local myTitleLabel = vgui.Create( "DLabel", myBasePanel )
myTitleLabel:SetText( "My Awesome Panel" )
myTitleLabel:SetPos( 10, 10 )
myTitleLabel:SizeToContents()
myTitleLabel:SetTextColor( color_white )

local myCloseButton = vgui.Create( "DButton", myBasePanel )
myCloseButton:SetText( "Close Me" )
myCloseButton:SetSize( 100, 30 )
local panelW, panelH = myBasePanel:GetSize()
myCloseButton:SetPos( panelW - 110, panelH - 40 )

myCloseButton.DoClick = function( theButton )
  print( "Close button clicked!" )
  myBasePanel:Remove()
end
```

--------------------------------

### Start Dedicated Server

Source: https://gmodwiki.com/Linux_Dedicated_Server_Hosting

Use the srcds_run script to start your dedicated server. This command sets the maximum player slots, the starting map, and requires a Steam Game Server Account token. Optionally, you can include workshop collection IDs.

```bash
~ /server_1/srcds_run +maxplayers 12 +map gm_flatgrass +sv_setsteamaccount <your token>
```

--------------------------------

### Early Networking Example for OnRequestFullUpdate

Source: https://gmodwiki.com/gameevent/OnRequestFullUpdate

This example demonstrates how to handle early networking messages by queuing player UserIDs and processing them when the OnRequestFullUpdate event is received. It's useful for ensuring that network messages are sent reliably before the client has fully initialized.

```lua
local Queue = {}
hook.Add( "PlayerInitialSpawn", "EarlyNetworkingExample", function( ply )
	Queue[ ply:UserID() ] = true
end )

gameevent.Listen( "OnRequestFullUpdate" )
hook.Add( "OnRequestFullUpdate", "EarlyNetworkingExample", function( data )
	local UID = data.userid -- Same as Player:UserID()

	if ( not Queue[ UID ] ) then
		return
	end

	Queue[ UID ] = nil

	-- Some networking here
	-- net.Start( 'YourCoolNetMessage' )
	-- net.Send( Player( UID ) )
end )
```

--------------------------------

### Get Player Start Spot Name

Source: https://gmodwiki.com/game.StartSpot

Returns the name of the entity used as the player's start position for map transitions. This is distinct from spawn points.

```lua
string game.StartSpot()

```

--------------------------------

### Registering a Simple Drive Example in Lua

Source: https://gmodwiki.com/Entity_Driving

Registers a custom drive class named 'drive_example' that derives from 'drive_base'. This example implements a velocity-based noclip mode, handling movement calculations and entity updates.

```lua
DEFINE_BASECLASS( "drive_base" )
drive.Register( "drive_example", {
	--
	-- Calculates the view when driving the entity
	--
	CalcView = function( self, view )
		--
		-- Use the utility method on drive_base.lua to give us a 3rd person view
		--
		self:CalcView_ThirdPerson( view, 100, 2, { self.Entity } )
		view.angles.roll = 0
	end,

	--
	-- Called before each move. You should use your entity and cmd to 
	-- fill mv with information you need for your move.
	--
	StartMove = function( self, mv, cmd )
		-- Set observer mode to chase, so the entity will be drawn.
		self.Player:SetObserverMode( OBS_MODE_CHASE )
		--
		-- Update move position and velocity from our entity
		--
		mv:SetOrigin( self.Entity:GetNetworkOrigin() )
	mv:SetVelocity( self.Entity:GetAbsVelocity() )
	end,

	--
	-- Runs the actual move. On the client when there's 
	-- prediction errors this can be run multiple times.
	-- You should try to only change mv.
	--
	Move = function( self, mv )
		-- Set up a speed, go faster if shift is held down
		local speed = 0.0005 * FrameTime()
		if ( mv:KeyDown( IN_SPEED ) ) then
			speed = 0.005 * FrameTime()
		end

		-- Get information from the movedata
		local ang = mv:GetMoveAngles()
		local pos = mv:GetOrigin()
		local vel = mv:GetVelocity()

		-- Add velocities. This can seem complicated. On the first line
		-- we're basically saying get the forward vector, then multiply it
		-- by our forward speed (which will be > 0 if we're holding W, < 0 if we're
		-- holding S and 0 if we're holding neither) - and add that to velocity.
		-- We do that for right and up too, which gives us our free movement.
		--
		vel = vel + ang:Forward() * mv:GetForwardSpeed() * speed
		vel = vel + ang:Right() * mv:GetSideSpeed() * speed
		vel = vel + ang:Up() * mv:GetUpSpeed() * speed

		-- We don't want our velocity to get out of hand so we apply
		-- a little bit of air resistance. If no keys are down we apply
		-- more resistance so we slow down more.
		--
		if ( math.abs(mv:GetForwardSpeed()) + math.abs(mv:GetSideSpeed()) + math.abs(mv:GetUpSpeed()) < 0.1 ) then
			vel = vel * 0.90
		else
			vel = vel * 0.99
		end

		-- Add the velocity to the position (this is the movement)
		--
		pos = pos + vel

		-- We don't set the newly calculated values on the entity itself
		-- we instead store them in the movedata. These get applied in F inishMove.
		--
		mv:SetVelocity( vel )
	mv:SetOrigin( pos )
	end,

	--
	-- The move is finished. Use mv to set the new positions
	on your entities/players.
	--
	FinishMove = function( self, mv )
		-- Update our entity!
		--
		self.Entity:SetNetworkOrigin( mv:GetOrigin() )
	self.Entity:SetAbsVelocity( mv:GetVelocity() )
	self.Entity:SetAngles( mv:GetMoveAngles() )

		-- If we have a physics object update that too. But only on the server.
		--
		if ( SERVER && IsValid( self.Entity:GetPhysicsObject() ) ) then
			self.Entity:GetPhysicsObject():EnableMotion( true )
			self.Entity:GetPhysicsObject():SetPos( mv:GetOrigin() )
			self.Entity:GetPhysicsObject():Wake()
			self.Entity:GetPhysicsObject():EnableMotion( false )
		end
	end,
}, "drive_base" )

```

--------------------------------

### DCheckBox Example

Source: https://gmodwiki.com/DCheckBox

Demonstrates how to create and initialize a DCheckBox.

```APIDOC
## DCheckBox Example

### Description
Creates a DCheckBox and sets its initial value.

### Code
```lua
local window = vgui.Create( "DFrame" )
window:SetSize( 300, 200 )
window:Center()
window:MakePopup()

local checkbox = window:Add( "DCheckBox" ) -- Create the checkbox
checkbox:SetPos( 25, 50 ) -- Set the position
checkbox:SetValue( true ) -- Initial "ticked" value
```
```

--------------------------------

### Listen for Freezecam Started Event

Source: https://gmodwiki.com/gameevent/freezecam_started

Use this to register a callback function that will be executed when the freezecam starts. The 'data' argument contains information about the event, though it is not used in this basic example.

```lua
gameevent.Listen( "freezecam_started" )
hook.Add( "freezecam_started", "freezecam_started_example", function( data ) // Called when the freeze cam starts spectating something. end )
```

--------------------------------

### Garry's Mod Stack Example

Source: https://gmodwiki.com/Stack

Demonstrates creating a stack, pushing elements (string and function), accessing the top element, and popping elements. The example shows how to use the stack to print a pushed string after pushing and popping a function.

```lua
local NewStack = util.Stack(); -- Creating a Stack
NewStack:Push("Hello World!") -- Push "Hello World!" onto the stack
NewStack:Push(print) -- Push the print function onto the Stack
local PrintFunc = NewStack:Top() -- Get the print Function
NewStack:Pop() -- Remove the print Function from the stack
PrintFunc(NewStack:Top()) -- print "Hello World!"
NewStack:Pop() -- Remove "Hello World!"
```

--------------------------------

### UGCPublishWindow:Setup( string ugcType, string file, string imageFile, WorkshopFileBase handler )

Source: https://gmodwiki.com/UGCPublishWindow

Initializes the publish window with the specified UGC type, file, image file, and workshop file handler.

```APIDOC
## UGCPublishWindow:Setup( string ugcType, string file, string imageFile, WorkshopFileBase handler )

### Description
Updates the Workshop items list with the provided details.

### Method
(Implicitly called by the UI)

### Parameters
#### Path Parameters
- **ugcType** (string) - Required - The type of UGC being published.
- **file** (string) - Required - The path to the file to be published.
- **imageFile** (string) - Required - The path to the image file for the UGC.
- **handler** (WorkshopFileBase) - Required - The handler for the workshop file.
```

--------------------------------

### General Server Script Setup

Source: https://gmodwiki.com/Understanding_AddCSLuaFile_and_include

This snippet demonstrates setting up server-specific logic, ensuring clients receive necessary files, and including shared scripts for unified functionality.

```lua
AddCSLuaFile("cl_init.lua") AddCSLuaFile("shared.lua") include("shared.lua")
```

--------------------------------

### GM:PreRender

Source: https://gmodwiki.com/GM_Hooks

Called before the renderer starts rendering the next frame. Useful for pre-rendering setup.

```APIDOC
## GM:PreRender

### Description
Called before the renderer is about to start rendering the next frame.

### Method
boolean GM:PreRender()
```

--------------------------------

### Complete Book Class Definition and Usage Example

Source: https://gmodwiki.com/Object_Oriented_Lua

This snippet consolidates the entire Book class definition, including metatable setup, constructor, methods, and the __call metamethod. It serves as a complete, runnable example.

```lua
__Book = {}
__index = Book

function Book:new( series, seriesNum, title, text )
  local EmptyBook = { series = series or "", seriesNum = seriesNum or 0, title = title or "", text = text or "", }
  setmetatable( EmptyBook, Book )
  return EmptyBook
end

function Book:Print()
  if self:IsEmpty() then
    return
  end
  print( "\n===================================="
  if self.seriesNum > 0 then
    print( self.series .. " " .. self.seriesNum .. ": " .. self.title .. "\n" )
  else
    print( self.title .. "\n" )
  end
  print( self.text )
  print( "====================================\n")
end

function Book:IsEmpty()
  return #self.text == 0
end

function Book:SetSeries( series )
  self.series = series
end

function Book:GetSeries()
  return self.series
end

function Book:SetSeriesNum( num )
  self.seriesNum = num
end

function Book:GetSeriesNum()
  return self.seriesNum
end

function Book:SetTitle( title )
  self.title = title
end

function Book:GetTitle()
  return self.title
end

function Book:AddText( text )
  self.text = self.text .. text
end

function Book:AddLine()
  self.text = self.text .. "\n"
end

function Book:RemoveLine()
  if self:IsEmpty() then
    return
  end
  local index = string.find( self.text, "\n" )
  if not index then
    self.text = ""
    return
  end
  local lastIndex = index
  while index do
    lastIndex = index
    index = string.find( self.text, "\n", index+1 )
  end
  self.text = string.sub( self.text, 1, lastIndex-1 )
end

setmetatable( Book, {__call = Book.new} )

```

--------------------------------

### Create and Configure a DPanel

Source: https://gmodwiki.com/Introduction_To_Using_Derma

This comprehensive example demonstrates creating a DPanel, setting its dimensions, position, background color, and ensuring it is visible.

```lua
-- Create the DPanel
local myFirstPanel = vgui.Create( "DPanel" )

-- Set its size (Width: 200px, Height: 100px)
myFirstPanel:SetSize( 200, 100 )

-- Set its position (X: 300px from left, Y: 200px from top)
-- (Trying slightly different coords for visibility)
myFirstPanel:SetPos( 300, 200 )

-- Make it paint its background
myFirstPanel:SetPaintBackground( true )

-- Set the background color to blue (R=0, G=0, B=255, Alpha=255)
myFirstPanel:SetBackgroundColor( Color( 0, 0, 255, 255 ) )

-- Make sure it's visible (usually is by default if not parented to hidden)
myFirstPanel:SetVisible( true )
```

--------------------------------

### GMod Usermessage Example

Source: https://gmodwiki.com/Networking_Usage

Demonstrates how to properly send and receive usermessages on the server and client. Ensure the usermessage name matches between Start and Hook.

```lua
if SERVER then
local filter = RecipientFilter()
filter:AddAllPlayers()
umsg.Start( "Example" )
umsg.String( "Hello World" )
umsg.End()
else
usermessage.Hook( "Example", function( msg )
  print( msg:ReadString() )
end)
end
```

--------------------------------

### Basic Render Target Setup and Drawing

Source: https://gmodwiki.com/render_rendertargets

Sets up a Render Target, draws 2D and 3D content to it, and then displays it on screen. Requires a basic understanding of Garry's Mod's rendering functions.

```lua
local renderTarget = GetRenderTarget( "RenderTargetExample", -- The name we'll call new Render Target's Texture 
1024, 
1024 -- The size of the Render Target 
)
local renderTargetMaterial = CreateMaterial( "RenderTargetExampleMaterial", -- All Materials need a name 
"UnlitGeneric", -- This shader will work great for drawing onto the screen, but can't be used on models -- To use this material on a model, this would need to use the "VertexLitGeneric" shader. 
{ ["$basetexture"] = renderTarget:GetName(), -- Use our Render Target as the Texture for this Material 
[" $translucent"] = "1", -- Without this, the Material will be fully opaque and any translucency won't be shown 
} )
local clientsideModel = ClientsideModel( "models/props_lab/huladoll.mdl", RENDERGROUP_OPAQUE )
clientsideModel:SetNoDraw( true )
local colorMaterial = Material( "color" ) -- An all-white material is built-in to the game

local function DrawSomething2D()
 surface.SetMaterial( colorMaterial )
 surface.SetDrawColor( Color( 255, 0, 255, 200 ) )
 surface.DrawTexturedRectRotated( ScrW()/2, ScrH()/2, 500, 500, ( CurTime() * 200 ) % 360 )
end

local function DrawSomething3D()
 render.SuppressEngineLighting( true )
 render.SetWriteDepthToDestAlpha( false )
 render.Model( {
  model = "models/props_lab/huladoll.mdl",
  pos = Vector( 20, -math.sin( CurTime() * 7.5 ) * 0.35, -3.5 ),
  angle = Angle( 0, 180 + math.sin( CurTime() * 7.5 ) * 7, math.sin( CurTime() * 7.5 ) * 15 )
 }, clientsideModel )
 render.SetWriteDepthToDestAlpha( true )
 render.SuppressEngineLighting( false )
end

hook.Add( "PreDrawEffects", "DrawingToExampleRenderTarget", function()
 render.PushRenderTarget( renderTarget )
 render.Clear( 0, 255, 0, 200, true, true )

 cam.Start2D()
 DrawSomething2D()
 cam.End2D()

 cam.Start3D( Vector( 0, 0, 0 ), 
 Angle( 0, 0, 0 ), 
 40 
 )
 DrawSomething3D()
 cam.End3D()

 render.PopRenderTarget()
end
)

hook.Add( "DrawOverlay", "DrawingRenderTargetToScreen", function()
 surface.SetMaterial( renderTargetMaterial )
 surface.SetDrawColor( Color( 255, 255, 255, 255 ) )
 surface.DrawTexturedRectRotated( 300, 300, 500, 500, 0 )
end
)
```

--------------------------------

### Run Garry's Mod Dedicated Server on Linux

Source: https://gmodwiki.com/Downloading_a_Dedicated_Server

Starts the Garry's Mod dedicated server after installation. This command assumes you are in the correct directory.

```bash
cd ~ /gmodds/ ./srcds_run -game garrysmod +maxplayers 32 +map gm_construct
```

--------------------------------

### Example premake5.lua Structure

Source: https://gmodwiki.com/Binary_Modules_Detouring_Functions

A basic structure for your premake5.lua file, demonstrating where to include the detouring and scanning modules.

```lua
CreateWorkspace({
    name = "[Your Project]",
    abi_compatible = false
})

CreateProject({
    serverside = [true or false],
    manual_files = false
})

[Your includes ...]

IncludeHelpersExtended()
IncludeDetouring()
IncludeScanning()
```

--------------------------------

### CSS with Base64 Encoding

Source: https://gmodwiki.com/DHTML

Example of using Base64 encoding for image sources in CSS. The string starts with the data type (e.g., 'data:image/jpeg;base64,') followed by the encoded data.

```css
url("data:image/jpeg;base64,LzlqLzRBQ...<!-- base64 data -->")
```

--------------------------------

### Keep Garry's Mod Server Alive After Reboot

Source: https://gmodwiki.com/Linux_Dedicated_Server_Hosting

Configure crontab to automatically restart the Garry's Mod server on system reboot. This example sets the player limit and starting map.

```bash
crontab -e
```

```bash
@reboot /home/steam/server_1/srcds_run +maxplayers 12 +map gm_flatgrass
```

--------------------------------

### HTML Image Tag with Base64 Encoding

Source: https://gmodwiki.com/DHTML

Example of using Base64 encoding for image sources in HTML. The string starts with the data type (e.g., 'data:image/jpeg;base64,') followed by the encoded data.

```html
<img src="data:image/jpeg;base64,LzlqLzRBQ...<!-- base64 data -->">
```

--------------------------------

### Create and Populate DListBox

Source: https://gmodwiki.com/DListBox

Creates a DListBox within a DFrame, docks it to fill the frame, and adds three items. It also enables multi-select functionality. This example demonstrates basic setup and item addition.

```lua
local DFrame = vgui.Create( "DFrame" )
DFrame:SetPos( 100, 100 )
DFrame:SetSize( 300, 200 )
DFrame:SetTitle( "Derma Frame" )
DFrame:MakePopup()

local DListBox = vgui.Create( "DListBox", DFrame )
DListBox:Dock( FILL )

DListBox:AddItem( "test1" )
DListBox:AddItem( "test2" )
DListBox:AddItem( "test3" )

DListBox:SetMultiple( true )
```

--------------------------------

### Create and Use DPanPanel

Source: https://gmodwiki.com/DPanPanel

This example demonstrates how to create a DPanPanel, add it to a frame, and populate it with buttons. It shows two instances of DPanPanel, one with small content and another with larger content to illustrate panning.

```lua
local dpan = vgui.Create( "DFrame" )
dpan:SetSize( 700, 500 )
dpan:Center()
dpan:MakePopup()

local dpl = vgui.Create( "DPanel", dpan )
dpl:SetSize( 200, 200 )
dpl:SetPos( 100, 100 )

local panl = vgui.Create( "DPanPanel", dpl )
panl:Dock( FILL )

local bl1 = panl:Add( "DButton" )
bl1:SetText( "Small" )

local bl2 = panl:Add( "DButton" )
bl2:SetPos( 100, 100 )
bl2:SetText( "Contents" )

local dpr = vgui.Create( "DPanel", dpan )
dpr:SetSize( 200, 200 )
dpr:SetPos( 310, 100 )

local panr = vgui.Create( "DPanPanel", dpr )
panr:Dock( FILL )

local br1 = panr:Add( "DButton" )
br1:SetText( "Big" )

local br2 = panr:Add( "DButton" )
br2:SetPos( 300, 300 )
br2:SetText( "Contents" )
```

--------------------------------

### NW System: Hello World Example

Source: https://gmodwiki.com/Networking_Usage

Shows how to set a string value on an entity server-side and receive it client-side using the NW system. The client-side function is invoked when the value changes.

```lua
if SERVER then
    Entity( 1 ):SetNWString( "Example", "Hello World" )
else
    Entity( 1 ):SetNWVarProxy( "Example", function(_, _, _, value )
        print( value )
    end)
end
```

--------------------------------

### Basic Drag and Drop Example

Source: https://gmodwiki.com/Drag_and_Drop_for_VGUI

Demonstrates setting up two frames, creating draggable panels within one, and configuring both frames to receive drops. Includes one-way and two-way drop configurations.

```lua
-- Create two frames side by side
local left_dframe = vgui.Create("DFrame")
local right_dframe = vgui.Create("DFrame")
local w, h = 200, 300
local screen_w, screen_h = ScrW(), ScrH()
local x = screen_w / 2 - w - 10
local y = screen_h / 2 - h / 2

left_dframe:SetSize(w, h)
right_dframe:SetSize(w, h)
left_dframe:SetPos(x, y)
right_dframe:SetPos(x + w + 20, y)

left_dframe:SetTitle("Source")
right_dframe:SetTitle("Target")

left_dframe:MakePopup()
right_dframe:MakePopup()

local red = vgui.Create("DPanel", left_dframe)
local green = vgui.Create("DPanel", left_dframe)

red:SetSize(50, 50)
green:SetSize(50, 50)

red:SetPos(20, 50)
green:SetPos(20, 120)

red.Paint = function(s, w, h)
    surface.SetDrawColor(120, 0, 0)
    surface.DrawRect(0, 0, w, h)
    draw.DrawText("One-way", "DermaDefault", w / 2, h / 2, color_white, TEXT_ALIGN_CENTER)
end

green.Paint = function(s, w, h)
    surface.SetDrawColor(0, 120, 0)
    surface.DrawRect(0, 0, w, h)
    draw.DrawText("Two-way", "DermaDefault", w / 2, h / 2, color_white, TEXT_ALIGN_CENTER)
end

-- Make panels draggable
red:Droppable("one-way")
green:Droppable("two-way")

-- Make only right dframe receive one-way drops
right_dframe:Receiver("one-way", function(self, panels, dropped, _, x, y)
    if dropped then
        panels[1]:SetParent(self)
        panels[1]:SetPos(x - 25, y - 25)
    end
end)

-- Make both dframes receive two-way drops
right_dframe:Receiver("two-way", function(self, panels, dropped, _, x, y)
    if dropped then
        panels[1]:SetParent(self)
        panels[1]:SetPos(x - 25, y - 25)
    end
end)

left_dframe:Receiver("two-way", function(self, panels, dropped, _, x, y)
    if dropped then
        panels[1]:SetParent(self)
        panels[1]:SetPos(x - 25, y - 25)
    end
end)
```

--------------------------------

### Get UTF-8 Character Byte Index

Source: https://gmodwiki.com/utf8.offset

Use this function to find the starting byte index of the n'th UTF-8 character. The `startPos` argument defaults to 1 for positive `n` and -1 for negative `n`. If `n` is 0, it returns the byte index of the character at `startPos`.

```lua
print(utf8.offset("( ͡° ͜ʖ ͡°)", 5))
```

--------------------------------

### Creating a SpawnmenuContentPanel

Source: https://gmodwiki.com/SpawnmenuContentPanel

This example demonstrates how to create and configure a SpawnmenuContentPanel, including adding a custom category and enabling modifications. It's intended for internal use but can be adapted.

```lua
local function CreateContentPanel() local ctrl = vgui.Create( "SpawnmenuContentPanel" ) ctrl.OldSpawnlists = ctrl.ContentNavBar.Tree:AddNode( "#spawnmenu.category.browse", "icon16/cog.png" ) ctrl:EnableModify() hook.Call( "PopulatePropMenu", GAMEMODE ) ctrl:CallPopulateHook( "PopulateContent" ) ctrl.OldSpawnlists:MoveToFront() ctrl.OldSpawnlists:SetExpanded( true ) return ctrl end spawnmenu.AddCreationTab( "#spawnmenu.content_tab", CreateContentPanel, "icon16/application_view_tile.png", -10 )
```

--------------------------------

### DSprite Example

Source: https://gmodwiki.com/DSprite

Example of creating and configuring a DSprite.

```APIDOC
## Example Usage

### Description
Creates a DSprite with the `sent_ball` material, and sets the color to cyan. It is then centered and resized.

### Code
```lua
local sprite = vgui.Create("DSprite")
sprite:SetMaterial(Material("sprites/sent_ball"))
sprite:SetColor(Color(0, 255, 255))
sprite:Center()
sprite:SetSize(200, 200)
```

### Output
See Preview above.
```

--------------------------------

### Creating and Configuring a DProperty_Combo

Source: https://gmodwiki.com/DProperty_Combo

This example demonstrates how to create a DProperties panel and add two DProperty_Combo controls. The first combo uses default text, while the second customizes the placeholder text and adds different types of choices. It also shows how to handle the DataChanged event.

```lua
local Panel = vgui.Create( "DFrame" )
Panel:SetSize( 500, 500 )
Panel:MakePopup()

local DP = vgui.Create( "DProperties", Panel )
DP:Dock( FILL )

local choice = DP:CreateRow( "Choices", "Combo #1: Default" )
choice:Setup( "Combo", {} )
choice:AddChoice( "Allow", true )
choice:AddChoice( "Disallow", false )

local choice = DP:CreateRow( "Choices", "Combo #2: Custom default text" )
choice:Setup( "Combo", { text = "Select type..." } )
choice:AddChoice( "Table", {} )
choice:AddChoice( "Function", function() end )
choice:AddChoice( "String", "Hello world" )

choice.DataChanged = function( self, data )
    print( "You selected: ", data )
end
```

--------------------------------

### Example Usage

Source: https://gmodwiki.com/DNumberWang

Example of creating and configuring a DNumberWang element.

```APIDOC
## Example
Create the Number Wang with the minimum number being 0 and the max being 100
```lua
local frame = vgui.Create( "DFrame" )
frame:SetSize( 300, 250 )
frame:Center()
frame:MakePopup()

local Wang = vgui.Create("DNumberWang", frame)
Wang:SetPos(85, 25)
Wang:SetSize(45, 26)
Wang:SetMin(0)
Wang:SetMax(100)

Wang.OnValueChanged = function(self)
    print(self:GetValue())
end
```
```

--------------------------------

### Create Empty and Predefined Tables

Source: https://gmodwiki.com/Beginner_Tutorial_Tables

Demonstrates creating an empty table using the table constructor and a table with predefined numeric keys. Remember to use commas after each key-value pair.

```lua
-- Here, we are creating an empty table using the "table constructor" ( {} )
emptyTable = {}

-- We can create a table with predefined values:
table1 = { [1] = "First", [2] = "Second", }

-- (Remember to put a comma after every 'key = value' line.)

-- We can also have Lua fill in numeric "order" values automatically:
table1 = { "First", "Second" }

-- table1 will then contain [1] = First, and [2] = Second.

-- We can define string keys on our table in two different ways:
-- First, the shorthand way:
table1.SomeStringKey = "Hello!"

-- or, the long way:
table1["SomeStringKey"] = "Hello!"

-- To verbally describe both of these methods, we could say that:
-- "table1 AT SomeStringKey EQUALS Hello!"
```

--------------------------------

### Example Usage of MatSelect Panel

Source: https://gmodwiki.com/MatSelect

Demonstrates how to create and configure a MatSelect panel, add materials to it, and handle material selection events. Ensure the panel is docked and its item dimensions are set appropriately.

```lua
__local frame = vgui.Create( "DFrame" ) frame:SetSize( 500, 500 ) frame:Center() frame:MakePopup() local MatSelect = vgui.Create( "MatSelect", frame ) MatSelect:Dock( TOP ) Derma_Hook( MatSelect.List, "Paint", "Paint", "Panel" ) -- MatSelect:SetConVar( "my_convar_name" ) MatSelect:SetAutoHeight( true ) MatSelect:SetItemWidth( 64 ) MatSelect:SetItemHeight( 64 ) local items = { "effects/flashlight001", "effects/flashlight/slit", "effects/flashlight/circles" } for k, material in pairs( items ) do MatSelect:AddMaterial( "Item #" .. k, material ) end function MatSelect:OnSelect( mat, pnl ) print( "Selected material: ", mat ) end
```
Tokens:
Raw