Multi Theft Auto: Wiki - User contributions [en]

SetElementPosition

2024-12-17T07:57:31Z

LopSided: Reverted edits by CoolDark (talk) to last revision by FileEX

__NOTOC__
{{Shared function}}
This function sets the position of an element to the specified coordinates.
{{Warning|Do not use this function to spawn a [[player]]. It will cause problems with other functions like [[warpPedIntoVehicle]]. Use [[spawnPlayer]] instead.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementPosition ( element theElement, float x, float y, float z [, bool warp = true ] )
</syntaxhighlight>
{{OOP||[[element]]:setPosition|position|getElementPosition}}

===Required Arguments===
*'''theElement:''' A valid [[element]] to be moved.
*'''x:''' The x coordinate of the destination.
*'''y:''' The y coordinate of the destination.
*'''z:''' The z coordinate of the destination.

===Optional Arguments===
*'''warp:''' teleports players, resetting any animations they were doing. Setting this to ''false'' preserves the current animation.

===Returns===
Returns ''true'' if the function was successful, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example lets admins teleport 5 random players to themselves
<syntaxhighlight lang="lua">
function randomPlayersToLocation(p)
if not isPlayerStaff(p) then return end

local playersOnline = getElementsByType("player")
local amount = #playersOnline

if amount == 0 then return end

for index = 1,(amount > 5 and 5 or amount) do
local player = playersOnline[index]
setElementPosition(player, getElementPosition(p))
end
end
addCommandHandler("randomtp", randomPlayersToLocation)
addCommandHandler("playershere", randomPlayersToLocation)

-- Utility function
local staffACLs = {
aclGetGroup("Admin"),
aclGetGroup("Moderator")
}

function isPlayerStaff(p)
if isElement(p) and getElementType(p) == "player" and not isGuestAccount(getPlayerAccount(p)) then
local object = getAccountName(getPlayerAccount(p))

for _, group in ipairs(staffACLs) do
if isObjectInACLGroup("user." .. object, group) then
return true
end
end
end
return false
end
</syntaxhighlight>
</section>

If you want to put a vehicle or player out of the water or simulate the position-resetting behaviour if CJ goes below the ground too far, then you need to retrieve a recommended coordinate on ground to place the element at. Take a look at [https://forum.mtasa.com/topic/132891-important-helprespawn-vehicle/?do=findComment&comment=1003198 this MTA forums post] for steps in the right direction.

==Issues==
{{Issues|
{{Issue|539|Changing player position when he/she has a jetpack will remove the jetpack and bug when skin is changed}}
{{Issue|529|Player falls from his bike when its teleported by setElementPosition}}
}}

==See Also==
{{Element functions}}

[[hu:setElementPosition]]
[[ru:setElementPosition]]

FindRotation

2024-12-17T07:57:27Z

LopSided: Reverted edits by CoolDark (talk) to last revision by Myonlake

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function takes two sets of XY coordinates. It returns the direction from point A to point B. This can for example be used to make peds face a given point.

==Syntax==
<syntaxhighlight lang="lua">float findRotation( float x1, float y1, float x2, float y2 )</syntaxhighlight>

===Required Arguments===
* '''x1''': The X coordinate of the starting point.
* '''y1''': The Y coordinate of the starting point.
* '''x2''': The X coordinate of the target point.
* '''y2''': The Y coordinate of the target point.

==Code==
<syntaxhighlight lang="lua">
function findRotation( x1, y1, x2, y2 )
local t = -math.deg( math.atan2( x2 - x1, y2 - y1 ) )
return t < 0 and t + 360 or t
end
</syntaxhighlight>

==Example==
This command makes the player who enters it face the player whose name is given.
<section name="Server-side example" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("facePlayer",function (player, _, targetName)

local target = getPlayerFromName(targetName); --get player name

if not target then --if there isn't a player
outputChatBox("Invalid player", player); --output to them and tell them that there's no player
return; --end the function so nothing else goes through
end

local x,y,z = getElementPosition(player); --get your position
local tx,ty,tz = getElementPosition(target); --get the players position

setPedRotation(player, findRotation(x,y,tx,ty) ); --let's set you facing them

end
);
</syntaxhighlight>
</section>

Original function by '''Doomed_Space_Marine'''. Fixed, tested and wiki-fied by '''robhol'''.

==See Also==
{{Useful_Functions}}

OnPlayerChangesProtectedData

2024-12-17T07:56:59Z

LopSided: Reverted edits by CoolDark (talk) to last revision by Srslyyyy

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22790|This event is triggered when a player tries to change protected element data. The server protects element data with using [[Server_mtaserver.conf#elementdata_whitelisted|elementdata_whitelisted]] from '''mtaserver.conf''' and the '''clientChangesPolicy''' parameter in [[setElementData]].}}
==Parameters==
*'''element''': The affected element.
*'''key''': The name of the element data entry that has changed.
*'''value''': The value that the player sends.

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who changes protected element data.

==Example==
The below example will ban all players who are trying to change protected element data.
<syntaxhighlight lang="lua">
function processPlayerElementDataHack()
addBan(source, "Element data hacking attempt")
end
addEventHandler("onPlayerChangesProtectedData", root, processPlayerElementDataHack)

</syntaxhighlight>
{{See also/Server event|Player events}}

IsBrowserGPUEnabled

2024-10-22T00:46:06Z

LopSided:

__NOTOC__
{{Client function}}
This function checks if the client has the "Enable GPU rendering" setting enabled, which allows the usage of things like WebGL in browsers.

'''Note''': this is a global setting, not specific to any browser instance and can only be changed by the client.

==Syntax==
<syntaxhighlight lang="lua">
bool isBrowserGPUEnabled()
</syntaxhighlight>
{{OOP||[[Element/Browser]]|gpuEnabled}}

===Returns===
Returns ''true'' if the client has browser GPU rendering enabled, ''false'' otherwise.

==See Also==
{{CEF_functions}}

IsBrowserGPUEnabled

2024-10-22T00:45:37Z

LopSided:

__NOTOC__
{{Client function}}
This function checks if the client has the "Enable GPU rendering" setting enabled, which allows the usage of things like WebGL in browsers.

'''Note''': this is a global setting, not specific to any browser instance and can only be changed by the user.

==Syntax==
<syntaxhighlight lang="lua">
bool isBrowserGPUEnabled()
</syntaxhighlight>
{{OOP||[[Element/Browser]]|gpuEnabled}}

===Returns===
Returns ''true'' if the client has browser GPU rendering enabled, ''false'' otherwise.

==See Also==
{{CEF_functions}}

IsBrowserGPUEnabled

2024-10-22T00:44:56Z

LopSided: Add note

__NOTOC__
{{Client function}}
This function checks if the client has the "Enable GPU rendering" setting enabled, which allows the usage of things like WebGL in browsers.

**Note**: this is a global setting, not specific to any browser instance and can only be changed by the user.

==Syntax==
<syntaxhighlight lang="lua">
bool isBrowserGPUEnabled()
</syntaxhighlight>
{{OOP||[[Element/Browser]]|gpuEnabled}}

===Returns===
Returns ''true'' if the client has browser GPU rendering enabled, ''false'' otherwise.

==See Also==
{{CEF_functions}}

IsBrowserGPUEnabled

2024-10-22T00:41:35Z

LopSided: Created page with "__NOTOC__ {{Client function}} This function checks if the client has the "Enable GPU rendering" setting enabled, which allows the usage of things like WebGL in browsers. ==Syntax== <syntaxhighlight lang="lua"> bool isBrowserGPUEnabled() </syntaxhighlight> {{OOP||Element/Browser|gpuEnabled}} ===Returns=== Returns ''true'' if the client has browser GPU rendering enabled, ''false'' otherwise. ==See Also== {{CEF_functions}}"

__NOTOC__
{{Client function}}
This function checks if the client has the "Enable GPU rendering" setting enabled, which allows the usage of things like WebGL in browsers.

==Syntax==
<syntaxhighlight lang="lua">
bool isBrowserGPUEnabled()
</syntaxhighlight>
{{OOP||[[Element/Browser]]|gpuEnabled}}

===Returns===
Returns ''true'' if the client has browser GPU rendering enabled, ''false'' otherwise.

==See Also==
{{CEF_functions}}

Template:Adding Pages to Categories and Templates

2024-10-15T23:28:48Z

LopSided:

<div class="page-category-note" style="background: #CEDFF2; border: 3px solid #CEDFF2;">
''Contributors:'' Did you create a page but it's not on this list? Confused? '''Read: [[Adding Pages to Categories and Templates]]'''</div>

Template:Note

2024-10-15T23:19:37Z

LopSided:

<div class="note-messagebox">{{MessageBox|
bordercolorhex = d5b5f5 |
bgcolorhex = ccccff |
bordertype = invalid |
message = '''Note:''' {{{1}}} }}</div><noinclude>

{{Template documentation|Note template for notes in an article/page.|
<syntaxhighlight lang="lua",N><nowiki>{{Note|TEXT for the note}}</nowiki></syntaxhighlight>
* Example:
<syntaxhighlight lang="lua",N><nowiki>{{Note|This function is not working in 1.0.0}}</nowiki></syntaxhighlight>
{{Note|This function is not working in 1.0.0}}
}}
</noinclude>

Template:Warning

2024-10-15T23:17:31Z

LopSided:

<div class="warning-messagebox">{{MessageBox|
bordercolorhex = FFB2B2 |
bgcolorhex = FFE5E5 |
image = {{ #if: {{{2|}}} | File:Dialog-warning.png }} |
title = Warning: |
message = {{{1}}} }}</div> <noinclude>

{{Template documentation|Warning template for in-line and page warnings.|
<syntaxhighlight lang="lua",N><nowiki>{{Warning|information|use warning image}}</nowiki></syntaxhighlight>
* Example with warning image (recommended for page warnings):
<syntaxhighlight lang="lua",N><nowiki>{{Warning|information|true}}</nowiki></syntaxhighlight>
{{Warning|information|true}}
* Example without warning image (recommended for in-line warnings):
<syntaxhighlight lang="lua",N><nowiki>{{Warning|information}}</nowiki></syntaxhighlight>
{{Warning|information}}
}}
</noinclude>

Template:Template documentation

2024-10-15T23:14:50Z

LopSided:

<div class="template-documentation" style="border: 1px solid #A5A5A5; background: #DAEFDD; padding: 10px;">
<h2>[[File:Applications-office.png]]Template Documentation</h2>
{{{1}}}
<h3>Usage</h3>
{{{2}}}
{{ #if: {{{3|}}} |
<br/><br/>
----
{{{3}}}}}
</div>

Template:New feature/item

2024-10-15T20:09:03Z

LopSided:

<includeonly>{{#ifexpr:({{{1|}}})>{{Current Version}}|<div class='new-feature-item' style='border: 2px solid #121319; border-radius: 10px; margin: 14px 0; overflow: hidden'><div style='background: #121319; color: #fff; font-weight: bold; padding: 4px 8px'>ADDED/UPDATED IN VERSION {{{2}}} {{#if:{{{3|}}}|{{r|{{{3}}}}}|}}:</div><div style='padding: 4px 8px'>{{{4}}} </div></div>| {{{4}}}}}[[Category:{{#switch:{{{5}}}|EN=Changes in|RU=Изменения в версии|AR|ES|HR|HU|PL|PT-BR=Mudanças em|RO|DE|AT|Other=Translated/Changes in|Changes in}} {{{2}}}]]</includeonly><noinclude>Template for using in function and event pages. For functions/events lists please use <nowiki>{{New items}}</nowiki>.

===Parameters===
#Version in numeric format
#Version in release format
#Revision
#Description
#Language
##Enter your language designation:
###EN - English
###RU - Russian (Русский)
###AR - Argentina (Argentina)
###ES - Spain (España)
###HR - Croatia (Hrvatska)
###HU - Hungary (Magyarország)
###PL - Poland (Polska)
###PT-BR - Portugal (Portugal)
###RO - Romania (România)
###DE - Germany (Deutschland)
###AT - Austria (Österreich)
###Other - languages not on this list
##If the language is Russian, then use '''[[Template:RU/New feature/item]]'''

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

Template:New items

2024-10-15T20:08:45Z

LopSided: Add class

<includeonly>{{#ifexpr:({{{1|}}})>{{Current Version}}|<div class='new-items' style='border: 2px solid #121319; border-radius: 10px; margin: 14px 0; overflow: hidden'><div style='background: #121319; color: #fff; font-weight: bold; padding: 4px 8px'>ADDED/UPDATED IN VERSION {{{2}}} {{#if:{{{4|}}}|{{r|{{{4}}}}}|}}:</div><div style='padding: 4px 8px'>{{{3}}} </div></div>| {{{3}}}}}</includeonly><noinclude>Use this template for functions/events lists. In function and event pages use <nowiki>{{New feature/item}}</nowiki>. This will prevent wrong pages appear in changelog category.
=== Parameters ===
# Version float (value is compared with <code>></code> to <code><nowiki>{{Current Version}}</nowiki> = {{Current Version}}</code>)
# Version text (only visual, example: <code>{{Current Version|full}}</code>)
# Text
# Revision number (only visual)
[[Category:Utility templates]]</noinclude>

Template:New feature/item

2024-10-15T20:08:10Z

LopSided: Add class

<includeonly>{{#ifexpr:({{{1|}}})>{{Current Version}}|<div class="new-feature-item" style='border: 2px solid #121319; border-radius: 10px; margin: 14px 0; overflow: hidden'><div style='background: #121319; color: #fff; font-weight: bold; padding: 4px 8px'>ADDED/UPDATED IN VERSION {{{2}}} {{#if:{{{3|}}}|{{r|{{{3}}}}}|}}:</div><div style='padding: 4px 8px'>{{{4}}} </div></div>| {{{4}}}}}[[Category:{{#switch:{{{5}}}|EN=Changes in|RU=Изменения в версии|AR|ES|HR|HU|PL|PT-BR=Mudanças em|RO|DE|AT|Other=Translated/Changes in|Changes in}} {{{2}}}]]</includeonly><noinclude>Template for using in function and event pages. For functions/events lists please use <nowiki>{{New items}}</nowiki>.

===Parameters===
#Version in numeric format
#Version in release format
#Revision
#Description
#Language
##Enter your language designation:
###EN - English
###RU - Russian (Русский)
###AR - Argentina (Argentina)
###ES - Spain (España)
###HR - Croatia (Hrvatska)
###HU - Hungary (Magyarország)
###PL - Poland (Polska)
###PT-BR - Portugal (Portugal)
###RO - Romania (România)
###DE - Germany (Deutschland)
###AT - Austria (Österreich)
###Other - languages not on this list
##If the language is Russian, then use '''[[Template:RU/New feature/item]]'''

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

Template:Requirements

2024-10-13T20:51:52Z

LopSided:

<div class="mta-feature-requirements" style="display:inline-block; border: 1px solid #a2a9b1; border-radius: 10px; overflow: hidden;">
{| cellpadding="4" style="border-collapse: collapse;"
|-
!style="border-top-left-radius: 10px; font-weight: 600; background-color: #FFAA44; border-style: solid; border-width: 1px; border-color: #a2a9b1; color:#7A4A20"| Minimum server version
!width=60 style="white-space: nowrap; border-top-right-radius: 10px; background-color: #FFCC66; border-style: solid; border-width: 1px; border-color: #a2a9b1; color:#202122"| {{{1}}}
|-
!style="border-bottom-left-radius: 10px; font-weight: 600; background-color: #FF6666; border-style: solid; border-width: 1px; border-color: #a2a9b1; color:#AA0028"| Minimum client version
!style="white-space: nowrap; border-bottom-right-radius: 10px; background-color: #FFBBBB; border-style: solid; border-width: 1px; border-color: #a2a9b1; color: #202122"| {{{2}}}
|}
</div>
'''Note''': Using this feature requires the resource to have the above minimum version declared in the [[Meta.xml|meta.xml]] '''<min_mta_version>''' section. ''e.g. <min_mta_version {{#ifeq: {{{1}}} |n/a||server="{{{1}}}"}} {{#ifeq: {{{2}}} |n/a||client="{{{2}}}"}} />''

HU/Főoldal

2024-10-13T18:08:22Z

LopSided:

{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |
<div style="/*border: 1px solid #D8D8D8;*/ padding-left: 15px; padding-right: 15px; height: 100%;">
[[File:Mtalogo.png|left|100px|link=http://wiki.multitheftauto.com/]]'''Üdvözöllek a [[Multi Theft Auto]] wikin.''' Itt rengeteg információt találhatsz a Multi Theft Auto használatáról.

Sok [[HU/How you can help|dologban segíthetsz Te is]], amivel fejleszted az MTA-t - készíts pályákat, játékmódokat, írj leírást, példákat a függvényekhez, írj útmutatókat, vagy csak játssz, és jelezd a hibákat amiket találtál!

Ha bármilyen kérdésed van a scripteléssel kapcsolatban, vedd fel velünk a kapcsolatot az [[Discord |Discord csatornánkon.]]
<br/><br/>
</div>
|}
{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |
|-
|width="50%" style="vertical-align:top;" |<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Input-gaming.png‎|link=]]</div>
<h3>Játék</h3>
<div class="downloadmta" style="background: #FFEEAA; border: 1px solid #FFCD19;">
[[File:Go-down.png|link=http://mtasa.com/]] ''' [http://mtasa.com/ Töltsd le a Multi Theft Auto San Andreas {{Current Version|full}}-t!]'''</div>
* [[HU/Where to buy GTASA|Hol lehet megvásárolni a GTASA-t?]]
* [[HU/Client Manual | Kliens kézikönyv]]

* [[Changes_in_{{padleft:|5|{{Current Version|full}}}}| Változtatások az {{padleft:|5|{{Current Version|full}}}} verzióban]]
* [[HU/Known_Issues_-_FAQ|Ismert problémák]]
* [[HU/Upgrading_from_MTA:Race|MTA:Race frissítése MTA:SA {{padleft:|3|{{Current Version|full}}}} -ra ]]
* [[HU/Server Manual|Szerver kézikönyv]]
* [[HU/Map manager|Map Manager]]

<h3>Map Editor</h3>
*[[HU/Resource:Editor|Kézikönyv]]
*[[HU/Resource:Editor/EDF|Editort definiáló fájl (EDF)]]
*[[HU/Resource:Editor/Plugins|Bővítmények]]
*[[HU/Resource:Editor#FAQ|Gyakran Ismételt Kérdések]]
</div>
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Package-x-generic.png‎|link=]]</div>
<h3>Adatbázisok</h3>
Az alábbi oldalakból megtudhatod mire képes a Lua az MTA-ban.
* [[HU/:Category:Resource|Resource katalógus]] - Igazán jól működő scriptek készítéséhez érdemes áttanulmányozni őket
* [[Client side scripts|Kliens oldali scriptek]]
* [[Modules|Modulok]]
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Applications-development.png‎‎‎|link=]]</div>
<h3>A Multi Theft Auto fejlesztése</h3>
[[File:Go-down.png|link=http://nightly.mtasa.com/]] [http://nightly.mtasa.com/ Fejlesztői verzió]
* [[HU/Compiling_MTASA|MTA SA fordítása Windowson]]
* [[Building_MTASA_Server_on_GNU_Linux|MTA SA fordítása GNU/Linux rendszeren]]
* [[HU/Coding guidelines|Kódolási útmutató]]
* [http://code.google.com/p/mtasa-blue Google Code SVN]
* [[Roadmap|Tervezet]]
* [http://bugs.mtasa.com/ Hibák]
* [[Branches|Fejlesztési ágazatok]]
</div>
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Applications-office.png|link=]]</div>
<h3>Wiki - Hogyan segíthetsz</h3>
* Egészítsd ki a [[:Category:Incomplete|függvények hiányos leírású oldalát]].
* [[:Category:Needs_Example |Írj példákat függvények használatára]].
* Ellenőrizd az [[:Category:Needs Checking|ellenőrzésre váró lapokat]].
* Írj útmutatókat
* Fordíts wiki lapokat
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Internet-group-chat.png‎|link=]]</div>
<h3>Közösség</h3>
* [http://forum.multitheftauto.com/ Fórum]
* [https://discord.com/invite/mtasa Community Discord]
* [https://discord.com/invite/GNN6PRtTnu Development Discord]
* [http://community.mtasa.com/ MTA Community] - Ossz meg és tölts le resourceokat!
* [http://twitter.com/#!/MTAQA/ Twitter] - [http://www.youtube.com/user/MTAQA Youtube] - [http://plus.google.com/102014133442331779727/ Google+] - [http://www.moddb.com/mods/multi-theft-auto-san-andreas ModDB]
</div>

| width="50%" style="vertical-align:top;" |

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Accessories-text-editor.png|link=]]</div>
<h3>Scriptelés</h3>
* [[HU/Bevezetés a scriptelésbe|Bevezetés a scriptelésbe]]
* [[HU/Introduction to Scripting the GUI|Bevezetés a GUI készítésébe]]
* [[HU/Debugging|Hibakeresés]] - Találd meg a hibát a kódodban
* [[HU/Resources|Bevezetés a Resourceokba]]
** [[HU/Resource Web Access|Resource Web Hozzáférés]] - Internet elérése
** [[HU/:Category:Resource|Resource katalógus]]
** [[HU/Meta.xml|Meta.xml]] - Minden resource alapja
** [[ACL]] - A megfelelő jogok meghatározása az összetettebb kódokhoz elengedhetetlen
* [[HU/Writing_Gamemodes|Játékmódok írása]]
* [[HU/Useful_Functions|Hasznos függvények]]
* [http://forum.mtasa.com/viewtopic.php?f=13&t=29363 Offline Wiki Másolatok]
Forum Linkek
* [https://forum.mtasa.com/forum/71-scripting/ Scripting Forum]
* [https://forum.mtasa.com/forum/123-tutorials/ Scripting Tutorials Sub-Forum]
* [https://forum.mtasa.com/topic/24702-mtasa-wiki-offline-copies-online-mirrors/ Offline Wiki Copies]
<div style="float:right; width: 32px;">[[File:start-here.png|link=]]</div>
<h3>Általános Lua Segítség</h3>
Oldalak a Lua megértésehez:
*[http://www.lua.org/pil/index.html "Lua Programozás" Kézikönyv]
**[http://www.lua.org/manual/5.1/#index Lua belső/beépített függvények]
*[http://lua-users.org/wiki/TutorialDirectory Lua Wiki]
*[http://nixstaller.berlios.de/manual/0.2/nixstaller_9.html Nixstaller Lua útmutatója]
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Preferences-system.png|link=]]</div>
<h3>Referenciák</h3>
* [[HU/Client Scripting Functions|Kliens-oldali függvények]]
* [[HU/Client Scripting Events|Kliens-oldali események]]
* [[HU/Server Scripting Functions|Szerver-oldali függvények]]
* [[HU/Server Scripting Events|Szerver-oldali események]]

* [[HU/MTA Classes|MTA Osztályok]] - MTA osztályok részletes leírása
** [[HU/Element|MTA Elemek]] / [[Element tree|Element ágak]]
</div>
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:System-file-manager.png|link=]]</div>
<h3>[[Id|ID Lista]]</h3>
*[[HU/Animations|Animációk]]
*[[HU/Character Skins|Karakter skinek]]
*[[CJ_Clothes|CJ Ruhái]]
*[[HU/Garage|Garázs ID listák]]
*[[Interior IDs|Interiorok]]
*[[Material IDs|Material]]
*[[HU/Ped voices|Ped hangok]]
*[[HU/Projectiles|Lövedékek]]
*[[HU/Radar Blips|Radar jelzések]]
*[[HU/Sounds|Hangok]]
*[[HU/Vehicle IDs|Járművek]]
*[[Vehicle Colors|Jármű színek]]
*[[HU/Vehicle Upgrades|Jármű fejlesztések]]
*[[HU/Vehicle variants|Járművek egyedi tulajdonságai]]
*[[HU/Vehicle component manipulation|Jármű komponens változtatások]]
*[[HU/Weapons|Fegyverek]]
*[[HU/Weather|Időjárás]]
</div>
<div style="padding:4px 8px 8px 8px; margin:10px;">
[[File:Osi symbol.png|75px|link=http://opensource.org/|left]]
A '''Multi Theft Auto''' '''nyílt forráskódú'''.
<br/>Ez azt jelenti, hogy a játékot bárki jobbá teheti!
</div>
|-
| colspan="2" |
|}
{| width="100%" cellspacing="0" cellpadding="0"
| colspan="2" |
<div style="padding-left: 15px; padding-right: 15px;" class="plainlinks">
[[File:MTALogo_8ball.png|left|85px|link=Archive]]
<ul style="list-style: none; width: 200px; float: left;">
<li>'''A [[Multi Theft Auto]] - ról'''</li>
<li>[[Archive|Archívum]]</li>
<li>[[Press Coverage|Sajtó]]</li>
<li>[http://code.google.com/p/mtasa-blue/people/list Fejlesztők]</li>
</ul>
<ul style="list-style: none; width: 200px; float: left;">
<li>'''Multi Theft Auto 0.5'''</li>
<li>[[Archive#Multi_Theft_Auto_0.5|Letöltés]]</li>
<li>[[MTA 0.5r2 Known Issues|Ismert hibák]]</li>
</ul>
<ul style="list-style: none; width: 200px; float: left;">
<li>'''Wiki Statisztikák'''</li>
<li>{{NUMBEROFARTICLES}} cikk</li>
<li>{{NUMBEROFPAGES}} oldal</li>
<li>{{NUMBEROFUSERS}} regisztrált felhasználó</li>
</ul>
</div>
|}

__NOTOC__
__NOEDITSECTION__
{{Languages list|en}}

Main Page

2024-10-13T17:36:37Z

LopSided:

<div style="display: flex; align-items: center; padding-left: 15px; padding-right: 15px;">
[[File:Mtalogo.png||100px|link=https://wiki.multitheftauto.com/]]
<div style="margin-left: .5em">
'''Welcome to the [[Multi Theft Auto]] wiki.''' On this wiki you'll find a wealth of information on using Multi Theft Auto.

There are many [[How you can help|things you can do to help us]] improve MTA - create a map, a gamemode, help document scripting functions, write example code, write tutorials or just play MTA and report the bugs you find.

If you have any questions or problems related to scripting, feel free to get in touch with us on [[Places To Chat#Scripting Help|Discord]].

<span style="margin-top: 1em; display: block;">[ Stop playing with yourself ]</span>
</div>
</div>

<div style="display: flex; flex-direction: row; flex-wrap: wrap;">

<div style="flex-grow: 1"> 
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Input-gaming.png‎|link=]]</div>
<h3>Play</h3>
<div class="downloadmta" style="background: #FFEEAA; border: 1px solid #FFCD19;">
[[File:Go-down.png|link=https://multitheftauto.com/]] ''' [https://multitheftauto.com/ Download Multi Theft Auto: San Andreas {{Current Version|full}}]'''</div>
* [[Where to buy GTASA]]
* [[Client Manual]]

* [[Changes_in_{{padleft:|5|{{Current Version|full}}}}|Changes in {{padleft:|5|{{Current Version|full}}}}]]
* [[Known_Issues_-_FAQ|Known Issues]]
* [[Server Manual]]
* [[Map manager|Map Manager]]

<h3>Map Editor</h3>
*[[Resource:Editor|Manual]]
*[[Resource:Editor/EDF|Editor Definition Format]]
*[[Resource:Editor/Plugins|Plugins]]
*[[Resource:Editor#FAQ|Frequently Asked Questions]]
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Package-x-generic.png‎|link=]]</div>
<h3>Databases</h3>
This section outlines all the Lua capabilites MTA or resources provide.
* [[:Category:Resource|Resource Catalogue]] - You must learn these to make proper scripts
* [[Client side scripts]]
* [[Modules]]
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Applications-development.png‎‎‎|link=]]</div>
<h3>Developing Multi Theft Auto</h3>
[[File:Go-down.png|link=https://nightly.mtasa.com/]] [https://nightly.mtasa.com/ Nightly builds]
* [[Compiling_MTASA|Compiling MTASA on Windows]]

* [[Building_MTASA_Server_on_GNU_Linux|Compiling MTASA on GNU/Linux]]
* [[Coding guidelines]]
* [https://github.com/multitheftauto/mtasa-blue Main GitHub repository]
* [[Roadmap]]
* [https://github.com/multitheftauto/mtasa-blue/issues Bugtracker]
* [[Branches]]
*[[Forks|Forks and anti cheat]]
</div>
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Applications-office.png|link=]]</div>
<h3>Wiki - How can you help</h3>
* Finish documentation for [[:Category:Incomplete|Incomplete functions]].
* [[:Category:Needs_Example |Add examples to functions and events]].
* Review and verify [[:Category:Needs Checking|pages that need checking]].
* Write tutorials to help new people.
* Translate wiki pages.
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Internet-group-chat.png‎|link=]]</div>
<h3>Community</h3>
* [https://forum.multitheftauto.com/ Forum]
* Community Discord: [https://discord.com/invite/mtasa Official MTA Discord server] ([https://forum.multitheftauto.com/topic/95008-multi-theft-autos-official-discord-server/ Forum post])
* Development Discord: [https://discord.com/invite/GNN6PRtTnu Server invite link]
* [https://community.multitheftauto.com/ MTA Community] - Share and download resources.
* [https://twitter.com/MTAQA Twitter] - [https://www.youtube.com/user/MTAQA YouTube] - [https://www.facebook.com/multitheftauto Facebook] - [https://www.moddb.com/mods/multi-theft-auto-san-andreas ModDB]
</div>
</div> 

<div style="flex-grow: 1"> 
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Accessories-text-editor.png|link=]]</div>
<h3>Scripting</h3>
* [[Scripting Introduction|Introduction to Scripting]]
* [[Introduction to Scripting the GUI]]
* [[Debugging|Debugging Tutorial]] - How to find errors in your scripts
* [[Resources|Introduction to Resources]]
** [[Resource Web Access]] - How you can write websites with resources
** [[CEF_Tutorial|CEF Tutorial]] - How you can use the in-game web browser in your resources
** [[:Category:Resource|Resource Catalogue]]
** [[Meta.xml]] - Behind every resource is a meta file that defines it
** [[ACL]] - Access Control List, this is vital for complex scripts to work
* [[Writing_Gamemodes|Writing Gamemodes]]
* [[Script security]] - How to write safe scripts and not be afraid of cheaters
Forum Links
* [https://forum.multitheftauto.com/forum/71-scripting/ Scripting Sub-Forum], [https://forum.multitheftauto.com/forum/123-tutorials/ Scripting Tutorials Sub-Forum]
* [https://forum.multitheftauto.com/topic/24702-mtasa-wiki-offline-copies-online-mirrors/ Offline Wiki Copies]
<div style="float:right; width: 32px;">[[File:start-here.png|link=]]</div>
<h3>General Lua Help</h3>
Pages designed to aid your understanding of Lua
*[http://www.lua.org/pil/index.html "Programming in Lua" Manual]
**[http://www.lua.org/manual/5.1/#index Internal Lua functions reference]
*[http://lua-users.org/wiki/TutorialDirectory Lua Wiki]
*[http://nixstaller.sourceforge.net/manual/0.5.1/nixstaller_10.html A general guide to Lua from Nixstaller]
</div>

<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:Preferences-system.png|link=]]</div>
<h3>Reference</h3>
* [[Client Scripting Functions|Client-side Functions]]
* [[Client Scripting Events|Client-side Events]]
* [[Server Scripting Functions|Server-side Functions]]
* [[Server Scripting Events|Server-side Events]]
* [[Useful Functions]]

* [[MTA Classes]] - Detailed descriptions of all MTA custom types
** [[Element|MTA Elements]] / [[Element tree]]
</div>
<div style="border: 1px solid #D8D8D8; padding:4px 8px 8px 8px; margin:10px;">
<div style="float:right; width: 32px;">[[File:System-file-manager.png|link=]]</div>
<h3>[[Id|ID Lists]]</h3>
*[[Animations|Animations]]
*[[Character Skins]]
*[[CJ_Clothes|Clothing styles]]
*[[Garage|Garage IDs]]
*[[Interior IDs]]
*[[Material IDs]]
*[[Ped voices|Ped Voices]]
*[[Projectiles]]
*[[Radar Blips]]
*[[Sounds]]
*[[Vehicle IDs]]
*[[Vehicle Colors]]
*[[Vehicle Upgrades]]
*[[Vehicle variants|Vehicle Variants]]
*[[Vehicle component manipulation]]
*[[Weapons|Weapons]]
*[[Weather]]
</div>
</div> 
</div> 


<div style="display: flex; flex-wrap: wrap; align-items: center; padding-left: 15px; padding-right: 15px;" class="plainlinks">
<span style="margin-right: 1em;">[[File:MTALogo_8ball.png||85px|link=Archive]]</span>

<div style="display: flex; flex-wrap: wrap;>
<div style="margin-right: 5em;">
'''About [[Multi Theft Auto]]''' <br>
[[Archive]] <br>
[[Press Coverage]] <br>
[https://github.com/multitheftauto/mtasa-blue/graphs/contributors Developers]
</div>

<div style="margin-right: 5em;">
'''Multi Theft Auto 0.5''' <br>
[[Archive#Multi_Theft_Auto_0.5|Download]] <br>
[[MTA 0.5r2 Known Issues|Known Issues]]
</div>

<div style="margin-right: 5em;">
'''Wiki Stats''' <br>
{{NUMBEROFARTICLES}} Articles <br>
{{NUMBEROFPAGES}} Pages <br>
{{NUMBEROFUSERS}} Registered Users <br>
</div>

<div>
[[File:Osi symbol.png|75px|link=https://opensource.org/|left]]
'''Multi Theft Auto''' is '''Open Source'''.
<br/>This means anyone can contribute to making Multi Theft Auto even better!
</div>
</div>

</div>

__NOTOC__
__NOEDITSECTION__
{{Languages list|en}}

TestCustomVars

2024-10-13T03:43:53Z

LopSided: Created page with "Current skin: {{CURRENT_SKIN}} {{#ifeq: {{CURRENT_SKIN}} | darkvector | Congrats, you're using the best skin! }}"

Current skin: {{CURRENT_SKIN}}

{{#ifeq: {{CURRENT_SKIN}} | darkvector
| Congrats, you're using the best skin!
}}

User:LopSided

2024-10-13T03:40:06Z

LopSided: Blanked the page

User:LopSided

2024-10-13T03:35:52Z

LopSided:

Current skin: {{CURRENT_SKIN}}

{{#ifeq: {{CURRENT_SKIN}} | darkvector
| Congrats, you're using the best skin!
}}

User:LopSided

2024-10-13T03:17:59Z

LopSided:

User:LopSided

2024-10-12T21:47:15Z

LopSided: Created page with "{{CurrentSkin}}"

Template:CurrentSkin

2024-10-12T21:44:48Z

LopSided: Created page with "<div id='current-skin-value></div>"

File:7dfJyoO6 2x.jpg

2024-04-03T20:53:59Z

LopSided:

Template:Server client function

2024-03-13T18:47:08Z

LopSided: Undo revision 78887 by RubyCommunity (talk)

#REDIRECT [[Template:Shared function]]

GetPlayerSerial

2024-02-02T16:15:37Z

LopSided:

__NOTOC__
{{Shared function}}
This function returns the [[serial]] for a specified [[player]].
{{Note|It's possible for a player to fake the value returned from getPlayerSerial when used on the clientside. For this reason you should only trust the value returned by this function when used serverside. }}
{{Important Note|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getSerial|serial|}}
===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player.

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.
</section>

==Syntax==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( )
</syntaxhighlight>
{{OOP||[[localPlayer]]:getSerial||}}
===Required Arguments===
None

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.
</section>

==Serverside examples==
<section name="Server" class="server" show="true">
This example creates a command with which player can check their own serial.
<syntaxhighlight lang="lua">
function checkMySerial( thePlayer, command )
local theSerial = getPlayerSerial( thePlayer )
if theSerial then
outputChatBox( "Your serial is: " .. theSerial, thePlayer )
else
outputChatBox( "Sorry, you have no serial. =(", thePlayer )
end
end
addCommandHandler( "myserial", checkMySerial )
</syntaxhighlight>

This example adds a command to ban a player's serial.
<syntaxhighlight lang="lua">
local function banSerialCommand ( source, command, playerName, reason )
if playerName then
local player, serial = getPlayerFromName ( playerName ), getPlayerSerial ( playerName )
if player then
addBan ( serial, source, reason )
end
end
end
addCommandHandler ( "banplayerserial", banSerialCommand )
</syntaxhighlight>

This example only allows clients with a certain serial to log in into an account.
<syntaxhighlight lang="lua">
local allowedAccountSerials =
{
-- List of allowed serials to log in into an account. Format:
-- [ Account name ] = { Allowed serial array }
[ "3ash8" ] = { "9C9F3B55D9D7BB7135FF274D3BF444E4" },
[ "test5" ] = { "1D6F76CF8D7193792D13789849498452" },
}

addEventHandler("onPlayerLogin", root,
function(_, account)
-- Get the player serial and the allowed serial list for that account
-- (If no serial is allowed for the account, do not allow the player to log in as a safety measure)
local playerSerial, allowedSerials = getPlayerSerial(source), allowedAccountSerials[getAccountName(account)] or {}
-- Check whether the client has an allowed serial or not
for i = 1, #allowedSerials do
if allowedSerials[i] == playerSerial then
-- The serial is allowed. Proceed with the normal log in proccess
return
end
end
-- If we reach this point the serial is not allowed. Do not let the player log in
cancelEvent(true, "Client serial not allowed to log in into the account")
end
)
</syntaxhighlight>
</section>
==See Also==
{{Player functions}}

[[ar:getPlayerSerial]]
[[en:GetPlayerSerial]]

GetPlayerSerial

2024-02-02T15:58:39Z

LopSided:

__NOTOC__
{{Shared function}}
This function returns the [[serial]] for a specified [[player]].
{{Important Note|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getSerial|serial|}}
===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player.

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.
</section>

==Syntax==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( )
</syntaxhighlight>
{{OOP||[[localPlayer]]:getSerial||}}
===Required Arguments===
None

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.
</section>

==Serverside examples==
<section name="Server" class="server" show="true">
This example creates a command with which player can check their own serial.
<syntaxhighlight lang="lua">
function checkMySerial( thePlayer, command )
local theSerial = getPlayerSerial( thePlayer )
if theSerial then
outputChatBox( "Your serial is: " .. theSerial, thePlayer )
else
outputChatBox( "Sorry, you have no serial. =(", thePlayer )
end
end
addCommandHandler( "myserial", checkMySerial )
</syntaxhighlight>

This example adds a command to ban a player's serial.
<syntaxhighlight lang="lua">
local function banSerialCommand ( source, command, playerName, reason )
if playerName then
local player, serial = getPlayerFromName ( playerName ), getPlayerSerial ( playerName )
if player then
addBan ( serial, source, reason )
end
end
end
addCommandHandler ( "banplayerserial", banSerialCommand )
</syntaxhighlight>

This example only allows clients with a certain serial to log in into an account.
<syntaxhighlight lang="lua">
local allowedAccountSerials =
{
-- List of allowed serials to log in into an account. Format:
-- [ Account name ] = { Allowed serial array }
[ "3ash8" ] = { "9C9F3B55D9D7BB7135FF274D3BF444E4" },
[ "test5" ] = { "1D6F76CF8D7193792D13789849498452" },
}

addEventHandler("onPlayerLogin", root,
function(_, account)
-- Get the player serial and the allowed serial list for that account
-- (If no serial is allowed for the account, do not allow the player to log in as a safety measure)
local playerSerial, allowedSerials = getPlayerSerial(source), allowedAccountSerials[getAccountName(account)] or {}
-- Check whether the client has an allowed serial or not
for i = 1, #allowedSerials do
if allowedSerials[i] == playerSerial then
-- The serial is allowed. Proceed with the normal log in proccess
return
end
end
-- If we reach this point the serial is not allowed. Do not let the player log in
cancelEvent(true, "Client serial not allowed to log in into the account")
end
)
</syntaxhighlight>
</section>
==See Also==
{{Player functions}}

[[ar:getPlayerSerial]]
[[en:GetPlayerSerial]]

GetPlayerSerial

2024-02-02T15:57:06Z

LopSided: Update clientside usage info

__NOTOC__
{{Shared function}}
This function returns the [[serial]] for a specified [[player]].
{{Important Note|You should '''use this function''' in conjunction '''with account system''' (e.g: '''login & password''') - especially for critical things, because '''serials could be invalid''' (as in, '''non-unique''' or '''faked'''). See: [https://wiki.multitheftauto.com/wiki/Script_security Script security].}}

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getSerial|serial|}}
===Required Arguments===
*'''thePlayer:''' A [[player]] object referencing the specified player.

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.
</section>

==Syntax==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
string getPlayerSerial ( )
</syntaxhighlight>
{{OOP||[[localPlayer]]:getSerial|serial|}}
===Required Arguments===
None

==Returns==
Returns the serial as a ''string'' if it was found, ''false'' otherwise.
</section>

==Serverside examples==
<section name="Server" class="server" show="true">
This example creates a command with which player can check their own serial.
<syntaxhighlight lang="lua">
function checkMySerial( thePlayer, command )
local theSerial = getPlayerSerial( thePlayer )
if theSerial then
outputChatBox( "Your serial is: " .. theSerial, thePlayer )
else
outputChatBox( "Sorry, you have no serial. =(", thePlayer )
end
end
addCommandHandler( "myserial", checkMySerial )
</syntaxhighlight>

This example adds a command to ban a player's serial.
<syntaxhighlight lang="lua">
local function banSerialCommand ( source, command, playerName, reason )
if playerName then
local player, serial = getPlayerFromName ( playerName ), getPlayerSerial ( playerName )
if player then
addBan ( serial, source, reason )
end
end
end
addCommandHandler ( "banplayerserial", banSerialCommand )
</syntaxhighlight>

This example only allows clients with a certain serial to log in into an account.
<syntaxhighlight lang="lua">
local allowedAccountSerials =
{
-- List of allowed serials to log in into an account. Format:
-- [ Account name ] = { Allowed serial array }
[ "3ash8" ] = { "9C9F3B55D9D7BB7135FF274D3BF444E4" },
[ "test5" ] = { "1D6F76CF8D7193792D13789849498452" },
}

addEventHandler("onPlayerLogin", root,
function(_, account)
-- Get the player serial and the allowed serial list for that account
-- (If no serial is allowed for the account, do not allow the player to log in as a safety measure)
local playerSerial, allowedSerials = getPlayerSerial(source), allowedAccountSerials[getAccountName(account)] or {}
-- Check whether the client has an allowed serial or not
for i = 1, #allowedSerials do
if allowedSerials[i] == playerSerial then
-- The serial is allowed. Proceed with the normal log in proccess
return
end
end
-- If we reach this point the serial is not allowed. Do not let the player log in
cancelEvent(true, "Client serial not allowed to log in into the account")
end
)
</syntaxhighlight>
</section>
==See Also==
{{Player functions}}

[[ar:getPlayerSerial]]
[[en:GetPlayerSerial]]

Template:Player events

2023-11-28T19:21:08Z

LopSided: Update version

<ul>
<li>[[onPlayerACInfo]]</li>
<li>[[onPlayerBan]]</li>
<li>[[onPlayerChangeNick]]</li>
<li>[[onPlayerChat]]</li>
<li>[[onPlayerClick]]</li>
<li>[[onPlayerCommand]]</li>
<li>[[onPlayerConnect]]</li>
<li>[[onPlayerContact]]</li>
<li>[[onPlayerDamage]]</li>
{{Added feature/item|1.6.1|1.6.0|22293|
<li>[[onPlayerDetonateSatchels]]</li>
}}
<li>[[onPlayerJoin]]</li>
<li>[[onPlayerLogin]]</li>
<li>[[onPlayerLogout]]</li>
<li>[[onPlayerMarkerHit]]</li>
<li>[[onPlayerMarkerLeave]]</li>
<li>[[onPlayerModInfo]]</li>
<li>[[onPlayerMute]]</li>
<li>[[onPlayerNetworkStatus]]</li>
<li>[[onPlayerPickupHit]]</li>
{{New items|3.0156|1.5.5|
<li>[[onPlayerPickupLeave]]</li>
|11783}}
<li>[[onPlayerPickupUse]]</li>
<li>[[onPlayerPrivateMessage]]</li>
{{Added feature/item|1.6.1|1.6.0|22293|
<li>[[onPlayerProjectileCreation]]</li>
}}
<li>[[onPlayerQuit]]</li>
<li>[[onPlayerScreenShot]]</li>
<li>[[onPlayerSpawn]]</li>
<li>[[onPlayerStealthKill]]</li>
<li>[[onPlayerTarget]]</li>
{{Added feature/item|1.6.1|1.6.0|22313|
<li>[[onPlayerTriggerEventThreshold]]</li>
}}
<li>[[onPlayerUnmute]]</li>
<li>[[onPlayerVehicleEnter]]</li>
<li>[[onPlayerVehicleExit]]</li>
<li>[[onPlayerVoiceStart]]</li>
<li>[[onPlayerVoiceStop]]</li>
<li>[[onPlayerWasted]]</li>
<li>[[onPlayerWeaponFire]]</li>
<li>[[onPlayerWeaponSwitch]]</li>
</ul>

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

OnPlayerTriggerEventThreshold

2023-11-28T19:20:38Z

LopSided: Update version

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22313|This event is triggered when a player exceeds the maximum threshold for events via [[triggerServerEvent]].}}

During each interval (''player_triggered_event_interval''), all usage of [[triggerServerEvent]] will be counted for each player. This includes registered events, non-registered events and non-remote events.

If the count exceeds ''max_player_triggered_events_per_interval'', this event will be fired. The count is reset each interval.

You can set these options via [[setServerConfigSetting]].

==Parameters==
None

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who exceeded the threshold.

===Canceling===
Canceling this event has no effect.

==Example==
<syntaxhighlight lang="lua">
function processPlayerTriggerEventThreshold()
kickPlayer(source, "Event spam")
end
addEventHandler("onPlayerTriggerEventThreshold", root, processPlayerTriggerEventThreshold)

</syntaxhighlight>
{{See also/Server event|Player events}}

OnPlayerTriggerEventThreshold

2023-11-27T14:01:02Z

LopSided: /* Example */

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22311|This event is triggered when a player exceeds the maximum threshold for events via [[triggerServerEvent]].}}

During each interval (''player_triggered_event_interval''), all usage of [[triggerServerEvent]] will be counted for each player. This includes registered events, non-registered events and non-remote events.

If the count exceeds ''max_player_triggered_events_per_interval'', this event will be fired. The count is reset each interval.

You can set these options via [[setServerConfigSetting]].

==Parameters==
None

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who exceeded the threshold.

===Canceling===
Canceling this event has no effect.

==Example==
<syntaxhighlight lang="lua">
function processPlayerTriggerEventThreshold()
kickPlayer(source, "Event spam")
end
addEventHandler("onPlayerTriggerEventThreshold", root, processPlayerTriggerEventThreshold)

</syntaxhighlight>
{{See also/Server event|Player events}}

OnPlayerTriggerEventThreshold

2023-11-27T13:55:48Z

LopSided:

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22311|This event is triggered when a player exceeds the maximum threshold for events via [[triggerServerEvent]].}}

During each interval (''player_triggered_event_interval''), all usage of [[triggerServerEvent]] will be counted for each player. This includes registered events, non-registered events and non-remote events.

If the count exceeds ''max_player_triggered_events_per_interval'', this event will be fired. The count is reset each interval.

You can set these options via [[setServerConfigSetting]].

==Parameters==
None

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who exceeded the threshold.

===Canceling===
Canceling this event has no effect.

==Example==
<syntaxhighlight lang="lua">
function start()
setServerConfigSetting("player_triggered_event_interval", "500") -- set event usage interval to 500ms (default is 1000)
setServerConfigSetting("max_player_triggered_events_per_interval", "50") -- set max events per interval to 50 (default is 100)
end
addEventHandler("onResourceStart", resourceRoot, start)

function processPlayerTriggerEventThreshold()
kickPlayer(source, "Event spam")
end
addEventHandler("onPlayerTriggerEventThreshold", root, processPlayerTriggerEventThreshold)

</syntaxhighlight>
{{See also/Server event|Player events}}

OnPlayerTriggerEventThreshold

2023-11-27T13:51:56Z

LopSided: Created page with "__NOTOC__ {{Server event}} {{Added feature/item|1.6.1|1.6.0|22311|This event is triggered when a player exceeds the maximum threshold for events via triggerServerEvent.}} ==Parameters== None ==Source== The source of this event is the player who exceeded the threshold. ===Canceling=== Canceling this event has no effect. ==Example== <syntaxhighlight lang="lua"> function start() setServerConfigSetting("player_triggered_event_inte..."

__NOTOC__
{{Server event}}
{{Added feature/item|1.6.1|1.6.0|22311|This event is triggered when a player exceeds the maximum threshold for events via [[triggerServerEvent]].}}
==Parameters==
None

==Source==
The [[event system#Event source|source]] of this event is the [[player]] who exceeded the threshold.

===Canceling===
Canceling this event has no effect.

==Example==
<syntaxhighlight lang="lua">
function start()
setServerConfigSetting("player_triggered_event_interval", "500") -- set event usage interval to 500ms (default is 1000)
setServerConfigSetting("max_player_triggered_events_per_interval", "50") -- set max events per interval to 50 (default is 100)
end
addEventHandler("onResourceStart", resourceRoot, start)

function processPlayerTriggerEventThreshold()
kickPlayer(source, "Event spam")
end
addEventHandler("onPlayerTriggerEventThreshold", root, processPlayerTriggerEventThreshold)

</syntaxhighlight>
{{See also/Server event|Player events}}

Template:Player events

2023-11-27T13:45:37Z

LopSided:

<ul>
<li>[[onPlayerACInfo]]</li>
<li>[[onPlayerBan]]</li>
<li>[[onPlayerChangeNick]]</li>
<li>[[onPlayerChat]]</li>
<li>[[onPlayerClick]]</li>
<li>[[onPlayerCommand]]</li>
<li>[[onPlayerConnect]]</li>
<li>[[onPlayerContact]]</li>
<li>[[onPlayerDamage]]</li>
{{Added feature/item|1.6.1|1.6.0|22293|
<li>[[onPlayerDetonateSatchels]]</li>
}}
<li>[[onPlayerJoin]]</li>
<li>[[onPlayerLogin]]</li>
<li>[[onPlayerLogout]]</li>
<li>[[onPlayerMarkerHit]]</li>
<li>[[onPlayerMarkerLeave]]</li>
<li>[[onPlayerModInfo]]</li>
<li>[[onPlayerMute]]</li>
<li>[[onPlayerNetworkStatus]]</li>
<li>[[onPlayerPickupHit]]</li>
{{New items|3.0156|1.5.5|
<li>[[onPlayerPickupLeave]]</li>
|11783}}
<li>[[onPlayerPickupUse]]</li>
<li>[[onPlayerPrivateMessage]]</li>
{{Added feature/item|1.6.1|1.6.0|22293|
<li>[[onPlayerProjectileCreation]]</li>
}}
<li>[[onPlayerQuit]]</li>
<li>[[onPlayerScreenShot]]</li>
<li>[[onPlayerSpawn]]</li>
<li>[[onPlayerStealthKill]]</li>
<li>[[onPlayerTarget]]</li>
{{Added feature/item|1.6.1|1.6.0|22311|
<li>[[onPlayerTriggerEventThreshold]]</li>
}}
<li>[[onPlayerUnmute]]</li>
<li>[[onPlayerVehicleEnter]]</li>
<li>[[onPlayerVehicleExit]]</li>
<li>[[onPlayerVoiceStart]]</li>
<li>[[onPlayerVoiceStop]]</li>
<li>[[onPlayerWasted]]</li>
<li>[[onPlayerWeaponFire]]</li>
<li>[[onPlayerWeaponSwitch]]</li>
</ul>

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

SetServerConfigSetting

2023-11-27T13:44:14Z

LopSided:

__NOTOC__
{{Server function}}
This function sets server settings which are stored in the [[Server mtaserver.conf|mtaserver.conf]] file.
{{Note|This function is protected by default and must be explicitly allowed in the servers acl before it can be used.}}
{{Warning|"bandwidth_reduction" set to 'maximum' will cause player movement synchronization issues, on locations built outside 3000m radius from world center.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setServerConfigSetting ( string name, string value [, bool bSave = false ] )
</syntaxhighlight>

===Required Arguments===
*'''name :''' The name of the setting. Only certain settings from [[Server mtaserver.conf|mtaserver.conf]] can be changed with this function. These are:
** minclientversion
** recommendedclientversion
** password
** fpslimit - (0-100)
** networkencryption - 0 for off, 1 for on
** bandwidth_reduction - "none", "medium", "maximum" Set to maximum for less bandwidth usage (medium is recommended for race servers)
** player_sync_interval - See [[Sync_interval_settings]] for all *_sync_interval settings
** lightweight_sync_interval
** camera_sync_interval
** ped_sync_interval
** unoccupied_vehicle_sync_interval
** keysync_mouse_sync_interval
** keysync_analog_sync_interval
** bullet_sync
** player_triggered_event_interval
** max_player_triggered_events_per_interval
*'''value:''' The value of the setting

===Optional Arguments===
*'''bSave:''' Set to ''true'' to make the setting permanent, or ''false'' for use only until the next server restart.

===Returns===
Returns ''true'' if the setting was successfully set, or ''false'' otherwise.

==Example==
This example enables network encryption
<syntaxhighlight lang="lua">
setServerConfigSetting( "networkencryption", "1", true )
</syntaxhighlight>

==See Also==
{{Utility functions}}

DxDrawModel3D

2023-10-17T03:08:52Z

LopSided:

__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|22271|
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]] in order to display continuously.
}}

{{Disabled|Feature temporarily removed in 22272 due to feedback||3212}}

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

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

===Required Arguments===
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds
* '''positionX/Y/Z:''' Position of model
* '''rotationX/Y/Z:''' Rotation of model

===Optional Arguments===
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}

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

==Example==
<section name="Client" class="client" show="true">
Simple example
<syntaxhighlight lang="lua">
addEventHandler("onClientPreRender", root, function()
dxDrawModel3D(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)
end)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

Template:Disabled

2023-10-17T03:08:37Z

LopSided:

{{MessageBox|
bordercolorhex = FF0000 |
bgcolorhex = E5E5E5 |
image = File:Dialog-warning.png |
title = {{#ifeq: {{padleft:|2|{{lc:{{PAGENAME}}}}}}|on|Event|Function}} has been disabled. |
subtext = {{ #if: {{{1|}}} | '''Reason/Note:''' {{{1|}}} }} {{ #if: {{{2|}}} | - '''Bugtracker Issue:''' [http://bugs.mtasa.com/view.php?id={{{2}}} #{{{2}}}] }} {{ #if: {{{3|}}} | - '''Bugtracker Issue:''' [https://github.com/multitheftauto/mtasa-blue/issues/{{{3}}} #{{{3}}}] }} |
}}
<includeonly>{{ #ifeq: {{NAMESPACE}}|Help||[[Category:Disabled Functions and Events]]}}</includeonly>
<noinclude>[[Category:Utility templates]]</noinclude>

Template:Disabled

2023-10-17T03:06:55Z

LopSided:

{{MessageBox|
bordercolorhex = FF0000 |
bgcolorhex = E5E5E5 |
image = File:Dialog-warning.png |
title = {{#ifeq: {{padleft:|2|{{lc:{{PAGENAME}}}}}}|on|Event|Function}} has been disabled. |
subtext = {{ #if: {{{1|}}} | '''Reason/Note:''' {{{1|}}} }} {{ #if: {{{2|}}} | - '''Bugtracker Issue:''' [http://bugs.mtasa.com/view.php?id={{{2}}} #{{{2}}}] }} {{ #if: {{{3|}}} | - '''Bugtracker Issue:''' [https://github.com/multitheftauto/mtasa-blue/issues/{{{2}}} #{{{2}}}] }} |
}}
<includeonly>{{ #ifeq: {{NAMESPACE}}|Help||[[Category:Disabled Functions and Events]]}}</includeonly>
<noinclude>[[Category:Utility templates]]</noinclude>

DxDrawModel3D

2023-10-17T03:04:32Z

LopSided:

__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|22271|
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]] in order to display continuously.
}}

{{Disabled|Feature temporarily removed in 22272 due to feedback|https://github.com/multitheftauto/mtasa-blue/issues/3212}}

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

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

===Required Arguments===
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds
* '''positionX/Y/Z:''' Position of model
* '''rotationX/Y/Z:''' Rotation of model

===Optional Arguments===
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}

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

==Example==
<section name="Client" class="client" show="true">
Simple example
<syntaxhighlight lang="lua">
addEventHandler("onClientPreRender", root, function()
dxDrawModel3D(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)
end)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

Template:Drawing functions

2023-10-14T06:22:35Z

LopSided:

<ul>
<li>[[dxConvertPixels]]</li>
<li>[[dxCreateFont]]</li>
<li>[[dxCreateRenderTarget]]</li>
<li>[[dxCreateScreenSource]]</li>
<li>[[dxCreateShader]]</li>
<li>[[dxCreateTexture]]</li>
{{New items|3.0156|1.5.5|
<li>[[dxDrawCircle]]</li>
|13977}}
<li>[[dxDrawImage]]</li>
<li>[[dxDrawImageSection]]</li>
<li>[[dxDrawLine]]</li>
<li>[[dxDrawLine3D]]</li>
<li>[[dxDrawMaterialLine3D]]</li>
<li>[[dxDrawMaterialPrimitive]]</li>
<li>[[dxDrawMaterialPrimitive3D]]</li>
<li>[[dxDrawMaterialSectionLine3D]]</li>
{{New feature/item|3.0161|1.6.0|22271|
<li>[[dxDrawModel3D]]</li>
}}
<li>[[dxDrawPrimitive]]</li>
<li>[[dxDrawPrimitive3D]]</li>
<li>[[dxDrawRectangle]]</li>
<li>[[dxDrawText]]</li>
{{New items|3.0158|1.5.7|
<li>[[dxDrawWiredSphere]]</li>
|20328}}
<li>[[dxGetBlendMode]]</li>
<li>[[dxGetFontHeight]]</li>
<li>[[dxGetMaterialSize]]</li>
<li>[[dxGetPixelColor]]</li>
<li>[[dxGetPixelsSize]]</li>
<li>[[dxGetPixelsFormat]]</li>
<li>[[dxGetStatus]]</li>
{{New items|3.0158|1.5.7|
<li>[[dxGetTextSize]]</li>
|20447}}
<li>[[dxGetTextWidth]]</li>
<li>[[dxGetTexturePixels]]</li>
<li>[[dxIsAspectRatioAdjustmentEnabled]]</li>
<li>[[dxSetAspectRatioAdjustmentEnabled]]</li>
<li>[[dxSetBlendMode]]</li>
<li>[[dxSetPixelColor]]</li>
<li>[[dxSetRenderTarget]]</li>
<li>[[dxSetShaderValue]]</li>
<li>[[dxSetShaderTessellation]]</li>
<li>[[dxSetShaderTransform]]</li>
<li>[[dxSetTestMode]]</li>
<li>[[dxSetTextureEdge]]</li>
<li>[[dxSetTexturePixels]]</li>
<li>[[dxUpdateScreenSource]]</li>
</ul>

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

DxDrawModel3D

2023-10-14T06:21:55Z

LopSided:

__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|22271|
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]] in order to display continuously.
}}

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

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

===Required Arguments===
* '''modelId:''' Model you want to draw, must be regular object, you can not draw vehicles and peds
* '''positionX/Y/Z:''' Position of model
* '''rotationX/Y/Z:''' Rotation of model

===Optional Arguments===
* '''scaleX/Y/Z:''' Scale of model, by default {1,1,1}

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

==Example==
<section name="Client" class="client" show="true">
Simple example
<syntaxhighlight lang="lua">
addEventHandler("onClientPreRender", root, function()
dxDrawModel3d(3276, -719.64984, 951.26685, 12.13281, 0, 0,90)
end)
</syntaxhighlight>
</section>

==See Also==
{{Drawing_functions}}

SetDiscordRichPresenceStartTime

2023-10-12T16:42:47Z

LopSided:

__NOTOC__
{{Client function}}
{{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
This function sets the elapsed time of Discord Rich Presence.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceStartTime(int seconds)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setStartTime}}

===Required arguments===
*'''seconds''': an integer representing the number of seconds that has elapsed. If 0, the timer will not be displayed.

===Returns===
Returns ''true'' if function succeeds, ''false'' otherwise.

==Example==
This example shows how to change the elapsed timer of the Discord Rich Presence application.
<syntaxhighlight lang="lua">
local app_key = "YOUR_APPLICATION_KEY"
if setDiscordApplicationID(app_key) then
setDiscordRichPresenceState("In-game")
setDiscordRichPresenceStartTime(1)
end
</syntaxhighlight>

==See Also==
{{Client_Discord_functions}}

[[ar:setDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

SetDiscordRichPresenceEndTime

2023-10-12T16:42:37Z

LopSided: Created page with "__NOTOC__ {{Client function}} {{Important Note|To use this function, you must set up your own application setDiscordApplicationID}} {{New feature/item|3.0161|1.6.0|22270| This function sets the remaining time of Discord Rich Presence. }} ==Syntax== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceEndTime(int seconds) </syntaxhighlight> {{OOP||DiscordRPC:setEndTime}} ===Required arguments=== *'''seconds''': an integer representing the number of seconds..."

__NOTOC__
{{Client function}}
{{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
This function sets the remaining time of Discord Rich Presence.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceEndTime(int seconds)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setEndTime}}

===Required arguments===
*'''seconds''': an integer representing the number of seconds that are remaining. If 0, or lower than the start time ([[setDiscordRichPresenceStartTime]]) the timer will not be displayed.

===Returns===
Returns ''true'' if function succeeds, ''false'' otherwise.

==Example==
This example shows how to change the remaining timer of the Discord Rich Presence application.
<syntaxhighlight lang="lua">
local app_key = "YOUR_APPLICATION_KEY"
if setDiscordApplicationID(app_key) then
setDiscordRichPresenceState("In-game")
setDiscordRichPresenceStartTime(60)
setDiscordRichPresenceEndTime(60)
end
</syntaxhighlight>

==See Also==
{{Client_Discord_functions}}

[[ar:setDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

SetDiscordRichPresencePartySize

2023-10-12T06:39:28Z

LopSided:

__NOTOC__
{{Client function}}
{{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}}
{{Note|For the party size to be displayed, the state must be set [[setDiscordRichPresenceState]]}}
{{New feature/item|3.0161|1.6.0|22270|
This function sets the party size of Discord Rich Presence.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setDiscordRichPresencePartySize(int size, int max)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setPartySize}}

===Required arguments===
*'''size''': an integer representing the current party size.
*'''max''': an integer representing the maximum party size.

'''If both values are 0, the party size will not be displayed'''

===Returns===
Returns ''true'' if function succeeds, ''false'' otherwise.

==Example==
This example shows how to change the party size of the Discord Rich Presence application.
<syntaxhighlight lang="lua">
local app_key = "YOUR_APPLICATION_KEY"
if setDiscordApplicationID(app_key) then
setDiscordRichPresenceState("In-game")
setDiscordRichPresencePartySize(1, 32)
end
</syntaxhighlight>

==See Also==
{{Client_Discord_functions}}

[[ar:setDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

Template:Client Discord functions

2023-10-12T06:38:53Z

LopSided:

{{New items|3.0161|1.6.0|
<ul>
<li>[[isDiscordRichPresenceConnected]]</li>
<li>[[resetDiscordRichPresenceData]]</li>
<li>[[setDiscordApplicationID]]</li>
<li>[[setDiscordRichPresenceAsset]]</li>
<li>[[setDiscordRichPresenceButton]]</li>
<li>[[setDiscordRichPresenceDetails]]</li>
<li>[[setDiscordRichPresenceSmallAsset]]</li>
<li>[[setDiscordRichPresenceState]]</li>
</ul>
|22270}}

{{New items|3.0161|1.6.0|
<ul>
<li>[[setDiscordRichPresencePartySize]]</li>
<li>[[setDiscordRichPresenceStartTime]]</li>
</ul>
<noinclude>[[Category:Functions templates]]</noinclude>
|22271}}

Template:Client Discord functions

2023-10-12T06:38:11Z

LopSided:

{{New items|3.0161|1.6.0|
<ul>
<li>[[isDiscordRichPresenceConnected]]</li>
<li>[[resetDiscordRichPresenceData]]</li>
<li>[[setDiscordApplicationID]]</li>
<li>[[setDiscordRichPresenceAsset]]</li>
<li>[[setDiscordRichPresenceButton]]</li>
<li>[[setDiscordRichPresenceDetails]]</li>
<li>[[setDiscordRichPresencePartySize]]</li>
<li>[[setDiscordRichPresenceSmallAsset]]</li>
<li>[[setDiscordRichPresenceStartTime]]</li>
<li>[[setDiscordRichPresenceState]]</li>
</ul>
|22270}}

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

SetDiscordRichPresencePartySize

2023-10-12T06:37:24Z

LopSided: Created page with "__NOTOC__ {{Client function}} {{Important Note|To use this function, you must set up your own application setDiscordApplicationID}} {{Note|For the party size to be displayed, the state must be set setDiscordRichPresenceState}} {{New feature/item|3.0161|1.6.0|22270| This function sets the party size of Discord Rich Presence. }} ==Syntax== <syntaxhighlight lang="lua"> bool setDiscordRichPresencePartySize(int size, int max) </syntaxhighlight> {{OOP||DiscordRPC..."

__NOTOC__
{{Client function}}
{{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}}
{{Note|For the party size to be displayed, the state must be set [[setDiscordRichPresenceState]]}}
{{New feature/item|3.0161|1.6.0|22270|
This function sets the party size of Discord Rich Presence.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setDiscordRichPresencePartySize(int size, int max)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setPartySize}}

===Required arguments===
*'''size''': an integer representing the current party size.
*'''max''': an integer representing the maximum party size.

===Returns===
Returns ''true'' if function succeeds, ''false'' otherwise.

==Example==
This example shows how to change the party size of the Discord Rich Presence application.
<syntaxhighlight lang="lua">
local app_key = "YOUR_APPLICATION_KEY"
if setDiscordApplicationID(app_key) then
setDiscordRichPresenceState("In-game")
setDiscordRichPresencePartySize(1, 32)
end
</syntaxhighlight>

==See Also==
{{Client_Discord_functions}}

[[ar:setDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

SetDiscordRichPresenceStartTime

2023-10-12T06:35:12Z

LopSided: Created page with "__NOTOC__ {{Client function}} {{Important Note|To use this function, you must set up your own application setDiscordApplicationID}} {{New feature/item|3.0161|1.6.0|22270| This function sets the elapsed time of Discord Rich Presence. }} ==Syntax== <syntaxhighlight lang="lua"> bool setDiscordRichPresenceStartTime(int seconds) </syntaxhighlight> {{OOP||DiscordRPC:setDetails}} ===Required arguments=== *'''seconds''': an integer representing the number of seconds..."

__NOTOC__
{{Client function}}
{{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
This function sets the elapsed time of Discord Rich Presence.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceStartTime(int seconds)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setDetails}}

===Required arguments===
*'''seconds''': an integer representing the number of seconds that has elapsed. If 0, the timer will not be displayed.

===Returns===
Returns ''true'' if function succeeds, ''false'' otherwise.

==Example==
This example shows how to change the elapsed timer of the Discord Rich Presence application.
<syntaxhighlight lang="lua">
local app_key = "YOUR_APPLICATION_KEY"
if setDiscordApplicationID(app_key) then
setDiscordRichPresenceState("In-game")
setDiscordRichPresenceStartTime(1)
end
</syntaxhighlight>

==See Also==
{{Client_Discord_functions}}

[[ar:setDiscordRichPresenceDetails]]
[[de:setDiscordRichPresenceDetails]]
[[hu:setDiscordRichPresenceDetails]]
[[pl:setDiscordRichPresenceDetails]]
[[ro:setDiscordRichPresenceDetails]]
[[ru:SetDiscordRichPresenceDetails]]
[[PT-BR:SetDiscordRichPresenceDetails]]

Template:Client Discord functions

2023-10-11T22:13:53Z

LopSided:

{{New items|3.0161|1.6.0|
<ul>
<li>[[isDiscordRichPresenceConnected]]</li>
<li>[[resetDiscordRichPresenceData]]</li>
<li>[[setDiscordApplicationID]]</li>
<li>[[setDiscordRichPresenceAsset]]</li>
<li>[[setDiscordRichPresenceButton]]</li>
<li>[[setDiscordRichPresenceDetails]]</li>
<li>[[setDiscordRichPresenceSmallAsset]]</li>
<li>[[setDiscordRichPresenceState]]</li>
</ul>
|22270}}

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

SetDiscordRichPresenceState

2023-10-11T22:13:33Z

LopSided:

__NOTOC__
{{Client function}}
{{Important Note|To use this function, you must set up your own application [[setDiscordApplicationID]]}}
{{New feature/item|3.0161|1.6.0|22270|
This function sets the status of the Discord Rich Presence application.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setDiscordRichPresenceState(string state)
</syntaxhighlight>
{{OOP||[[DiscordRPC]]:setState}}

===Required arguments===
*'''state''': a string containing the status text

===Returns===
Returns ''true'' if function succeeds, ''false'' otherwise.

==Example==
This example shows how to set the state of the Discord Rich Presence application.
<syntaxhighlight lang="lua">
local app_key = "YOUR_APPLICATION_KEY"
if setDiscordApplicationID(app_key) then
setDiscordRichPresenceState("waiting in lobby")
end
</syntaxhighlight>

==See Also==
{{Client_Discord_functions}}

[[ar:setDiscordRichPresenceState]]
[[de:setDiscordRichPresenceState]]
[[hu:setDiscordRichPresenceState]]
[[pl:setDiscordRichPresenceState]]
[[ro:setDiscordRichPresenceState]]
[[ru:SetDiscordRichPresenceState]]
[[PT-BR:SetDiscordRichPresenceState]]