Multi Theft Auto: Wiki - User contributions [en]

Shared Scripting Functions

2025-11-12T13:31:36Z

Fernando187: /* Sound functions */

<pageclass class="both"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''shared''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]

For more functions, check the [[Useful_Functions|useful functions page]].
__TOC__

==Element functions==
{{Element_functions}}

==Ped functions==
{{Ped_functions}}

==Player functions==
{{Player_functions}}

==Weapon functions==
{{Weapon_functions}}

==Audio functions==
{{Audio functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Shared_camera_functions}}

==Clothes and body functions==
{{Clothes_and_body_functions}}

==Collision shape functions==
{{Collision_shape_functions}}

==Cursor functions==
{{Cursor_functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==File functions==
{{Shared_file_functions}}

==Input functions==
{{Input_functions}}

==Marker functions==
{{Marker_functions}}

==Matrix functions==
{{Matrix_functions}}

==Object functions==
{{Object_functions}}

==Output functions==
{{Output_functions}}

==Path functions==
{{Shared_path_functions}}

==Pickup functions==
{{Pickup_functions}}

==Projectile functions==
{{Projectile_functions}}

==Radar area functions==
{{Radar_area_functions}}

==Resource functions==
{{Resource_functions}}

==Team functions==
{{Team_functions}}

==Utility functions==
{{Utility_functions}}

==UTF8 Library==
{{UTF8_functions}}

==Vehicle functions==
{{Vehicle_functions}}

==Water functions==
{{Water_functions}}

==World functions==
{{World_functions}}

==XML functions==
{{XML functions}}

[[pl:Shared Scripting Functions]]
[[ru:Shared Scripting Functions]]

Template:Audio functions

2025-11-12T13:23:53Z

Fernando187: Undo revision 82615 by Fernando187 (talk)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[getRadioChannel]]</li>
<li>[[getRadioChannelName]]</li>
<li>[[getSFXStatus]]</li>
<li>[[getSoundBPM]]</li>
<li>[[getSoundBufferLength]]</li>
<li>[[getSoundEffectParameters]]</li>
<li>[[getSoundEffects]]</li>
<li>[[getSoundFFTData]]</li>
<li>[[getSoundLength]]</li>
<li>[[getSoundLevelData]]</li>
<li>[[getSoundMaxDistance]]</li>
<li>[[getSoundMetaTags]]</li>
<li>[[getSoundMinDistance]]</li>
<li>[[getSoundPan]]</li>
<li>[[getSoundPosition]]</li>
<li>[[getSoundProperties]]</li>
<li>[[getSoundSpeed]]</li>
<li>[[getSoundVolume]]</li>
<li>[[getSoundWaveData]]</li>
<li>[[isSoundLooped]]</li>
<li>[[isSoundPanningEnabled]]</li>
<li>[[isSoundPaused]]</li>
<li>[[playSFX3D]]</li>
<li>[[playSFX]]</li>
<li>[[playSound3D]]</li>
<li>[[playSound]]</li>
<li>[[setRadioChannel]]</li>
<li>[[setSoundEffectEnabled]]</li>
<li>[[setSoundEffectParameter]]</li>
<li>[[setSoundLooped]]</li>
<li>[[setSoundMaxDistance]]</li>
<li>[[setSoundMinDistance]]</li>
<li>[[setSoundPan]]</li>
<li>[[setSoundPanningEnabled]]</li>
<li>[[setSoundPaused]]</li>
<li>[[setSoundPosition]]</li>
<li>[[setSoundProperties]]</li>
<li>[[setSoundSpeed]]</li>
<li>[[setSoundVolume]]</li>
<li>[[stopSound]]</li>
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[playSoundFrontEnd]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Audio functions

2025-11-12T13:22:41Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[getRadioChannel]]</li>
<li>[[getRadioChannelName]]</li>
<li>[[getSFXStatus]]</li>
<li>[[getSoundBPM]]</li>
<li>[[getSoundBufferLength]]</li>
<li>[[getSoundEffectParameters]]</li>
<li>[[getSoundEffects]]</li>
<li>[[getSoundFFTData]]</li>
<li>[[getSoundLength]]</li>
<li>[[getSoundLevelData]]</li>
<li>[[getSoundMaxDistance]]</li>
<li>[[getSoundMetaTags]]</li>
<li>[[getSoundMinDistance]]</li>
<li>[[getSoundPan]]</li>
<li>[[getSoundPosition]]</li>
<li>[[getSoundProperties]]</li>
<li>[[getSoundSpeed]]</li>
<li>[[getSoundVolume]]</li>
<li>[[getSoundWaveData]]</li>
<li>[[isSoundLooped]]</li>
<li>[[isSoundPanningEnabled]]</li>
<li>[[isSoundPaused]]</li>
<li>[[playSFX3D]]</li>
<li>[[playSFX]]</li>
<li>[[playSound3D]]</li>
<li>[[playSound]]</li>
<li>[[setRadioChannel]]</li>
<li>[[setSoundEffectEnabled]]</li>
<li>[[setSoundEffectParameter]]</li>
<li>[[setSoundLooped]]</li>
<li>[[setSoundMaxDistance]]</li>
<li>[[setSoundMinDistance]]</li>
<li>[[setSoundPan]]</li>
<li>[[setSoundPanningEnabled]]</li>
<li>[[setSoundPaused]]</li>
<li>[[setSoundPosition]]</li>
<li>[[setSoundProperties]]</li>
<li>[[setSoundSpeed]]</li>
<li>[[setSoundVolume]]</li>
<li>[[stopSound]]</li>
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Shared Scripting Functions

2025-11-12T13:20:04Z

Fernando187: /* Radar functions */ FIX

<pageclass class="both"></pageclass>
{{Adding_Pages_to_Categories_and_Templates}}
This page lists all the '''shared''' scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use [[Requested Functions and Events]]

For more functions, check the [[Useful_Functions|useful functions page]].
__TOC__

==Element functions==
{{Element_functions}}

==Ped functions==
{{Ped_functions}}

==Player functions==
{{Player_functions}}

==Weapon functions==
{{Weapon_functions}}

==Sound functions==
{{Audio functions}}

==Blip functions==
{{Blip_functions}}

==Camera functions==
{{Shared_camera_functions}}

==Clothes and body functions==
{{Clothes_and_body_functions}}

==Collision shape functions==
{{Collision_shape_functions}}

==Cursor functions==
{{Cursor_functions}}

==Event functions==
{{Event_functions}}

==Explosion functions==
{{Explosion_functions}}

==File functions==
{{Shared_file_functions}}

==Input functions==
{{Input_functions}}

==Marker functions==
{{Marker_functions}}

==Matrix functions==
{{Matrix_functions}}

==Object functions==
{{Object_functions}}

==Output functions==
{{Output_functions}}

==Path functions==
{{Shared_path_functions}}

==Pickup functions==
{{Pickup_functions}}

==Projectile functions==
{{Projectile_functions}}

==Radar area functions==
{{Radar_area_functions}}

==Resource functions==
{{Resource_functions}}

==Team functions==
{{Team_functions}}

==Utility functions==
{{Utility_functions}}

==UTF8 Library==
{{UTF8_functions}}

==Vehicle functions==
{{Vehicle_functions}}

==Water functions==
{{Water_functions}}

==World functions==
{{World_functions}}

==XML functions==
{{XML functions}}

[[pl:Shared Scripting Functions]]
[[ru:Shared Scripting Functions]]

Template:Radar functions

2025-11-12T13:19:16Z

Fernando187: Fix duplicate template

Template:Player functions

2025-11-12T12:45:20Z

Fernando187: Undo revision 82611 by Fernando187 (talk)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[getLocalPlayer]]</li>
<li>[[getPlayerMapBoundingBox]]</li>
<li>[[getPlayerMapOpacity]]</li>
{{New items|3.0161|1.6.0|
<li>[[getPlayerHudComponentProperty]]</li>
|22868}}
<li>[[isPlayerMapVisible]]</li>
<li>[[isPlayerHudComponentVisible]]</li>
{{New items|3.0161|1.6.0|
<li>[[isPlayerCrosshairVisible]]</li>
|22751}}
{{New items|3.0161|1.6.0|
<li>[[resetPlayerHudComponentProperty]]</li>
|22868}}
{{New items|3.0161|1.6.0|
<li>[[setPlayerHudComponentProperty]]</li>
|22868}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[getAlivePlayers]]</li>
<li>[[getDeadPlayers]]</li>
<li>[[getPlayerAnnounceValue]]</li>
<li>[[getPlayerCount]]</li>
<li>[[getPlayerIdleTime]]</li>
<li>[[getPlayerIP]]</li>
<li>[[getPlayerVersion]]</li>
<li>[[getRandomPlayer]]</li>
<li>[[isPlayerMuted]]</li>
<li>[[redirectPlayer]]</li>
<li>[[resendPlayerACInfo]]</li>
<li>[[resendPlayerModInfo]]</li>
<li>[[setPlayerAnnounceValue]]</li>
<li>[[setPlayerMuted]]</li>
<li>[[setPlayerScriptDebugLevel]]</li>
<li>[[setPlayerTeam]]</li>
<li>[[setPlayerName]]</li>
<li>[[setPlayerVoiceBroadcastTo]]</li>
<li>[[setPlayerVoiceIgnoreFrom]]</li>
<li>[[setPlayerWantedLevel]]</li>
<li>[[spawnPlayer]]</li>
<li>[[takePlayerScreenShot]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[getPlayerTeam]]</li>
<li>[[getPlayerBlurLevel]]</li>
<li>[[setPlayerBlurLevel]]</li>
<li>[[getPlayerSerial]]</li>
<li>[[forcePlayerMap]]</li>
<li>[[getPlayerScriptDebugLevel]]</li>
<li>[[getPlayerFromName]]</li>
<li>[[getPlayerMoney]]</li>
<li>[[getPlayerName]]</li>
<li>[[getPlayerNametagColor]]</li>
<li>[[getPlayerNametagText]]</li>
<li>[[getPlayerPing]]</li>
<li>[[getPlayerWantedLevel]]</li>
<li>[[givePlayerMoney]]</li>
<li>[[isPlayerMapForced]]</li>
<li>[[isPlayerNametagShowing]]</li>
<li>[[setPlayerHudComponentVisible]]</li>
<li>[[setPlayerMoney]]</li>
<li>[[setPlayerNametagColor]]</li>
<li>[[setPlayerNametagShowing]]</li>
<li>[[setPlayerNametagText]]</li>
<li>[[takePlayerMoney]]</li>
<li>[[countPlayersInTeam]]</li>
<li>[[getPlayersInTeam]]</li>
<li>[[isVoiceEnabled]]</li>
<li>[[setControlState]]</li>
<li>[[getControlState]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Player functions

2025-11-12T12:45:09Z

Fernando187:

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[getLocalPlayer]]</li>
<li>[[getPlayerMapBoundingBox]]</li>
<li>[[getPlayerMapOpacity]]</li>
{{New items|3.0161|1.6.0|
<li>[[getPlayerHudComponentProperty]]</li>
|22868}}
<li>[[isPlayerMapVisible]]</li>
<li>[[isPlayerHudComponentVisible]]</li>
{{New items|3.0161|1.6.0|
<li>[[isPlayerCrosshairVisible]]</li>
|22751}}
{{New items|3.0161|1.6.0|
<li>[[resetPlayerHudComponentProperty]]</li>
|22868}}
{{New items|3.0161|1.6.0|
<li>[[setPlayerHudComponentProperty]]</li>
|22868}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[getAlivePlayers]]</li>
<li>[[getDeadPlayers]]</li>
<li>[[getPlayerAnnounceValue]]</li>
<li>[[getPlayerCount]]</li>
<li>[[getPlayerIdleTime]]</li>
<li>[[getPlayerIP]]</li>
<li>[[getPlayerVersion]]</li>
<li>[[getRandomPlayer]]</li>
<li>[[isPlayerMuted]]</li>
<li>[[redirectPlayer]]</li>
<li>[[resendPlayerACInfo]]</li>
<li>[[resendPlayerModInfo]]</li>
<li>[[setPlayerAnnounceValue]]</li>
<li>[[setPlayerMuted]]</li>
<li>[[setPlayerScriptDebugLevel]]</li>
<li>[[setPlayerTeam]]</li>
<li>[[setPlayerName]]</li>
<li>[[setPlayerVoiceBroadcastTo]]</li>
<li>[[setPlayerVoiceIgnoreFrom]]</li>
<li>[[setPlayerWantedLevel]]</li>
<li>[[spawnPlayer]]</li>
<li>[[takePlayerScreenShot]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[getPlayerTeam]]</li>
<li>[[getPlayerBlurLevel]]</li>
<li>[[setPlayerBlurLevel]]</li>
<li>[[getPlayerSerial]]</li>
<li>[[forcePlayerMap]]</li>
<li>[[getPlayerScriptDebugLevel]]</li>
<li>[[getPlayerFromName]]</li>
<li>[[getPlayerMoney]]</li>
<li>[[getPlayerName]]</li>
<li>[[getPlayerNametagColor]]</li>
<li>[[getPlayerNametagText]]</li>
<li>[[getPlayerPing]]</li>
<li>[[getPlayerWantedLevel]]</li>
<li>[[givePlayerMoney]]</li>
<li>[[isPlayerMapForced]]</li>
<li>[[isPlayerNametagShowing]]</li>
<li>[[setPlayerHudComponentVisible]]</li>
<li>[[setPlayerMoney]]</li>
<li>[[setPlayerNametagColor]]</li>
<li>[[setPlayerNametagShowing]]</li>
<li>[[setPlayerNametagText]]</li>
<li>[[takePlayerMoney]]</li>
<li>[[getPlayersInTeam]]</li>
<li>[[isVoiceEnabled]]</li>
<li>[[setControlState]]</li>
<li>[[getControlState]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

CountPlayersInTeam

2025-11-12T12:44:48Z

Fernando187: Undo revision 82609 by Fernando187 (talk)

__NOTOC__
{{Server client function}}
This function is for returning the number of players in the specified team.

==Syntax==
<syntaxhighlight lang="lua">
int countPlayersInTeam ( team theTeam )
</syntaxhighlight>
{{OOP||[[team]]:countPlayers|playerCount|}}
===Optional Arguments===
*'''theTeam:''' The team you wish to retrieve the player count of.

===Returns===
Returns an integer containing the number of players in the team, ''false'' if it could not be retrieved.

==Example==
<section name="Example 1" class="server" show="true">
This example adds a command in the console to find out how many players are on your team.
<syntaxhighlight lang="lua">
function outputTeamSize ( source, commandName )
-- Get player's team
local theTeam = getPlayerTeam ( source )
-- If the player is in any team
if theTeam then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players.", source )
else
outputChatBox ( "You're not in a team.", source )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This example adds a command in the console to find out how many players are on your team, clientside
<syntaxhighlight lang="lua">
function outputTeamSize ( commandName )
-- Get player's team
local theTeam = getPlayerTeam ( getLocalPlayer() )
-- If the player is in any team
if team then
-- Tell the player how big his team is
outputChatBox ( "Your team has " .. countPlayersInTeam ( theTeam ) .. " players." )
else
outputChatBox ( "You're not in a team." )
end
end
addCommandHandler ( "teamsize", outputTeamSize )
</syntaxhighlight>
</section>
<section name="Example 3" class="server" show="true">
This example balances a gamemode, to ensure equal number of players between the "grove" and "ballas" teams. This could be triggered when a player joins the server, or for all players currently in the server when the gamemode starts.
<syntaxhighlight lang="lua">
function balanceTeams ( thePlayer )
--get the team pointers from their names
local groveTeam = getTeamFromName ( "grove" )
local ballasTeam = getTeamFromName ( "ballas" )
--count the number of players in each team, and store them
local groveCount = countPlayersInTeam ( groveTeam )
local ballasCount = countPlayersInTeam ( ballasTeam )
if groveCount == ballasCount then --if the teams are equal
setPlayerTeam ( thePlayer , groveTeam ) --place the player in grove
elseif groveCount > ballasCount then --if there are more in grove
setPlayerTeam ( thePlayer , ballasTeam ) --place him in ballas
elseif groveCount < ballasCount then --if there are more in ballas
setPlayerTeam ( thePlayer , groveTeam ) --place him in grove.
end
end</syntaxhighlight>
</section>

==See Also==
{{Team functions}}

CountPlayersInTeam

2025-11-12T12:44:28Z

Fernando187: /* See Also */

ResetWorldProperties

2025-11-11T17:12:21Z

Fernando187: Move unnecessary note section to desc

__NOTOC__
{{Shared function}}
{{New feature/item|3.0161|1.6.0|22741|This function resets all world properties to default.

Regardless of the value of the arguments, the following properties are reset:
* Far clip distance
* Near clip distance
* Clouds (enabled)
* Birds (enabled)
* Occlusions (enabled)
* Gravity
* Game speed
* Aircraft max height & velocity
* Jetpack max height
* Interior furnitures (enabled)
* Minute duration
* Blur level
* Corona reflections
* Traffic lights locked state
* Water level and color
* Wave height
* Volumetric shadows
* Game time freeze
* Dynamic ped shadows
}}

==Syntax==
<syntaxhighlight lang="lua">nil resetWorldProperties( [ bool resetSpecialProperties = true, bool resetWorldProperties = true, bool resetWeatherProperties = true, bool resetLODs = true, bool resetSounds = true, bool resetGlitches = true, bool resetJetpackWeapons = true ] )</syntaxhighlight>
===Optional arguments===
{{OptionalArg}}
* '''resetSpecialProperties:''' Restores all special world properties changed by [[setWorldSpecialPropertyEnabled]] to default.
* '''resetWorldProperties:''' Reset all world properties changed by [[setWorldProperty]].
* '''resetWeatherProperties:''' Reset all weather properties like heat haze, rain level, sun color etc.
* '''resetLODs:''' Reset vehicles and peds lod distance.
* '''resetSounds:''' Restore interior sounds, world sounds and ambient sounds.
<section name="Server" class="server" show="true">
* '''resetGlitches:''' Disable all glitches enabled by [[setGlitchEnabled]].
* '''resetJetpackWeapons:''' Reset jetpack weapons changes by [[setJetpackWeaponEnabled]] to default (uzi, pistol, tec9).
</section>

===Returns===
This function returns nothing (''nil'').

==Example==
<syntaxhighlight lang="lua">
resetWorldProperties()
</syntaxhighlight>

==See Also==
{{World functions}}

GuiGetInputMode

2025-11-11T17:11:21Z

Fernando187: Move unnecessary note section to desc

{{Client function}}
__NOTOC__
This function returns the current input mode as set by [[guiSetInputMode]].
Default mode is ''"allow_binds"''.

This function is '''not''' a replacement of [[guiGetInputEnabled]], indeed for the mode ''"no_binds_when_editing"'' the actual state of binds depends on the currently focused GUI widget. However:
* when ''guiGetInputMode ( )'' returns ''"allow_binds"'' you can be sure that ''guiGetInputEnabled ()'' will return ''false''
* when ''guiGetInputMode ( )'' returns ''"no_binds"'' you can be sure that ''guiGetInputEnabled ()'' will return ''true''

==Syntax==
<syntaxhighlight lang="lua">
string guiGetInputMode ( )
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]].getInputMode|inputMode|guiSetInputMode}}

===Returns===
Returns a string defining the current input mode, potential values are:
* '''"allow_binds":''' binds are enabled, hence using a key such as t in an editbox will still activate the chatbox
* '''"no_binds":''' binds are disabled, hence using a key such as t in an editbox will not activate the chatbox
* '''"no_binds_when_editing":''' binds are always enabled except when an editable editbox or memo has input focus

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addCommandHandler( "checkmode",
function ()
outputChatBox( string.format( "The current input mode is: '%s'", guiGetInputMode () ) )
end )
</syntaxhighlight>
</section>

==See Also==
{{GUI_functions}}
{{GUI_events}}

GuiSetInputMode

2025-11-11T17:10:23Z

Fernando187: Move unncessary note section to desc

{{Client function}}
__NOTOC__
This function controls the input mode to define whether or not (and when) keybinds or MTA binds are overridden (disabled) so that text can be input into an editbox, for example.
Available input modes are:
* '''allow_binds:''' never disabled (hence using a key such as t in an editbox will still open the chatbox)
* '''no_binds:''' always disabled (hence using a key such as t will never open the chatbox)
* '''no_binds_when_editing:''' only disabled when editing an editbox or a memo (binds are enabled except when an editbox or memo has input focus)

This function can be used as a replacement of [[guiSetInputEnabled]] since it provides the same functionality with one added feature.
* ''guiSetInputEnabled ( false )'' is the same as ''guiSetInputMode ( "allow_binds" )''
* ''guiSetInputEnabled ( true )'' is the same as ''guiSetInputMode ( "no_binds" )''

==Syntax==
<syntaxhighlight lang="lua">
bool guiSetInputMode ( string mode )
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]].setInputMode|inputMode|guiGetInputMode}}

===Required Arguments===
* '''mode:''' a string representing the desired input mode. Accepted values are:
** '''"allow_binds":''' binds are enabled, hence using a key such as t in an editbox will still open the chatbox (default)
** '''"no_binds":''' binds are disabled, hence using a key such as t will never open the chatbox
** '''"no_binds_when_editing":''' binds are enabled except when an editbox or memo has input focus

===Returns===
Returns ''true'' if input mode could be changed, ''false'' if invalid parameters are passed.

==Example==
<syntaxhighlight lang="lua">
function onClientResourceStartSetGUIInputMode()
guiSetInputMode("no_binds_when_editing") -- Calls guiSetInputMode once and for all to not have to handle binds state dynamically
end
addEventHandler("onClientResourceStart", resourceRoot, onClientResourceStartSetGUIInputMode)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
{{GUI_events}}

Template:Utility functions

2025-11-10T15:03:30Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[createTrayNotification]]</li>
<li>[[downloadFile]]</li>
<li>[[getKeyboardLayout]]</li>
<li>[[getLocalization]]</li>
{{New items|3.0161|1.6.0|
<li>[[getServerIp]]</li>
|22890}}
<li>[[isShowCollisionsEnabled]]</li>
<li>[[isShowSoundEnabled]]</li>
<li>[[isTransferBoxAlwaysVisible]]</li>
<li>[[isTrayNotificationEnabled]]</li>
<li>[[setClipboard]]</li>
<li>[[setWindowFlashing]]</li>
<li>[[showCol]]</li>
<li>[[showSound]]</li>
| {{#ifeq: {{lc:{{{1}}}}} | server
|
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[addDebugHook]]</li>
<li>[[debugSleep]]</li>
<li>[[decodeString]]</li>
<li>[[encodeString]]</li>
<li>[[fromJSON]]</li>
<li>[[generateKeyPair]]</li>
<li>[[getColorFromString]]</li>
<li>[[getDevelopmentMode]]</li>
<li>[[getDistanceBetweenPoints2D]]</li>
<li>[[getDistanceBetweenPoints3D]]</li>
<li>[[getEasingValue]]</li>
<li>[[getNetworkStats]]</li>
<li>[[getNetworkUsageData]]</li>
<li>[[getPerformanceStats]]</li>
<li>[[getRealTime]]</li>
<li>[[getTickCount]]</li>
<li>[[getTimerDetails]]</li>
<li>[[getTimers]]</li>
<li>[[getFPSLimit]]</li>
<li>[[getUserdataType]]</li>
<li>[[getVersion]]</li>
<li>[[gettok]]</li>
<li>[[isTransferBoxVisible]]</li>
<li>[[setTransferBoxVisible]]</li>
<li>[[hash]]</li>
<li>[[inspect]]</li>
<li>[[interpolateBetween]]</li>
<li>[[iprint]]</li>
<li>[[isOOPEnabled]]</li>
<li>[[isTimer]]</li>
{{New items|3.0161|1.6.0|
<li>[[isTimerPaused]]</li>
<li>[[setTimerPaused]]</li>
|22701}}
<li>[[killTimer]]</li>
<li>[[md5]]</li>
<li>[[passwordHash]]</li>
<li>[[passwordVerify]]</li>
<li>[[pregFind]]</li>
<li>[[pregMatch]]</li>
<li>[[pregReplace]]</li>
<li>[[removeDebugHook]]</li>
<li>[[resetTimer]]</li>
<li>[[setDevelopmentMode]]</li>
<li>[[setFPSLimit]]</li>
<li>[[setTimer]]</li>
<li>[[ref]]</li>
<li>[[deref]]</li>
<li>[[sha256]]</li>
<li>[[split]]</li>
<li>[[teaDecode]]</li>
<li>[[teaEncode]]</li>
<li>[[toJSON]]</li>
<li>[[tocolor]]</li>
<li>[[getProcessMemoryStats]]</li>
<li>[[utfChar]]</li>
<li>[[utfCode]]</li>
<li>[[utfLen]]</li>
<li>[[utfSeek]]</li>
<li>[[utfSub]]</li>
</ul>
{{Bit_functions}}
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:World functions

2025-11-10T15:02:51Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[createSWATRope]]</li>
<li>[[getBirdsEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22188|
<li>[[getColorFilter]]</li>
}}
<li>[[getCoronaReflectionsEnabled]]</li>
<li>[[getGarageBoundingBox]]</li>
<li>[[getGaragePosition]]</li>
<li>[[getGarageSize]]</li>
<li>[[getGroundPosition]]</li>
<li>[[getInteriorFurnitureEnabled]]</li>
<li>[[getNearClipDistance]]</li>
<li>[[getPedsLODDistance]]</li>
<li>[[getRoofPosition]]</li>
<li>[[getScreenFromWorldPosition]]</li>
<li>[[getVehiclesLODDistance]]</li>
<li>[[getWorldFromScreenPosition]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[getWorldProperty]]</li>
}}
<li>[[isAmbientSoundEnabled]]</li>
<li>[[isLineOfSightClear]]</li>
{{New feature/item|3.0161|1.6.0|22676|
<li>[[isTimeFrozen]]</li>
}}
{{New feature/item|3.0161|1.6.0|22721|
<li>[[isVolumetricShadowsEnabled]]</li>
}}
<li>[[isWorldSoundEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22219|
<li>[[processLineAgainstMesh]]</li>
}}
<li>[[processLineOfSight]]</li>
<li>[[resetAmbientSounds]]</li>
<li>[[resetBlurLevel]]</li>
<li>[[resetColorFilter]]</li>
<li>[[resetCoronaReflectionsEnabled]]</li>
<li>[[resetNearClipDistance]]</li>
<li>[[resetPedsLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22676|
<li>[[resetTimeFrozen]]</li>
}}
{{New feature/item|3.0161|1.6.0|22721|
<li>[[resetVolumetricShadows]]</li>
}}
<li>[[resetVehiclesLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[resetWorldProperty]]</li>
}}
<li>[[resetWorldSounds]]</li>
<li>[[setAmbientSoundEnabled]]</li>
<li>[[setBirdsEnabled]]</li>
<li>[[setColorFilter]]</li>
<li>[[setCoronaReflectionsEnabled]]</li>
<li>[[setInteriorFurnitureEnabled]]</li>
<li>[[setNearClipDistance]]</li>
<li>[[setPedsLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22676|
<li>[[setTimeFrozen]]</li>
}}
<li>[[setVehiclesLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[setWorldProperty]]</li>
}}
<li>[[setWorldSoundEnabled]]</li>
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainLevel]]</li>
}}
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainMultiplier]]</li>
}}
<li>[[testLineAgainstWater]]</li>
{{New feature/item|3.0161|1.6.0|22721|
<li>[[setVolumetricShadowsEnabled]]</li>
}}
{{New items|3.0161|1.6.0|
<li>[[testSphereAgainstWorld]]</li>
|22837}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[getJetpackWeaponEnabled]]</li>
<li>[[setJetpackWeaponEnabled]]</li>
}}
}}
</br>
}}

<li>[[areTrafficLightsLocked]]</li>
<li>[[getAircraftMaxHeight]]</li>
<li>[[getAircraftMaxVelocity]]</li>
<li>[[getCloudsEnabled]]</li>
<li>[[getFarClipDistance]]</li>
<li>[[getFogDistance]]</li>
<li>[[getGameSpeed]]</li>
<li>[[getGravity]]</li>
<li>[[getHeatHaze]]</li>
<li>[[getInteriorSoundsEnabled]]</li>
<li>[[getJetpackMaxHeight]]</li>
<li>[[getMinuteDuration]]</li>
<li>[[getMoonSize]]</li>
<li>[[getOcclusionsEnabled]]</li>
<li>[[getRainLevel]]</li>
<li>[[getSunColor]]</li>
<li>[[getSunSize]]</li>
<li>[[getTime]]</li>
<li>[[getTrafficLightState]]</li>
<li>[[getWeather]]</li>
<li>[[getWindVelocity]]</li>
<li>[[getSkyGradient]]</li>
{{New items|3.0161|1.6.0|
<li>[[isWorldSpecialPropertyEnabled]]</li>
|22195}}
<li>[[getZoneName]]</li>
<li>[[isGarageOpen]]</li>
<li>[[removeWorldModel]]</li>
<li>[[resetFarClipDistance]]</li>
<li>[[resetFogDistance]]</li>
<li>[[resetHeatHaze]]</li>
<li>[[resetMoonSize]]</li>
<li>[[resetRainLevel]]</li>
<li>[[resetSkyGradient]]</li>
<li>[[resetSunColor]]</li>
<li>[[resetSunSize]]</li>
<li>[[resetWindVelocity]]</li>
<li>[[restoreAllWorldModels]]</li>
<li>[[restoreWorldModel]]</li>
<li>[[setAircraftMaxHeight]]</li>
<li>[[setAircraftMaxVelocity]]</li>
<li>[[setCloudsEnabled]]</li>
<li>[[setFarClipDistance]]</li>
<li>[[setFogDistance]]</li>
<li>[[setGameSpeed]]</li>
<li>[[setGarageOpen]]</li>
<li>[[setGravity]]</li>
<li>[[setHeatHaze]]</li>
<li>[[setInteriorSoundsEnabled]]</li>
<li>[[setMinuteDuration]]</li>
<li>[[setMoonSize]]</li>
<li>[[setOcclusionsEnabled]]</li>
<li>[[setRainLevel]]</li>
<li>[[setSkyGradient]]</li>
<li>[[setSunColor]]</li>
<li>[[setSunSize]]</li>
<li>[[setTime]]</li>
<li>[[setTrafficLightState]]</li>
<li>[[setTrafficLightsLocked]]</li>
<li>[[setWeather]]</li>
<li>[[setWeatherBlended]]</li>
<li>[[setWindVelocity]]</li>
<li>[[setJetpackMaxHeight]]</li>
{{New items|3.0161|1.6.0|
<li>[[setWorldSpecialPropertyEnabled]]</li>
|22195}}
{{New items|3.0161|1.6.0|
<li>[[resetWorldProperties]]</li>
|22741}}
{{New items|3.0161|1.6.0|
<li>[[removeGameWorld]]</li>
<li>[[restoreGameWorld]]</li>
|22909}}
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Player functions

2025-11-10T15:02:30Z

Fernando187: Fix function in wrong category (wiki cleaning)

Template:Vehicle functions

2025-11-10T15:02:01Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[areVehicleLightsOn]]</li>
<li>[[getHeliBladeCollisionsEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22344|
<li>[[getVehicleRotorSpeed]]</li>
}}
{{New items|3.0161|1.6.0|
<li>[[getVehicleRotorState]]</li>
|22862}}
<li>[[getVehicleAdjustableProperty]]</li>
<li>[[getVehicleComponentPosition]]</li>
<li>[[getVehicleComponentRotation]]</li>
<li>[[getVehicleComponents]]</li>
<li>[[getVehicleComponentScale]]</li>
<li>[[getVehicleComponentVisible]]</li>
<li>[[getVehicleCurrentGear]]</li>
<li>[[getVehicleDummyPosition]]</li>
{{New items|3.0161|1.6.0|
<li>[[getVehicleEntryPoints]]</li>
|22649}}
<li>[[getVehicleGravity]]</li>
<li>[[getVehicleModelDummyDefaultPosition]]</li>
<li>[[getVehicleModelDummyPosition]]</li>
<li>[[getVehicleModelExhaustFumesPosition]]</li>
<li>[[getVehicleModelWheelSize]]</li>
<li>[[getVehicleNitroCount]]</li>
<li>[[getVehicleNitroLevel]]</li>
<li>[[getVehicleWheelFrictionState]]</li>
<li>[[getVehicleWheelScale]]</li>
<li>[[isTrainChainEngine]]</li>
<li>[[isVehicleNitroActivated]]</li>
<li>[[isVehicleNitroRecharging]]</li>
<li>[[isVehicleWheelOnGround]]</li>
<li>[[isVehicleWindowOpen]]</li>
<li>[[resetVehicleComponentPosition]]</li>
<li>[[resetVehicleComponentRotation]]</li>
<li>[[resetVehicleComponentScale]]</li>
<li>[[resetVehicleDummyPositions]]</li>
<li>[[setHeliBladeCollisionsEnabled]]</li>
{{New items|3.0161|1.6.0|
<li>[[setVehicleRotorSpeed]]</li>
|22344}}
{{New items|3.0161|1.6.0|
<li>[[setVehicleRotorState]]</li>
|22862}}
<li>[[setVehicleAdjustableProperty]]</li>
<li>[[setVehicleComponentPosition]]</li>
<li>[[setVehicleComponentRotation]]</li>
<li>[[setVehicleComponentScale]]</li>
<li>[[setVehicleComponentVisible]]</li>
<li>[[setVehicleDummyPosition]]</li>
<li>[[setVehicleGravity]]</li>
<li>[[setVehicleModelDummyPosition]]</li>
<li>[[setVehicleModelExhaustFumesPosition]]</li>
<li>[[setVehicleModelWheelSize]]</li>
<li>[[setVehicleNitroCount]]</li>
<li>[[setVehicleNitroLevel]]</li>
<li>[[setVehicleWheelScale]]</li>
<li>[[setVehicleWindowOpen]]</li>
{{New items|3.0161|1.6.0|
<li>[[setVehicleWheelsRotation]]</li>
|22592}}
{{New items|3.0161|1.6.0|
<li>[[setVehicleSmokeTrailEnabled]]</li>
|22815}}
{{New items|3.0161|1.6.0|
<li>[[isVehicleSmokeTrailEnabled]]</li>
|22815}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[getModelHandling]]</li>
<li>[[getVehicleIdleRespawnDelay]]</li>
<li>[[getVehicleRespawnDelay]]</li>
<li>[[getVehicleRespawnPosition]]</li>
<li>[[getVehicleRespawnRotation]]</li>
<li>[[getVehiclesOfType]]</li>
<li>[[isVehicleRespawnable]]</li>
<li>[[resetVehicleExplosionTime]]</li>
<li>[[resetVehicleIdleTime]]</li>
<li>[[respawnVehicle]]</li>
<li>[[setModelHandling]]</li>
<li>[[setVehicleIdleRespawnDelay]]</li>
<li>[[setVehicleRespawnDelay]]</li>
<li>[[setVehicleRespawnPosition]]</li>
<li>[[setVehicleRespawnRotation]]</li>
<li>[[spawnVehicle]]</li>
<li>[[toggleVehicleRespawn]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[addVehicleUpgrade]]</li>
<li>[[addVehicleSirens]]</li>
<li>[[attachTrailerToVehicle]]</li>
<li>[[blowVehicle]]</li>
<li>[[createVehicle]]</li>
<li>[[detachTrailerFromVehicle]]</li>
<li>[[fixVehicle]]</li>
<li>[[getOriginalHandling]]</li>
<li>[[getTrainDirection]]</li>
<li>[[getTrainPosition]]</li>
<li>[[getTrainSpeed]]</li>
<li>[[getVehicleColor]]</li>
<li>[[getVehicleCompatibleUpgrades]]</li>
<li>[[getVehicleController]]</li>
<li>[[getVehicleDoorOpenRatio]]</li>
<li>[[getVehicleDoorState]]</li>
<li>[[getVehicleEngineState]]</li>
<li>[[getVehicleHandling]]</li>
<li>[[getVehicleHeadLightColor]]</li>
<li>[[getVehicleLandingGearDown]]</li>
<li>[[getVehicleLightState]]</li>
<li>[[getVehicleMaxPassengers]]</li>
<li>[[getVehicleModelFromName]]</li>
<li>[[getVehicleName]]</li>
<li>[[getVehicleNameFromModel]]</li>
<li>[[setVehicleNitroActivated]]</li>
<li>[[getVehicleOccupant]]</li>
<li>[[getVehicleOccupants]]</li>
<li>[[getVehicleOverrideLights]]</li>
<li>[[getVehiclePaintjob]]</li>
<li>[[getVehiclePanelState]]</li>
<li>[[getVehiclePlateText]]</li>
<li>[[getVehicleSirenParams]]</li>
<li>[[getVehicleSirens]]</li>
<li>[[getVehicleSirensOn]]</li>
<li>[[getVehicleTowedByVehicle]]</li>
<li>[[getVehicleTowingVehicle]]</li>
<li>[[getVehicleTurretPosition]]</li>
<li>[[getVehicleType]]</li>
<li>[[getVehicleUpgradeOnSlot]]</li>
<li>[[getVehicleUpgradeSlotName]]</li>
<li>[[getVehicleUpgrades]]</li>
<li>[[getVehicleVariant]]</li>
<li>[[getVehicleWheelStates]]</li>
<li>[[isTrainDerailable]]</li>
<li>[[isTrainDerailed]]</li>
<li>[[isVehicleBlown]]</li>
<li>[[isVehicleDamageProof]]</li>
<li>[[isVehicleFuelTankExplodable]]</li>
<li>[[isVehicleLocked]]</li>
<li>[[isVehicleOnGround]]</li>
<li>[[isVehicleTaxiLightOn]]</li>
<li>[[removeVehicleUpgrade]]</li>
<li>[[removeVehicleSirens]]</li>
<li>[[setTrainDerailable]]</li>
<li>[[setTrainDerailed]]</li>
<li>[[setTrainDirection]]</li>
<li>[[setTrainPosition]]</li>
<li>[[setTrainSpeed]]</li>
<li>[[setVehicleColor]]</li>
<li>[[setVehicleDamageProof]]</li>
<li>[[setVehicleDoorOpenRatio]]</li>
<li>[[setVehicleDoorState]]</li>
<li>[[setVehicleDoorsUndamageable]]</li>
<li>[[setVehicleEngineState]]</li>
<li>[[setVehicleFuelTankExplodable]]</li>
{{New items|3.0161|1.6.0|
<li>[[spawnVehicleFlyingComponent]]</li>
|22771}}
<li>[[setVehicleHandling]]</li>
<li>[[setVehicleHeadLightColor]]</li>
<li>[[setVehicleLandingGearDown]]</li>
<li>[[setVehicleLightState]]</li>
<li>[[setVehicleLocked]]</li>
<li>[[setVehicleOverrideLights]]</li>
<li>[[setVehiclePaintjob]]</li>
<li>[[setVehiclePanelState]]</li>
<li>[[setVehiclePlateText]]</li>
<li>[[setVehicleSirens]]</li>
<li>[[setVehicleSirensOn]]</li>
<li>[[setVehicleTaxiLightOn]]</li>
<li>[[setVehicleTurretPosition]]</li>
<li>[[setVehicleVariant]]</li>
<li>[[setVehicleWheelStates]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Utility functions

2025-11-10T15:00:26Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[createTrayNotification]]</li>
<li>[[downloadFile]]</li>
<li>[[getKeyboardLayout]]</li>
<li>[[getLocalization]]</li>
{{New items|3.0161|1.6.0|
<li>[[getServerIp]]</li>
|22890}}
<li>[[isShowCollisionsEnabled]]</li>
<li>[[isShowSoundEnabled]]</li>
<li>[[isTransferBoxAlwaysVisible]]</li>
<li>[[isTrayNotificationEnabled]]</li>
<li>[[setClipboard]]</li>
<li>[[setWindowFlashing]]</li>
<li>[[showCol]]</li>
<li>[[showSound]]</li>
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[setServerConfigSetting]]</li>
<li>[[getServerConfigSetting]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[addDebugHook]]</li>
<li>[[debugSleep]]</li>
<li>[[decodeString]]</li>
<li>[[encodeString]]</li>
<li>[[fromJSON]]</li>
<li>[[generateKeyPair]]</li>
<li>[[getColorFromString]]</li>
<li>[[getDevelopmentMode]]</li>
<li>[[getDistanceBetweenPoints2D]]</li>
<li>[[getDistanceBetweenPoints3D]]</li>
<li>[[getEasingValue]]</li>
<li>[[getNetworkStats]]</li>
<li>[[getNetworkUsageData]]</li>
<li>[[getPerformanceStats]]</li>
<li>[[getRealTime]]</li>
<li>[[getTickCount]]</li>
<li>[[getTimerDetails]]</li>
<li>[[getTimers]]</li>
<li>[[getFPSLimit]]</li>
<li>[[getUserdataType]]</li>
<li>[[getVersion]]</li>
<li>[[gettok]]</li>
<li>[[isTransferBoxVisible]]</li>
<li>[[setTransferBoxVisible]]</li>
<li>[[hash]]</li>
<li>[[inspect]]</li>
<li>[[interpolateBetween]]</li>
<li>[[iprint]]</li>
<li>[[isOOPEnabled]]</li>
<li>[[isTimer]]</li>
{{New items|3.0161|1.6.0|
<li>[[isTimerPaused]]</li>
<li>[[setTimerPaused]]</li>
|22701}}
<li>[[killTimer]]</li>
<li>[[md5]]</li>
<li>[[passwordHash]]</li>
<li>[[passwordVerify]]</li>
<li>[[pregFind]]</li>
<li>[[pregMatch]]</li>
<li>[[pregReplace]]</li>
<li>[[removeDebugHook]]</li>
<li>[[resetTimer]]</li>
<li>[[setDevelopmentMode]]</li>
<li>[[setFPSLimit]]</li>
<li>[[setTimer]]</li>
<li>[[ref]]</li>
<li>[[deref]]</li>
<li>[[sha256]]</li>
<li>[[split]]</li>
<li>[[teaDecode]]</li>
<li>[[teaEncode]]</li>
<li>[[toJSON]]</li>
<li>[[tocolor]]</li>
<li>[[getProcessMemoryStats]]</li>
<li>[[utfChar]]</li>
<li>[[utfCode]]</li>
<li>[[utfLen]]</li>
<li>[[utfSeek]]</li>
<li>[[utfSub]]</li>
</ul>
{{Bit_functions}}
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Ped functions

2025-11-10T14:58:41Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[canPedBeKnockedOffBike]]</li>
<li>[[getPedAnalogControlState]]</li>
<li>[[getPedAnimation]]</li>
<li>[[getPedBonePosition]]</li>
<li>[[getPedCameraRotation]]</li>
<li>[[getPedControlState]]</li>
<li>[[getPedMoveState]]</li>
<li>[[getPedOxygenLevel]]</li>
<li>[[getPedSimplestTask]]</li>
<li>[[getPedTargetCollision]]</li>
<li>[[getPedTargetEnd]]</li>
<li>[[getPedTargetStart]]</li>
<li>[[getPedTask]]</li>
<li>[[getPedVoice]]</li>
<li>[[getPedWeaponMuzzlePosition]]</li>
<li>[[givePedWeapon]]</li>
<li>[[isPedBleeding]]</li>
<li>[[isPedDoingTask]]</li>
<li>[[isPedTargetingMarkerEnabled]]</li>
{{New items|3.0161|1.6.0|
<li>[[resetPedVoice]]</li>
|21874}}
<li>[[setPedAimTarget]]</li>
<li>[[setPedAnalogControlState]]</li>
<li>[[setPedBleeding]]</li>
<li>[[setPedCameraRotation]]</li>
<li>[[setPedCanBeKnockedOffBike]]</li>
<li>[[setPedControlState]]</li>
<li>[[setPedEnterVehicle]]</li>
<li>[[setPedExitVehicle]]</li>
<li>[[IsPedFootBloodEnabled]]</li>
<li>[[setPedFootBloodEnabled]]</li>
<li>[[setPedLookAt]]</li>
<li>[[setPedOxygenLevel]]</li>
<li>[[setPedTargetingMarkerEnabled]]</li>
<li>[[setPedVoice]]</li>
{{New items|3.0161|1.6.0|
<li>[[playPedVoiceLine]]</li>
|22997}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[getPedGravity]]</li>
<li>[[reloadPedWeapon]]</li>
<li>[[setPedChoking]]</li>
<li>[[setPedGravity]]</li>
<li>[[setPedWearingJetpack]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[addPedClothes]]</li>
<li>[[getPedClothes]]</li>
<li>[[removePedClothes]]</li>
<li>[[createPed]]</li>
<li>[[getPedAmmoInClip]]</li>
<li>[[getPedArmor]]</li>
<li>[[getPedFightingStyle]]</li>
<li>[[getPedOccupiedVehicle]]</li>
<li>[[getPedOccupiedVehicleSeat]]</li>
<li>[[getPedStat]]</li>
<li>[[getPedTarget]]</li>
<li>[[getPedTotalAmmo]]</li>
<li>[[getPedWalkingStyle]]</li>
<li>[[getPedWeapon]]</li>
<li>[[getPedWeaponSlot]]</li>
<li>[[getPedContactElement]]</li>
<li>[[getValidPedModels]]</li>
<li>[[isPedChoking]]</li>
<li>[[isPedDead]]</li>
<li>[[isPedDoingGangDriveby]]</li>
<li>[[isPedDucked]]</li>
<li>[[isPedHeadless]]</li>
<li>[[isPedInVehicle]]</li>
<li>[[isPedOnGround]]</li>
<li>[[isPedReloadingWeapon]]</li>
<li>[[isPedWearingJetpack]]</li>
<li>[[killPed]]</li>
<li>[[removePedFromVehicle]]</li>
<li>[[setPedAnimation]]</li>
<li>[[setPedAnimationProgress]]</li>
<li>[[setPedAnimationSpeed]]</li>
<li>[[setPedArmor]]</li>
<li>[[setPedDoingGangDriveby]]</li>
<li>[[setPedFightingStyle]]</li>
<li>[[setPedHeadless]]</li>
<li>[[setPedStat]]</li>
<li>[[setPedWalkingStyle]]</li>
<li>[[setPedWeaponSlot]]</li>
<li>[[warpPedIntoVehicle]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Clothes and body functions

2025-11-10T14:57:56Z

Fernando187: Fix function in wrong category (wiki cleaning)

<ul>
<li>[[getBodyPartName]]</li>
<li>[[getClothesByTypeIndex]]</li>
<li>[[getClothesTypeName]]</li>
<li>[[getTypeIndexFromClothes]]</li>
{{Added feature/item|1.6.1|1.6.0|23124|
<li>[[addClothingModel]]</li>
}}
</ul>

<noinclude>[[Category:Functions templates]]</noinclude>

Template:World functions

2025-11-10T14:54:41Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[createSWATRope]]</li>
<li>[[getBirdsEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22188|
<li>[[getColorFilter]]</li>
}}
<li>[[getCoronaReflectionsEnabled]]</li>
<li>[[getGarageBoundingBox]]</li>
<li>[[getGaragePosition]]</li>
<li>[[getGarageSize]]</li>
<li>[[getGroundPosition]]</li>
<li>[[getInteriorFurnitureEnabled]]</li>
<li>[[getNearClipDistance]]</li>
<li>[[getPedsLODDistance]]</li>
<li>[[getRoofPosition]]</li>
<li>[[getScreenFromWorldPosition]]</li>
<li>[[getVehiclesLODDistance]]</li>
<li>[[getWorldFromScreenPosition]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[getWorldProperty]]</li>
}}
<li>[[isAmbientSoundEnabled]]</li>
<li>[[isLineOfSightClear]]</li>
{{New feature/item|3.0161|1.6.0|22676|
<li>[[isTimeFrozen]]</li>
}}
{{New feature/item|3.0161|1.6.0|22721|
<li>[[isVolumetricShadowsEnabled]]</li>
}}
<li>[[isWorldSoundEnabled]]</li>
{{New feature/item|3.0161|1.6.0|22219|
<li>[[processLineAgainstMesh]]</li>
}}
<li>[[processLineOfSight]]</li>
<li>[[resetAmbientSounds]]</li>
<li>[[resetBlurLevel]]</li>
<li>[[resetColorFilter]]</li>
<li>[[resetCoronaReflectionsEnabled]]</li>
<li>[[resetNearClipDistance]]</li>
<li>[[resetPedsLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22676|
<li>[[resetTimeFrozen]]</li>
}}
{{New feature/item|3.0161|1.6.0|22721|
<li>[[resetVolumetricShadows]]</li>
}}
<li>[[resetVehiclesLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[resetWorldProperty]]</li>
}}
<li>[[resetWorldSounds]]</li>
<li>[[setAmbientSoundEnabled]]</li>
<li>[[setBirdsEnabled]]</li>
<li>[[setColorFilter]]</li>
<li>[[setCoronaReflectionsEnabled]]</li>
<li>[[setInteriorFurnitureEnabled]]</li>
<li>[[setInteriorSoundsEnabled]]</li>
<li>[[setNearClipDistance]]</li>
<li>[[setPedsLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22676|
<li>[[setTimeFrozen]]</li>
}}
<li>[[setVehiclesLODDistance]]</li>
{{New feature/item|3.0161|1.6.0|22592|
<li>[[setWorldProperty]]</li>
}}
<li>[[setWorldSoundEnabled]]</li>
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainLevel]]</li>
}}
{{New feature/item|3.0161|1.6.0|21902|
<li>[[setGrainMultiplier]]</li>
}}
<li>[[testLineAgainstWater]]</li>
{{New feature/item|3.0161|1.6.0|22721|
<li>[[setVolumetricShadowsEnabled]]</li>
}}
{{New items|3.0161|1.6.0|
<li>[[testSphereAgainstWorld]]</li>
|22837}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[getJetpackWeaponEnabled]]</li>
<li>[[setJetpackWeaponEnabled]]</li>
}}
}}
</br>
}}

<li>[[areTrafficLightsLocked]]</li>
<li>[[getAircraftMaxHeight]]</li>
<li>[[getAircraftMaxVelocity]]</li>
<li>[[getCloudsEnabled]]</li>
<li>[[getFarClipDistance]]</li>
<li>[[getFogDistance]]</li>
<li>[[getGameSpeed]]</li>
<li>[[getGravity]]</li>
<li>[[getHeatHaze]]</li>
<li>[[getInteriorSoundsEnabled]]</li>
<li>[[getJetpackMaxHeight]]</li>
<li>[[getMinuteDuration]]</li>
<li>[[getMoonSize]]</li>
<li>[[getOcclusionsEnabled]]</li>
<li>[[getRainLevel]]</li>
<li>[[getSunColor]]</li>
<li>[[getSunSize]]</li>
<li>[[getTime]]</li>
<li>[[getTrafficLightState]]</li>
<li>[[getWeather]]</li>
<li>[[getWindVelocity]]</li>
<li>[[getSkyGradient]]</li>
{{New items|3.0161|1.6.0|
<li>[[isWorldSpecialPropertyEnabled]]</li>
|22195}}
<li>[[getZoneName]]</li>
<li>[[isGarageOpen]]</li>
<li>[[removeWorldModel]]</li>
<li>[[resetFarClipDistance]]</li>
<li>[[resetFogDistance]]</li>
<li>[[resetHeatHaze]]</li>
<li>[[resetMoonSize]]</li>
<li>[[resetRainLevel]]</li>
<li>[[resetSkyGradient]]</li>
<li>[[resetSunColor]]</li>
<li>[[resetSunSize]]</li>
<li>[[resetWindVelocity]]</li>
<li>[[restoreAllWorldModels]]</li>
<li>[[restoreWorldModel]]</li>
<li>[[setAircraftMaxHeight]]</li>
<li>[[setAircraftMaxVelocity]]</li>
<li>[[setCloudsEnabled]]</li>
<li>[[setFarClipDistance]]</li>
<li>[[setFogDistance]]</li>
<li>[[setGameSpeed]]</li>
<li>[[setGarageOpen]]</li>
<li>[[setGravity]]</li>
<li>[[setHeatHaze]]</li>
<li>[[setInteriorSoundsEnabled]]</li>
<li>[[setMinuteDuration]]</li>
<li>[[setMoonSize]]</li>
<li>[[setOcclusionsEnabled]]</li>
<li>[[setRainLevel]]</li>
<li>[[setSkyGradient]]</li>
<li>[[setSunColor]]</li>
<li>[[setSunSize]]</li>
<li>[[setTime]]</li>
<li>[[setTrafficLightState]]</li>
<li>[[setTrafficLightsLocked]]</li>
<li>[[setWeather]]</li>
<li>[[setWeatherBlended]]</li>
<li>[[setWindVelocity]]</li>
<li>[[setJetpackMaxHeight]]</li>
{{New items|3.0161|1.6.0|
<li>[[setWorldSpecialPropertyEnabled]]</li>
|22195}}
{{New items|3.0161|1.6.0|
<li>[[resetWorldProperties]]</li>
|22741}}
{{New items|3.0161|1.6.0|
<li>[[removeGameWorld]]</li>
<li>[[restoreGameWorld]]</li>
|22909}}
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Team functions

2025-11-10T14:54:14Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[createTeam]]</li>
<li>[[setTeamColor]]</li>
<li>[[setTeamFriendlyFire]]</li>
<li>[[setTeamName]]</li>
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[getTeamColor]]</li>
<li>[[getTeamFriendlyFire]]</li>
<li>[[getTeamFromName]]</li>
<li>[[getTeamName]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Player functions

2025-11-10T14:54:00Z

Fernando187: Undo revision 82593 by Fernando187 (talk)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[getLocalPlayer]]</li>
<li>[[getPlayerMapBoundingBox]]</li>
<li>[[getPlayerMapOpacity]]</li>
{{New items|3.0161|1.6.0|
<li>[[getPlayerHudComponentProperty]]</li>
|22868}}
<li>[[isPlayerMapVisible]]</li>
<li>[[isPlayerHudComponentVisible]]</li>
{{New items|3.0161|1.6.0|
<li>[[isPlayerCrosshairVisible]]</li>
|22751}}
<li>[[resetBlurLevel]]</li>
{{New items|3.0161|1.6.0|
<li>[[resetPlayerHudComponentProperty]]</li>
|22868}}
{{New items|3.0161|1.6.0|
<li>[[setPlayerHudComponentProperty]]</li>
|22868}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[getAlivePlayers]]</li>
<li>[[getDeadPlayers]]</li>
<li>[[getPlayerAnnounceValue]]</li>
<li>[[getPlayerCount]]</li>
<li>[[getPlayerIdleTime]]</li>
<li>[[getPlayerIP]]</li>
<li>[[getPlayerVersion]]</li>
<li>[[getRandomPlayer]]</li>
<li>[[isPlayerMuted]]</li>
<li>[[redirectPlayer]]</li>
<li>[[resendPlayerACInfo]]</li>
<li>[[resendPlayerModInfo]]</li>
<li>[[setPlayerAnnounceValue]]</li>
<li>[[setPlayerMuted]]</li>
<li>[[setPlayerScriptDebugLevel]]</li>
<li>[[setPlayerTeam]]</li>
<li>[[setPlayerName]]</li>
<li>[[setPlayerVoiceBroadcastTo]]</li>
<li>[[setPlayerVoiceIgnoreFrom]]</li>
<li>[[setPlayerWantedLevel]]</li>
<li>[[spawnPlayer]]</li>
<li>[[takePlayerScreenShot]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[getPlayerTeam]]</li>
<li>[[getPlayerBlurLevel]]</li>
<li>[[setPlayerBlurLevel]]</li>
<li>[[getPlayerSerial]]</li>
<li>[[forcePlayerMap]]</li>
<li>[[getPlayerScriptDebugLevel]]</li>
<li>[[getPlayerFromName]]</li>
<li>[[getPlayerMoney]]</li>
<li>[[getPlayerName]]</li>
<li>[[getPlayerNametagColor]]</li>
<li>[[getPlayerNametagText]]</li>
<li>[[getPlayerPing]]</li>
<li>[[getPlayerWantedLevel]]</li>
<li>[[givePlayerMoney]]</li>
<li>[[isPlayerMapForced]]</li>
<li>[[isPlayerNametagShowing]]</li>
<li>[[setPlayerHudComponentVisible]]</li>
<li>[[setPlayerMoney]]</li>
<li>[[setPlayerNametagColor]]</li>
<li>[[setPlayerNametagShowing]]</li>
<li>[[setPlayerNametagText]]</li>
<li>[[takePlayerMoney]]</li>
<li>[[countPlayersInTeam]]</li>
<li>[[getPlayersInTeam]]</li>
<li>[[isVoiceEnabled]]</li>
<li>[[setControlState]]</li>
<li>[[getControlState]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Player functions

2025-11-10T14:53:08Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[getLocalPlayer]]</li>
<li>[[getPlayerMapBoundingBox]]</li>
<li>[[getPlayerMapOpacity]]</li>
{{New items|3.0161|1.6.0|
<li>[[getPlayerHudComponentProperty]]</li>
|22868}}
<li>[[isPlayerMapVisible]]</li>
<li>[[isPlayerHudComponentVisible]]</li>
{{New items|3.0161|1.6.0|
<li>[[isPlayerCrosshairVisible]]</li>
|22751}}
<li>[[resetBlurLevel]]</li>
{{New items|3.0161|1.6.0|
<li>[[resetPlayerHudComponentProperty]]</li>
|22868}}
{{New items|3.0161|1.6.0|
<li>[[setPlayerHudComponentProperty]]</li>
|22868}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[getAlivePlayers]]</li>
<li>[[getDeadPlayers]]</li>
<li>[[getPlayerAnnounceValue]]</li>
<li>[[getPlayerCount]]</li>
<li>[[getPlayerIdleTime]]</li>
<li>[[getPlayerIP]]</li>
<li>[[getPlayerVersion]]</li>
<li>[[getRandomPlayer]]</li>
<li>[[isPlayerMuted]]</li>
<li>[[redirectPlayer]]</li>
<li>[[resendPlayerACInfo]]</li>
<li>[[resendPlayerModInfo]]</li>
<li>[[setPlayerAnnounceValue]]</li>
<li>[[setPlayerMuted]]</li>
<li>[[setPlayerScriptDebugLevel]]</li>
<li>[[setPlayerTeam]]</li>
<li>[[setPlayerName]]</li>
<li>[[setPlayerVoiceBroadcastTo]]</li>
<li>[[setPlayerVoiceIgnoreFrom]]</li>
<li>[[setPlayerWantedLevel]]</li>
<li>[[spawnPlayer]]</li>
<li>[[takePlayerScreenShot]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[getPlayerTeam]]</li>
<li>[[getPlayerBlurLevel]]</li>
<li>[[setPlayerBlurLevel]]</li>
<li>[[getPlayerSerial]]</li>
<li>[[forcePlayerMap]]</li>
<li>[[getPlayerScriptDebugLevel]]</li>
<li>[[getPlayerFromName]]</li>
<li>[[getPlayerMoney]]</li>
<li>[[getPlayerName]]</li>
<li>[[getPlayerNametagColor]]</li>
<li>[[getPlayerNametagText]]</li>
<li>[[getPlayerPing]]</li>
<li>[[getPlayerWantedLevel]]</li>
<li>[[givePlayerMoney]]</li>
<li>[[isPlayerMapForced]]</li>
<li>[[isPlayerNametagShowing]]</li>
<li>[[setPlayerHudComponentVisible]]</li>
<li>[[setPlayerMoney]]</li>
<li>[[setPlayerNametagColor]]</li>
<li>[[setPlayerNametagShowing]]</li>
<li>[[setPlayerNametagText]]</li>
<li>[[takePlayerMoney]]</li>
<li>[[getPlayersInTeam]]</li>
<li>[[isVoiceEnabled]]</li>
<li>[[setControlState]]</li>
<li>[[getControlState]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Element functions

2025-11-10T14:52:41Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[getElementBoneMatrix]]</li>
<li>[[getElementBonePosition]]</li>
<li>[[getElementBoneRotation]]</li>
{{New feature/item|3.0161|1.6.0|22741|<li>[[getElementBoneQuaternion]]</li>}}
<li>[[getElementBoundingBox]]</li>
<li>[[getElementDistanceFromCentreOfMassToBaseOfModel]]</li>
<li>[[getElementLighting]]</li>
<li>[[getElementRadius]]</li>
<li>[[isElementCollidableWith]]</li>
<li>[[isElementLocal]]</li>
{{New items|3.0161|1.6.0|
<li>[[setElementLighting]]</li>
|22862}}
<li>[[isElementOnScreen]]</li>
<li>[[isElementStreamable]]</li>
<li>[[isElementStreamedIn]]</li>
<li>[[isElementSyncer]]</li>
<li>[[isElementWaitingForGroundToLoad]]</li>
<li>[[setElementBoneMatrix]]</li>
<li>[[setElementBonePosition]]</li>
<li>[[setElementBoneRotation]]</li>
{{New feature/item|3.0161|1.6.0|22741|<li>[[setElementBoneQuaternion]]</li>}}
<li>[[setElementCollidableWith]]</li>
<li>[[setElementStreamable]]</li>
<li>[[updateElementRpHAnim]]</li>
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[addElementDataSubscriber]]</li>
<li>[[clearElementVisibleTo]]</li>
<li>[[cloneElement]]</li>
<li>[[getElementSyncer]]</li>
<li>[[getElementZoneName]]</li>
<li>[[hasElementDataSubscriber]]</li>
<li>[[isElementVisibleTo]]</li>
<li>[[removeElementData]]</li>
<li>[[removeElementDataSubscriber]]</li>
<li>[[setElementSyncer]]</li>
<li>[[setElementVisibleTo]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[attachElements]]</li>
<li>[[createElement]]</li>
<li>[[destroyElement]]</li>
<li>[[detachElements]]</li>
<li>[[getAttachedElements]]</li>
<li>[[getElementAlpha]]</li>
<li>[[getElementAttachedOffsets]]</li>
<li>[[getElementAttachedTo]]</li>
<li>[[getElementByIndex]]</li>
<li>[[getElementByID]]</li>
<li>[[getElementChild]]</li>
<li>[[getElementChildren]]</li>
<li>[[getElementChildrenCount]]</li>
<li>[[getElementCollisionsEnabled]]</li>
<li>[[getElementColShape]]</li>
<li>[[getElementData]]</li>
<li>[[getAllElementData]]</li>
<li>[[hasElementData]]</li>
<li>[[getElementDimension]]</li>
<li>[[getElementHealth]]</li>
<li>[[getElementID]]</li>
<li>[[getElementInterior]]</li>
<li>[[getElementMatrix]]</li>
<li>[[getElementModel]]</li>
<li>[[getElementParent]]</li>
<li>[[getElementPosition]]</li>
<li>[[getElementRotation]]</li>
<li>[[getElementsByType]]</li>
<li>[[getElementsWithinColShape]]</li>
<li>[[getElementsWithinRange]]</li>
<li>[[getElementType]]</li>
<li>[[getElementVelocity]]</li>
<li>[[getLowLODElement]]</li>
<li>[[getRootElement]]</li>
<li>[[isElement]]</li>
<li>[[isElementAttached]]</li>
<li>[[isElementCallPropagationEnabled]]</li>
<li>[[isElementDoubleSided]]</li>
<li>[[isElementFrozen]]</li>
<li>[[isElementInWater]]</li>
<li>[[isElementLowLOD]]</li>
{{New items|3.0161|1.6.0|
<li>[[isElementOnFire]]</li>
|22864}}
<li>[[isElementWithinColShape]]</li>
<li>[[isElementWithinMarker]]</li>
<li>[[setElementAlpha]]</li>
<li>[[setElementAngularVelocity]]</li>
<li>[[getElementAngularVelocity]]</li>
<li>[[setElementAttachedOffsets]]</li>
<li>[[setElementCallPropagationEnabled]]</li>
<li>[[setElementCollisionsEnabled]]</li>
<li>[[setElementData]]</li>
<li>[[setElementDimension]]</li>
<li>[[setElementDoubleSided]]</li>
<li>[[setElementFrozen]]</li>
<li>[[setElementHealth]]</li>
<li>[[setElementID]]</li>
<li>[[setElementInterior]]</li>
<li>[[setElementModel]]</li>
{{New items|3.0161|1.6.0|
<li>[[setElementOnFire]]</li>
|22864}}
<li>[[setElementParent]]</li>
<li>[[setElementPosition]]</li>
<li>[[setElementRotation]]</li>
<li>[[setElementVelocity]]</li>
<li>[[setLowLODElement]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Weapon functions

2025-11-10T14:49:50Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

{{New items|3.0161|1.6.0|
<li>[[setWeaponRenderEnabled]]</li>
<li>[[isWeaponRenderEnabled]]</li>
|22880}}
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[giveWeapon]]</li>
<li>[[takeAllWeapons]]</li>
<li>[[takeWeapon]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[getWeaponProperty]]</li>
<li>[[getOriginalWeaponProperty]]</li>
<li>[[getSlotFromWeapon]]</li>
<li>[[getWeaponIDFromName]]</li>
<li>[[getWeaponNameFromID]]</li>
<li>[[setWeaponAmmo]]</li>
<li>[[setWeaponProperty]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Marker functions

2025-11-10T14:49:30Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[isCoronaReflectionEnabled]]</li>
<li>[[setCoronaReflectionEnabled]]</li>
| {{#ifeq: {{lc:{{{1}}}}} | server
|

}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[createMarker]]</li>
<li>[[getMarkerColor]]</li>
<li>[[getMarkerCount]]</li>
<li>[[getMarkerIcon]]</li>
<li>[[getMarkerSize]]</li>
<li>[[getMarkerTarget]]</li>
{{New items|3.161|1.6.0|
<li>[[getMarkerTargetArrowProperties]]</li>
|22620}}
<li>[[getMarkerType]]</li>
<li>[[setMarkerColor]]</li>
<li>[[setMarkerIcon]]</li>
<li>[[setMarkerSize]]</li>
<li>[[setMarkerTarget]]</li>
{{New items|3.161|1.6.0|
<li>[[setMarkerTargetArrowProperties]]</li>
|22620}}
<li>[[setMarkerType]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

Template:Collision shape functions

2025-11-10T14:45:54Z

Fernando187:

<ul>
<li>[[addColPolygonPoint]]</li>
<li>[[createColCircle]]</li>
<li>[[createColCuboid]]</li>
<li>[[createColPolygon]]</li>
<li>[[createColRectangle]]</li>
<li>[[createColSphere]]</li>
<li>[[createColTube]]</li>
<li>[[getColPolygonHeight]]</li>
<li>[[getColPolygonPoints]]</li>
<li>[[getColPolygonPointPosition]]</li>
<li>[[getColShapeType]]</li>
<li>[[getColShapeRadius]]</li>
<li>[[getColShapeSize]]</li>
<li>[[isInsideColShape]]</li>
<li>[[removeColPolygonPoint]]</li>
<li>[[setColPolygonHeight]]</li>
<li>[[setColPolygonPointPosition]]</li>
<li>[[setColShapeRadius]]</li>
<li>[[setColShapeSize]]</li>
</ul>

<noinclude>[[Category:Functions templates]]</noinclude>

Template:Clothes and body functions

2025-11-10T14:44:03Z

Fernando187: Fix function in wrong category (wiki cleaning)

<ul>
<li>[[getBodyPartName]]</li>
<li>[[getClothesByTypeIndex]]</li>
<li>[[getClothesTypeName]]</li>
<li>[[getTypeIndexFromClothes]]</li>
<li>[[removePedClothes]]</li>
{{Added feature/item|1.6.1|1.6.0|23124|
<li>[[addClothingModel]]</li>
}}
</ul>

<noinclude>[[Category:Functions templates]]</noinclude>

Template:Element functions

2025-11-10T14:42:48Z

Fernando187: Fix function in wrong category (wiki cleaning)

<includeonly>
<ul>
{{#if: {{{1|}}}
| {{#ifeq: {{lc:{{{1}}}}} | client
|

<li>[[getElementBoneMatrix]]</li>
<li>[[getElementBonePosition]]</li>
<li>[[getElementBoneRotation]]</li>
{{New feature/item|3.0161|1.6.0|22741|<li>[[getElementBoneQuaternion]]</li>}}
<li>[[getElementBoundingBox]]</li>
<li>[[getElementDistanceFromCentreOfMassToBaseOfModel]]</li>
<li>[[getElementLighting]]</li>
<li>[[getElementRadius]]</li>
<li>[[isElementCollidableWith]]</li>
<li>[[isElementLocal]]</li>
{{New items|3.0161|1.6.0|
<li>[[setElementLighting]]</li>
|22862}}
<li>[[isElementOnScreen]]</li>
<li>[[isElementStreamable]]</li>
<li>[[isElementStreamedIn]]</li>
<li>[[isElementSyncer]]</li>
<li>[[isElementWaitingForGroundToLoad]]</li>
<li>[[setElementBoneMatrix]]</li>
<li>[[setElementBonePosition]]</li>
<li>[[setElementBoneRotation]]</li>
{{New feature/item|3.0161|1.6.0|22741|<li>[[setElementBoneQuaternion]]</li>}}
<li>[[setElementCollidableWith]]</li>
<li>[[setElementStreamable]]</li>
<li>[[updateElementRpHAnim]]</li>
| {{#ifeq: {{lc:{{{1}}}}} | server
|

<li>[[addElementDataSubscriber]]</li>
<li>[[clearElementVisibleTo]]</li>
<li>[[cloneElement]]</li>
<li>[[getElementSyncer]]</li>
<li>[[getElementZoneName]]</li>
<li>[[hasElementDataSubscriber]]</li>
<li>[[isElementVisibleTo]]</li>
<li>[[removeElementData]]</li>
<li>[[removeElementDataSubscriber]]</li>
<li>[[setElementSyncer]]</li>
<li>[[setElementVisibleTo]]</li>
}}
}}
</br>
<li style="list-style: none; margin-left: -1.6em;">'''Shared'''</li>
}}


<li>[[attachElements]]</li>
<li>[[createElement]]</li>
<li>[[destroyElement]]</li>
<li>[[detachElements]]</li>
<li>[[getAttachedElements]]</li>
<li>[[getElementAlpha]]</li>
<li>[[getElementAttachedOffsets]]</li>
<li>[[getElementAttachedTo]]</li>
<li>[[getElementByIndex]]</li>
<li>[[getElementByID]]</li>
<li>[[getElementChild]]</li>
<li>[[getElementChildren]]</li>
<li>[[getElementChildrenCount]]</li>
<li>[[getElementCollisionsEnabled]]</li>
<li>[[getElementColShape]]</li>
<li>[[getElementData]]</li>
<li>[[getAllElementData]]</li>
<li>[[hasElementData]]</li>
<li>[[getElementDimension]]</li>
<li>[[getElementHealth]]</li>
<li>[[getElementID]]</li>
<li>[[getElementInterior]]</li>
<li>[[getElementMatrix]]</li>
<li>[[getElementModel]]</li>
<li>[[getElementParent]]</li>
<li>[[getElementPosition]]</li>
<li>[[getElementRotation]]</li>
<li>[[getElementsByType]]</li>
<li>[[getElementsWithinColShape]]</li>
<li>[[getElementsWithinRange]]</li>
<li>[[getElementType]]</li>
<li>[[getElementVelocity]]</li>
<li>[[getLowLODElement]]</li>
<li>[[getRootElement]]</li>
<li>[[isElement]]</li>
<li>[[isElementAttached]]</li>
<li>[[isElementCallPropagationEnabled]]</li>
<li>[[isElementDoubleSided]]</li>
<li>[[isElementFrozen]]</li>
<li>[[isElementInWater]]</li>
<li>[[isElementLowLOD]]</li>
{{New items|3.0161|1.6.0|
<li>[[isElementOnFire]]</li>
|22864}}
<li>[[isElementWithinColShape]]</li>
<li>[[isElementWithinMarker]]</li>
<li>[[setElementAlpha]]</li>
<li>[[setElementAngularVelocity]]</li>
<li>[[getElementAngularVelocity]]</li>
<li>[[setElementAttachedOffsets]]</li>
<li>[[setElementCallPropagationEnabled]]</li>
<li>[[setElementCollisionsEnabled]]</li>
<li>[[setElementData]]</li>
<li>[[setElementDimension]]</li>
<li>[[setElementDoubleSided]]</li>
<li>[[setElementFrozen]]</li>
<li>[[setElementHealth]]</li>
<li>[[setElementID]]</li>
<li>[[setElementInterior]]</li>
<li>[[setElementModel]]</li>
{{New items|3.0161|1.6.0|
<li>[[setElementOnFire]]</li>
|22864}}
<li>[[setElementParent]]</li>
<li>[[setElementPosition]]</li>
<li>[[setElementRotation]]</li>
<li>[[setElementVelocity]]</li>
<li>[[setLowLODElement]]</li>
<li>[[getResourceDynamicElementRoot]]</li>
<li>[[getResourceRootElement]]</li>
</ul>
</includeonly>

<noinclude>
{{Functions list info}}
[[Category:Functions templates]]</noinclude>

DxDrawModel3D

2025-11-10T10:13:05Z

Fernando187: /* Example */

__NOTOC__
{{Client function}}
{{Important Note|You can not use this function to draw vehicles and ped}}
{{Important Note|This function doesn't obey any streaming limits, you can draw as many models as you want}}
{{Important Note|You can not render model to render target.}}
{{New feature/item|3.0161|1.6.0|22708|
This function draws a 3D model - rendered for '''one''' frame. Drawn models are indistinguishable from this one created by [[createObject]] function. This should be used in conjunction with [[onClientRender]] or [[onClientPreRender]] in order to display continuously. Note that a model must be loaded at the time this function is called. A model can be loaded and unloaded with the help of [[engineStreamingRequestModel]] and [[engineStreamingReleaseModel]] functions.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawModel3D( int modelId, float positionX, float positionY, float positionZ, float rotationX, float rotationY, float rotationZ [, float scaleX = 1, float scaleY = 1, float scaleZ = 1, float lighting = 0 ])
</syntaxhighlight>

[[Image:DxDrawModel3D_at_day.png|thumb|Model during day]]
[[Image:DxDrawModel3D_at_night.png|thumb|Model during night]]

===Required Arguments===
* '''modelId:''' [[object]] you want to draw, must be regular object, you can not draw vehicles and peds. See [[Object_IDs|Object IDs]] for a list of model IDs.
*'''positionX:''' A floating point number representing the X coordinate on the map.
*'''positionY:''' A floating point number representing the Y coordinate on the map.
*'''positionZ:''' A floating point number representing the Z coordinate on the map.
*'''rotationX:''' A floating point number representing the rotation about the X axis in degrees.
*'''rotationY:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rotationZ:''' A floating point number representing the rotation about the Z axis in degrees.

===Optional Arguments===
*'''scaleX''': a float containing the new scale on the X axis
*'''scaleY''': a float containing the new scale on the Y axis
*'''scaleZ''': a float containing the new scale on the Z axis

{{New feature/item|3.0161|1.6.0|22862|
*'''lighting:''' Lighting of model. Allowed range is [0, 1].
}}

===Returns===
Returns true if the operation was successful, false otherwise.

==Example==
<section name="Simple example" class="client" show="true">
This example draws a model
<syntaxhighlight lang="lua">
local modelId = 1337

local function drawMyModel()
dxDrawModel3D(modelId, 0, 0, 4, 0, 0, 0)
end

local function startDraw()
engineStreamingRequestModel(modelId, true, true)
addEventHandler("onClientPreRender", root, drawMyModel)
end

local function stopDraw()
engineStreamingReleaseModel(modelId, true)
removeEventHandler("onClientPreRender", root, drawMyModel)
end
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

Client on Linux Manual

2025-09-16T12:36:00Z

Fernando187: other methods

{{Needs Checking|MTA:SA support on Linux is on a best-effort basis, and you can run into a long list of issues. Also see "Known issues" paragraph}}
{{Warning|This page is for Linux players '''ONLY''', for Windows go [[Client Manual|here]].|true}}

==Other Methods==
These are related Client on Linux methods for other setups:

===Lutris===

Lutris can be used instead for easier Prefix management, see
[[Client on Linux using Lutris Manual]]

===Bottles/Soda===

Bottles can also be used in conjunction with the Soda runner, see
[[Client on Linux using Bottles/Soda Manual]]

===Steam Deck===
Steam Deck mobile device can also be used to play MTA, see
[[Client on Steam Deck Manual]]

==Before you start==

First of all, please ensure your computer fits the requirements needed.
Read the [[Client_Manual|Client Manual]] page for further informations, or join us on [https://mtasa.com/discord Discord].

It is recommended to use '''32-bit Wine prefix'''. But if you do not want to install 32-bit libs, or your distro ships with enforced WoW64 Wine mode, use 64-bit Wine prefix instead, although 64-bit Wine prefix introduces some instability, bugs and potential performance issues, but it's still very playable.

===Requirements===
The hardware requirements for Multi Theft Auto: San Andreas are the same as on Windows.
For software requirements, you need:
* Wine (get it on your package manager (synaptic, apt, pacman, yum, etc.); follow instructions [https://www.winehq.org/download/ubuntu here] if you're using Ubuntu; (Install Wine Staging if you want better audio quality (experimental))
* Winetricks (same as wine, get it on your package manager, or follow instructions [https://wiki.winehq.org/Winetricks here])
* '''(for 32-bit wine bottle only)''' 32-bit GPU mesa drivers for your GPU (for arch, use package lib32-mesa)
* '''(for 32-bit wine bottle only)''' 32-bit Audio drivers (for arch, follow instructions [https://wiki.archlinux.org/title/wine#Sound here]
* TLS libraries (for arch, use packages gnutls and '''(lib32-gnutls for 32-bit wine bottle only)''')
* MTA:SA version 1.6 or newer (1.6 contains many improvements for Wine)
* Windows fonts:
** tahoma.ttf
** tahomabd.ttf
** verdana.ttf

You can download them from following places:
* Get them on the Internet, e.g. [http://fontonic.com/ fontonic.com]
* Get the zip archive with the 3 fonts {{WineFonts}}.
* Get them via your package manager (apt, pacman (ttf-tahoma and ttf-ms-fonts from AUR))

==Create new prefix==

Firstly, we need to create a new prefix:

# Start Winetricks
# Select '''Create new prefix'''
# If you can, select '''32-bit prefix'''. If you did not installed 32-bit libraries, or you have enforced WoW64, create '''64-bit prefix'''.
# Write name of prefix, we will use '''mtasa'''

==Installing the game==
(You can skip this if you installed the game via Steam or other supported Games Store)
Install the game from DVD or ISO into our prefix, by executing following command:
<syntaxhighlight lang="bash">
WINEPREFIX=~/.local/share/wineprefixes/mtasa wine /mnt/setup.exe
</syntaxhighlight>
(Replace /mnt/setup.exe with path to installer's setup.exe)

Complete the installation as usual, you can keep installation path as is.<br/>
Afterwards, download the MTA installer from [http://www.mtasa.com mtasa.com], and execute it inside our prefix with following command:
<syntaxhighlight lang="bash">
WINEPREFIX=~/.local/share/wineprefixes/mtasa wine ~/Downloads/mtasa-1.6.exe
</syntaxhighlight>
(As previously, change path to the installer)<br/>
Keep the options as is, only change is required if installation path of GTA is different from default, in that case, browse the path to the game.

==Configuring prefix==

Firstly, we need to assure that our prefix have required fonts, mentioned in Requirements part. If you installed those fonts via package manager or into your Linux system, Wine should be able to pick them up automatically.<br/>
If that doesn't work, manually install them in <syntaxhighlight lang="lua">~/.local/share/wineprefixes/mtasa/drive_c/windows/Fonts</syntaxhighlight>

If you installed Wine Staging, we can enable '''Environmental Audio Extensions (EAX)''', which is experimental feature, although I didn't encountered any issues with it.
You can enable it as follows:

# Open Winetricks
# Select '''mtasa prefix'''
# Select '''Run winecfg'''
# Go to '''Staging''' tab
# Enable Environmental Audio Extensions (EAX)

===For 64-bit prefix===

Normally for DirectX games, DirectX to OpenGL shim is used. Wine WoW64 have significant performance issues in games using OpenGL.
Because of this, it is recommended to install DXVK through WineTricks. In the past, DXVK did not worked with MTA, although, so far it works quite nicely, although it's less stable as on 32-bit bottle with internal DirectX to OpenGL shim.

# Open Winetricks
# Select '''mtasa prefix'''
# Select '''Install a Windows DLL or component'''
# Select '''dxvk'''

==Running the game==
Once installed, double-clicking on the Desktop shortcut or menu item should work. If not, try in a terminal the following command:
<syntaxhighlight lang="bash">
WINEPREFIX=~/.local/share/wineprefixes/mtasa wine ~/.local/share/wineprefixes/mtasa/drive_c/Program\ Files/MTA\ San\ Andreas\ 1.6\Multi\ Theft\ Auto.exe
</syntaxhighlight>

===Known issues===
* MTA isn't starting (even with fonts installed)
#Try to start MTA:SA in a virtual desktop
#:Go to WineConfig, choose the tab "Graphics" and select "Emulate a virtual desktop".<br>
#Try to delete your gta_sa.set file
#:which is located in the "GTA San Andreas User Files" folder, which can be found in your home directory.<br>'''(Remember to create a copy, if you're playing San Andreas in singleplayer)'''
#Try to delete your MTA config file
#:which is: "MTA San Andreas 1.6/MTA/coreconfig.xml"<br>'''(Also remember to create a copy, if you don't want to lose your edited MTA configuration)'''

* "SD #16 Error" when connecting to a server
* "No audio card detected" when launching either GTA:SA or MTA
* Using standard Full-screen mode on MTA might cause some occasional artifacts
* Enabling DXVK might not break GTA:SA, but it breaks MTA (NOTE: DXVK seems to work on latest versions of Wine, DXVK and MTA)
* Using Linux brings a higher-than-usual chance for game crashes due to various reasons (sometimes to do with resources & mods on individual servers)
* CEF crashes with some wine versions. Use [https://github.com/multitheftauto/mtasa-blue/issues/1000 workaround] for this issue
<br><br>
'''* Making the mistake of using a 64-bit prefix may ''specifically'' result in:'''
* "SD #16 Error" when connecting to a server
* "libcef.dll" MTA crash upon joining servers, or during gameplay (when server uses CEF and your CEF web browser is enabled)
* Even higher chance for instability, lag issues and game crashes
.. and much more

<br>

===Specific issues with workarounds===
<br>
'''Crash when connecting'''<br>
Sometimes the audio-server makes problems (could be related to PulseAudio), in this case, you've to go to WineConfig and choose the tab Audio, then deselect "ALSA" and select "EsoundD". Save the settings and restart MTA.<br><br>
'''Crash in basswma.dll module while streaming audio'''<br>
Workaround: Install Windows Media Player 11<br>
Before carrying this out, [https://wiki.winehq.org/Winetricks install Winetricks]
<syntaxhighlight lang="lua">
winetricks -q wmp11

If that doesnt solve the issue, try an older version:
winetricks -q wmp10
</syntaxhighlight>

'''Special Detections (SD)'''<br>
This was already described above in general terms, of possible issues if you're not using 32-bit prefix as is recommended. But for this "Specific issues" section we will go in-depth more regarding '''SD #21''' kick from AC that commonly affects Linux/Wine users:<br>
If you are using a 64-bit wine version/prefix you may have problems with [http://wiki.multitheftauto.com/wiki/Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E Special Detections]. If the server you are trying to connect keeps showing something like [http://i.imgur.com/33T8a82.jpg this], then you should make a [https://wiki.archlinux.org/title/Wine#WINEARCH 32 bit wine prefix] (or bottle).

<syntaxhighlight lang="lua">export WINEARCH=win32 WINEPREFIX=~/.winegta
winecfg</syntaxhighlight>
Look at your Windows version and press OK to create the prefix. Now you have a 32-bit wine prefix on ~/.winegta.
Install GTA:SA and them MTA.
After this, MTA and GTA have been installed within ~/.winegta prefix which is a 32-bit wine environment.

'''Note''': In some scenario's, while creating your 32-bit prefix, it may be needed to change Windows version on the bottom to Windows 7. But avoid it whenever possible.
<br><br>
'''Font Artifacts'''<br>
If you see weird fonts artifacts [https://media.discordapp.net/attachments/278521065435824128/1000827089022373978/unknown.png like this] then you need to add a new DLL override to your prefix/bottle. <br>
#Open '''Wine configuration''' for your prefix/bottle, go to the Libraries tab
#Click on the ''''New override for library''':' dropdown and select ''''d3dx9_42''''
#Click on ''''Edit...'''' and select ''''Builtin (Wine)'''' then 'OK'
Apply all the changes and you're good to go.<br>
(Make sure you have ''''d3dx9_42'''' installed in your prefix)
<syntaxhighlight> winetricks d3dx9_42</syntaxhighlight><br/>
(NOTE: This does not work anymore, MTA stops due integrity check failure.)
<br><br>

'''Closing words'''<br>
To avoid many of the roadblocks when it comes to Linux/Wine issues in general, just use 32-bit Prefix as suggested. However, if you still run into issues, you can inform yourself better about MTA's Linux/Mac support levels and background by joining the [https://discord.gg/mtasa MTA discord] and going to #help-support channel, to specifically read information at this pinned message: https://discord.com/channels/278474088903606273/278521065435824128/894932698269900830
<br>

We realize that the wiki pages & documentation regarding Linux, macOS support (such as: through Wine, Lutris, PlayOnLinux, Parallels Desktop etc) is far from perfect, and that the list of potential issues you can run into isn't complete. As the MTA discord linked post tries to explain, these platforms are supported on a best-effort basis (in a technical sense, not an user support sense) and even then you'll find others on the MTA discord that are Linux users & play MTA after performing some workarounds, that may be willing to help you. These people are also advised to add any known issue (and workaround for it) to the wiki documentations, so if that sounds like you then feel free to edit this page for instance, and help future users that find themselves in the same situation as you were. Linux/Wine just gives really obscure, hard to fix issues with MTA and other applications/games, including niche ones that individual users happen to resolve somehow.. that's the point.

== See Also ==
* [http://nightly.mtasa.com/ nightly.mtasa.com] - For nightly builds.
* https://bugs.mtasa.com/view.php?id=8895 - a bug report containing useful info for running MTA in Wine
[[Category:Support]]
[[ru:Client on Linux Manual]]
[[hu:Client on Linux Manual]]

TakePlayerScreenShot

2025-06-08T13:51:43Z

Fernando187: /* Example */

__NOTOC__
{{Server function}}
This function forces a client to capture the current screen output and send it back to the server. The image will contain the GTA HUD and the output of any dxDraw functions that are not flagged as 'post GUI'. The image specifically excludes the chat box and all GUI (including the client console). The result is received with the event [[onPlayerScreenShot]].

==Syntax==
<syntaxhighlight lang="lua">
bool takePlayerScreenShot ( player thePlayer, int width, int height [, string tag = "", int quality = 30, int maxBandwidth = 5000, int maxPacketSize = 500 ] )
</syntaxhighlight>
{{OOP||[[player]]:takeScreenShot||}}
===Required Arguments===
*'''thePlayer:''' the player to get the screen capture from.
*'''width:''' the width of the capture image.
*'''height:''' the height of the capture image.

===Optional Arguments===
*'''tag:''' A string to help identify the screen capture. The string is passed to the matching [[onPlayerScreenShot]] event for your personal convenience.
*'''quality:''' Quality of the final JPEG image from 0 to 100. A lower value can reduce the memory used by the image considerably which will result in faster and less intrusive uploads.
*'''maxBandwidth:''' The amount of client upload bandwidth to use (in bytes per second) when sending the image.
*'''maxPacketSize: ''' The maximum size of one packet.

===Returns===
Returns ''true'' if the function was successfully, ''false'' if invalid arguments are specified.

==Examples==
This example will take a player screenshot whenever a player takes a picture with the camera weapon and then send the picture to all clients, which will render the latest screenshot in the bottom right corner of their screen.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local screenSizeX,screenSizeY = guiGetScreenSize() -- save the current screen dimensions
local imgtexture
local takenBy

function wepFire(weapon)
if weapon == 43 then -- if the weapon the player just fired is the camera
triggerServerEvent("onPlayerTakesPhoto",localPlayer)
end
end
addEventHandler("onClientPlayerWeaponFire",localPlayer,wepFire)

function updateLatestPhoto(img)
if imgtexture then -- clean up the old dxTextrue if there is one
destroyElement(imgtexture)
end
imgtexture = dxCreateTexture(img) -- create a new dxTexture from the image data so that we can render it using dxDrawImage
takenBy = "taken by "..getPlayerName(source) -- let's also credit the photographer
end
addEvent("updatePhoto",true)
addEventHandler("updatePhoto",root,updateLatestPhoto)

function renderPhoto()
if imgtexture then
local sizeX, sizeY = 320, 240
dxDrawImage(screenSizeX-sizeX,screenSizeY-sizeY,sizeX,sizeY,imgtexture) -- render the picture as well as the name of the photographer in the bottom right corner of the screen
dxDrawText(takenBy,screenSizeX-sizeX,screenSizeY-sizeY,screenSizeX,screenSizeY,tocolor(0,0,0))
end
end
addEventHandler("onClientRender",root,renderPhoto)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function requestScreenshot()
takePlayerScreenShot(client,320,240,"cameraphoto",50) -- the player just took a picture with the camera, let's request a screenshot to see what they took a photo of
end
addEvent("onPlayerTakesPhoto",true)
addEventHandler("onPlayerTakesPhoto",root,requestScreenshot)

function incomingPlayerScreenshot(res,status,img,timestamp,tag)
if status == "ok" and tag == "cameraphoto" then -- make sure a picture was taken successfully and that we're the ones who requested this screenshot
triggerClientEvent("updatePhoto",source,img) -- trigger a client event to share the image with everyone on the server
end
end
addEventHandler("onPlayerScreenShot",root,incomingPlayerScreenshot)
</syntaxhighlight>
</section>

==See Also==
{{Player functions|server}}

TriggerClientEvent

2025-06-08T13:50:51Z

Fernando187: /* Examples */

__NOTOC__
{{Server function}}
This function triggers an event previously registered on a client. This is the primary means of passing information between the server and the client. Clients have a similar [[triggerServerEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerServerEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[element]]s and complex nested [[table]]s. Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.

Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. '''It is marginally more efficient to pass one large event than two smaller ones'''.
{{Important Note | Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.}}
{{Note|It is marginally more efficient to pass one large event than two smaller ones.}}

==Syntax==
<syntaxhighlight lang="lua">
bool triggerClientEvent ( [ table/element sendTo = getRootElement(), ] string name, element sourceElement [, arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''sourceElement:''' The element that is the [[Event system#Event handlers|source]] of the event.
{{Important Note|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}

===Optional Arguments===
{{OptionalArg}}
*'''sendTo:''' The event will be sent to all [[player]]s that are children of the specified element. By default this is the root element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Examples==
This example shows how you can pass a simple "Hello World" message from the server to the all the clients using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>

When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommand ( playerSource, commandName )
triggerClientEvent ( playerSource, "onGreeting", playerSource, "Hello World!" )
end
addCommandHandler ( "greet", greetingCommand )
</syntaxhighlight>
</section>

This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>

This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommandOne ( playerSource, commandName, playerName )
if playerName then
local thePlayer = getPlayerFromName ( playerName )
if thePlayer then
triggerClientEvent ( thePlayer, "onGreeting", thePlayer, "Hello World!" )
else
-- invalid player name specified
end
else
-- No player name specified
end
end
addCommandHandler ( "greet_one", greetingCommandOne )
</syntaxhighlight>
</section>

This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function nameFunction(message)
if source == resourceRoot then
outputChatBox(message)
end
end
addEvent("toClientSide", true )
addEventHandler("toClientSide", resourceRoot, nameFunction)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function commandFunction(source)
triggerClientEvent(source, "toClientSide", resourceRoot, "Hello World!")
end
addCommandHandler("cool", commandFunction)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04570|Added option to use a list of player elements for the 'sendTo' argument}}

==See Also==
{{Event functions|server}}
[[ru:triggerClientEvent]]

TriggerClientEvent

2025-06-08T13:50:29Z

Fernando187: /* Examples */

__NOTOC__
{{Server function}}
This function triggers an event previously registered on a client. This is the primary means of passing information between the server and the client. Clients have a similar [[triggerServerEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerServerEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[element]]s and complex nested [[table]]s. Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.

Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. '''It is marginally more efficient to pass one large event than two smaller ones'''.
{{Important Note | Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.}}
{{Note|It is marginally more efficient to pass one large event than two smaller ones.}}

==Syntax==
<syntaxhighlight lang="lua">
bool triggerClientEvent ( [ table/element sendTo = getRootElement(), ] string name, element sourceElement [, arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''sourceElement:''' The element that is the [[Event system#Event handlers|source]] of the event.
{{Important Note|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}

===Optional Arguments===
{{OptionalArg}}
*'''sendTo:''' The event will be sent to all [[player]]s that are children of the specified element. By default this is the root element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Examples==
This example shows how you can pass a simple "Hello World" message from the server to the all the clients using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>

When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommand ( playerSource, commandName )
triggerClientEvent ( playerSource, "onGreeting", playerSource, "Hello World!" )
end
addCommandHandler ( "greet", greetingCommand )
</syntaxhighlight>
</section>

This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommandOne ( playerSource, commandName, playerName )
if playerName then
local thePlayer = getPlayerFromName ( playerName )
if thePlayer then
triggerClientEvent ( thePlayer, "onGreeting", thePlayer, "Hello World!" )
else
-- invalid player name specified
end
else
-- No player name specified
end
end
addCommandHandler ( "greet_one", greetingCommandOne )
</syntaxhighlight>
</section>

This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.

This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function nameFunction(message)
if source == resourceRoot then
outputChatBox(message)
end
end
addEvent("toClientSide", true )
addEventHandler("toClientSide", resourceRoot, nameFunction)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function commandFunction(source)
triggerClientEvent(source, "toClientSide", resourceRoot, "Hello World!")
end
addCommandHandler("cool", commandFunction)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04570|Added option to use a list of player elements for the 'sendTo' argument}}

==See Also==
{{Event functions|server}}
[[ru:triggerClientEvent]]

TriggerClientEvent

2025-06-08T13:50:17Z

Fernando187: /* Examples */

__NOTOC__
{{Server function}}
This function triggers an event previously registered on a client. This is the primary means of passing information between the server and the client. Clients have a similar [[triggerServerEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerServerEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[element]]s and complex nested [[table]]s. Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.

Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. '''It is marginally more efficient to pass one large event than two smaller ones'''.
{{Important Note | Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.}}
{{Note|It is marginally more efficient to pass one large event than two smaller ones.}}

==Syntax==
<syntaxhighlight lang="lua">
bool triggerClientEvent ( [ table/element sendTo = getRootElement(), ] string name, element sourceElement [, arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''sourceElement:''' The element that is the [[Event system#Event handlers|source]] of the event.
{{Important Note|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}

===Optional Arguments===
{{OptionalArg}}
*'''sendTo:''' The event will be sent to all [[player]]s that are children of the specified element. By default this is the root element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Examples==
This example shows how you can pass a simple "Hello World" message from the server to the all the clients using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>

When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommand ( playerSource, commandName )
triggerClientEvent ( playerSource, "onGreeting", playerSource, "Hello World!" )
end
addCommandHandler ( "greet", greetingCommand )
</syntaxhighlight>
</section>

This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommandOne ( playerSource, commandName, playerName )
if playerName then
local thePlayer = getPlayerFromName ( playerName )
if thePlayer then
triggerClientEvent ( thePlayer, "onGreeting", thePlayer, "Hello World!" )
else
-- invalid player name specified
end
else
-- No player name specified
end
end
addCommandHandler ( "greet_one", greetingCommandOne )
</syntaxhighlight>
</section>

This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.

This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function nameFunction(message)
if source == resourceRoot then
outputChatBox(message)
end
end
addEvent("toClientSide", true )
addEventHandler("toClientSide", resourceRoot, nameFunction)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function commandFunction(source)
triggerClientEvent(source, "toClientSide", resourceRoot, "Hello World!")
end
addCommandHandler("cool", commandFunction)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04570|Added option to use a list of player elements for the 'sendTo' argument}}

==See Also==
{{Event functions|server}}
[[ru:triggerClientEvent]]

TriggerClientEvent

2025-06-08T13:49:53Z

Fernando187: Fix examples header

__NOTOC__
{{Server function}}
This function triggers an event previously registered on a client. This is the primary means of passing information between the server and the client. Clients have a similar [[triggerServerEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerServerEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[element]]s and complex nested [[table]]s. Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.

Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. '''It is marginally more efficient to pass one large event than two smaller ones'''.
{{Important Note | Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.}}
{{Note|It is marginally more efficient to pass one large event than two smaller ones.}}

==Syntax==
<syntaxhighlight lang="lua">
bool triggerClientEvent ( [ table/element sendTo = getRootElement(), ] string name, element sourceElement [, arguments... ] )
</syntaxhighlight>

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''sourceElement:''' The element that is the [[Event system#Event handlers|source]] of the event.
{{Important Note|To save client CPU, you should avoid setting theElement to the [[root]] element where possible - it should be used as a last resort (rather questionable thing to do, limited to very specific tasks, if any). Using target element ([[player]] who should receive event, if expected to be delivered to particular one) is preferred and highly advisable. [[resourceRoot]] can also be used as alternative choice, if [[addEventHandler]] is bound to [[root]] element, or to [[resourceRoot]] when there is need to restrict event to single certain resource.}}

===Optional Arguments===
{{OptionalArg}}
*'''sendTo:''' The event will be sent to all [[player]]s that are children of the specified element. By default this is the root element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Examples==
This example shows how you can pass a simple "Hello World" message from the server to the all the clients using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommand ( playerSource, commandName )
triggerClientEvent ( playerSource, "onGreeting", playerSource, "Hello World!" )
end
addCommandHandler ( "greet", greetingCommand )
</syntaxhighlight>
</section>

When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.

This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommandOne ( playerSource, commandName, playerName )
if playerName then
local thePlayer = getPlayerFromName ( playerName )
if thePlayer then
triggerClientEvent ( thePlayer, "onGreeting", thePlayer, "Hello World!" )
else
-- invalid player name specified
end
else
-- No player name specified
end
end
addCommandHandler ( "greet_one", greetingCommandOne )
</syntaxhighlight>
</section>

This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.

This example uses resourceRoot to avoid being called by resources other than the same one that was created. (it can still be circumvented with [[getResourceRootElement]] but it makes it more difficult for cheating players).

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function nameFunction(message)
if source == resourceRoot then
outputChatBox(message)
end
end
addEvent("toClientSide", true )
addEventHandler("toClientSide", resourceRoot, nameFunction)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function commandFunction(source)
triggerClientEvent(source, "toClientSide", resourceRoot, "Hello World!")
end
addCommandHandler("cool", commandFunction)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04570|Added option to use a list of player elements for the 'sendTo' argument}}

==See Also==
{{Event functions|server}}
[[ru:triggerClientEvent]]

SetGameType

2025-06-08T13:49:28Z

Fernando187: Fix examples header

__NOTOC__
{{Server function}}
This function sets a string containing a name for the game type. This should be the game-mode that is active, for example "Capture The Flag" or "Deathmatch". This is then displayed in the server browser and external server browsers.

'''It should be noted that [[mapmanager]] handles this automatically for gamemodes that utilise the map/gamemode system.'''

==Syntax==
<syntaxhighlight lang="lua">
bool setGameType ( string gameType )
</syntaxhighlight>
[[File:GameType.png|thumb|Gamemode column that shows a server's game type.]]
===Required Arguments===
*'''gameType:''' A string containing a name for the game mode, or ''false'' to clear it. '''(MAX 200 characters)'''

===Returns===
Returns ''true'' if the game type was set, ''false'' if an invalid argument was passed to the function.

==Examples==
This example sets the game type to ''Capture The Flag''.
<syntaxhighlight lang="lua">
setGameType ( "Capture The Flag" )
</syntaxhighlight>

This example adds a command to change the game type.
<syntaxhighlight lang="lua">
function setNewGameType( source, commandName, newGameType )
local oldGameType = getGameType() -- check old Game Type
setGameType( newGameType ) -- set new Game Type
outputChatBox( "Game Type " .. oldGameType .. " changed to " .. newGameType .. ".", getRootElement(), 255, 128, 0 )
end
addCommandHandler( "setgametype", setNewGameType )
</syntaxhighlight>

==See Also==
{{Announce functions}}

AddBan

2025-06-08T13:49:12Z

Fernando187: Fix examples header

__NOTOC__
{{Server function}}
This function will add a [[ban]] for the specified IP/username/serial to the server.
{{Note|One of the three: IP, Username or Serial have to be specified.}}
{{note| Don't forget to give admin rights to the resource, in which you are using addBan function or it won't work.}}

==Syntax==
<syntaxhighlight lang="lua">
ban addBan ( string IP, string Username, string Serial, [ player responsibleElement, string reason, int seconds = 0 ] )
</syntaxhighlight>

{{OOP||[[Ban]]}}

===Required Arguments===
*'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''.
*'''Username:''' The [http://community.mtasa.com/ MTA Community] username to be banned (now obsolete). If you don't want to ban by username, set this to ''nil''.
*'''Serial:''' The serial to be banned. If you don't want to ban by serial, set this to ''nil''.

===Optional Arguments===
{{OptionalArg}}
*'''responsibleElement:''' The element that is responsible for banning the IP/username/serial. This can be a player or the root ([[getRootElement]]()).
*'''reason:''' The reason the IP/username/serial will be banned from the server.
*'''seconds:''' The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.

===Returns===
Returns the new [[ban]] if the IP/username/serial was banned successfully, ''false'' if invalid arguments are specified.

==Examples==
This example bans a player's IP with the reason "Requested" when they type "/ban-me".
<syntaxhighlight lang="lua">
function banMe ( source, command ) -- The function header and where source is defined
local ipToBan = getPlayerIP ( source ) -- Get the player's IP
addBan ( ipToBan, nil, nil, source, "Requested" ) -- Ban him with the reason; Requested
end
addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"
</syntaxhighlight>

This example add command to ban player serial.
<syntaxhighlight lang="lua">
function banSerial( source, command, noob, reason )
if ( noob ) then
local theNoob = getPlayerFromName( noob )
if ( theNoob ) then
local theNoobSerial = getPlayerSerial( theNoob )
addBan( nil, nil, theNoobSerial, source, reason )
end
end
end
addCommandHandler( "ban-serial", banSerial )
</syntaxhighlight>

==See Also==
{{Admin functions}}
[[ru:addBan]]

AddBan

2025-06-08T13:48:57Z

Fernando187:

__NOTOC__
{{Server function}}
This function will add a [[ban]] for the specified IP/username/serial to the server.
{{Note|One of the three: IP, Username or Serial have to be specified.}}
{{note| Don't forget to give admin rights to the resource, in which you are using addBan function or it won't work.}}

==Syntax==
<syntaxhighlight lang="lua">
ban addBan ( string IP, string Username, string Serial, [ player responsibleElement, string reason, int seconds = 0 ] )
</syntaxhighlight>

{{OOP||[[Ban]]}}

===Required Arguments===
*'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''.
*'''Username:''' The [http://community.mtasa.com/ MTA Community] username to be banned (now obsolete). If you don't want to ban by username, set this to ''nil''.
*'''Serial:''' The serial to be banned. If you don't want to ban by serial, set this to ''nil''.

===Optional Arguments===
{{OptionalArg}}
*'''responsibleElement:''' The element that is responsible for banning the IP/username/serial. This can be a player or the root ([[getRootElement]]()).
*'''reason:''' The reason the IP/username/serial will be banned from the server.
*'''seconds:''' The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.

===Returns===
Returns the new [[ban]] if the IP/username/serial was banned successfully, ''false'' if invalid arguments are specified.

==Example==
This example bans a player's IP with the reason "Requested" when they type "/ban-me".
<syntaxhighlight lang="lua">
function banMe ( source, command ) -- The function header and where source is defined
local ipToBan = getPlayerIP ( source ) -- Get the player's IP
addBan ( ipToBan, nil, nil, source, "Requested" ) -- Ban him with the reason; Requested
end
addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"
</syntaxhighlight>

==Example 2==
This example add command to ban player serial.
<syntaxhighlight lang="lua">
function banSerial( source, command, noob, reason )
if ( noob ) then
local theNoob = getPlayerFromName( noob )
if ( theNoob ) then
local theNoobSerial = getPlayerSerial( theNoob )
addBan( nil, nil, theNoobSerial, source, reason )
end
end
end
addCommandHandler( "ban-serial", banSerial )
</syntaxhighlight>

==See Also==
{{Admin functions}}
[[ru:addBan]]

AddBan

2025-06-08T13:48:14Z

Fernando187: /* Syntax */

__NOTOC__
{{Server function}}
This function will add a [[ban]] for the specified IP/username/serial to the server.
{{Note|One of the three: IP, Username or Serial have to be specified.}}
{{note| Don't forget to give admin rights to the resource, in which you are using addBan function or it won't work.}}

==Syntax==
<syntaxhighlight lang="lua">
ban addBan ( string IP, string Username, string Serial, [ player responsibleElement, string reason, int seconds = 0 ] )
</syntaxhighlight>

{{OOP||[[Ban]]}}

===Required Arguments===
*'''IP:''' The IP to be banned. If you don't want to ban by IP, set this to ''nil''.
'''or'''
*'''Username:''' The [http://community.mtasa.com/ MTA Community] username to be banned (now obsolete). If you don't want to ban by username, set this to ''nil''.
'''or'''
*'''Serial:''' The serial to be banned. If you don't want to ban by serial, set this to ''nil''.
''' or any combination.'''

===Optional Arguments===
{{OptionalArg}}
*'''responsibleElement:''' The element that is responsible for banning the IP/username/serial. This can be a player or the root ([[getRootElement]]()).
*'''reason:''' The reason the IP/username/serial will be banned from the server.
*'''seconds:''' The amount of seconds the player will be banned from the server for. This can be 0 for an infinite amount of time.

===Returns===
Returns the new [[ban]] if the IP/username/serial was banned successfully, ''false'' if invalid arguments are specified.

==Example==
This example bans a player's IP with the reason "Requested" when they type "/ban-me".
<syntaxhighlight lang="lua">
function banMe ( source, command ) -- The function header and where source is defined
local ipToBan = getPlayerIP ( source ) -- Get the player's IP
addBan ( ipToBan, nil, nil, source, "Requested" ) -- Ban him with the reason; Requested
end
addCommandHandler ( "ban-me", banMe ) -- Make it trigger when a player types "/ban-me"
</syntaxhighlight>

==Example 2==
This example add command to ban player serial.
<syntaxhighlight lang="lua">
function banSerial( source, command, noob, reason )
if ( noob ) then
local theNoob = getPlayerFromName( noob )
if ( theNoob ) then
local theNoobSerial = getPlayerSerial( theNoob )
addBan( nil, nil, theNoobSerial, source, reason )
end
end
end
addCommandHandler( "ban-serial", banSerial )
</syntaxhighlight>

==See Also==
{{Admin functions}}
[[ru:addBan]]

GetGroundPosition

2025-06-08T13:46:53Z

Fernando187: Fix examples header

__NOTOC__
{{Client function}}
This function gets the Z level of the highest ground below a point.

It is required that the point is near enough to the local player so that it's within the area where collision data is loaded. If this is not the case, an incorrect position will be returned.

==Syntax==
<syntaxhighlight lang="lua">
float getGroundPosition ( float x, float y, float z )
</syntaxhighlight>

===Required Arguments===
*'''x:''' A floating point number representing the X world coordinate of the point.
*'''y:''' A floating point number representing the Y world coordinate of the point.
*'''z:''' A floating point number representing the Z world coordinate of the point.

===Returns===
Returns a float with the highest ground-level Z coord if parameters are valid, ''0'' if the point you tried to test is outside the loaded world map, ''false'' otherwise.

==Examples==
This clientside function determines if a player is under a ceiling or not.
<syntaxhighlight lang="lua">
function isPlayerUnderCover ( thePlayer )
--we get the player's position
local px, py, pz = getElementPosition ( thePlayer )
--we'll check for ground level at the player's position, and also 500 units over him.
--if these ground levels match, it must mean there were no obstacles (such as a ceiling) over the player,
return getGroundPosition ( px, py, pz ) ~= getGroundPosition ( px, py, pz + 530 )
end
</syntaxhighlight>

This clientside function returns the distance between you and the ground (if there is)
<syntaxhighlight lang="lua">
function getGroundDistance( thePlayer, zHeight )
local x,y,z = getElementPosition(thePlayer) -- get position
local groundPosition = getGroundPosition(x,y,z) -- get default ground pos
local hit, x1, y1, groundPosition = processLineOfSight(x,y,z+1,x,y,z-(zHeight+0.7)) -- using zHeight get a better ground position
local distance = getDistanceBetweenPoints3D(x, y, z, x,y, (groundPosition or z)) -- get distance between both positions
return distance -- return the distance
end

-- Some cool examples:
addCommandHandler("gdistance",function(_, amount)
local distance = getGroundDistance(localPlayer, tonumber(amount))
outputChatBox("The distance to reach ground is: " .. distance)
end)

addCommandHandler("do_im_flying",function()
local distance = getGroundDistance(localPlayer, 20)
if distance > 1 then
outputChatBox("Superman!! the distance between you and ground is: " .. distance)
else
outputChatBox("naah")
end
end)
</syntaxhighlight>

==See Also==
{{Client_world_functions}}

[[ru:getGroundPosition]]

GetColorFilter

2025-06-08T13:46:34Z

Fernando187: Fix examples header

__NOTOC__
{{Client function}}
{{Added feature/item|3.0161|1.6.0|22188|This function is used to get the values of color filtering.}}
{{Tip|Normally the game is adding these colors to a screen to simulate weather effects. Sometimes it can be important to disable these effects. You can get rid of the effects by calling [[setColorFilter]] with zero values.}}

==Syntax==
<syntaxhighlight lang="lua">
int, int, int, int, int, int, int, int getColorFilter ( bool isOriginal )
</syntaxhighlight>

===Required Arguments===
*'''isOriginal:''' A bool indicates if the return values of color filter are GTASA original or changed by [[setColorFilter]]. If this is set to ''false'', the return values would be the color filter that is currently being used.

===Returns===
Returns 8 ''[[integer|integers]]'', of which the first 4 indicate the color (R,G,B,A) of color filter A, and the last 4 indicate the color (R,G,B,A) of color filter B.

==Examples==
This example corrects color of dxDrawMaterialLine3D. But this method has some limit.
<syntaxhighlight lang="lua">
local testRT = dxCreateRenderTarget(32,32,true)

x,y,z = 0, 0, 4
size = 4
addEventHandler("onClientRender", root, function()
dxSetRenderTarget(testRT,true)
dxDrawRectangle(0,0,32,32,tocolor(255,255,255,255))
dxSetRenderTarget()

local aR,aG,aB,aA,bR,bG,bB,bA = getColorFilter(false) --Get current color filter
local cR,cG,cB = 127/255+(aR*aA+bR*bA)/65535*0.5, 127/255+(aG*aA+bG*bA)/65535*0.5, 127/255+(aB*aA+bB*bA)/65535*0.5 --Calculate the result color of color filter
dxDrawMaterialLine3D(x+size, y+size, z-0.95, x-size, y-size, z-0.95,false, testRT, size*2,tocolor(127, 127, 127, 255))
dxDrawMaterialLine3D(x+size+20, y+size, z-0.95, x-size+20, y-size, z-0.95,false, testRT, size*2,tocolor(127/cR, 127/cG, 127/cB, 255))
end)
</syntaxhighlight>

This example corrects color of dxDrawMaterialLine3D using shader
<syntaxhighlight lang="lua">
local shader = [[
float3 colorFilter = float3(1,1,1);
texture sourceTexture;

sampler2D SamplerTex = sampler_state{
Texture = sourceTexture;
MipFilter = Linear;
MinFilter = Linear;
MagFilter = Linear;
AddressU = Mirror;
AddressV = Mirror;
};

float4 colorFilterRemover(float4 color:COLOR0, float2 UV:TEXCOORD0) : COLOR0{
color *= tex2D(SamplerTex, UV);
color.rgb /= colorFilter;
return color;
}

technique cFilterRemover{
pass P0{
PixelShader = compile ps_2_0 colorFilterRemover();
}
}
]]

local cFilterRemover = dxCreateShader(shader)
local testRT = dxCreateRenderTarget(32,32,true)
dxSetShaderValue(cFilterRemover,"sourceTexture",testRT)

x,y,z = 0, 0, 4
size = 4
addEventHandler("onClientRender", root, function()
dxSetRenderTarget(testRT,true)
dxDrawRectangle(0,0,32,32,tocolor(255,255,255,255))
dxSetRenderTarget()

local aR,aG,aB,aA,bR,bG,bB,bA = getColorFilter(false) --Get current color filter
local cR,cG,cB = 127+(aR*aA+bR*bA)/255*0.5, 127+(aG*aA+bG*bA)/255*0.5, 127+(aB*aA+bB*bA)/255*0.5 --Calculate the result color of color filter
dxSetShaderValue(cFilterRemover,"colorFilter",cR/255,cG/255,cB/255) --Apply to the color filter remover shader
dxDrawMaterialLine3D(x+size, y+size, z-0.95, x-size, y-size, z-0.95,false, cFilterRemover, size*2,tocolor(127, 127, 127, 255))
dxDrawMaterialLine3D(x+size+20, y+size, z-0.95, x-size+20, y-size, z-0.95,false, testRT, size*2,tocolor(127, 127, 127, 255))
end)
</syntaxhighlight>

==See Also==
{{World functions}}

CreateTrayNotification

2025-06-08T13:42:50Z

Fernando187: Fix examples header

__NOTOC__
{{Client function}}
This function creates a notification balloon on the desktop.

{{Note|MTA won't show any tray notifications if the MTA window is focused, because there is no reason to show tray notifications if you are in-game. If you want to test this function you should use a Timer and switch to your desktop.}}
{{Note|You can only show a tray notification every 30 seconds.}}

==Syntax==
<syntaxhighlight lang="lua">bool createTrayNotification ( string notificationText [, string iconType = "default", bool useSound = true ] )</syntaxhighlight>

[[File:TrayNotification.gif|301px|thumb|right|alt=GIF preview of a tray notification|Tray Notification GIF]]

===Required Arguments===
*'''notificationText:''' The text to send in the notification.

===Optional Arguments===
*'''iconType:''' The notification icon type. Possible values are: '''"default" (the MTA icon), "info", "warning", "error"'''
*'''useSound:''' A boolean value indicating whether or not to play a sound when receiving the notification.

===Returns===
Returns ''true'' if the notification is correctly created, ''false'' otherwise.

==Examples==
<syntaxhighlight lang="lua">
-- Note: You have to wait 30 seconds before showing another tray notification, there is no queuing

createTrayNotification("Hello World") -- Show a 'Hello World' notification

createTrayNotification("Hello World", "warning") -- Show a notification with a warning symbol

createTrayNotification("Hello World", "default", false) -- Show a default notification without sound
</syntaxhighlight>

Example of notification on minimize MTA application:
<syntaxhighlight lang="lua">
function setTrayOnMinimize()
createTrayNotification("We are waiting for you again...", "warning")
end
addEventHandler("onClientMinimize", root, setTrayOnMinimize)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.5.6-9.16925|Added support for Windows 10}}

==See Also==
{{Client_utility_functions}}

GetPedBonePosition

2025-06-08T13:42:19Z

Fernando187: Fix examples header

__NOTOC__
{{Client function}}
Returns the 3D world coordinates of a specific bone of a given ped.
{{Tip|If you want attach element to ped bone, use [[https://github.com/Patrick2562/mtasa-pAttach pAttach]] resource}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getPedBonePosition ( ped thePed, int bone )
</syntaxhighlight>
{{OOP||[[ped]]:getBonePosition||}}

===Required Arguments===
*'''thePed:''' the ped you want to inspect.
*'''bone:''' the number of the bone to get the position of.

[[Image:Bones.jpg|thumb|Bone numbers]]

<div style="border: 3px red solid; margin-bottom:3px; padding-left:5px;">
*'''1:''' BONE_PELVIS1
*'''2:''' BONE_PELVIS
*'''3:''' BONE_SPINE1
*'''4:''' BONE_UPPERTORSO
*'''5:''' BONE_NECK
*'''6:''' BONE_HEAD2
*'''7:''' BONE_HEAD1
*'''8:''' BONE_HEAD
*'''21:''' BONE_RIGHTUPPERTORSO
*'''22:''' BONE_RIGHTSHOULDER
*'''23:''' BONE_RIGHTELBOW
*'''24:''' BONE_RIGHTWRIST
*'''25:''' BONE_RIGHTHAND
*'''26:''' BONE_RIGHTTHUMB
*'''31:''' BONE_LEFTUPPERTORSO
*'''32:''' BONE_LEFTSHOULDER
*'''33:''' BONE_LEFTELBOW
*'''34:''' BONE_LEFTWRIST
*'''35:''' BONE_LEFTHAND
*'''36:''' BONE_LEFTTHUMB
*'''41:''' BONE_LEFTHIP
*'''42:''' BONE_LEFTKNEE
*'''43:''' BONE_LEFTANKLE
*'''44:''' BONE_LEFTFOOT
*'''51:''' BONE_RIGHTHIP
*'''52:''' BONE_RIGHTKNEE
*'''53:''' BONE_RIGHTANKLE
*'''54:''' BONE_RIGHTFOOT
</div>

===Returns===
Returns the x, y, z world position of the bone.

==Examples==
This example renders name tags above a player's head bone.
<syntaxhighlight lang="lua">
addEventHandler( "onClientRender",root,
function( )
local px, py, pz, tx, ty, tz, dist
px, py, pz = getCameraMatrix( )
for _, v in ipairs( getElementsByType ( 'player' ) ) do
tx, ty, tz = getElementPosition( v )
dist = math.sqrt( ( px - tx ) ^ 2 + ( py - ty ) ^ 2 + ( pz - tz ) ^ 2 )
if dist < 30.0 then
if isLineOfSightClear( px, py, pz, tx, ty, tz, true, false, false, true, false, false, false,localPlayer ) then
local sx, sy, sz = getPedBonePosition( v, 5 )
local x,y = getScreenFromWorldPosition( sx, sy, sz + 0.3 )
if x then -- getScreenFromWorldPosition returns false if the point isn't on screen
dxDrawText( getPlayerName( v ), x, y, x, y, tocolor(150, 50, 0), 0.85 + ( 15 - dist ) * 0.02, "bankgothic" )
end
end
end
end
end
)
</syntaxhighlight>

This one draw all local player's bones
<syntaxhighlight lang="lua">
addEventHandler('onClientRender', root, function()
for bone = 1, 54 do
local bonePos = {getPedBonePosition(localPlayer, bone)}
if bonePos[1] then
local screen = {getScreenFromWorldPosition(unpack(bonePos))}
if screen[1] then
dxDrawText(''..bone, screen[1], screen[2])
end
end
end
end)
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}

[[hu:getPedBonePosition]]
[[ru:GetPedBonePosition]]

GetPedAnimation

2025-06-08T13:41:59Z

Fernando187: Fix examples header

__NOTOC__
{{Client function}}

Gets the animation of a player or ped that was set using [[setPedAnimation]].
{{Note|Use [[getPedTask]] to monitor what movements the player is currently doing.''}}

==Syntax==
{{Deprecated items|3.0158|1.5.7|<syntaxhighlight lang="lua">string, string getPedAnimation ( ped thePed )</syntaxhighlight>|20450}}
{{New feature/item|3.0158|1.5.7|20450|<syntaxhighlight lang="lua"> string, string, int, int, bool, bool, bool, int, bool getPedAnimation ( ped thePed )</syntaxhighlight>}}

{{OOP||[[ped]]:getAnimation||setPedAnimation}}

===Required Arguments===
*'''thePed:''' the [[player]] or [[ped]] you want to get the [[animations|animation]] of.

===Returns===
{{Deprecated items|3.0158|1.5.7|Returns two [[string|strings]]: the first is the name of the block, the second is the name of the animation. Returns ''false'' if there was an error or if the ped is not doing an animation.|20450}}

{{New feature/item|3.0158|1.5.7|20450|The function returns 9 values in the same order as required by [[setPedAnimation]]:
<syntaxhighlight lang="lua">string block, string anim, int time, bool loop, bool updatePosition, bool interruptable, bool freezeLastFrame, int blendTime, bool restoreTaskOnAnimEnd</syntaxhighlight>
}}

==Examples==
This example adds a command that allows you to copy the animation being used by another player using /copyanim theirName
<syntaxhighlight lang="lua">
function CopyAnimation(theCommand, thePlayer) -- The Command Function
if thePlayer then -- If a player name entered then
thePlayerToCopyFrom = getPlayerFromName(thePlayer) -- get player from his name
block, anim = getPedAnimation(thePlayerToCopyFrom) -- get the player animation
if block then -- if got the animation successfully then
setPedAnimation(localPlayer, block, anim) -- set my animation the same
outputChatBox("* Copied Successfully !") -- output chat message
end
else
outputChatBox("* Please Enter a Player Name To Copy From !") -- if you didnt entered a player name , then output a chat box message
end
end
addCommandHandler("copyanim", CopyAnimation) -- adding the Command Handler
</syntaxhighlight>

This example shows what block and animation your player is currently performing. Note this will return "N/A" if you did not set an animation with [[setPedAnimation]]. If you want to see what the player ped is doing as you control them that is [[getPedTask]].
<syntaxhighlight lang="lua">
addEventHandler("onClientPreRender",root,
function ()
local block, animation = getPedAnimation(localPlayer)
dxDrawText ( "CURRENT ANIMATION INFO...", 100, 300 )
if not block then block = "N/A" end
if not animation then animation = "N/A" end
dxDrawText ( "Block = "..block.." Animation = "..animation, 100, 315 )
end )
</syntaxhighlight>

==See Also==
{{Client_ped_functions}}

[[hu:getPedAnimation]]

GetElementBoneRotation

2025-06-08T13:41:32Z

Fernando187: Fix examples header

__NOTOC__
{{Client function}}
{{Added feature/item|1.5.9|1.5.8|20704|Returns the orientation of a specific bone relative to the [[element]]. Currently the [[Element/Player|Player]] and [[Element/Ped|Ped]] element types are accepted.}}
{{Tip|If you want to attach an element to a bone, see [[attachElementToBone]].}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float getElementBoneRotation ( element theElement, int boneId )
</syntaxhighlight>

[[Image:The-yaw-pitch-and-roll-angles-in-the-human-head-motion-11.png|thumb|Rotation axes]]

===Required Arguments===
*'''theElement:''' the [[element]] to get the bone rotation on.
*'''boneId:''' the ID of the bone to get the rotation of. See [[Bone IDs]].

===Returns===
Returns 3 [[Float|floats]], representing the yaw, pitch, roll rotation values.

==Examples==
This example outputs the yaw, pitch and roll orientation of a specific bone relative to the local player bone specified through a command:
<syntaxhighlight lang="lua">
function getBoneRotation (commandName, boneId)
if not tonumber (boneId) then
outputChatBox ("You didn't insert an bone ID!", 255, 0, 0)
return false
end

local x, y, z = getElementBoneRotation (localPlayer, boneId)
outputChatBox ("The bone rotation is: "..x..", "..y..", "..z)
end

addCommandHandler ("getbonerotation", getBoneRotation)
</syntaxhighlight>

This example takes the current rotation of all player bones. by ThigasDEV
<syntaxhighlight lang="lua">
local settings = {
copyDiscord = false; -- true = "yes" // false = "no" - Copy to paste table in discord format.
tableName = "bonesPos"; -- Table name to be copied.
}

local boneIDs = {0, 1, 2, 3, 4, 5, 6, 7, 8, 21, 22, 23, 24, 25, 26, 31, 32, 33, 34, 35, 36, 41, 42, 43, 44, 51, 52, 53, 54, 201, 301, 302}

addCommandHandler ("getbonerotation", function ()
local bonesPositions = { }
local bonesConverted = ""
for _, v in ipairs (boneIDs) do
local x, y, z = getElementBoneRotation (localPlayer, v)
table.insert (bonesPositions, "["..v.."] = {"..x..", "..y..", "..z.."};")
end
for i, v in ipairs (bonesPositions) do
bonesConverted = " "..bonesConverted.."\n".." "..v
end
setClipboard ((settings["copyDiscord"] and "```lua\nlocal "..string.gsub(settings["tableName"], " ", "_").." = {"..bonesConverted.."\n}\n```" or "local "..string.gsub(settings["tableName"], " ", "_").." = {"..bonesConverted.."\n}"))
outputChatBox ("Copy to clipboard.")
end)
</syntaxhighlight>

==See Also==
{{Client_element_functions}}

CreateBrowser

2025-06-08T13:40:27Z

Fernando187: Fix examples header

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function creates a new web [[Element/Browser|browser]] element.
}}
{{Note|You can also enable CEF development tools using [[toggleBrowserDevTools]]}}

==Syntax==
<syntaxhighlight lang="lua">element createBrowser ( int width, int height, bool isLocal [, bool transparent = false ] )</syntaxhighlight>
{{OOP||[[Element/Browser|Browser]]}}

===Required Arguments===
*'''width:''' The browser's native width. This should be greater than or equal to 1.
*'''height:''' The browser's native height. This should be greater than or equal to 1.
*'''isLocal:''' Sets whether the browser can only show local content or content from the internet (see examples for more information)

{{New feature/item|3.0160|1.6||Invalid sizes will be a hard error.}}

===Optional Arguments===
*'''transparent:''' ''true'' if you want the browser transparent, ''false'' for opaque.

===Returns===
Returns a [[texture]] of the [[browser]] if it was created successfully, ''false'' otherwise. Returns also ''false'', if the user disabled remote pages and ''isLocal'' was set to ''false''.

==Examples==
{{Warning|The scheme for local files has changed. Please read [[Local_Scheme_Handler|Local Scheme Handler]] for details.|true}}
'''Local Example''': This example shows you how to create a fullscreen web browser (showing a local html file) without input-handling.
<syntaxhighlight lang="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

--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/html/site.html")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>

'''Remote Example''': This example shows you how to create a fullscreen web browser (showing youtube.com) without input-handling.<br>
Remember, that youtube.com is on the global whitelist. If you want to load a domain/page that is not on the global whitelist, you have to request it with [[requestBrowserDomains|requestBrowserDomains]].
<syntaxhighlight lang="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
)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

[[ar:createBrowser]]
[[en:CreateBrowser]]
[[hu:createBrowser]]
[[RO:CreateBrowser]]

IsVehicleFuelTankExplodable

2025-06-08T13:37:24Z

Fernando187: Fix examples header

{{Server client function}}
__NOTOC__
This will tell you if a vehicle's petrol tank is explodable.

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleFuelTankExplodable ( vehicle theVehicle )</syntaxhighlight>

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you want to obtain the fuel tank status of.

===Returns===
Returns ''true'' if the specified vehicle is valid and its fuel tank is explodable, ''false'' otherwise.

==Examples==
This example creates a vehicle, then displays if it fuel tank is explodable or not in the chatbox.
<syntaxhighlight lang="lua">
newcar = createVehicle ( 520, 1024, 1024, 1024 )
if ( isVehicleFuelTankExplodable ( newcar ) ) then
outputChatBox ( "Vehicle's tank is explodable" )
else
outputChatBox ( "Vehicle's tank is not explodable" )
end
</syntaxhighlight>

This example toggles vehicle fuel tank explodable when the player type ''fueltank'' in the chat.
<syntaxhighlight lang="lua">
function toggleFuelTankExplodable(playerSource)
vehicle = getPedOccupiedVehicle(playerSource)
if vehicle then
if isVehicleFuelTankExplodable(vehicle) then
setVehicleFuelTankExplodable(vehicle, false)
else
setVehicleFuelTankExplodable(vehicle, true)
end
else
outputChatBox("You are not in a vehicle.", playerSource, 220, 0, 0)
end
end
addCommandHandler("fueltank", toggleFuelTankExplodable)
</syntaxhighlight>

==See Also==
{{Vehicle functions}}

FromJSON

2025-06-08T13:36:50Z

Fernando187: /* Examples */

__NOTOC__
{{Server client function}}
This function parses a [[JSON]] formatted string into variables. You can use [[toJSON]] to encode variables into a JSON string that can be read by this function.

==Syntax==
<syntaxhighlight lang="lua">
var fromJSON ( string json )
</syntaxhighlight>

===Required Arguments===
*'''json:''' A JSON formatted string

===Returns===
Returns variables read from the JSON string.

'''Note:''' Indices of a JSON object such as "1": "cat" are being returned as [[string]], not as [[int]]eger.

==Examples==
This makes data equal: ''{ ["1"] = "cat", ["2"] = "mouse", ["3"] = 5, ["4"] = null, ["cat"] = 5, ["mouse"] =1 }''
<syntaxhighlight lang="lua">
local data = fromJSON ( '[ { "1": "cat", "2": "mouse", "3": 5, "4": null, "cat":5, "mouse":1 } ]' )
</syntaxhighlight>

This shows how to extract data from JSON:
<syntaxhighlight lang="lua">
local name, weapon, ammo = fromJSON("[\"Desert Eagle\", 24, 147]")
</syntaxhighlight>

==See Also==
{{Server_functions}}

FromJSON

2025-06-08T13:36:14Z

Fernando187: Fix examples header

__NOTOC__
{{Server client function}}
This function parses a [[JSON]] formatted string into variables. You can use [[toJSON]] to encode variables into a JSON string that can be read by this function.

==Syntax==
<syntaxhighlight lang="lua">
var fromJSON ( string json )
</syntaxhighlight>

===Required Arguments===
*'''json:''' A JSON formatted string

===Returns===
Returns variables read from the JSON string.

'''Note:''' Indices of a JSON object such as "1": "cat" are being returned as [[string]], not as [[int]]eger.

==Examples==
This makes data equal: ''{ ["1"] = "cat", ["2"] = "mouse", ["3"] = 5, ["4"] = null, ["cat"] = 5, ["mouse"] =1 }''
<syntaxhighlight lang="lua">
local data = fromJSON ( '[ { "1": "cat", "2": "mouse", "3": 5, "4": null, "cat":5, "mouse":1 } ]' )
</syntaxhighlight>

<syntaxhighlight lang="lua">
local name, weapon, ammo = fromJSON("[\"Desert Eagle\", 24, 147]")
</syntaxhighlight>

==See Also==
{{Server_functions}}