Multi Theft Auto

https://wiki.multitheftauto.com/wiki/
Admin
Multi Theft Auto is an open-source multiplayer modification for Grand Theft Auto that allows players...
Tokens:2,327,585
Snippets:27,546
Trust Score:8.8
Update:1 month ago
Show doc for...
Tokens:
Raw
### Create SQL table on resource start

Source: https://wiki.multitheftauto.com/wiki/ExecuteSQLCreateTable

Example demonstrating how to initialize a database table when a resource starts.

```lua
function createSQLOnStart ()
	-- create our table, if it doesn't already exist
	executeSQLCreateTable ( "players", "clothes_head_texture TEXT, clothes_head_model TEXT, player TEXT" )
end
addEventHandler ( "onResourceStart", getResourceRootElement(),createSQLOnStart )
```

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

### Start a resource via command

Source: https://wiki.multitheftauto.com/wiki/StartResource

An example of creating a command handler to start a resource by name.

```lua
function startTheResource ( thePlayer, command, resourceName )
	if ( resourceName ) then -- Check if they specified a resource name
		local resource = getResourceFromName ( resourceName ) -- Get the resource
		
		local start = startResource ( resource ) -- Start the resource
		if ( start ) then -- If it was successfully started...
			outputChatBox ( resourceName .. " was started successfully.", thePlayer, 255, 0, 0 )
		else -- If it wasn't successfully started...
			outputChatBox ( "This resource doesn't exist.", thePlayer, 255, 0, 0 )
		end
	else -- If they didn't put a resource name...
		outputChatBox ( "Please specify a resource to start.", thePlayer, 255, 0, 0 )
	end
end
addCommandHandler ( "resource-start", startTheResource ) -- Make it trigger when somebody types "/resource-start"
```

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

### Start the MTA server

Source: https://wiki.multitheftauto.com/wiki/Installing_and_Running_MTASA_Server_on_GNU_Linux

Execute the server binary to test the installation.

```bash
./mta-server
```

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

### Server-side usage example

Source: https://wiki.multitheftauto.com/wiki/AddResourceConfig

Example of creating a settings.xml file within the ctf resource when the current resource starts.

```lua
function onStart()
   addResourceConfig(":ctf/settings.xml", "server")
end
addEventHandler("onResourceStart",getResourceRootElement(),onStart)
```

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

### Connect an ircbot on resource start

Source: https://wiki.multitheftauto.com/wiki/Modules/bIRC/ircConnect

Example demonstrating the creation of an ircbot and initiating a connection to an IRC server when the resource starts.

```lua
function resourceStart()
    theBot = ircCreateBot ( "DummyBot" )
    ircConnect ( theBot, "irc.gtanet.com", 6667 )
end
addEventHandler ( "onResourceStart", getResourceRootElement (), resourceStart )
```

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

### getTableFromSql Usage Example

Source: https://wiki.multitheftauto.com/wiki/GetTableFromSql

An example of how to retrieve a saved table when a resource starts.

```lua
TableT = {}

addEventHandler( "onResourceStart",resourceRoot,
function()
local table = getTableFromSql( 1 )
	if table then
		TableT = table
	end
end )
```

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

### setSoundProperties Usage Example

Source: https://wiki.multitheftauto.com/wiki/SetSoundProperties

Example of playing a sound file and applying custom properties upon resource start.

```lua
function editSongSound()
	local sound = playSound("song.wav", false) -- Play the file 'song.wav' and make it play only once
	setSoundProperties(sound, 48000.0, 128.00, 440.0, false) -- Set its samplerate to 48,000 Hz, tempo to 128.00, pitch to 440 Hz and not reversed
end
addEventHandler("onClientResourceStart", resourceRoot, editSongSound) -- Execute the function when the resource is started
```

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

### Full Server Configuration Example

Source: https://wiki.multitheftauto.com/wiki/Server_Browser_Rules

A complete example of how to define multiple server rules in the mtaserver.conf file.

```xml
<rule name="description" value="Custom cars and maps! Join various minigames from racing to drifting" />
<rule name="languages" value="en_US" />
<rule name="tags" value="freeroam, minigames, pvp, drifting" />
<rule name="website_url" value="https://example-website.com" />
<rule name="social_url_1" value="https://discord.com/invite/example" />
<rule name="social_url_2" value="https://youtube.com/@exampleChannel" />
<rule name="social_url_3" value="https://facebook.com/examplePage" />
```

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

### Output Resource Start Time to Chat

Source: https://wiki.multitheftauto.com/wiki/GetResourceLastStartTime

Example demonstrating how to retrieve and display the current resource's start time in the chatbox.

```lua
function whenStarted()
    local startTime = getResourceLastStartTime ( getThisResource() )    --Get the time and date
    outputChatBox( "This resource was started on: " .. startTime )    --tell everybody when the current resource was started.
end
```

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

### setPedVoice Usage Example

Source: https://wiki.multitheftauto.com/wiki/SetPedVoice

Example of setting the local player's voice upon resource start.

```lua
addEventHandler("onClientResourceStart", resourceRoot,
    function()
        setPedVoice(localPlayer, "PED_TYPE_GANG", "VOICE_GNG_MACCER")
    end
)
```

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

### Example usage of startPoll

Source: https://wiki.multitheftauto.com/wiki/Resource%3AVotemanager

An example demonstrating how to initiate a kill vote poll.

```lua
local playerToKill = getRandomPlayer()
local notEnoughVotesMessage = "Not enough votes to kill "..getPlayerName(playerToKill).."."
startPoll {
   --start settings (dictionary part)
   title="Kill "..getPlayerName(playerToKill).."?",
   percentage=75,
   timeout=30,
   allowchange=false,
   maxnominations=3,
   visibleTo=getRootElement(),
   --start options (array part)
   [1]={"Yes", "doKillPlayer", playerToKill},
   [2]={"No", "doOutputChatBox", notEnoughVotesMessage, getRootElement(), vR, vG, vB; default=true},
}
```

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

### stopSound Usage Example

Source: https://wiki.multitheftauto.com/wiki/StopSound

Demonstrates starting a sound and stopping it via a command handler.

```lua
local sound

function startMySound()
    sound = playSound("sound.mp3", true)
end
addEventHandler("onClientResourceStart", resourceRoot, startMySound)

function stopMySound()
    if isElement(sound) then
        stopSound(sound)
    end
end
addCommandHandler("stopsound", stopMySound) --using the command 'stopsound' will stop the sound
```

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

### Get Weapon State Example

Source: https://wiki.multitheftauto.com/wiki/GetWeaponState

Demonstrates creating a weapon and outputting its initial state to the chat box upon resource start.

```lua
local function testWeaponState()
    local weapon = createWeapon("m4", getElementPosition(localPlayer)) -- Create the weapon
    outputChatBox("The weapon that has just been created state is " .. getWeaponState(weapon) .. ".") -- Tell the player its state
end
addEventHandler("onClientResourceStart", resourceRoot, testWeaponState)
```

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

### Full Implementation Example

Source: https://wiki.multitheftauto.com/wiki/DgsImportFunction

A complete example showing the import process followed by property configuration.

```lua
loadstring(exports.dgs:dgsImportFunction())()
local label = dgsCreateLabel(0,0,1,1,"DGS",true)
dgsSetProperty(label,"rightbottom",{"center","center"})
dgsSetProperty(label,"shadow",{1,1,tocolor(0,0,0,255)})
```

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

### Usage example for renameAclGroup

Source: https://wiki.multitheftauto.com/wiki/RenameAclGroup

Example showing how to trigger the renameAclGroup function when a resource starts.

```lua
--// Changes a group named 'Moderator' to 'HassoN' when the script is starting.
addEventHandler("onResourceStart", resourceRoot, function()
    local renamedSuccess = renameAclGroup("Moderator", "HassoN")
    if (renamedSuccess) then
        outputDebugString("ACL Group 'Moderator' has been renamed Successfully to 'HassoN'.")
    else
        outputDebugString("Failed to rename ACL Group 'Moderator' to 'HassoN'.", 1)
    end
end)
```

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

### guiSetSize Example

Source: https://wiki.multitheftauto.com/wiki/GuiSetSize

Demonstrates creating a window and dynamically updating its size using a timer.

```lua
function changeWindowSize ( )
	--Called by the timer every 2 seconds. It decides an x and y width randomly between .1 and .5
	guiSetSize ( myWindow, ( math.random( 10, 50 ) / 100 ), ( math.random( 10, 50 ) / 100 ), true )
end

--Create a gui window called 'myWindow'
myWindow = guiCreateWindow ( 0.3, 0.3, 0.5, 0.60, "GUI window title", true )
--Set a timer to change the window's size every 2 seconds, infinite times
setTimer ( changeWindowSize, 2000, 0 )
```

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

### Example: Creating and Deleting Table Rows

Source: https://wiki.multitheftauto.com/wiki/ExecuteSQLDelete

Demonstrates creating a table on resource start and defining a command to delete a specific row.

```lua
-- Create's the table named "table" on resource start.
function tableCreate()
    executeSQLCreateTable("table", "row TEXT")
end
addEventHandler("onResourceStart", getResourceRootElement(), tableCreate)

-- Add's a command "deleterow" to delete the row called "row"

function rowDelete()
    executeSQLDelete("table", "row")
end
addCommandHandler("deleterow", rowDelete)
```

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

### Implementing an AJAX handler

Source: https://wiki.multitheftauto.com/wiki/SetBrowserAjaxHandler

Example demonstrating how to create a browser, set an AJAX handler to process GET parameters, and render the browser content.

```lua
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()
 
--Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = createBrowser(screenWidth, screenHeight, true, false)
 
--This is the function to render the browser.
function webBrowserRender()
	--Render the browser on the full size of the screen.
	dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end


local counter = 0
setBrowserAjaxHandler(webBrowser, "ajax.html",
	function(get, post)
		counter = counter+1
		local output = string.format("<pre>You have requested this page %d times.\n", counter)
		-- List Parameters
		local getParameters = "Get Parameters: \n"
		for k, v in pairs(get) do 
			getParameters = getParameters..string.format("[%s] = %s\n", k, v)
		end 
		
		output = output..getParameters.."</pre>"
		return output
	end
);
 
--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser, 
	function()
		--After the browser has been initialized, we can load our file.
		loadBrowserURL(webBrowser, "http://mta/local/ajax.html?hello=world")
		--Now we can start to render the browser.
		addEventHandler("onClientRender", root, webBrowserRender)
	end
)
```

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

### Usage example for engineRestreamModel

Source: https://wiki.multitheftauto.com/wiki/EngineRestreamModel

Example of triggering a model re-stream upon resource start.

```lua
addEventHandler ("onClientResourceStart", resourceRoot, function ()
    engineRestreamModel (445)
end)
```

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

### Get Account Experience Example

Source: https://wiki.multitheftauto.com/wiki/Resource%3AExp_system

Example usage of getAccountEXP within a command handler.

```lua
addCommandHandler ( "myexp", function ( thePlayer ) local account = getPlayerAccount ( thePlayer ) 
               local myExp = exports.exp_system:getAccountEXP ( account )

outputChatBox ( "Your account experience is: ".. myExp, thePlayer ) end )
```

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

### Get Account Level Example

Source: https://wiki.multitheftauto.com/wiki/Resource%3AExp_system

Example usage of getAccountLevel within a command handler.

```lua
addCommandHandler ( "mylevel", function ( thePlayer ) local account = getPlayerAccount ( thePlayer ) 
               local myExp = exports.exp_system:getAccountLevel ( account )

outputChatBox ( "Your account level is: ".. myLevel, thePlayer ) end )
```

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

### Client-side Example

Source: https://wiki.multitheftauto.com/wiki/GetCameraMatrix

Example demonstrating how to retrieve the camera matrix and shift the camera position.

```lua
local x, y, z, lx, ly, lz = getCameraMatrix ()
x, lx = x + 1, lx + 1

setCameraMatrix (x, y, z, lx, ly, lz)
```

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

### setPlayerMoney Usage Examples

Source: https://wiki.multitheftauto.com/wiki/SetPlayerMoney

Examples demonstrating how to set player money via command handlers.

```lua
function setCash(thePlayer, command, amount)       -- when the setcash function is called
    setPlayerMoney(thePlayer, tonumber(amount))    -- change player's money to the desired amount
end
addCommandHandler("setcash", setCash)           -- add a command handler for setcash
```

```lua
function leetmoney()
	setPlayerMoney(root, 1337)
end
addCommandHandler("leet", leetmoney)
```

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

### setVehiclesLODDistance Usage Example

Source: https://wiki.multitheftauto.com/wiki/SetVehiclesLODDistance

Example of setting the vehicle LOD distance when a resource starts.

```lua
addEventHandler("onClientResourceStart",resourceRoot,function()
	setVehiclesLODDistance(10)
end)
```

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

### getBrowserSettings Usage Example

Source: https://wiki.multitheftauto.com/wiki/GetBrowserSettings

Demonstrates creating a browser and retrieving its settings upon successful creation.

```lua
window = guiCreateWindow(377, 156, 671, 454, "", false)
guiWindowSetSizable(window, true)

webBrowser = guiCreateBrowser(9, 26, 652, 418, false, false, false, window)

local theBrowser = guiGetBrowser(webBrowser)

addEventHandler("onClientBrowserCreated", theBrowser, function()
showCursor(true)
loadBrowserURL(source, "http://google.com\")
for k,v in pairs(getBrowserSettings(theBrowser)) do
outputChatBox("['"..tostring(k).."'] = "..tostring(v))
end
end
)
```

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

### setWeaponState Usage Example

Source: https://wiki.multitheftauto.com/wiki/SetWeaponState

Demonstrates creating a weapon and setting its state to firing upon resource start.

```lua
addEventHandler("onClientResourceStart", resourceRoot,
      function()
            local wep = createWeapon("m4", 0, 0, 4)
            setWeaponState(wep, "firing")
      end
)
```

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

### Usage example for engineRestream

Source: https://wiki.multitheftauto.com/wiki/EngineRestream

Example of triggering a vehicle model restream upon resource start.

```lua
addEventHandler ("onClientResourceStart", resourceRoot, function ()
    engineRestream ("vehicles")
end)
```

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

### guiSetLocation Usage Example

Source: https://wiki.multitheftauto.com/wiki/GuiSetLocation

A client-side example demonstrating how to create a window and set its location to the bottom-left corner.

```lua
window = guiCreateWindow ( 100, 100, 400, 400, "Test", false );
guiSetLocation ( window, "left", "down" );
```

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

### Comprehensive Meta Configuration

Source: https://wiki.multitheftauto.com/wiki/Meta

An advanced example demonstrating info tags, resource dependencies, file definitions, exports, settings, and ACL requests.

```xml
<meta>
    <info author="Slothman" version="1.0.2" name="Stealth" description="Allow scripts to insert a ped that simulates combat with a real player" type="gamemode" />

    <script src="stealthmain_server.lua" />
    <script src="noiseblip.lua" />
    <script src="mission_timer.lua" />
    <script src="gadgets_server.lua" />
    <script src="gadgets_client.lua" type="client"/>
    <script src="stealthmain_client.lua" type="client" validate="true"/>
    <script src="noisebar.lua" type="client"/>
    <script src="spycam.lua" type="client"/>
    <script src="riemann_z_demonstration.lua" type="client" cache="false"/>

    <map src="base.map" dimension="1"/>

    <file src="riot_shield.txd" download="false" />
    <file src="riot_shield.dff" download="false" />
    <file src="riot_shield.col" download="false" />
    <file src="armor.png" />
    <file src="camera.png" />
    <file src="cloak.png" />
    <file src="goggles.png" />
    <file src="mine.png" />
    <file src="radar.png" />
    <file src="shield.png" />

    <include resource="scoreboard" />
    <include resource="killmessages" />
    <include resource="maplimits" />
    
    <config src="help.xml" type="client"/>

    <export function="exampleExport1" type="server" />
    <export function="exampleExport2" type="client" />
    <export function="exampleExport3" type="shared" />

    <settings>
        <setting name="roundlimit" value="[6]" /> 
	<setting name="teamdamage" value="[1]" /> 
	<setting name="teambalance" value="[1]" /> 
	<setting name="isAllowedToShoot" value="true" />
	<setting name="admingroup" value="Admin,AdminPlus"
		friendlyname="Admin group list"
		group="_Advanced"
		accept="*"
		examples="Admin,Moderator,SuperModerator"
		desc="To use this resource, the player must belong to one of the groups listed."
		/> 
	<setting name="spazammo" value="[25]" /> 
	<setting name="m4ammo" value="[100]" />
	<setting name="shotgunammo" value="[25]" />
	<setting name="sniperammo" value="[20]" />
	<setting name="ak47ammo" value="[120]" />
	<setting name="rifleammo" value="[40]" />
	<setting name="deserteagleammo" value="[45]" />
	<setting name="pistolammo" value="[132]" />
	<setting name="uziammo" value="[150]" />
	<setting name="tec9ammo" value="[150]" />
	<setting name="silencedammo" value="[65]" />
	<setting name="grenadeammo" value="[4]" />
	<setting name="satchelammo" value="[4]" />
	<setting name="teargasammo" value="[4]" />
	<setting name="molatovammo" value="[4]" />
    </settings>

    <min_mta_version server="1.5.2-9.07903" client="1.5.2-9.07903" />

    <aclrequest>
        <right name="function.startResource" access="true" />
        <right name="function.stopResource" access="true" />
        <right name="function.setPlayerMuted" access="true" />
    </aclrequest>

    <sync_map_element_data>false</sync_map_element_data>

    <oop>false</oop>

    <download_priority_group>0</download_priority_group>
</meta>
```

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

### Create and focus a browser

Source: https://wiki.multitheftauto.com/wiki/FocusBrowser

Example demonstrating the creation of a browser and setting focus once it has been initialized.

```lua
local browser = createBrowser(860, 680, false)
addEventHandler("onClientBrowserCreated", browser,
   function ()
       focusBrowser(source)
   end
)
```

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

### Freeing Memory on Resource Start

Source: https://wiki.multitheftauto.com/wiki/EngineStreamingFreeUpMemory

Example of triggering a memory cleanup operation when a client-side resource starts.

```lua
addEventHandler ("onClientResourceStart", resourceRoot,
    function ()
        engineStreamingFreeUpMemory (104857600) -- 100 megabytes
    end
)
```

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

### Set Browser Volume Example

Source: https://wiki.multitheftauto.com/wiki/SetBrowserVolume

Demonstrates creating a browser, rendering it to the screen, and using a command handler to update its volume.

```lua
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()
 
--Let's create a new browser in remote mode.
local webBrowser = createBrowser(screenWidth, screenHeight, false, false)
 
--Function to render the browser.
function webBrowserRender()
	--Render the browser on the full size of the screen.
	dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end
 
--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser, 
	function()
		--After the browser has been initialized, we can load www.youtube.com
		loadBrowserURL(webBrowser, "http://www.youtube.com")
		--Now we can start to render the browser.
		addEventHandler("onClientRender", root, webBrowserRender)
	end
)

addCommandHandler ("volume", -- Add command named 'volume'
  function (command, value)
    if tonumber (value) then -- checking if the value is a number
      setBrowserVolume (webBrowser, value) -- setting the volume value
    else -- if there is no value
      outputChatBox ("You must enter a value.")
    end
  end
)
```

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

### aclRemoveRight Usage Example

Source: https://wiki.multitheftauto.com/wiki/AclRemoveRight

Example demonstrating the removal of a specific right from the Admin ACL when a resource starts.

```lua
addEventHandler("onResourceStart",resourceRoot,function()
   aclRemoveRight(aclGet("Admin"),"function.setServerPassword")
end)
```

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

### Example: Loading a URL in a browser

Source: https://wiki.multitheftauto.com/wiki/LoadBrowserURL

Demonstrates creating a browser, waiting for the onClientBrowserCreated event, and then loading a URL and rendering it to the screen.

```lua
-- In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

-- Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = createBrowser(screenWidth, screenHeight, false, false)
	
-- This is the function to render the browser.
function webBrowserRender()
	-- Render the browser on the full size of the screen.
	dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser, 
	function()
		-- After the browser has been initialized, we can load our website.
		loadBrowserURL(webBrowser, "https://www.youtube.com/")

		-- Now we can start to render the browser.
		addEventHandler("onClientRender", root, webBrowserRender)
	end
)
```

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

### Client-side XML Configuration Example

Source: https://wiki.multitheftauto.com/wiki/xmlNodeSetValue

Shows how to create or load a client-side XML file for user settings, including setting node values and retrieving them.

```xml
<root>
    <hud_display>
        <IconSizeX>60</IconSizeX>
        <IconSizeY>60</IconSizeY>
    </hud_display>
    <hud_binds>
        <weaponSlot0>tab</weaponSlot0>
        <weaponSlot1>1</weaponSlot1>
    </hud_binds>
</root>
```

```lua
function ClientResourceStart ()
	xmlRootTree = xmlLoadFile ( "userSettings.xml" ) --Attempt to load the xml file	

	if xmlRootTree then -- If the xml loaded then...
		xmlHudBranch = xmlFindChild(xmlRootTree,"hud_display",0) -- Find the hud sub-node
		xmlBindsBranch = xmlFindChild(xmlRootTree,"hud_binds",0) -- Find the binds sub-node
		outputChatBox ( "XML Found and Loaded" )
	else -- If the xml does not exist then...
		xmlRootTree = xmlCreateFile ( "userSettings.xml", "root" ) -- Create the xml file	
		xmlHudBranch = xmlCreateChild ( xmlRootTree, "hud_display" ) -- Create the hud sub-node under the root node
		xmlBindsBranch = xmlCreateChild ( xmlRootTree, "hud_binds" )-- Create the binds sub-node under the root node
		xmlNodeSetValue (xmlCreateChild ( xmlHudBranch, "IconSizeX"), "60" ) --Create sub-node values under the hud sub-node
		xmlNodeSetValue (xmlCreateChild ( xmlHudBranch, "IconSizeY"), "60" ) --Create sub-node values under the hud sub-node
		xmlNodeSetValue (xmlCreateChild ( xmlBindsBranch, "weaponSlot0"), "tab" ) --Create sub-node values under the binds sub-node
		xmlNodeSetValue (xmlCreateChild ( xmlBindsBranch, "weaponSlot1"), "1" ) --Create sub-node values under the binds sub-node
		outputChatBox ( "XML Created" )
	end

	--Retrieve a single sub-node name or value
	outputChatBox( "Node name: "..xmlNodeGetName (xmlFindChild(xmlHudBranch,"IconSizeX",0)), 0, 0, 255 ) --blue outputs
	outputChatBox( "Node Value: "..xmlNodeGetValue (xmlFindChild(xmlHudBranch,"IconSizeX",0)), 0, 0, 255 ) --blue outputs
	
        --Retrieve multiple sub-node names or values	
	xmlHudChildrenTable = xmlNodeGetChildren ( xmlHudBranch ) --Create a table of this branch's children
	for i,node in pairs(xmlHudChildrenTable ) do --Loop through the branch's children for sub-nodes
            outputChatBox( "Node name: "..xmlNodeGetName (node), 0, 255, 0 ) --green outputs
	    outputChatBox( "Node Value: "..xmlNodeGetValue(node), 0, 255, 0 ) --green outputs
	end
end
addEventHandler ( "onClientResourceStart", resourceRoot, ClientResourceStart )
 
function ClientResourceStop ()
	xmlSaveFile ( xmlRootTree ) --Save the xml from memory for use next time
	xmlUnloadFile ( xmlRootTree ) --Unload the xml from memory
	outputChatBox ( "Saved and unloaded the XML." )
end
addEventHandler ( "onClientResourceStop", resourceRoot, ClientResourceStop )
```

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

### removeResourceFile Usage Example

Source: https://wiki.multitheftauto.com/wiki/RemoveResourceFile

Example demonstrating the removal of a .txt file from the sx_resmanager resource upon resource start.

```lua
addEventHandler("onResourceStart",resourceRoot,function()
	resource = getResourceFromName("sx_resmanager")
	removeResourceFile(resource,"description.txt")
end)
```

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

### Check Resolution on Resource Start

Source: https://wiki.multitheftauto.com/wiki/DgsGetScreenSize

This example demonstrates how to check the user's screen resolution upon resource startup and display a warning if it is too low.

```lua
--setup a function when the resource starts
DGS = exports.dgs

function checkResolutionOnStart ()
	local x,y = DGS:dgsGetScreenSize() --get their screen size
	if ( x <= 640 ) and ( y <= 480 ) then --if their resolution is lower or equal to 640x480
		--warn them about GUI problems.
		outputChatBox ( "WARNING: You are running on a low resolution.  Some GUI may be placed or appear incorrectly." )
	end
end
--attach the function to the event handler
addEventHandler ( "onClientResourceStart", resourceRoot, checkResolutionOnStart )
```

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

### Backing up a configuration file

Source: https://wiki.multitheftauto.com/wiki/Modules/FileSystem/translator/copy

Example demonstrating how to create a translator and copy a configuration file to a backup location.

```lua
-- Create a generic translator.
local resRoot = fileCreateTranslator( "/" );

resRoot:copy( "config.xml", "backup/config.xml" );
```

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

### Bring dxGUI Window to Front

Source: https://wiki.multitheftauto.com/wiki/DxGUI/dxSetAlwaysOnTop

Example demonstrating how to create a window and set it to always be on top using the dxGUI_v1 export.

```lua
window = exports.dxGUI_v1:dxCreateWindow(0,0,250,300,"Hello!",white,"default-bold","Sath Metro [Green]")
exports.dxGUI_v1:dxSetAlwaysOnTop(window, true)
```

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

### createBlip Server Examples

Source: https://wiki.multitheftauto.com/wiki/CreateBlip

Examples demonstrating how to create a player-specific blip and how to attach a blip to an element by setting its parent.

```Lua
-- Pick a random player
local myPlayer = getRandomPlayer( )
-- Retrieve the player's position and store it in the variables x, y and z
local x, y, z = getElementPosition( myPlayer )
-- Create a radar blip at the player's position, with a 'cash' icon and only visible to the player
local myBlip = createBlip( x, y, z, 51, 0, 0, 0, 255, myPlayer )
```

```Lua
-- Pick a random player
local myPlayer = getRandomPlayer( )
-- Create a radar blip in the middle of the map
local myBlip = createBlip( 0, 0, 0 )
-- Make the player the parent of the blip, so that the blip follows the player around
setElementParent( myBlip, myPlayer )
```

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

### Iterate elements example

Source: https://wiki.multitheftauto.com/wiki/IterElements

Usage example demonstrating how to iterate through players and vehicles to perform batch operations on resource start.

```lua
addEventHandler( "onResourceStart", resourceRoot,
    function( )
        for _, plr in iterElements( "player" ) do
            setElementHealth( plr, 100 );
            givePlayerMoney( plr, 1000 );
            outputChatBox( "You've just been healed and given $1000!", plr );
        end

        for _, veh in iterElements( "vehicle" ) do
            fixVehicle( veh );
        end
    end
)
```

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

### Get Resource State Command Example

Source: https://wiki.multitheftauto.com/wiki/GetResourceState

An example of a command handler that retrieves and outputs the state of a resource provided by the user.

```lua
function getState( player, command, resourceName )
	if not resourceName then
		outputChatBox( "Syntax: " .. command .. " [resource name]", player, 255, 0, 0 )
		return
	end
	local resource = getResourceFromName( resourceName )
	if not resource then
		outputChatBox( "Error: No resource with name " .. resourceName .. " exists.", player, 255, 0, 0 )
		return
	end
	local state = getResourceState( resource )
	outputChatBox( "Resource " .. resourceName .. " is " .. state, player, 0, 0, 255 )
end

addCommandHandler( "state", getState )
```

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

### Add Example Section Template

Source: https://wiki.multitheftauto.com/wiki/Category%3ANeeds_Example

Use this XML-like structure to define a new example section in the wiki. Set the class attribute to 'client' or 'server' to specify the script context.

```xml
<section name="Client" class="client" show="true">
--Explain what the code does
<syntaxhighlight lang="lua">
-- Add example
</syntaxhighlight>
</section>
```

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

### Install build dependencies

Source: https://wiki.multitheftauto.com/wiki/User%3ANecktrox

Install the necessary build tools, headers, and libraries required for compilation.

```bash
$ sudo apt-get install git build-essential automake libtool lib32z1-dev g++-multilib
```

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

### Resizing a Custom Window

Source: https://wiki.multitheftauto.com/wiki/CustomWidget%3AsetSize

Example demonstrating how to create a window and set its size to half the screen dimensions.

```lua
local Width, Height = guiGetScreenSize()

local Window = CustomWindow.create(0, 0, 100, 100, "Example", false)
Window:setSize(Width/2, Height/2)
```

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

### Get Player Ammo Example

Source: https://wiki.multitheftauto.com/wiki/GetPlayerTotalAmmo

Example demonstrating how to retrieve and output the total ammo for a specific player named 'Someguy'.

```lua
-- Find the player called 'Someguy'
myPlayer = getPlayerFromNick ( "Someguy" )
-- If a player called 'Someguy' was found then
if ( myPlayer ) then
	-- Retrieve the total amount of ammo for that player, and store it in a variable called 'ammo'
	ammo = getPlayerTotalAmmo ( myPlayer )
	-- Tell all the players how much ammo 'Someguy' has
	outputChatBox ( "Someguy's current total ammo: " .. ammo .. "." )
end
```

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

### Change Moon Size on Resource Start

Source: https://wiki.multitheftauto.com/wiki/SetMoonSize

Example of using an event handler to set the moon size when a resource starts.

```lua
function handleResourceStart( )
    setMoonSize( 0 )
end
addEventHandler( "onResourceStart",  resourceRoot, handleResourceStart )
```

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

### Resize browser via command

Source: https://wiki.multitheftauto.com/wiki/ResizeBrowser

Example demonstrating how to resize a browser using a command handler.

```lua
screenWidth, screenHeight = guiGetScreenSize()
initBrowser = guiCreateBrowser(0, 0, screenWidth, screenHeight, true, true, false)
addCommandHandler("resize",
	function ( cmd, width, height )
		local browser = guiGetBrowser(initBrowser)
		local width, height = tonumber(width), tonumber(height)
		resizeBrowser( browser, width, height )
	end
)
```

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

### Initialize FileSystem Interface

Source: https://wiki.multitheftauto.com/wiki/Modules/FileSystem/createFilesystemInterface

Sets up a FileSystem interface and creates a translator for the current resource directory to access files like meta.xml.

```lua
-- Create the interface.
local fsys = createFilesystemInterface();

-- Make sure we have access to the module.
-- Access could be blocked by acl.xml priviledges.
if not ( fsys ) then
    outputDebugString( "could not create FileSystem interface" );
    return false;
end

-- Assume the resource is located inside a folder in the deathmatch resources directory.
-- Then we create a raw OS filesystem link to it.
local resRoot = fsys.createTranslator( "mods/deathmatch/resources/" .. getResourceName(resource) .. "/" );

-- Check that we have access (i.e. passed OS priviledges test) for this folder.
-- Will fail if the resource is not inside a folder in the deathmatch resources directory.
if not ( resRoot ) then
    outputDebugString( "cannot link resource instance directory" );
    return false;
end

-- Open the "meta.xml" file.
local metaFile = resRoot.open( "meta.xml", "rb" );

-- Success!
```

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

### Create and Configure DxTab

Source: https://wiki.multitheftauto.com/wiki/Astrath%3AcreateTab

Demonstrates initializing a DxTabPanel and adding multiple tabs with custom configurations.

```lua
-- Crear un tab panel
local tabPanel = DxTabPanel:new(100, 100, 400, 300)
tabPanel:setVisible(true)

-- Agregar tabs
local tab1 = DxTab:new(tabPanel, "Tab 1")
local tab2 = DxTab:new(tabPanel, "Tab 2", tocolor(200,0,0,255))

-- Establecer tab seleccionado
tabPanel:setSelected(tab1)
```

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

### logOut Example

Source: https://wiki.multitheftauto.com/wiki/LogOut

Logs all players out of their accounts when the resource starts.

```lua
function logoutAll ()
	local players = getElementsByType ( "player" ) -- Get every player
		for k, player in ipairs ( players ) do -- For every player do the following...
			account = getPlayerAccount ( player ) -- Get every player's account
				if ( not isGuestAccount ( account ) ) then -- For every player that's logged in....
					logOut ( player ) -- Log them out.
				end
		end
end
 -- Trigger it when the resource (re)starts
addEventHandler ( "onResourceStart", getResourceRootElement(), logoutAll )
```

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

### Update searchlight position example

Source: https://wiki.multitheftauto.com/wiki/SetSearchLightStartPosition

Demonstrates attaching a searchlight's start position to the current camera matrix during the pre-render frame.

```lua
local searchLight = createSearchLight(0, 0, 0, 0, 0, 0, 0, 10)

if searchLight then
    local function updateSearchLight()
        -- Set its start position to the camera position
        setSearchLightStartPosition(searchLight, getCameraMatrix())
    end
    addEventHandler("onClientPreRender", root, updateSearchLight)
end
```

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

### Server-side createPed Example

Source: https://wiki.multitheftauto.com/wiki/CreatePed

Creates a ped when the resource starts.

```lua
function pedLoad ( name )
   createPed ( 120, 5540.6654, 1020.55122, 1240.545 )
end
addEventHandler ( "onResourceStart", getResourceRootElement(), pedLoad )
```

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

### Triggering a client-side event on resource start

Source: https://wiki.multitheftauto.com/wiki/OnPlayerResourceStart

This example demonstrates how to detect when a resource has started for a player and subsequently trigger a custom client-side event.

```lua
function onPlayerResourceStart(startedResource)
	local resourceName = getResourceName(startedResource)
	local playerName = getPlayerName(source)
	local matchingResource = (startedResource == resource) -- 'resource' is predefined variable, see: https://wiki.multitheftauto.com/wiki/Predefined_variables_list#MTA_Predefined_variables
	local chatMessage = (resourceName.." has started for "..playerName)

	outputChatBox(chatMessage) -- display message when any resource starts for player

	if (not matchingResource) then -- check if startedResource matches current, if it doesn't do not trigger custom event
		return false
	end

	triggerClientEvent(source, "onClientCustomEvent", resourceRoot) -- send a custom clientside event defined in this resource, for specific player (source) only
end
addEventHandler("onPlayerResourceStart", root, onPlayerResourceStart)
```

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

### Complete resource configuration example

Source: https://wiki.multitheftauto.com/wiki/Resource_Web_Access

A full meta.xml configuration including resource inclusion, script definition, and function export.

```xml
<meta>
   <include resource="ajax" />
   <script src='code.lua' />
   <html src='page.htm' default='true' />
   <export function='showChatMessage' http='true' />
</meta>
```

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

### Hide multiple HUD components on resource start (Client)

Source: https://wiki.multitheftauto.com/wiki/SetPlayerHudComponentVisible

This client-side example hides a predefined list of HUD components when the resource starts.

```lua
-- Hide the hud when the resource is started
local components = { "weapon", "ammo", "health", "clock", "money", "breath", "armour", "wanted" }

addEventHandler("onClientResourceStart", getResourceRootElement(getThisResource()),
function ()
	for _, component in ipairs( components ) do
		setPlayerHudComponentVisible( component, false )
	end
end)
```

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

### Example usage of dgsWindowGetSizable

Source: https://wiki.multitheftauto.com/wiki/DgsWindowGetSizable

Demonstrates creating a window, setting it to sizable, and verifying its state using the DGS library.

```lua
DGS = exports.dgs

-- Create a DGS window.
window = DGS:dgsCreateWindow ( 0.50, 0.50, 0.25, 0.25, "Test", true ) 
dgsWindowSetSizable(window, true)
sizable = DGS:dgsIsSizable ( window )
if (sizable) then
   outputChatBox(“The window is sizable”)
end
```

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

### Notify resource start via debug message

Source: https://wiki.multitheftauto.com/wiki/OutputDebugString

An example of using outputDebugString within an event handler to notify when a specific resource has successfully started.

```lua
function resourceStartNotify ( resourcename )
	-- if the started resource is this one
	if ( resourcename == getThisResource() ) then
		-- send an info debug message as a notification
		outputDebugString ( "Resource " .. getResourceName(resourcename) .. " loaded." )
	end
end
addEventHandler( "onResourceStart", root, resourceStartNotify )
```

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

### guiBringToFront Usage Example

Source: https://wiki.multitheftauto.com/wiki/guiBringToFront

Creates a window and immediately brings it to the front of the GUI stack.

```lua
local window = guiCreateWindow ( 0.4, 0.4, 0.3, 0.3, "My dummy window", true )
guiBringToFront ( window )
```

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

### Filesystem Explorer Implementation

Source: https://wiki.multitheftauto.com/wiki/Modules/FileSystem/translator/chdir

A command-based example demonstrating how to use chdir to navigate a filesystem translator and list directory contents.

```lua
-- Create a generic FileSystem translator.
local cmdTranslator = fileCreateTranslator( "/" );

-- Set up some commands.
addCommandHandler( "chdir",
    function(...)
        local myPath = table.concat( { ... }, " " );

        cmdTranslator:chdir( myPath );
    end
);

addCommandHandler( "dir",
    function()
        -- todo: resolve a path given as arguments.

        local myEntries = {};

        local function itemIterator( path )
            table.insert( myEntries, cmdTranslator:relPath( path ) );
        end

        cmdTranslator:scanDirEx( "/", "*", itemIterator, itemIterator, false );

        -- Output the filesystem entries to the chatbox.
        for m,n in ipairs( myEntries ) do
            outputChatBox( n );
        end

        -- todo: print statistics (file size, number of files, number of directories, ...)
    end
);
```

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

### getPedWalkingStyle Client Example

Source: https://wiki.multitheftauto.com/wiki/GetPedWalkingStyle

Example usage showing how to retrieve and display the local player's walking style ID upon resource start.

```lua
addEventHandler("onClientResourceStart", resourceRoot, function()
    local style = getPedWalkingStyle(localPlayer)
    outputChatBox("Your walking style ID is " .. style)
end)
```

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

### Usage examples for setAccountSerial

Source: https://wiki.multitheftauto.com/wiki/SetAccountSerial

Examples demonstrating basic serial assignment and an administrative command implementation.

```lua
-- Simple example: Set a serial for a player's account
local player = getPlayerFromName("John")
local account = getPlayerAccount(player)
local newSerial = "A1B2C3D4E5F6789012345678901234AB"

if setAccountSerial(account, newSerial) then
    outputChatBox("Serial updated successfully!")
else
    outputChatBox("Failed to update serial!")
end
```

```lua
-- Advanced example: Administrative command system
function changePlayerSerial(player, newSerial)
    local account = getPlayerAccount(player)
    if account and not isGuestAccount(account) then
        if setAccountSerial(account, newSerial) then
            outputChatBox("Serial number updated successfully!", player, 0, 255, 0)
            return true
        else
            outputChatBox("Failed to update serial number. Invalid format!", player, 255, 0, 0)
            return false
        end
    else
        outputChatBox("You must be logged into a registered account.", player, 255, 0, 0)
        return false
    end
end

-- Command to set a player's account serial
addCommandHandler("setserial", function(player, cmd, targetPlayer, newSerial)
    if not targetPlayer or not newSerial then
        outputChatBox("Usage: /setserial <player> <32-char-hex-serial>", player)
        return
    end
    
    local target = getPlayerFromName(targetPlayer)
    if target then
        if string.len(newSerial) == 32 and string.match(newSerial, "^[A-Fa-f0-9]+$") then
            changePlayerSerial(target, newSerial)
        else
            outputChatBox("Serial must be 32 hexadecimal characters!", player, 255, 0, 0)
        end
    else
        outputChatBox("Player not found!", player, 255, 0, 0)
    end
end)
```

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

### getResourceName Usage Example

Source: https://wiki.multitheftauto.com/wiki/GetResourceName

Outputs the name of a resource to the console when it starts.

```lua
addEventHandler("onResourceStart", getRootElement(),
    function(res)
        outputConsole("Resource " .. getResourceName(res) .. " just started.")
    end
)
```

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

### Creating a Combo Box and Adding Items

Source: https://wiki.multitheftauto.com/wiki/CustomComboBox%3AaddItem

Example demonstrating the creation of a window, a combo box, and the addition of multiple items to that combo box.

```lua
local Window = CustomWindow.create(50, 50, 120, 60, "Example")

local ComboBox = CustomComboBox.create(5, 25, 110, 30, "Combo Box", false, Window)

local Item = ComboBox:addItem("Hello World")
ComboBox:addItem("Quick Brown Fox")
ComboBox:addItem("Jumps Over")
ComboBox:addItem("The Lazy Dog")
ComboBox:addItem("Over Size...")
ComboBox:addItem("...Items")
ComboBox:setMaxHeight(100)
```

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

### setSoundSpeed Usage Example

Source: https://wiki.multitheftauto.com/wiki/SetSoundSpeed

Example demonstrating how to play a sound and adjust its playback speed using a command handler.

```lua
function soundFunc()
sound = playSound ( "/sounds/jizzy.mp3",true) -- Let's play a sound
setSoundSpeed ( sound, 1.2 ) -- And it will be a little bit faster !
end
addCommandHandler("play",soundFunc)
```

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

### Browser Rendering Control Example

Source: https://wiki.multitheftauto.com/wiki/SetBrowserRenderingPaused

Demonstrates creating a browser, loading a URL, and toggling its rendering state via a command handler.

```lua
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()
 
--Let's create a new browser in remote mode.
local window = guiCreateWindow(0, 0, screenWidth, screenHeight, "Webbrowser", false)
local browser = guiCreateBrowser(0, 0, 800, 600, false, false, false, window)
 
-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- After this event has been triggered, we will be able to load our URL
local theBrowser = guiGetBrowser(browser) -- Get the browser element from gui-browser
addEventHandler("onClientBrowserCreated", theBrowser, 
	function()
		-- After the browser has been initialized, we can load www.youtube.com
		loadBrowserURL(source, "http://www.youtube.com")
	end
)


addCommandHandler ("pause", -- Add command named 'pause'
  function (player, command, value)
      setBrowserRenderingPaused (theBrowser, value)
  end
)
```

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

### Example usage of setTransferBoxVisible

Source: https://wiki.multitheftauto.com/wiki/SetTransferBoxVisible

Hides the transfer box when the resource starts.

```lua
addEventHandler ("onResourceStart", resourceRoot, function()
    setTransferBoxVisible (false)
end)
```

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

### Get Vehicle Headlight Color Examples

Source: https://wiki.multitheftauto.com/wiki/GetVehicleHeadLightColor

Examples demonstrating how to retrieve and output the headlight color of the player's current vehicle on both client and server sides.

```lua
function getHeadLightsColor()
	local vehicle = getPedOccupiedVehicle(localPlayer) -- We get the player vehicle..
	if (vehicle) then -- We check if he's on a vehicle...
		local r, g, b = getVehicleHeadLightColor(vehicle) -- We get the vehicle head lights color..
		outputChatBox("Your vehicle lights color are: ".. r ..", ".. g ..", ".. b) -- We output them to the chatbox.
	end
end
addCommandHandler("lightscolor",getHeadLightsColor) -- Add the command handler attached to the function "getHeadLightsColor".
```

```lua
function getHeadLightsColor(thePlayer)
	local vehicle = getPedOccupiedVehicle(thePlayer) -- We get the player vehicle..
	if (vehicle) then -- We check if he's on a vehicle...
		local r, g, b = getVehicleHeadLightColor(vehicle) -- We get the vehicle head lights color..
		outputChatBox("Your vehicle lights color are: ".. r ..", ".. g ..", ".. b, thePlayer) -- We output them to the chatbox.
	end
end
addCommandHandler("lightscolor",getHeadLightsColor) -- Add the command handler attached to the function "getHeadLightsColor".
```

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

### Change directory to installation folder

Source: https://wiki.multitheftauto.com/wiki/Installing_and_Running_MTASA_Server_on_GNU_Linux

Navigate to the server installation directory.

```bash
cd multitheftauto_linux
```
Tokens:
Raw