Garry's Mod Wiki

https://wiki.facepunch.com/gmod
Admin
This repository contains documentation for Garry's Mod, a sandbox game developed by Facepunch...
Tokens:11,654,301
Snippets:98,461
Trust Score:9.8
Update:4 hours ago
Show doc for...
Tokens:
Raw
### drive.PlayerStartDriving Example

Source: https://wiki.facepunch.com/gmod/Entity_Driving~diff:514594

Example call to start driving with a custom drive class named "drive_mydriveclass".

```lua
drive.PlayerStartDriving( player, ent, "drive_mydriveclass" )
```

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

### Complete DPanel creation and configuration example

Source: https://wiki.facepunch.com/gmod/Introduction_To_Using_Derma~diff:564587

A full example combining creation, sizing, positioning, background painting, color, and visibility. This demonstrates the typical setup for a visible DPanel.

```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 )
```

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

### net.Start with true parameter example

Source: https://wiki.facepunch.com/gmod/Networking_Usage~diff:548261

Example of using net.Start with a second parameter of true. When a net message is already started, the library discards it and prints a warning instead of crashing.

```lua
util.AddNetworkString( "Example" )
for k = 1, 4 do
	net.Start( "Example", true )
	net.WriteString( string )
	net.Broadcast()
end
```

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

### NW System - Hello World Example

Source: https://wiki.facepunch.com/gmod/Networking_Usage~diff:551014

Demonstrates setting a networked string on the server and reading it on the client using the NW system.

```APIDOC
## NW System - Hello World Example

### Description
Demonstrates setting a networked string on the server and reading it on the client using the NW system.

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

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

### Basic Lerp Animation Example

Source: https://wiki.facepunch.com/gmod/Global.Lerp~diff:561399

A basic example of a Lerp animation. The code is incomplete in the source, showing only the start of an animation setup.

```lua
animation_start = CurTime() end end
```

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

### Example implementation of ENTITY:StartTask

Source: https://wiki.facepunch.com/gmod/ENTITY:StartTask~diff:518283

Shows how the hook is defined. The hook is called on the server when a task starts, and the example calls task:Start on the entity.

```lua
function ENT:StartTask( task )
	task:Start( self.Entity )
end
```

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

### premake5.lua: Full project setup with detouring includes

Source: https://wiki.facepunch.com/gmod/Binary_Modules_Detouring_Functions~diff:552462

Example of a complete premake5.lua file that includes the necessary functions for detouring. Replace placeholders with your project details.

```lua
CreateWorkspace({name = "[Your Project]", abi_compatible = false})
CreateProject({serverside = [true or false], manual_files = false})
[Your includes ...]
IncludeHelpersExtended()
IncludeDetouring()
IncludeScanning()
```

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

### Setup a Combo control with custom text and values

Source: https://wiki.facepunch.com/gmod/DProperty_Combo:Setup

Example of using DProperty_Combo:Setup via DP:CreateRow. The CreateRow method returns an internal panel with its own Setup method, which calls this setup method. The example sets a custom default text and two options with different data types.

```lua
-- CreateRow returns an internal panel with its own Setup method, which calls this setup method.
local Combo = DP:CreateRow( "Catergory", "Hello World" )
Combo:Setup( "Combo", {
	text = "Select me!",
	values = {
		[ "Label 1" ] = "data 1",
		[ "Label 2" ] = 2,
	}
} )
```

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

### Get weapon activity example

Source: https://wiki.facepunch.com/gmod/Weapon:GetActivity~edit

Example usage of Weapon:GetActivity. It gets the active weapon of entity 1, checks if it is valid, and prints the current activity sequence number.

```lua
local wep = Entity(1):GetActiveWeapon()
if ( IsValid( wep ) ) then
	// Makes sure that wep exists
	print( wep:GetActivity() ) // Prints the sequence number
end
```

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

### Hello World Example with NW2

Source: https://wiki.facepunch.com/gmod/Networking_Usage~diff:548262

Demonstrates how to set and receive a networked string using the NW2 system on the server and client.

```APIDOC
## Hello World Example with NW2

### Description
Demonstrates how to set and receive a networked string using the NW2 system on the server and client.

### Code Example
```lua
if SERVER then
    Entity( 1 ):SetNW2String( "Example", "Hello World" )
else
    Entity( 1 ):SetNW2VarProxy( "Example", function( _, _, _, value )
        print( value )
    end )
end
```

### Alternative Client Hook
```lua
if SERVER then
    Entity( 1 ):SetNW2String( "Example", "Hello World" )
else
    hook.Add( "EntityNetworkedVarChanged", "Example", function( _, _, _, value )
        print( value )
    end )
end
```
```

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

### NW2 Hello World Example

Source: https://wiki.facepunch.com/gmod/Networking_Usage~diff:548403

Demonstrates how to set and retrieve a networked string using the NW2 system on the server and client.

```APIDOC
## NW2 Hello World Example

### Description
Demonstrates how to set and retrieve a networked string using the NW2 system on the server and client.

### Code
```lua
if SERVER then
    Entity( 1 ):SetNW2String( "Example", "Hello World" )
else
    Entity( 1 ):SetNW2VarProxy( "Example", function( _, _, _, value )
        print( value )
    end )
end
```

### Alternative Client-Side Hook
```lua
if SERVER then
    Entity( 1 ):SetNW2String( "Example", "Hello World" )
else
    hook.Add( "EntityNetworkedVarChanged", "Example", function( _, _, _, value )
        print( value )
    end )
end
```
```

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

### LerpVector example: Get midpoint between two vectors

Source: https://wiki.facepunch.com/gmod/Global.LerpVector~diff:514893

Example from the wiki showing how to get the middle point (50%) between two vectors using LerpVector. The output is Vector( 0, 0, 150 ). For frame-based smoothing, couple it with FrameTime().

```lua
local output = LerpVector( 0.5, Vector( 0, 0, 100 ), Vector( 0, 0, 200 ) )
```

```output
Vector( 0, 0, 150 )
```

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

### Repetition and anchoring: %bxy

Source: https://wiki.facepunch.com/gmod/Patterns~diff:527641

Matches strings that start with x and end with y. Example: '%b()' matches a string starting with '(' and ending with ')'.

```lua
%b()
```

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

### init.lua example

Source: https://wiki.facepunch.com/gmod/Entity_Creating_Custom_Entities~diff:560682

Server-side initialization for the entity, including model, physics, movement, and solidity setup, plus waking the physics object.

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

-- Server-side initialization function for the entity
function ENT:Initialize()
    self:SetModel( "models/hunter/blocks/cube025x025x025.mdl" ) -- Sets the model for the entity.
    self:PhysicsInit( SOLID_VPHYSICS ) -- Initializes physics for the entity, making it solid and interactable.
    self:SetMoveType( MOVETYPE_VPHYSICS ) -- Sets how the entity moves, using physics.
    self:SetSolid( SOLID_VPHYSICS ) -- Makes the entity solid, allowing for collisions.
    local phys = self:GetPhysicsObject() -- Retrieves the physics object of the entity.
    if phys:IsValid() then -- Checks if the physics object is valid.
        phys:Wake() -- Activates the physics object, making the entity subject to physics (gravity, collisions, etc.).
    end
end
```

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

### string.StartWith example

Source: https://wiki.facepunch.com/gmod/string.StartWith~diff:515916

Prints 'true' because 'hello there' starts with 'hell'.

```lua
print(string.StartWith("hello there", "hell"))
```

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

### Table creation examples

Source: https://wiki.facepunch.com/gmod/Beginner_Tutorial_Tables

Shows how to create empty tables, tables with predefined numeric keys, tables with automatic numeric keys, and how to define string keys using both dot notation and bracket notation.

```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!"
```

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

### Get Network Variable Value

Source: https://wiki.facepunch.com/gmod/Networking_Entities~diff:515811

Retrieve the value of a network variable using the generated getter function. This example gets the BloodPos variable.

```lua
local bloodpos = self:GetBloodPos()
```

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

### Output of the example

Source: https://wiki.facepunch.com/gmod/GM:WorkshopSubscriptionsMessage~diff:553040

The expected output when the example runs, showing the mounting message before and after the 10-second timer.

```lua
Mounting Workshop content, please wait...
[After 10 Seconds]
Mounting Workshop content, please wait...
```

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

### Example: Get file name from path

Source: https://wiki.facepunch.com/gmod/string.GetFileFromFilename

Returns the file name and extension from the given path. The example prints 'string.lua' when called with 'garrysmod/lua/modules/string.lua'.

```lua
print( string.GetFileFromFilename( "garrysmod/lua/modules/string.lua" ) )
```

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

### Final product: complete inventory system

Source: https://wiki.facepunch.com/gmod/Grid-Based_Inventory_System~diff:519141

The complete example combining all parts: initializing the backpack, defining the GetInvItem method, creating the InvSlot panel with drag-and-drop, and the InvItem panel.

```lua
local ply = LocalPlayer()
ply.Inv = {}
ply.Inv.Backpack = {} --The actual backpack.
ply.Inv.Equipped = {} --This is the equipped items, assuming it's going to be Diablo-Style.
ply.Inv.Weight = 0
for i=1,8 do --8 being the width of the backpack.
ply.Inv.Backpack[i] = {}
end
for k,v in pairs(ply.Inv.Backpack)do
for i=1,4 do --4 being the height of the backpack.
ply.Inv.Backpack[k][i] = false --False is a placeholder here. We'll overwrite that later.
end
end
local plymeta = FindMetaTable("Player")
function plymeta:GetInvItem(x,y)
return self.Inv.Backpack[x][y]
end
local PANEL = {}
AccessorFunc(PANEL, "m_ItemPanel", "ItemPanel")
AccessorFunc(PANEL, "m_Color", "Color")
function PANEL:Init()
self.m_Coords = {x=0,y=0}
self:SetSize(30,30)
self:SetColor(Color(200,200,200))
self:SetItemPanel(false)
self:Receiver("invitem", function(pnl, item, drop, i, x, y) --Drag-drop
if drop then
item = item[1]
local x1,y1 = pnl:GetPos()
local x2,y2 = item:GetPos()
if math.Dist(x1,y1,x2,y2) <= 30 then --Find the top left slot.
if not pnl:GetItemPanel() then
local itm = item:GetItem()
local x,y = pnl:GetCoords()
local itmw, itmh = itm:GetSize() --GetSize needs to be a function in your items system.
local full = false
for i1=x, (x+itmw)-1 do
if full then break end
for i2=y, (y+itmh)-1 do
if LocalPlayer():GetInvItem(i1,i2):GetItemPanel() then --check if the panels in the area are full.
full = true
break
end
end
end
if not full then --If none of them are full then
for i1=x, (x+itmw)-1 do
for i2=y, (y+itmh)-1 do
LocalPlayer():GetInvItem(i1,i2):SetItemPanel(item) -- Tell all the things below it that they are now full of this item.
end
end
item:SetRoot(pnl) --like a parent, but not a parent.
item:SetPos(pnl:GetPos()) --move the item.
end
end
end
else --Something about coloring of hovered slots.
end
end)
end
function PANEL:PaintOver(w,h)
draw.NoTexture()
if self:GetItemPanel() then
surface.SetMaterial(self:GetItemPanel():GetItem():GetIcon()) --Your items must have a GetIcon method.
surface.DrawTexturedRect(0,0,w,h)
end
end
local col
function PANEL:Paint(w,h)
draw.NoTexture()
col = self:GetColor()
surface.SetDrawColor(col.r,col.g,col.b,180)
surface.DrawRect(0,0,w,h) --background square
end
vgui.Register("InvSlot", PANEL, "DPanel")
```

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

### umsg Example

Source: https://wiki.facepunch.com/gmod/Networking_Usage~diff:562991

Shows how to use the deprecated umsg library. Serverside starts a message with 'Example' and sends a string, while clientside hooks 'Example' to read the string. Note that umsg is deprecated and net is recommended.

```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
```

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

### Complete example: DPanel with DLabel and DButton

Source: https://wiki.facepunch.com/gmod/Introduction_To_Using_Derma

Combines the base panel, label, and button with its DoClick hook into a single complete example.

```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
```

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

### NW Hello World Example

Source: https://wiki.facepunch.com/gmod/Networking_Usage~diff:549833

Sets a networked string on the server and prints it on the client using a NW var proxy. The value is networked every 10 seconds.

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

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

### mountdepots.txt example

Source: https://wiki.facepunch.com/gmod/Mounting_Content_on_a_Dedicated_Server~diff:510665

Example mountdepots.txt file that tells Garry's Mod which games are installed and should be mounted, regardless of whether they are actually installed. This can resolve issues with clients unable to spawn Hunters or NPCs from Half-Life: Source, spawning the Jalopy, or addons complaining about missing game content.

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