Multi Theft Auto: Wiki - User contributions [en]

Server mtaserver.conf

2020-09-30T07:32:13Z

Emiliano Castro: Revert last changes

This page lists the settings that can be set in the settings file. ''Setting from the default '''mtaserver.conf''' settings file is in italics''.

====servername====
:''<servername>Default MTA Server</servername>''
:This parameter specifies the name the server will be visible as in the ingame server browser and on Game-Monitor. It is a required parameter.

====owner_email_address====
:''<owner_email_address></owner_email_address>''
:This parameter specifies the contact email addresses for the owner(s) of this server.
:The email addresses will not be publicly available, and only used by MTA administrators to contact the server owner.
:Note: Missing or incorrect owner_email_address can affect visibility in the master server list.
:Values: Comma separated list of email addresses

====serverip====
:''<serverip>auto</serverip>
:'''ONLY USE THIS PARAMETER IF YOU ARE SURE OF WHAT YOU ARE DOING''' - it is generally only needed for complex network topologies and should be left at the default value otherwise.
: This parameter specifies the public IP address that the server will announce to the MTA servers, for the purposes of registering itself in the master server list and receiving some internal status updates. Usually, setting this parameter is only useful for some specialized scenarios, like servers that can be reached by multiple public addresses, or when a firewall is used for controlling incoming connections. If set to auto, the public IP address the requests originate from will be used as the server IP for communicating with MTA servers, which works fine in most cases.
:Values: auto or x.x.x.x ; default value: auto
:SERVERIP SHOULD BE LEFT SET TO auto UNLESS YOU ARE SURE OF WHAT YOU ARE DOING
:WARNING: SETTING serverip AND THEN ASKING FOR SUPPORT CAN CAUSE DEATH OR INJURY

====serverport====
:''<serverport>22003</serverport>
:This parameter specifies the UDP port on which the server will be accepting incoming player connections;
:default value: 22003. It is a required parameter.

====maxplayers====
:''<maxplayers>32</maxplayers>
:This parameter specifies the number of maximum player slots available on the server;
:default value: 32. It is a required parameter.

====httpserver====

:''<httpserver>1</httpserver>
:This parameter specifies whether the built-in http server will be used.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpport====
:''<httpport>22005</httpport>
:This parameter specifies the TCP port on which the server will be accepting incoming http connections. It can be set to the same value as <serverport>. It is a required parameter if <httpserver> is set to 1.
:More information: [[Server_Manual#Using_the_web_interface|Using the web interface]]

====httpdownloadurl====
:''<httpdownloadurl></httpdownloadurl>
:If set, this parameter specifies the external URL from which clients will be able to download needed resources ingame. Otherwise they will download them directly from the server.
:More information: [[Server_Manual#Configuring_an_external_web_server|Configuring an external web server]]

====httpmaxconnectionsperclient====
:''<httpmaxconnectionsperclient>5</httpmaxconnectionsperclient>
:This parameter limits the number of http connections each client can make. Depending on the type of http server that is used, a lower figure may reduce download timeouts. Only relevant when using an external http server.
:Available range: 1 to 8.

====httpdosthreshold====
:''<httpdosthreshold>20</httpdosthreshold>
:This parameter limits the number http connections that an IP can initiate over a short period of time.
:Available range: 1 to 100. default value: 20

====http_dos_exclude====
:''<http_dos_exclude></http_dos_exclude>
:This parameter lists the IP addresses that are to be excluded from http dos threshold limits.
:e.g. 88.11.22.33,101.2.3.4

====allow_gta3_img_mods====
:''<allow_gta3_img_mods>none</allow_gta3_img_mods>
:By default, the server will block the use of locally customized gta3.img player skins
:This setting can be used to allow such mods. Not recommended for competitive servers.
:Values: none, peds ; default value: none

====client_file====
:''<nowiki></nowiki>
:By default, the server will block the use of customized GTA:SA data files.
:To allow specific client files, add one or more of the above lines.
:More information: [[Anti-cheat_guide#.3Cclient_file_name.3D.22data.2Fcarmods.dat.22_verify.3D.220.22.2F.3E|Anti-cheat guide]]

====disableac====
:''<disableac></disableac>
:Comma separated list of disabled anti-cheats.
:e.g. To disable anti-cheat #2 and #3, use: 2,3
:More information: [[Anti-cheat_guide#.3Cdisableac.3E.3C.2Fdisableac.3E|Anti-cheat guide]]

====enablesd====
:''<enablesd>31,32</enablesd>
:Comma separated list of enabled special detections. A special detection is a type of anti-cheat for (usually) harmless game modifications.
:Competitive servers may wish to enable certain special detections, but most servers should leave this setting on its default.
:Values: special detection (SD) codes ; default value: 31,32 (e.g. enables special detections #31 and #32)
:More information: [[Anti-cheat_guide#.3Cenablesd.3E.3C.2Fenablesd.3E|Anti-cheat guide]]

====minclientversion====
:''<minclientversion></minclientversion>
:Minimum client version. Clients with a lower version will not be allowed to connect. After disconnection, clients will be given an opportunity to download an update. If left blank, this setting is disabled and there are no restrictions on who can connect. Version numbers are described in [[getPlayerVersion]] and look like this: 1.1.0-9.03100.0
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[http://nightly.mtasa.com/ver highest available]].'''

====minclientversion_auto_update====
:''<minclientversion_auto_update>1</minclientversion_auto_update>
:This parameter specifies if/when the <minclientversion> setting is automatically updated.
:Keeping <minclientversion> updated can help reduce cheating.
:Note: The instant setting (2) is only recommended for competitive servers.
:Values: 0 - disabled, 1 - enabled (delayed by a few days), 2 - enabled (instant) ; default value: 1.

====recommendedclientversion====
:''<recommendedclientversion></recommendedclientversion>
:Recommended client version. When connecting, if clients have a lower version, they will be given the option to download an update. If left blank, this setting is disabled.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]
:'''Note that this setting only determines if the client should be prompted to update. The actual build number they receive will be the [[http://nightly.mtasa.com/ver highest available]].'''

====ase====
:''<ase>1</ase>
:This parameter can be used to make the server report to Game-Monitor master servers, allowing it to be visible in the in-game server browser. An additional UDP port needs to be available for this to work (value from <serverport> + 123 , so on a default <serverport> value 22003 the right port will be 22126 ).
:Available values: 0 - disabled , 1 - enabled. Optional parameter, defaults to 0.

====donotbroadcastlan====
:''<donotbroadcastlan>0</donotbroadcastlan>
:This parameter allows you to disable LAN broadcasting.

====password====
:''<password></password>
:If set, players will have to provide a password specified below, before they can connect to the server. If left blank, server doesn't require a password from them.
:This parameter can changed and saved while the server is running with [[setServerPassword]] or [[setServerConfigSetting]]

====bandwidth_reduction====
:''<bandwidth_reduction>medium</bandwidth_reduction>
:This parameter reduces the server's bandwidth usage by using various optimizations.
:Values: none, medium or maximum ; default value: medium
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====unoccupied_vehicle_syncer_distance====

:''<unoccupied_vehicle_syncer_distance>130</unoccupied_vehicle_syncer_distance>
:This parameter determines the distance limit for remote synced unoccupied vehicles
:Available range: 50 - 400; default value: 130
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====ped_syncer_distance====

:''<ped_syncer_distance>100</ped_syncer_distance>
:This parameter determines the distance limit for remote synced peds
:Available range: 50 - 400; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====player_sync_interval====
:''<player_sync_interval>100</player_sync_interval>
:This parameter determines the time in milliseconds between player sync packets.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====lightweight_sync_interval====
:''<lightweight_sync_interval>1500</lightweight_sync_interval>
:This parameter determines the time in milliseconds between lightweight (player) sync packets.
:Available range: 200 - 4000; default value: 1500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====camera_sync_interval====
:''<camera_sync_interval>500</camera_sync_interval>
:This parameter determines the time in milliseconds between camera sync packets.
:Available range: 200 - 400; default value: 500
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====ped_sync_interval====
:''<ped_sync_interval>400</ped_sync_interval>
:This parameter determines the time in milliseconds between ped sync packets.
:Available range: 200 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====unoccupied_vehicle_sync_interval====
:''<unoccupied_vehicle_sync_interval>400</unoccupied_vehicle_sync_interval>
:This parameter determines the time in milliseconds between unoccupied vehicle sync packets.
:Available range: 200 - 4000; default value: 400
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_mouse_sync_interval====
:''<keysync_mouse_sync_interval>100</keysync_mouse_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to mouse movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====keysync_analog_sync_interval====
:''<keysync_analog_sync_interval>100</keysync_analog_sync_interval>
:This parameter determines the minimum time in milliseconds between key sync packets due to joystick movement.
:Available range: 50 - 500; default value: 100
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]
:Suggested values for this and the other sync_interval settings can be found here: [[Sync_interval_settings|Sync interval settings]]

====bullet_sync====
:''<bullet_sync>1</bullet_sync>
:This parameter can improve the reliability of shots when using certain weapons. However, it uses more bandwidth.
:Note that bullet sync will be active regardless of this setting when certain [[setGlitchEnabled|glitches]] are enabled.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====vehext_percent====
:''<vehext_percent>0</vehext_percent>
:This parameter sets the amount of extrapolation that clients will apply to remote vehicles.
:This can reduce some of the latency induced location disparency by predicting where the remote vehicles will probably be.
:Depending on the gamemode, an incorrect prediction may have a negative effect.
:Therefore this setting should be considered experimental.
:Available range: 0 to 100. Default - 0

====vehext_ping_limit====
:''<vehext_ping_limit>150</vehext_ping_limit>
:This parameter places a limit on how much time (in milliseconds) the vehicle extrapolation will attempt to compensate for.
:Only relevant if <vehext_percent> is greater than zero.
:Available range: 50 to 500. Default - 150

====latency_reduction====
:''<latency_reduction>0</latency_reduction>
:This parameter can reduce the delay of player actions appearing on remote clients by 2 frames (approx 50ms).
:Due to the impact this may have on shot lag compensation, it should be considered experimental.
:Values: 0 - disabled , 1 - enabled ; default value: 0.
:Bugs caused by enabling latency_reduction: http://bugs.mtasa.com/view.php?id=8191 + http://bugs.mtasa.com/view.php?id=8226

====threadnet====

:''<threadnet>1</threadnet>
:This parameter specifies whether or not to run the network synchronization on another thread.
:Enabling will make the sync smoother, but may increase CPU usage slightly.
:Values: 0 - disabled , 1 - enabled ; default value: 1.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====idfile====
:''<idfile>server-id.keys</idfile>
:Specifies the location and file name of this servers unique private key. This is used to prevent private files saved on the client from being read by other servers.
:Keep a backup of this file in a safe place. Default value: server-id.keys
:More information about client private files: [[Filepath]]

====logfile====
:''<logfile>logs/server.log</logfile>
:Specifies the location and name of the main server log file. If left blank, server won't be saving this file.

====authfile====
:''<authfile>logs/server_auth.log</authfile>
:As well as the main log file, login successes and failures are logged here for easy reviewing of security issues. If left blank, this file is not used

====dbfile====
:''<dbfile>logs/db.log</dbfile>
:Specifies the location and name of the file used to log database queries. The server command [[Server_Commands#debugdb|debugdb]] sets the amount of logging.

====loadstringfile====
:''<nowiki></nowiki>
:Specifies the location and name of the file used to log loadstring function calls. If left blank or not set, no logging is done.

====acl====
:''<acl>acl.xml</acl>
:This parameter specifies the location and name of the Access Control List settings file. If left
:blank, server will use acl.xml file, located in the same folder as this configuration file.

====scriptdebuglogfile====
:''<scriptdebuglogfile>logs/scripts.log</scriptdebuglogfile>
:Specifies the location and name of the debugscript log file. If left blank, server won't be saving this file.

====scriptdebugloglevel====
:''<scriptdebugloglevel>0</scriptdebugloglevel>
:Specifies the level of the debugscript log file. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====htmldebuglevel====
:''<htmldebuglevel>0</htmldebuglevel>
:Specifies the level of the html debug. Available values: 0, 1, 2, 3. When not set, defaults to 0.

====filter_duplicate_log_lines====
:''<filter_duplicate_log_lines>1</filter_duplicate_log_lines>
:Specifies whether or not duplicate log lines should be filtered. Available values: 0 or 1, defaults to 1.

====fpslimit====
:''<fpslimit>36</fpslimit>
:Specifies the frame rate limit that will be applied to connecting clients.
:Available range: 25 to 100. Default: 36.
:When running the map editor locally (i.e. from the client), the default FPS limit is 50.
:This parameter can be changed and saved while the server is running with [[setServerConfigSetting]]

====voice====
:''<voice>0</voice>
:This parameter specifies whether or not to enable player voice chat in-game
:Values: 0 - disabled , 1 - enabled

====voice_samplerate====
:''<voice_samplerate>1</voice_samplerate>
:This parameter specifies the sample rate for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the sampling quality of voice chat
:Values: 0 - Narrowband (8kHz), 1 - Wideband (16kHz), 2 - Ultrawideband (32kHz). Default - 1

====voice_quality====
:''<voice_quality>4</voice_quality>
:This parameter specifies the voice quality for voice chat. 'voice' parameter must be set to 1 for this to be effective. Higher settings use more bandwidth and increase the the overall quality of voice chat
:Available range: 0 to 10. Default - 4

====voice_bitrate====
:''<nowiki></nowiki>
:Specifies the voice bitrate, in bps. This optional parameter overrides the previous two settings. If not set, MTA handles this automatically. Use with care.

====backup_path====
:''<backup_path>backups</backup_path>
:This parameter specifies the path to use for a basic backup of some server files. Note that basic backups are only made during server startup. Default value: backups

====backup_interval====
:''<backup_interval>3</backup_interval>
:This parameter specifies the number of days between each basic backup. Backups are only made during server startup, so the actual interval maybe much longer. Setting backup_interval to 0 will disable backups
:Available range: 0 to 30. Default - 3

====backup_copies====
:''<backup_copies>10</backup_copies>
:This parameter specifies the maximum number of backup copies to keep. Setting backup_copies to 0 will disable backups
:Available range: 0 to 100. Default - 10

====compact_internal_databases====
:''<compact_internal_databases>1</compact_internal_databases>
:This parameter specifies when the internal sqlite databases should be defragmented.
:For more info see: http://www.sqlite.org/lang_vacuum.html
:Values: 0 - Never, 1 - On server start only after basic backup, 2 - On server start always. Default - 1

====crash_dump_upload====
:''<crash_dump_upload>1</crash_dump_upload>
:This parameter specifies whether server crash dump files should be sent to MTA HQ.
:Values: 0 - Off, 1 - On. Default - 1

====fakelag====

:''<fakelag>0</fakelag>
:This parameter specifies whether the [[Command fakelag|fakelag and sfakelag]] commands are enabled
:Values: 0 - Off, 1 - On. Default - 0

====auth_serial_groups====
:''<auth_serial_groups>Admin</auth_serial_groups>
:This parameter lists the ACL groups that are protected by serial authorization.
:Login attempts to a protected account from a second serial are blocked until the serial is manually authorized via the authserial command.
:For more info see: https://mtasa.com/authserial
:Note: This is security critical feature and disabling auth_serial_groups can affect visibility in the master server list.
:Values: Comma separated list of ACL groups. Default - Admin

====auth_serial_http====
:''<auth_serial_http>1</auth_serial_http>
:This parameter specifies if the authorized serial login checks should also apply to the http interface.
:Protected account login attempts to the http interface will only succeed if the IP address matches one recently used by the account holder in-game.
:For more info see: https://mtasa.com/authserialhttp
:Note: This is security critical feature and disabling auth_serial_http can affect visibility in the master server list.
:Values: 0 - Off, 1 - Enabled. Default - 1

====auth_serial_http_ip_exceptions====
:''<auth_serial_http_ip_exceptions>127.0.0.1</auth_serial_http_ip_exceptions>
:This parameter specifies which IP addresses should always pass auth_serial_http checks.
:Values: Comma separated list of IP addresses

====database_credentials_protection====
:''<database_credentials_protection>1</database_credentials_protection>
:This parameter specifies if extra security measures are applied to resources which use [[dbConnect]] with MySQL.
:The extra measures are:
: - script files cannot be accessed with [[fileOpen]]
: - [[meta.xml]] is read-only
:'''NOTE:''' This only protects resources which use [[dbConnect]] with MySQL.
:Values: 0 - Off, 1 - Enabled. Default - 1

====module====
:''<nowiki></nowiki>
:''<nowiki></nowiki>
:Specifies the module(s) which are loaded with the server. To load several modules, add more <module> parameter(s). Optional parameter.

====resource====
:''<resource src="admin" startup="1" protected="0" />
:''<resource src="defaultstats" startup="1" protected="0" />
:''<resource src="helpmanager" startup="1" protected="0" />
:''<resource src="joinquit" startup="1" protected="0" />
:''<resource src="mapcycler" startup="1" protected="0" />
:''<resource src="mapmanager" startup="1" protected="0" />
:''<resource src="parachute" startup="1" protected="0" />
:''<resource src="resourcebrowser" startup="1" protected="1" default="true" />
:''<resource src="resourcemanager" startup="1" protected="1" />
:''<resource src="scoreboard" startup="1" protected="0" />
:''<resource src="spawnmanager" startup="1" protected="0" />
:''<resource src="voice" startup="1" protected="0" />
:''<resource src="votemanager" startup="1" protected="0" />
:''<resource src="webadmin" startup="1" protected="0" />
:''<resource src="play" startup="1" protected="0" />

:Specifies persistent resources which are loaded when the server starts. Persistent resources are not stopped even if all the other resources that depend on them stop; that is, the only way to stop them is by explicitly using the ''stop'' server command or [[stopResource]] scripting function. To load several resources, add more <resource> parameters.

:In addition, there are several flags which control how the server deals with each resource:

:* '''src''': the resource name. This is the only mandatory flag.
:* '''startup''': controls whether the resource will be started with the server or not. If "1", "true" or "yes", the resource will be started. If not specified, defaults to not starting the resource.
:* '''protected''': if "1", "true" or "yes", the resource will not be able to be stopped when started. Otherwise, even if not specified, it will default to the normal behaviour.
:* '''default''': if given a "1", "true" or "yes" value, this resource will be the one who populates the built-in HTTP server main page, which is seen when no resource is given in the web address. It is not possible to have more than one default resource.

==Deprecated settings==

The following settings have been deprecated in the production version of MTA:SA and no longer work.

====networkencryption====

:''<networkencryption>1</networkencryption>
:This parameter specifies whether communications between the server and client is encrypted. Encryption can help prevent network data being viewed and modified.
:Values: 0 - disabled , 1 - enabled ; default value: 1. Optional parameter.
:This parameter can changed and saved while the server is running with [[setServerConfigSetting]]

====autologin====

:''<autologin>0</autologin>
:Specifies whether or not players should automatically be logged in based on their IP adresses.
:Values: 0 - disabled , 1 - enabled ; default value: 0.

[[Category: Support]]
[[ru:Server mtaserver.conf]]

PHP SDK

2019-10-04T15:15:21Z

Emiliano Castro:

__NOTOC__
You can access the MTA Web Interface from almost any programming language that can request web pages. PHP can do this very easily.

This SDK provides one function call that will allow you to call any exported script functions on any server that you have access to.

See the [https://wiki.multitheftauto.com/wiki/PHP_SDK official wiki page] for further information.

== Installation ==

=== Prerequisites ===

This SDK requires PHP 7.1 or greater.

=== HTTPlug client abstraction ===

As this SDK uses HTTPlug, you will have to require some libraries for get it working. See [http://docs.php-http.org/en/latest/httplug/users.html “HTTPlug for library users”] for more info.

:warning: '''Note''': If you don’t follow this requirement before require the SDK, composer will throw you an error.

=== Setup ===

The only supported installation method is via [https://getcomposer.org Composer]. Run the following command to require this SDK in your project:

<pre>composer require multitheftauto/mtasa-php-sdk</pre>
== A simple example ==

There are three ways to call an MTA server’s exported functions, as shown in the following example:

<syntaxhighlight lang="php">
<?php

require_once('vendor/autoload.php');

use MultiTheftAuto\Sdk\Mta;
use MultiTheftAuto\Sdk\Model\Server;
use MultiTheftAuto\Sdk\Model\Authentication;

$server = new Server('127.0.0.1', 22005);
$auth = new Authentication('myUser', 'myPassword');
$mta = new Mta($server, $auth);

$response = $mta->getResource('someResource')->call('callableFunction', $arg1, $arg2, $arg3, ...);
// or
$response = $mta->getResource('someResource')->call->callableFunction($arg1, $arg2, $arg3, ...);

var_dump($response);
</syntaxhighlight>

==A page that can be called by [[callRemote]]==
This example just adds two numbers passed to it by a lua script.

'''PHP:''' (for the page that LUA expects to be at ''<nowiki>http://www.example.com/page.php</nowiki>'')
<syntaxhighlight lang="php">
<?php

require_once('vendor/autoload.php');

use MultiTheftAuto\Sdk\Mta;

$input = Mta::getInput();
Mta::doReturn($input[0] + $input[1]);
</syntaxhighlight>

'''LUA:'''
<syntaxhighlight lang="lua">
-- result is called when the function returns
function result(sum)
outputChatBox(sum)
end
function addNumbers(number1, number2)
callRemote ( "http://www.example.com/page.php", result, number1, number2 )
end
addNumbers ( 123, 456 ) -- call the function
</syntaxhighlight>

== Releases ==

Visit [https://github.com/multitheftauto/mtasa-php-sdk/releases the releases page on GitHub] to download the SDK.

=== Note for Python ===

There is a community made Python SDK with the same semantics on [https://gitlab.com/OwlGamingCommunity/mta-python-sdk the OwlGaming Gitlab] for use on Python projects.

== Version History ==

You can see in the [https://github.com/multitheftauto/mtasa-php-sdk/blob/master/CHANGELOG.md repository changelog file] the changes applied.

[[Category:Tutorials]]

PHP SDK

2019-10-04T01:30:25Z

Emiliano Castro:

__NOTOC__
You can access the MTA Web Interface from almost any programming language that can request web pages. PHP can do this very easily.

This SDK provides one function call that will allow you to call any exported script functions on any server that you have access to.

See the [https://wiki.multitheftauto.com/wiki/PHP_SDK official wiki page] for further information.

== Installation ==

=== Prerequisites ===

This SDK requires PHP 7.1 or greater.

=== HTTPlug client abstraction ===

As this SDK uses HTTPlug, you will have to require some libraries for get it working. See [http://docs.php-http.org/en/latest/httplug/users.html “HTTPlug for library users”] for more info.

:warning: '''Note''': If you don’t follow this requirement before require the SDK, composer will throw you an error.

=== Setup ===

The only supported installation method is via [https://getcomposer.org Composer]. Run the following command to require this SDK in your project:

<pre>composer require multitheftauto/mtasa-php-sdk</pre>
== A simple example ==

There are three ways to call an MTA server’s exported functions, as shown in the following example:

<syntaxhighlight lang="php">
<?php

require_once('vendor/autoload.php');

use MultiTheftAuto\Sdk\Mta;
use MultiTheftAuto\Sdk\Model\Server;
use MultiTheftAuto\Sdk\Model\Authentication;

$server = new Server('127.0.0.1', 22005);
$auth = new Authentication('myUser', 'myPassword');
$mta = new Mta($server, $auth);

$response = $mta->getResource('someResource')->call('callableFunction', $arg1, $arg2, $arg3, ...);
// or
$response = $mta->getResource('someResource')->call->callableFunction($arg1, $arg2, $arg3, ...);

var_dump($response);
</syntaxhighlight>

==A page that can be called by [[callRemote]]==
This example just adds two numbers passed to it by a lua script.

'''PHP:''' (for the page that LUA expects to be at ''<nowiki>http://www.example.com/page.php</nowiki>'')
<syntaxhighlight lang="php">
<?php

require_once('vendor/autoload.php');

$input = Mta::getInput();
Mta::doReturn($input[0] + $input[1]);
</syntaxhighlight>

'''LUA:'''
<syntaxhighlight lang="lua">
-- result is called when the function returns
function result(sum)
outputChatBox(sum)
end
function addNumbers(number1, number2)
callRemote ( "http://www.example.com/page.php", result, number1, number2 )
end
addNumbers ( 123, 456 ) -- call the function
</syntaxhighlight>

== Releases ==

Visit [https://github.com/multitheftauto/mtasa-php-sdk/releases the releases page on GitHub] to download the SDK.

=== Note for Python ===

There is a community made Python SDK with the same semantics on [https://gitlab.com/OwlGamingCommunity/mta-python-sdk the OwlGaming Gitlab] for use on Python projects.

== Version History ==

You can see in the [https://github.com/multitheftauto/mtasa-php-sdk/blob/master/CHANGELOG.md repository changelog file] the changes applied.

[[Category:Tutorials]]

PHP SDK

2019-10-04T01:30:05Z

Emiliano Castro:

__NOTOC__
= MTA:SA PHP SDK =

You can access the MTA Web Interface from almost any programming language that can request web pages. PHP can do this very easily.

This SDK provides one function call that will allow you to call any exported script functions on any server that you have access to.

See the [https://wiki.multitheftauto.com/wiki/PHP_SDK official wiki page] for further information.

== Installation ==

=== Prerequisites ===

This SDK requires PHP 7.1 or greater.

=== HTTPlug client abstraction ===

As this SDK uses HTTPlug, you will have to require some libraries for get it working. See [http://docs.php-http.org/en/latest/httplug/users.html “HTTPlug for library users”] for more info.

:warning: '''Note''': If you don’t follow this requirement before require the SDK, composer will throw you an error.

=== Setup ===

The only supported installation method is via [https://getcomposer.org Composer]. Run the following command to require this SDK in your project:

<pre>composer require multitheftauto/mtasa-php-sdk</pre>
== A simple example ==

There are three ways to call an MTA server’s exported functions, as shown in the following example:

<syntaxhighlight lang="php">
<?php

require_once('vendor/autoload.php');

use MultiTheftAuto\Sdk\Mta;
use MultiTheftAuto\Sdk\Model\Server;
use MultiTheftAuto\Sdk\Model\Authentication;

$server = new Server('127.0.0.1', 22005);
$auth = new Authentication('myUser', 'myPassword');
$mta = new Mta($server, $auth);

$response = $mta->getResource('someResource')->call('callableFunction', $arg1, $arg2, $arg3, ...);
// or
$response = $mta->getResource('someResource')->call->callableFunction($arg1, $arg2, $arg3, ...);

var_dump($response);
</syntaxhighlight>

==A page that can be called by [[callRemote]]==
This example just adds two numbers passed to it by a lua script.

'''PHP:''' (for the page that LUA expects to be at ''<nowiki>http://www.example.com/page.php</nowiki>'')
<syntaxhighlight lang="php">
<?php

require_once('vendor/autoload.php');

$input = Mta::getInput();
Mta::doReturn($input[0] + $input[1]);
</syntaxhighlight>

'''LUA:'''
<syntaxhighlight lang="lua">
-- result is called when the function returns
function result(sum)
outputChatBox(sum)
end
function addNumbers(number1, number2)
callRemote ( "http://www.example.com/page.php", result, number1, number2 )
end
addNumbers ( 123, 456 ) -- call the function
</syntaxhighlight>

== Releases ==

Visit [https://github.com/multitheftauto/mtasa-php-sdk/releases the releases page on GitHub] to download the SDK.

=== Note for Python ===

There is a community made Python SDK with the same semantics on [https://gitlab.com/OwlGamingCommunity/mta-python-sdk the OwlGaming Gitlab] for use on Python projects.

== Version History ==

You can see in the [https://github.com/multitheftauto/mtasa-php-sdk/blob/master/CHANGELOG.md repository changelog file] the changes applied.

[[Category:Tutorials]]

DxDrawPrimitive

2018-10-07T15:15:46Z

Emiliano Castro:

__NOTOC__
{{Client function}}
{{New feature/item|3.0157|1.5.6|14203|This function draws a 2D primitive shape across the screen - rendered for one frame. This should be used in conjunction with [[onClientRender]] in order to display continuously.}}

==Syntax==
<syntaxhighlight lang="lua">
bool dxDrawPrimitive ( string pType, bool postGUI, table vertice1 [, table vertice2, ...] )
</syntaxhighlight>

===Required Arguments===
* '''pType:''' Type of primitive to be drawn.
* '''postGUI:''' A bool representing whether the line should be drawn on top of or behind any ingame GUI (rendered by CEGUI).
* '''vertices:''' Tables representing each primitive vertice, required amount of them is determined by primitive type.

==Allowed types==
[[Image:MTAsa_primitives.png|thumb|240px|Available primitive types.]]
More info on primitives may be found on [https://msdn.microsoft.com/en-us/library/windows/desktop/bb147291(v=vs.85).aspx this MSDN site]
* '''pointlist:''' Renders the vertices as a collection of isolated points.
* '''linelist:''' Renders the vertices as a list of isolated straight line segments.
* '''linestrip:''' Renders the vertices as a single polyline.
* '''trianglelist:''' Renders the specified vertices as a sequence of isolated triangles. Each group of three vertices defines a separate triangle.
* '''trianglestrip:''' Renders the vertices as a triangle strip.
* '''trianglefan:''' Renders the vertices as a triangle fan.

==Vertices format==
* '''posX:''' An float representing the absolute X position of the vertice, represented by pixels on the screen.
* '''posY:''' An float representing the absolute Y position of the vertice, represented by pixels on the screen.
* '''color (optional):''' An integer of the hex color, produced using [[tocolor]] or 0xAARRGGBB (AA = alpha, RR = red, GG = green, BB = blue). If it's not specified, white color is used.

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

==Example==
This is a small example that creates trianglefan primitive with vertices in places that user clicks. It assigns every vertice random color.
<syntaxhighlight lang="lua">
local vertices = {}
function onClick(btn, state, x, y)
if btn ~= "left" then return end
if state ~= "up" then return end
local vertice = {x, y, tocolor(math.random(255), math.random(255), math.random(255))}
table.insert(vertices, vertice)
end
addEventHandler("onClientClick", root, onClick)

function draw()
dxDrawPrimitive("trianglefan", true, unpack(vertices))
end
addEventHandler("onClientPreRender", root, draw)
</syntaxhighlight>

==See Also==
{{Drawing_functions}}

PHP SDK

2017-08-30T18:02:07Z

Emiliano Castro:

__NOTOC__
You can access the MTA Web Interface from almost any programming language that can request web pages using HTTP POST and encode and decode [[JSON]]. PHP can do this very easily.

This SDK provides one function ''call'' that will allow you to call any exported script functions on any server that you have access to.

The download below includes two example pages - one that shows a simple scoreboard, the other that shows the automatic handling of element and resource objects.

If you use this and make any improvements, feel free to send us a copy and we can host it for others to benefit from.

==Functions==
===call===
This function calls an exported function in a specific resource.

'''Syntax:'''
<syntaxhighlight lang="php">
$mtaServer = new mta( $hostname, $port, $username, $password );
$resource = $mtaServer->getResource ( $resourceName );
$returns[] = $resource->call ( "functionName" [,args...] );
</syntaxhighlight>

===getInput===
This function is for use with web pages that are called by [[callRemote]].

'''Syntax:'''
<syntaxhighlight lang="php">
$inputData = mta::getInput();
</syntaxhighlight>

===doReturn===
Use this function when you want to return data when a page is called with [[callRemote]]. You should '''NOT''' output any other data to the page, e.g. using ''echo'' as this will cause the return to fail.

'''Syntax:'''
<syntaxhighlight lang="php">
mta::doReturn( argument1, argument2 ... argumentN );
</syntaxhighlight>

==Examples==
<syntaxhighlight lang="php">
include( "mta_sdk.php" );
$mtaServer = new mta("bastage.net", 33004);
$resource = $mtaServer->getResource ( "echobot" );
$retn = $resource->call ( "getThisResource" ); // $retn is an array containing the values the function returned
$resourceElement = $retn[0]; // the first returned value is the resource
$retn = $resource->call ( "getResourceName", $resourceElement );
$resourceName = $retn[0]; // contains the name of the resource 'echobot'
</syntaxhighlight>

==Authentication==
If the server you are accessing requires authentication, you must pass the ''http_username'' and ''http_password'' variables to your instantiated instance of the mta() class.

'''Example:'''
<syntaxhighlight lang="php">
include( "mta_sdk.php" );
$mtaServer = new mta("example.com", 33004, "myUsername", "myPassword" );
$mtaServer->getResource("someResource")->call("someFunction");
</syntaxhighlight>

==A page that can be called by [[callRemote]]==
This example just adds two numbers passed to it by a lua script.

'''PHP:''' (for the page that LUA expects to be at ''<nowiki>http://www.example.com/page.php</nowiki>'')
<syntaxhighlight lang="php">
include( "mta_sdk.php" );
$input = mta::getInput();
mta::doReturn($input[0] + $input[1]);
</syntaxhighlight>
'''LUA:'''
<syntaxhighlight lang="lua">
-- result is called when the function returns
function result(sum)
outputChatBox(sum)
end
function addNumbers(number1, number2)
callRemote ( "http://www.example.com/page.php", result, number1, number2 )
end
addNumbers ( 123, 456 ) -- call the function
</syntaxhighlight>

==Caveats==
* This only works with PHP 5.0 and above.
* You cannot currently compare two Element instances that you expect to be identical - you need to do a "deep compare", comparing the "id" fields.

==Download==
=== Node for version 0.4 ===
On line 80 in mta_sdk.php you will find the string:
<syntaxhighlight lang="php">
echo $json_output;
</syntaxhighlight>

Replace that one with:
<syntaxhighlight lang="php">
//echo $json_output;
</syntaxhighlight>

Or remove it completly!

*[http://code.opencoding.net/mta/mtaphpsdk_0.4.zip Download Version 0.4] - Renamed ''public function mta(..)'' to ''public function __construct(..)''.
*[http://code.opencoding.net/mta/mtaphpsdk_0.3_fix.zip Download Version 0.3] - Neater syntax, support functions for [[callRemote]] (fix version makes call work with args).
*[http://misc.opencoding.net/mta/mtaphpsdk_0.2.zip Download Version 0.2] - ''Deprecated - Syntax differs from examples shown above.'' - Adds authentication support.
*[http://misc.opencoding.net/mta/mtaphpsdk_0.1.zip Download Version 0.1] - ''Deprecated - Syntax differs from examples shown above.''

SetTrainPosition

2017-08-25T01:17:00Z

Emiliano Castro:

__NOTOC__
{{Shared function}}
{{New feature/item|3.0153|1.5.3|7485|
Sets the position the train is currently on the track
}}

==Syntax==
<syntaxhighlight lang="lua">bool setTrainPosition ( vehicle train, float position )</syntaxhighlight>
{{OOP||[[vehicle]]:setTrainPosition|trainPosition|getTrainPosition}}
===Required Arguments===
*'''train:''' the train of which to set the track (0 - 18107 a complete way round)
*'''position:''' the position along the track

===Returns===
Returns ''true'' if the train position was set, ''false'' otherwise.

==Example==
<section name="OOP Example 1" class="server" show="true">
This example adds a command called "/settrainpos", allowing you to set the position of the train.
<syntaxhighlight lang="lua">local function setMyPosition(player, _, position)
-- grab the vehicle, if it exists
local veh = player.vehicle

-- make sure we're actually in a vehicle
if not veh then
player:outputChat("You are not in a vehicle!")
return
end

-- make sure we're in a train
if veh.vehicleType ~= "Train" then
player:outputChat("You are not in a train!")
return
end

-- convert position to a number
position = tonumber(position)

-- if position cannot be converted to a number
if not position then
player:outputChat("Syntax: /settrainpos <position>")
return
end

-- finally set the train position
veh.trainPosition = position
end
addCommandHandler("settrainpos", setMyPosition)</syntaxhighlight></section>

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

AddBan

2016-03-11T23:31:39Z

Emiliano Castro: Undo revision 46833 by Emiliano Castro (talk)

__NOTOC__
{{Server function}}
This function will add a [[ban]] for the specified IP/username/serial to the server.

==Syntax==
<syntaxhighlight lang="lua">
ban addBan ( [ string IP, string Username, string Serial, player responsibleElement, string reason, int seconds = 0 ] )
</syntaxhighlight>
'''Note:''' One of the three: IP, Username or Serial have to be specified.

===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]]

AddBan

2016-03-11T23:30:57Z

Emiliano Castro:

__NOTOC__
{{Server function}}
This function will add a [[ban]] for the specified IP/username/serial to the server.

==Syntax==
<syntaxhighlight lang="lua">
ban addBan ( string IP/Username/Serial [, player responsibleElement, string reason, int seconds = 0 ] )
</syntaxhighlight>
'''Note:''' One of the three: IP, Username or Serial have to be specified.

===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]]

CenterWindow

2016-02-19T16:14:45Z

Emiliano Castro:

{{Useful Function}}
__NOTOC__
This function center the window in any resolution.<br>
* '''NOTE:''' This is made to be used clientside!.

==Syntax==
<syntaxhighlight lang="lua">bool centerWindow( element TheElement )</syntaxhighlight>

===Required Arguments===
* '''theElement''': The element you want to center it.

==Code==
<section name="Clientside script" class="client" show="true">
<syntaxhighlight lang="lua">
function centerWindow (center_window)
local screenW, screenH = guiGetScreenSize()
local windowW, windowH = guiGetSize(center_window, false)
local x, y = (screenW - windowW) /2,(screenH - windowH) /2
return guiSetPosition(center_window, x, y, false)
end
</syntaxhighlight>
</section>

==Example==
This example center the window.
<syntaxhighlight lang="lua">
addEventHandler( "onClientResourceStart", resourceRoot, function()
myWindow = guiCreateWindow( 350, 100, 200, 250, "Window Title", false )
end )

addCommandHandler( "center", function()
if myWindow then
centerWindow( myWindow )
end
end )
</syntaxhighlight>

Author: laserlaser

==See Also==
{{Useful_Functions}}

SetPedLookAt

2016-01-26T18:12:29Z

Emiliano Castro:

__NOTOC__
{{Client function}}
{{Note|Avoid calling setPedLookAt every frame as this can cause bugs like being invincible to burning.}}
{{Note|For remote players, you have to use [https://wiki.multitheftauto.com/wiki/SetPedAimTarget setPedAimTarget] before setPedLookAt.}}
Makes a ped turn his head and look at a specific world position or element.
==Syntax==
<syntaxhighlight lang="lua">
bool setPedLookAt ( ped thePed, float x, float y, float z [, int time = 3000 [, int blend = 1000 ], element target = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the ped to change the lookat of.
*'''x:''' the x coordinate of the world position to look at.
*'''y:''' the y coordinate of the world position to look at.
*'''z:''' the z coordinate of the world position to look at.

===Optional Arguments===
*'''time:''' the time, in milliseconds, during which the ped will look at the target. Once this time has elapsed, he will look ahead again like before the function was applied. A time of 0 will immediately stop any lookat. A negative time will make the ped look at the target indefinitely.
*'''blend:''' the time, in milliseconds, during which the look will blend.
*'''target:''' if this argument is specified, the position arguments will be ignored and the ped's gaze will follow the specified element instead. Can be a player, a vehicle, another ped etc.

==Example==
This example makes the local player look at where the camera points at. If you want to sync this effect with other players you can use [[triggerLatentServerEvent]] and [[triggerLatentClientEvent]] functions.
<syntaxhighlight lang="lua">
local sx, sy = guiGetScreenSize()

function updateLookAt()
-- The world coordinates of the center of the screen always are the point where the camera really looks at, so get them.
local tx, ty, tz = getWorldFromScreenPosition(sx / 2, sy / 2, 10)
setPedLookAt(localPlayer, tx, ty, tz, -1, 0) -- Make the player look that coordinates
end
addEventHandler("onClientPreRender", root, updateLookAt)
</syntaxhighlight>

== Issues ==
{{Issues|
{{Issue|4325|setPedLookAt does not work for remote players}}
}}
==See Also==
{{Client ped functions}}

SetPedLookAt

2016-01-26T18:12:01Z

Emiliano Castro: setPedAimTarget fixed the bug with remote players

__NOTOC__
{{Client function}}
{{Note|Avoid calling setPedLookAt every frame as this can cause bugs like being invincible to burning.
For remote players, you have to use [https://wiki.multitheftauto.com/wiki/SetPedAimTarget setPedAimTarget] before setPedLookAt.}}
Makes a ped turn his head and look at a specific world position or element.
==Syntax==
<syntaxhighlight lang="lua">
bool setPedLookAt ( ped thePed, float x, float y, float z [, int time = 3000 [, int blend = 1000 ], element target = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the ped to change the lookat of.
*'''x:''' the x coordinate of the world position to look at.
*'''y:''' the y coordinate of the world position to look at.
*'''z:''' the z coordinate of the world position to look at.

===Optional Arguments===
*'''time:''' the time, in milliseconds, during which the ped will look at the target. Once this time has elapsed, he will look ahead again like before the function was applied. A time of 0 will immediately stop any lookat. A negative time will make the ped look at the target indefinitely.
*'''blend:''' the time, in milliseconds, during which the look will blend.
*'''target:''' if this argument is specified, the position arguments will be ignored and the ped's gaze will follow the specified element instead. Can be a player, a vehicle, another ped etc.

==Example==
This example makes the local player look at where the camera points at. If you want to sync this effect with other players you can use [[triggerLatentServerEvent]] and [[triggerLatentClientEvent]] functions.
<syntaxhighlight lang="lua">
local sx, sy = guiGetScreenSize()

function updateLookAt()
-- The world coordinates of the center of the screen always are the point where the camera really looks at, so get them.
local tx, ty, tz = getWorldFromScreenPosition(sx / 2, sy / 2, 10)
setPedLookAt(localPlayer, tx, ty, tz, -1, 0) -- Make the player look that coordinates
end
addEventHandler("onClientPreRender", root, updateLookAt)
</syntaxhighlight>

== Issues ==
{{Issues|
{{Issue|4325|setPedLookAt does not work for remote players}}
}}
==See Also==
{{Client ped functions}}

MathNumber

2015-12-26T19:58:44Z

Emiliano Castro:

{{Useful Function}}
__NOTOC__
This function can be used to take or add a number from a large number.

MTA clients do only support 24-bits numbers, therefore you can't take or add a single digit from large numbers like '1364576384'.

This function is only needed clientside since the server runs with a floating-point precision of 56-bits, however this works also serverside.

==Syntax==
<syntaxhighlight lang="lua">int mathNumber ( int num, int integer [, string type = "+"] )</syntaxhighlight>

===Required Arguments===
* '''num''': The number you want to edit
* '''integer''': The amount you want to add or take from the number
* '''type ''': Can be either '-' or '+'

===Returns===
Returns a number if everything went good, ''false'' otherwise.

==Code==
<syntaxhighlight lang="lua">
-- Function that takes a digit from a larger number
function mathNumber ( num, integer, type )
if not ( num ) or not ( integer ) then return false end

local function formatNumber( numb )
if not ( numb ) then return false end
local fn = string.sub( tostring( numb ), ( #tostring( numb ) -6 ) )
return tonumber( fn )
end

if not ( type ) or ( type == "+" ) then
local fn = string.sub( tostring( num ), 1, -8 )..( formatNumber ( num ) ) + integer
return tonumber( fn )
else
local fn = string.sub( tostring( num ), 1, -8 )..( formatNumber ( num ) ) - integer
return tonumber( fn )
end
end
</syntaxhighlight>

==Example==
<syntaxhighlight lang="lua">
mathNumber ( 1364576384, 1, '-' )
-- Returns: 1364576383

1364576384 - 1
-- Returns: 1364576384

mathNumber ( 1364576384, 1, '+' )
-- Returns: 1364576385

1364576384 + 1
-- Returns: 1364576384
</syntaxhighlight>

Author: DennisUniOn

==See Also==
{{Useful_Functions}}

GetRGColorFromPercentage

2015-12-02T00:12:58Z

Emiliano Castro:

{{Useful Function}}
__NOTOC__
This function lets you get an RG Color depending on the percentage.

==Syntax==
<syntaxhighlight lang="lua">
int, int getRGColorFromPercentage ( int percentage )
</syntaxhighlight>

===Required Arguments===
*'''percentage:''' The value which you want to get the RG from. It must be between 0 and 100.

===Returns===
Returns two integers, with red, and green values if percentage goes between 0 and 100. Returns false otherwise.

==Code==
<section name="Server/Client-Side Script" class="both" show="true">
<syntaxhighlight lang="lua">
function getRGColorFromPercentage(percentage)
if not percentage or percentage and type(percentage) ~= "number" or percentage > 100 or percentage < 0 then outputDebugString( "Invalid argument @ 'getRGColorFromPercentage'", 2 ) return false end
if percentage > 50 then
local temp = 100 - percentage
return temp*5.1, 255
elseif percentage == 50 then
return 255, 255
else
return 255, percentage*5.1
end
end
</syntaxhighlight>
</section>

==Example==
<section name="Client-Side Example" class="client" show="true">
This example shows the vehicle health with a different color depending on its health in the bottom part of the screen.
<syntaxhighlight lang="lua">
local sW, sH = guiGetScreenSize()

function showHealth()
local health = getElementHealth(getPedOccupiedVehicle(localPlayer)) - 250
-- When the car has got a health of 250, it turns into fire, so we remove 250 of the original health in order not to take it into account.
if health < 0 then health = 0 end -- In case it goes negative, we set it as if it were 0.
-- Now we need to make the conversion to a number between 0 to 100 knowing that health goes from 0 to 750.
local percentage = math.floor((health*0.133333333333)+0.5) -- Transformation into percentage.
-- We now use the function
local r, g = getRGColorFromPercentage(percentage)
-- We show it
dxDrawText("Health: "..percentage.."%", sW/2-100, sH-45, sW/2+100, sH-15, tocolor(r, g, 0, 255), 1, "default", "center", "center")
end

-- We add the handler of the function when player enters a car.
addEventHandler("onClientPlayerVehicleEnter", localPlayer,
function()
addEventHandler("onClientPreRender", root, showHealth)
end )

-- We remove it when the player leaves a car.
addEventHandler("onClientPlayerVehicleExit", localPlayer,
function()
removeEventHandler("onClientPreRender", root, showHealth)
end )
</syntaxhighlight>
</section>

'''Author: Renkon'''

==See Also==
{{Useful_Functions}}
[[:Category:Useful_Functions]]

GetBrowserVolume

2015-11-05T22:02:36Z

Emiliano Castro: Undo revision 46093 by Emiliano Castro (talk)

__NOTOC__
{{Client function}}
{{New feature/item|3.0151|1.5.1||
This function returns a specific [[Element/Browser|browser]]'s volume.
}}

==Syntax==
<syntaxhighlight lang="lua">
float getBrowserVolume ( browser webBrowser )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:getVolume||setBrowserVolume}}

===Required Arguments===
*'''webBrowser:''' A browser element

===Returns===
Returns a specific [[Element/Browser|browser]]'s volume, or ''false'' if the browser element passed to the function is invalid.

==Example==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{CEF_functions}}

GetBrowserVolume

2015-11-05T22:01:10Z

Emiliano Castro:

__NOTOC__
{{Client function}}
{{New feature/item|3.0151|1.5.1||
This function returns a specific [[Element/Browser|browser]]'s volume.
}}

==Syntax==
<syntaxhighlight lang="lua">
int getBrowserVolume ( browser webBrowser )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:getVolume||setBrowserVolume}}

===Required Arguments===
*'''webBrowser:''' A browser element

===Returns===
Returns a specific [[Element/Browser|browser]]'s volume, or ''false'' if the browser element passed to the function is invalid.

==Example==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{CEF_functions}}

GetBrowserVolume

2015-10-31T19:15:31Z

Emiliano Castro:

__NOTOC__
{{Client function}}
{{New feature/item|3.0151|1.5.1||
This function gets a specific [[Element/Browser|browser]]'s volume.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool getBrowserVolume ( webBrowser )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:getVolume||setBrowserVolume}}

===Required Arguments===
*'''webBrowser:''' A browser element

===Returns===
Returns a specific [[Element/Browser|browser]]'s volume, or ''false'' if the browser element passed to the function is invalid.

==Example==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{CEF_functions}}

GetBrowserVolume

2015-10-31T19:14:55Z

Emiliano Castro: Created page with "__NOTOC__ {{Client function}} {{New feature/item|3.0151|1.5|| This function gets a specific browser's volume. }} ==Syntax== <syntaxhighlight lang="lua"> bool getBrowserV..."

__NOTOC__
{{Client function}}
{{New feature/item|3.0151|1.5||
This function gets a specific [[Element/Browser|browser]]'s volume.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool getBrowserVolume ( webBrowser )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:getVolume||setBrowserVolume}}

===Required Arguments===
*'''webBrowser:''' A browser element

===Returns===
Returns a specific [[Element/Browser|browser]]'s volume, or ''false'' if the browser element passed to the function is invalid.

==Example==
<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{CEF_functions}}

OnPlayerNetworkStatus

2015-10-10T04:33:12Z

Emiliano Castro:

{{Server event}}
{{New feature/item|3.0142|1.4.1|7295|
__NOTOC__
This event is triggered when a players network connection is interrupted.
}}
==Parameters==
<syntaxhighlight lang="lua">
int status, int ticks
</syntaxhighlight>

*'''status''': A number which is 0 if the interruption has begun, or 1 if the interruption is ending.
*'''ticks''': Number of ticks since the interruption started.

==Source==
The [[event system#Event source|source]] of this event is the [[player element]] that has the network interruption.

==Example==
This example shows a debug message when interruption starts and stops.
<syntaxhighlight lang="lua">
addEventHandler( "onPlayerNetworkStatus", root,
function( status, ticks )
if status == 0 then
outputDebugString( "(packets from " .. getPlayerName(source) .. ") interruption began " .. ticks .. " ticks ago" )
elseif status == 1 then
outputDebugString( "(packets from " .. getPlayerName(source) .. ") interruption began " .. ticks .. " ticks ago and has just ended" )
end
end
)
</syntaxhighlight>

==See Also==
===Other events===
{{Player_events}}

OnClientPlayerWeaponFire

2015-10-10T04:29:04Z

Emiliano Castro:

{{Client event}}
__NOTOC__
This event is called when a player fires a weapon. This does not trigger for projectiles, melee weapons, or camera.
{{Note|This event is only triggered for players that are streamed in}}
==Parameters==
<syntaxhighlight lang="lua">
int weapon, int ammo, int ammoInClip, float hitX, float hitY, float hitZ, element hitElement, float startX, float startY, float startZ
</syntaxhighlight>
*'''weapon''': an [[int]] representing [[weapons|weapon]] used for making a shot.
*'''ammo''': an [[int]] amount of ammo left for this weapon type.
*'''ammoInClip''': an [[int]] amount of ammo left for this weapon type in clip.
*'''hitX''', '''hitY''', '''hitZ''': [[float]] world coordinates representing a hit point.
*'''hitElement''': an [[element]] which was hit by a shot.
{{New feature/item|3.0131|1.3.1|4311|
*'''startX''', '''startY''', '''startZ''': [[float]] world coordinates representing the start of the bullet. Note: This is not the gun muzzle.
}}

==Source==
The [[event system#Event source|source]] of this event is the streamed in [[player]] who fired the weapon.

==Example==
This example sends a warning to the local player if they shoot another player with a minigun.
<syntaxhighlight lang="lua">
--First, we create a function for the event handler to use.
function onClientPlayerWeaponFireFunc(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement )
if weapon == 38 and getElementType(hitElement)=="player" then -- If the player shoots with a minigun, and hits another player...
outputChatBox ( "Don't kill people with minigun, it's lame!", 255, 0, 0 ) -- We output a warning to him.
end
end
-- Add this as a handler so that the function will be triggered every time the local player fires.
addEventHandler ( "onClientPlayerWeaponFire", getLocalPlayer(), onClientPlayerWeaponFireFunc )
</syntaxhighlight>
This example makes the Shotgun fire explosive rounds.
<syntaxhighlight lang="lua">
function onClientPlayerWeaponFireFunc(weapon, ammo, ammoInClip, hitX, hitY, hitZ, hitElement)
if (weapon == 25) then -- If the player shoots with a shotgun
createExplosion(hitX, hitY, hitZ, 12, true, 0, true) -- Creates a tiny explosion where the bullet hit.
end
end
-- Add this as a handler so that the function will be triggered every time a player fires.
addEventHandler("onClientPlayerWeaponFire", root, onClientPlayerWeaponFireFunc)
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|7459|[Fixed in 1.3.1-4916] onClientPlayerWeaponFire hitElement being nil sometimes with shotgun}}
}}

==See Also==
===Client player events===
{{Client_player_events}}
===Client event functions===
{{Client_event_functions}}

Meta.xml

2015-09-23T22:44:39Z

Emiliano Castro:

The ''meta.xml'' file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

=Tags=
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' The author of this resource
** '''version:''' The version of this resource
** '''name:''' The name of this resource
** '''description:''' A brief description of this resource
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client", "server" or "shared".
**'''cache:''' When the script file type is "client", this setting controls whether the file is saved on the clients' hard drive. Default is "true". Using "false" will mean the file is not saved. ''(Note: cache=false files are started at the client first, so lua file load order might differ when mixing cache settings)''
**'''validate:''' If set to "false", compatibility checks are skipped.
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
**'''download:''' Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by [[downloadFile]] (from version 1.4)
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "client", "server" and "shared")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the Lua interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}"). See example for example.
**'''client:''' The minimum client version
**'''server:''' The minimum server version
*'''<aclrequest />''' A list of [[Access_Control_List|ACL]] rights this resource will need.
{{New items|3.0132|1.3.1 r4141|
*'''<sync_map_element_data />''' Controls whether map [[Element_data|element data]] such as "PosX" and "DoubleSided" are transferred to the client. This data is usually not required by most gamemodes or resources. (Map Editor and Interiors require this to be not set to false to work). When set in a gamemode meta.xml, the setting will apply to all maps loaded by that resource.
**'''false:''' Disable transfer of map element data for all resources. This can reduce map download times considerably.
**'''true:''' Enable transfer of map element data for all resources. (If '''false''' and '''true''' are set in different resources, true will have priority and all resources will transfer map element data)
}}
{{New items|3.0140|1.4.0 r5313|
*'''<oop/>''' OOP - Please refer to [[OOP]] for documentation.
**'''false:''' Disable OOP.
**'''true:''' Enable OOP.
}}
{{New feature/item|3.0150|1.5.0|7308|
*'''<download_priority_group/>''' If not set, the download priority group for a resource defaults to 0. If this is set higher than 0, then the resource will be downloaded and started on the client earlier than other resources. If set to less than 0, the resource will be downloaded and started on the client later than other resources.
}}

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>

<download_priority_group>0</download_priority_group>
<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<sync_map_element_data>false</sync_map_element_data>

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

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

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

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

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
<setting name="isAllowedToShoot" value="true" />
</settings>

<aclrequest>
<right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
<right name="function.setPlayerMuted" access="true" />
</aclrequest>
</meta>
|lang="xml"}}
[[Category:Scripting Concepts]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

Meta.xml

2015-09-23T22:40:18Z

Emiliano Castro:

The ''meta.xml'' file presents MTA with a set of metadata, such as the resource's name, the scripts to include, and which files to precache for sending to clients among other things. It is also the scope of "elements". It is written in XML, which is based on HTML and is the parent of XHTML.

=Tags=
XML is a textual data format which is widely used for the representation of data. MTA uses an XML-based language to describe the metadata for resources by using the tags below:

*'''<info />''' Information about this resource, possible parameters include (any arbitrary parameters can be used and read using [[getResourceInfo]]):
** '''author:''' The author of this resource
** '''version:''' The version of this resource
** '''name:''' The name of this resource
** '''description:''' A brief description of this resource
** '''type:''' The type of this resource, that can be "gamemode", "script", "map" or "misc".
*'''<script />''' Source code for this resource, possible parameters are:
** '''src:''' The file name of the source code
** '''type:''' The type of source code: "client", "server" or "shared".
**'''cache:''' When the script file type is "client", this setting controls whether the file is saved on the clients' hard drive. Default is "true". Using "false" will mean the file is not saved. ''(Note: cache=false files are started at the client first, so lua file load order might differ when mixing cache settings)''
**'''validate:''' If set to "false", compatibility checks are skipped.
*'''<map />''' The map for a gamemode, possible parameters are:
**'''src:''' .map file name (can be path too eg. "maps/filename.map")
**'''dimension:''' Dimension in which the map will be loaded (optional)
*'''<file />''' A client-side file. Generally these are images, .txd, .col, .dff or .xml files. They'll be downloaded by clients when the resources is started (or on join)
**'''src:''' client-side file name (can be path too eg. "images/image.png")
**'''download:''' Whether or not to be sent to the client automatically (optional). Default is "true". Using "false" will mean they are not sent on resource start but could later be used by [[downloadFile]] (from version 1.4)
*'''<include />''' Include resources that this resource will use
**'''resource:''' Resource name that you want to start with this resource
**'''minversion:''' Minimum version that '''resource''' needs to be (optional)
**'''maxversion:''' Maximum version that '''resource''' needs to be (optional)
*'''<config />''' Config file (.xml) can be accessed by resource, possible parameters are:
**'''src:''' The file name of the config file
**'''type:''' The type of the config file: "client" or "server"
*'''<export />''' This exports functions from this resource, so other resources can use them with [[call]]
**'''function:''' The function name
**'''type''' Whether function is exported server-side or client-side (valid values are: "client", "server" and "shared")
**'''http:''' Can the function be called via HTTP (true/false)
*'''<html />'''
**'''src:''' The filename for the HTTP file (can be a path)
**'''default:''' The html file is one that is shown by default when visiting /resourceName/ on the server. Only one html can be default, the rest are ignored. (true/false)
**'''raw:''' The html file is not parsed by the Lua interpreter and is treated as binary data. Must be used for binary files (images mainly) (true/false)
*'''<settings> <setting name="" value=""/> </settings>:''' Most gamemodes use [[settings system]] to let server admins to configure it how they like. For instance you could set round time and then use [[get]] and [[set]] to get the value or change it, respectively.
*'''<min_mta_version />''' Minimum version requirements for this resource to run correctly. When authoring resources, the minimum version should usually be set to the current released version of MTA:SA (which at the moment is "{{Current Version|full}}"). See example for example.
**'''client:''' The minimum client version
**'''server:''' The minimum server version
*'''<aclrequest />''' A list of [[Access_Control_List|ACL]] rights this resource will need.
{{New items|3.0132|1.3.1 r4141|
*'''<sync_map_element_data />''' Controls whether map [[Element_data|element data]] such as "PosX" and "DoubleSided" are transferred to the client. This data is usually not required by most gamemodes or resources. (Map Editor and Interiors require this to be not set to false to work). When set in a gamemode meta.xml, the setting will apply to all maps loaded by that resource.
**'''false:''' Disable transfer of map element data for all resources. This can reduce map download times considerably.
**'''true:''' Enable transfer of map element data for all resources. (If '''false''' and '''true''' are set in different resources, true will have priority and all resources will transfer map element data)
}}
{{New items|3.0140|1.4.0 r5313|
*'''<oop/>''' OOP - Please refer to [[OOP]] for documentation.
**'''false:''' Disable OOP.
**'''true:''' Enable OOP.
}}
{{New feature/item|3.0150|1.5.0|7308|
*'''<download_priority_group/>''' If not set, the download priority group for a resource defaults to 0. If this is set higher than 0, then the resource will be downloaded and started on the client earlier than other resources. If set to less than 0, the resource will be downloaded and started on the client later than other resources.
}}

== Example ==
Heres an example of a meta file using some of the tags mentioned:
{{#tag:code |
<meta>
<info author="Slothman" type="gamemode" name="Stealth" />
<config src="help.xml" type="client"/>

<min_mta_version client="{{Current Version|full}}" server="{{Current Version|full}}" />

<sync_map_element_data>false</sync_map_element_data>

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

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

<include resource="scoreboard" />
<include resource="killmessages" />
<include resource="maplimits" />

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

<settings>
<setting name="roundlimit" value="[6]" /> 
<setting name="teamdamage" value="[1]" /> 
<setting name="teambalance" value="[1]" /> 
<setting name="spazammo" value="[25]" /> 
<setting name="m4ammo" value="[100]" />
<setting name="shotgunammo" value="[25]" />
<setting name="sniperammo" value="[20]" />
<setting name="ak47ammo" value="[120]" />
<setting name="rifleammo" value="[40]" />
<setting name="deserteagleammo" value="[45]" />
<setting name="pistolammo" value="[132]" />
<setting name="uziammo" value="[150]" />
<setting name="tec9ammo" value="[150]" />
<setting name="silencedammo" value="[65]" />
<setting name="grenadeammo" value="[4]" />
<setting name="satchelammo" value="[4]" />
<setting name="teargasammo" value="[4]" />
<setting name="molatovammo" value="[4]" />
<setting name="isAllowedToShoot" value="true" />
</settings>

<aclrequest>
<right name="function.startResource" access="true" />
<right name="function.stopResource" access="true" />
<right name="function.setPlayerMuted" access="true" />
</aclrequest>
</meta>
|lang="xml"}}
[[Category:Scripting Concepts]]
[[cs:Meta.xml]]
[[de:Meta.xml]]
[[es:Sobre el archivo "meta.xml"]]
[[it:Meta.xml]]
[[pl:Meta.xml]]
[[ru:Meta.xml]]

BanPlayer

2015-09-23T21:17:10Z

Emiliano Castro:

__NOTOC__
{{Server function}}
{{New feature|3|1.0|
This function will ban the specified player by either IP, [[serial]] or username
}}

{{Deprecated_feature|3|1.0|
This function will ban the specified player from the server by IP.
}}

==Syntax==
{{New feature|3|1.0|
<syntaxhighlight lang="lua">
ban banPlayer ( player bannedPlayer, [ bool IP = true, bool Username = false, bool Serial = false, player/string responsiblePlayer = nil, string reason = nil, int seconds = 0 ] )
</syntaxhighlight>
}}

{{Deprecated_feature|3|1.0|
<syntaxhighlight lang="lua">
bool banPlayer ( player bannedPlayer , [ element responsibleElement, string reason ] )
</syntaxhighlight>
}}
{{OOP||[[player]]:ban||}}
===Required Arguments===
*'''bannedPlayer:''' The player that will be banned from the server.

===Optional Arguments===
{{OptionalArg}}
{{New feature|3|1.0|
*'''IP:''' Will player be banned by IP?
*'''Username:''' Will player be banned by username?
*'''Serial:''' Will player be banned by serial?
}}
*'''responsibleElement:''' The element that is responsible for banning the player. This can be a player or the root ([[getRootElement]]()) (Maximum 30 characters if using a string).
*'''reason:''' The reason the player 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 a [[ban]] object if banned successfully, or ''false'' if unsuccessful.

==Example==
This example lets a player ban anyone if he has ACL rights.
<syntaxhighlight lang="lua">
--Add the "ban" command handler
-- Example with the player
function banPlayerCommand ( theClient, commandName, bannedName, reason )

-- Give the player a nice error if he doesn't have rights
if ( hasObjectPermissionTo ( theClient, "function.banPlayer" ) ) then
--Get player element from the name
local bannedPlayer = getPlayerFromName ( bannedName )

--Ban the player
banPlayer ( bannedPlayer, theClient, reason )
outputChatBox ( "ban: " .. bannedName .. " successfully banned", theClient )

else
outputChatBox ( "ban: You don't have enough permissions", theClient )
end

end
addCommandHandler ( "ban", banPlayerCommand )

-- Example function with the root element. Here you would pass a player element to the function.
function banCheater(theCheater)
banPlayer(theCheater, getRootElement(), "You are banned because of cheating.")
end
</syntaxhighlight>

This example is Firewall Account Player by serial on Login
<syntaxhighlight lang="lua">
Firewall =
{
[ 'AccountName' ] = 'SerialPlayer',
[ '3ash8' ] = '9C9F3B55D9D7BB7135FF274D3BF444E4',
[ 'test5' ] = '1D6F76CF8D7193792D13789849498452',
}

addEventHandler ( 'onPlayerLogin', getRootElement ( ),
function ( _, theCurrentAccount )
local Serial = Firewall[getAccountName(theCurrentAccount)]
if ( Serial ) then
if Serial ~= getPlayerSerial ( source ) then
banPlayer ( source, false, false, true, getRootElement ( ), 'reason ban' )
end
end
end
)
</syntaxhighlight>

==See Also==
{{Admin_functions}}
[[es:banPlayer]]
[[ru:BanPlayer]]

GetElementModel

2015-09-23T00:26:43Z

Emiliano Castro:

__NOTOC__
{{Server client function}}

Returns the model ID of a given element. This can be a player/ped skin, a pickup model, an object model or a vehicle model.

==Syntax==
<syntaxhighlight lang="lua">
int getElementModel ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getModel|model|setElementModel}}

===Required Arguments===
*'''theElement:''' the element to retrieve the model ID of.

===Returns===
Returns the model ID if successful, ''false'' otherwise.
* For players/peds: A GTASA player model (skin) ID. See [[Character Skins]].
* For vehicles: The [[Vehicle IDs|vehicle ID]] of the vehicle.
* For objects: An [[int]] specifying the model id.

==Example==
<section class="server" name="Example 1 (Server)" show="true">
This example destroys a haystack when a player targets it.
<syntaxhighlight lang="lua">
function onPlayerTargeted ( targetElem )
if ( getElementType ( targetElem ) == "object" ) and ( getElementModel ( targetElem ) == 3374 ) then
destroyElement ( targetElem )
end
end
addEventHandler ( "onPlayerTarget", root, onPlayerTargeted )
</syntaxhighlight>
</section>
<section class="server" name="Example 2 (Server)" show="true">
This example prints out a message when a Shamal or AT-400 is entered by a player.
<syntaxhighlight lang="lua">
function planeEnter ( theVehicle, seat, jacked ) -- when someone enters a vehicle
local id = getElementModel ( theVehicle ) -- get the model ID of the vehicle
if id == 519 or id == 577 then -- if theVehicle is either Shamal or AT-400
local vehicleName = getVehicleName ( theVehicle ) -- get the name of theVehicle
outputChatBox ( "Someone stole a " .. vehicleName .. "!" ) -- announce that someone stole the plane
end
end
-- add the event handler to the event
addEventHandler ( "onPlayerVehicleEnter", root, planeEnter )
</syntaxhighlight>
</section>

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

SetElementModel

2015-09-23T00:26:29Z

Emiliano Castro:

__NOTOC__
{{Server client function}}

Sets the model of a given element. This allows you to change the model of a player (or ped), a vehicle or an object.

==Syntax==
<syntaxhighlight lang="lua">
bool setElementModel ( element theElement, int model )
</syntaxhighlight>
{{OOP||[[element]]:setModel|model|getElementModel}}

===Required Arguments===
*'''theElement:''' the element you want to change.
*'''model:''' the model ID to set.
** For players/peds: A GTASA player model (skin) ID. See [[Character Skins]].
** For vehicles: The [[Vehicle IDs|vehicle ID]] of the vehicle being changed.
** For objects/projectiles/weapons: An [[int]] specifying the model id.

===Returns===
Returns ''true'' if successful, ''false'' otherwise.

==Example==
<section class="server" name="Example 1 (Server)" show="true">
<syntaxhighlight lang="lua">
addCommandHandler ( "changeveh",
function ( thePlayer, command, newModel )
local theVehicle = getPedOccupiedVehicle ( thePlayer ) -- get the vehicle the player is in
newModel = tonumber ( newModel ) -- try to convert the string argument to a number
if theVehicle and newModel then -- make sure the player is in a vehicle and specified a number
setElementModel ( theVehicle, newModel )
end
end
)
</syntaxhighlight>
After the above code is executed, a player can get in any vehicle and execute e.g. the command "/changeveh 520" to change it into a hydra.
</section>
<section class="server" name="Example 2 (Server)" show="true">
This will continually change an object model every 2.5 seconds at the location -1084.52, -1634.81, 76.36 (Truth's farm).
<syntaxhighlight lang="lua">
myobject = createObject ( 5822, -1084.52, -1634.81, 76.36 )
-- We create an initial object element. I choose object model 5822 to begin with.

function objectRandomization ()
local randomobjectnumber = math.random(1, 18000)
-- Choose a random number between 1 and 18000 as a whole integer and assign it to
-- the variable 'randomobjectnumber'
setElementModel ( myobject, randomobjectnumber )
-- Change our object appearance by applying a new model ID
end

setTimer ( objectRandomization, 2500, 0 )
-- Every 2.5 seconds, the function 'objectRandomization' is called by this timer.
-- Each time the function runs, it changes the object model by applying a new whole-
-- integer random object ID. This timer is called an infinite amount of times since
-- its repeat value is set to 0.
</syntaxhighlight>
</section>

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

GetElementRotation

2015-09-23T00:26:02Z

Emiliano Castro:

{{Server client function}}
__NOTOC__
Retrieve the rotation of elements.

==Syntax==
<syntaxhighlight lang="lua">
float float float getElementRotation ( element theElement [, string rotOrder = "default" ] )
</syntaxhighlight>
{{OOP||[[element]]:getRotation|rotation|setElementRotation}}

===Required Arguments===
*'''theElement:''' The element whose rotation will be retrieved

===Optional Arguments===
*'''rotOrder:''' A string representing the rotation order desired when returning the [http://en.wikipedia.org/wiki/Euler_angles euler angles]. If omitted, default value is ''"default"''. Allowed values are:
**''"default":'' default MTA behavior prior to 1.1, where rotation order depends on element type
**''"ZXY":'' rotation about the Z axis (''up''), then about the resulting X axis (''right'') and finally about the resulting Y axis (''front''). This is the default rotation order for [[object|objects]]
**''"ZYX":'' rotation about the Z axis (''up''), then about the resulting Y axis (''front''), and finally about the resulting X axis (''right''). This is the default rotation order for [[vehicle|vehicles]]

The default rotation order for peds/players is Z-Y-X (clientside) and -Z-Y-X (serverside) but those rotation orders (set using ''"default"'' on peds) can not be used manually on other element types since they only exist due to historical and backward compatibility reasons.
Specifying a rotation order other than ''"default"'' allows the same angles to later be uniformly used on several elements without having to consider their type.

===Returns===
* ''rx, ry, rz'': 3 ''float''s representing the Euler rotation angles on the axis X, Y and Z (with the rotation order depending on the ''rotOrder'' argument) if ''element'' exists and is a valid element, ''false'' if it's invalid.

==Example==
If a player points at a player element with a gun, its rotation will appear in the chat box.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function onPlayerTargeted ( targetElem )
if ( isElement(targetElem) and getElementType (targetElem) == "player" ) then
local x,y,z = getElementRotation ( targetElem )
outputChatBox ( "Target player rotation: " .. x .. " " .. y .. " " .. z )
end
end
addEventHandler ( "onClientPlayerTarget", root, onPlayerTargeted )
</syntaxhighlight>
</section>

==See Also==
{{Client_element_functions}}

SetElementRotation

2015-09-23T00:25:47Z

Emiliano Castro:

{{Server client function}}
__NOTOC__
Sets the rotation of elements according to the world (does not work with players that are on the ground).
{{Tip|New scripts should set '''conformPedRotation''' to ''true'' when using this function on [[Ped|peds]]. This will prevent quirky old behaviour.}}
==Syntax==
<syntaxhighlight lang="lua">
bool setElementRotation ( element theElement, float rotX, float rotY, float rotZ [, string rotOrder = "default", bool conformPedRotation = false ] )
</syntaxhighlight>
{{OOP||[[element]]:setRotation||getElementRotation}}

===Required Arguments===
*'''theElement:''' The element whose rotation will be set
*'''rotX:''' The element's rotation around the x axis in degrees
*'''rotY:''' The element's rotation around the y axis in degrees
*'''rotZ:''' The element's rotation around the z axis in degrees

===Optional Arguments===
{{New feature|3.0110|1.1|
*'''rotOrder:''' A string representing the rotation order desired when interpreting the provided [http://en.wikipedia.org/wiki/Euler_angles euler angles]. If omitted, default value is ''"default"''. Allowed values are:
**''"default":'' default MTA behavior prior to 1.1, where rotation order depends on element type
**''"ZXY":'' rotation about the Z axis (''up''), then about the resulting X axis (''right''), and finally about the resulting Y axis (''front''). This is the default rotation order for [[object|objects]]
**''"ZYX":'' rotation about the Z axis (''up''), then about the resulting Y axis (''front''), and finally about the resulting X axis (''right''). This is the default rotation order for [[vehicle|vehicles]]

The default rotation order for peds/players is -Z-Y-X but this rotation order (set using ''"default"'' on peds) can not be set manually on other element types since it only exists due to historical and backward compatibility reasons.
Specifying a rotation order other than ''"default"'' allows the same angles to be uniformly used on several elements without having to consider their type.
}}
{{New feature/item|3.0152|1.3.2|4680|
*'''conformPedRotation:''' ''Relevant only for peds and will be ignored for other element types.'' A bool which should be set to ''true'' to ensure the ped rotation is correctly set in all circumstances. Failing to set this argument may result in the ped rotation being inverted whilst it is in the air and other inconsistencies. The default value of false is for backward compatibility with scripts which may depend upon the incorrect behaviour.
}}

===Returns===
Returns ''true'' if the element rotation was successfully set and ''false'' otherwise.

==Example==
How to correctly set the rotation for a ped:
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function pedRotate ( )
local rotX, rotY, rotZ = getElementRotation(localPlayer) -- get the local players's rotation
setElementRotation(localPlayer,0,0,rotZ+10,"default",true) -- turn the player 10 degrees clockwise
end
addCommandHandler ( "turn", pedRotate )
</syntaxhighlight>
</section>

When a player used the command "turn" and they are the driver of a vehicle the vehicle will rotate 10 degrees clockwise
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function carRotate( )
if isPedInVehicle(localPlayer) then -- if the local client is in a vehicle
localVehicle = getPedOccupiedVehicle(localPlayer)
if getVehicleController(localVehicle) == localPlayer then -- if the local client is the controller (driver) of the vehicle
local rotX, rotY, rotZ = getElementRotation(localVehicle) -- get the local client's vehicle rotation
setElementRotation(localVehicle,rotX,rotY,rotZ+10) -- turn the vehicle 10 degrees clockwise
end
end
end
addCommandHandler ( "turn", carRotate )
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04680|Added conformPedRotation argument}}

==See Also==
{{Client_element_functions}}

GetElementInterior

2015-09-23T00:25:05Z

Emiliano Castro:

__NOTOC__
{{Server client function}}
This function allows you to retrieve the interior of any element. An interior is the current loaded place, 0 being outside.

==Syntax==
<syntaxhighlight lang="lua">
int getElementInterior ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getInterior|interior|setElementInterior}}

===Required Arguments===
*'''theElement:''' The element of which you'd like to retrieve the interior

===Returns===
Returns an [[int]] for the interior if '''theElement''' is valid, ''false'' otherwise.

==Example==
<section show="true" name="Server" class="server">
This example shows a player if he is outside or not, when he enters the command 'AmIOutside'.
<syntaxhighlight lang="lua">
function AmIOutside ( thePlayer, command )
if ( getElementInterior(thePlayer) == 0 ) then
outputChatBox ( "Yes you are outside " .. getPlayerName(thePlayer), thePlayer )
else
outputChatBox ( "No you aren't outside " .. getPlayerName(thePlayer), thePlayer )
end
end
addCommandHandler ( "AmIOutside", AmIOutside )
</syntaxhighlight>
</section>

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

[[de:getElementInterior]]

SetElementInterior

2015-09-23T00:24:54Z

Emiliano Castro:

{{Server client function}}
__NOTOC__
This function allows you to set the [[interior]] of any element. An interior is the current loaded place, 0 being outside.
{{Note|If passing the same interior as the element is in, the call will be ignored and position (optional arguments) will not be set either. Use [[setElementPosition]] separately to be sure the position will be set.}}

==Syntax==
<syntaxhighlight lang="lua">
bool setElementInterior ( element theElement, int interior [, float x, float y, float z] )
</syntaxhighlight>
{{OOP||[[element]]:setInterior||getElementInterior}}

===Required Arguments===
*'''theElement:''' The element in which you'd like to set the interior of.
*'''interior:''' The interior you want to set the element to. Valid values are 0 to 255.

===Optional Arguments===
{{OptionalArg}}
* '''x:''' A floating point number representing the X coordinate on the map.
* '''y:''' A floating point number representing the Y coordinate on the map.
* '''z:''' A floating point number representing the Z coordinate on the map.

===Returns===
Returns ''true'' if '''theElement''' and '''interior''' are valid arguments, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
In this example, if a player were to type /interior 1, they would be teleported into this interior
<syntaxhighlight lang="lua">
function interior ( source, commandName, interior )
--Let's see if they gave an interior ID
if ( interior ) then
--They did, so lets assign them to that interior and teleport them there (all in 1 function call!)
setElementInterior ( source, interior, 2233.91, 1714.73, 1011.38 )
else
--They didn't give one, so set them to the interior they wanted, but don't teleport them.
setElementInterior ( source, 0 )
end
end
addCommandHandler ( "interior", interior )
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
In this example, if a player were to type /interior 1, they would be teleported into this interior
<syntaxhighlight lang="lua">
function interior ( commandName, interior )
--Let's see if they gave a interior ID
if ( interior ) then
--They did, so let's assign them to that interior and teleport them there (all in 1 function call!)
setElementInterior ( localPlayer, interior, 2233.91, 1714.73, 1011.38 )
else
--They didn't give one, so set them to the interior they wanted, but don't teleport them.
setElementInterior ( localPlayer, 0 )
end
end
addCommandHandler ( "interior", interior )
</syntaxhighlight>
</section>

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

[[de:setElementInterior]]

SetElementPosition

2015-09-23T00:24:23Z

Emiliano Castro:

__NOTOC__
{{Server client function}}
This function sets the position of an element to the specified coordinates.

<div style="background: #FF7070; border: 3px solid #FF0000;">
'''Attention:''' Do not use this function to spawn a [[player]]. It will cause problems with other functions like [[warpPedIntoVehicle]]. <br>
Use [[spawnPlayer]] instead.
</div>

==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="Example 1" class="server" show="true">
This example adds a "setpos" command to console, which allows setting of a player's position.
<syntaxhighlight lang="lua">
function consoleSetPlayerPosition ( source, commandName, posX, posY, posZ )
setElementPosition ( source, posX, posY, posZ )
end
addCommandHandler ( "setpos", consoleSetPlayerPosition )
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="false">
This example adds a "setpos" command to console, which allows setting of the local player's position.
<syntaxhighlight lang="lua">
function consoleSetPlayerPosition ( commandName, posX, posY, posZ )
setElementPosition ( localPlayer, posX, posY, posZ )
end
addCommandHandler ( "setpos", consoleSetPlayerPosition )
</syntaxhighlight>
</section>
<section name="Example 3" class="server" show="false">
This example enables a player to type /warpto <playername> to warp to them. If the player being warped to is in a vehicle with a free passenger seat, it will warp into the vehicle.
<syntaxhighlight lang="lua">
function consoleWarpTo ( sourcePlayer, commandName, player2nick )
-- Make sure required parameters are set
if ( not sourcePlayer or not player2nick ) then return end
-- Setup the variables we will be using for teleportation
local x, y, z, r, d = 0, 0, 0, 0, 2.5
-- Grab the element identifier of the player we are trying to warp to
local player2 = getPlayerFromNick ( player2nick )
-- Make sure it exists!
if ( player2 ) then
-- Is the player we're warping to in a vehicle?
if ( isPlayerInVehicle ( player2 ) ) then
-- Indeed they are, let's get the vehicle information such as the vehicle element itself, and the seats it's got.
local player2vehicle = getPlayerOccupiedVehicle ( player2 )
local numseats = getVehicleMaxPassengers ( player2vehicle )
local i = 0
-- Loop over the seats to see if there's a free one
while ( i < numseats ) do
if ( getVehicleOccupant ( player2vehicle, i ) ) then
-- This seat isn't free, go ahead and check the next one
i = i + 1
else
-- This seat is free, get out of the loop
break
end
end
-- Check if 'i' is lower than the number of seats. If it is, it means it's the number of a free seat
if ( i < numseats ) then
-- Teleport the player into the seat
warpPlayerIntoVehicle ( sourcePlayer, player2vehicle, i )
else
-- There are no free seats, tell the player that.
outputChatBox ( "Sorry, the player's vehicle is full (" .. getVehicleName ( player2vehicle ) .. " " .. i .. "/" .. numseats .. ")", sourcePlayer )
end
else
-- The player isn't in a vehicle, let's get the player's position and warp to them.
x, y, z = getElementPosition ( player2 )
r = getPlayerRotation ( player2 )
-- Make sure we get interior data, they might be inside one!
interior = getElementInterior ( player2 )
dimension = getElementDimension ( player2 )
-- Do some funky math to make sure that we dont teleport inside of them (get us both stuck inside each other)
x = x - ( ( math.cos ( math.rad ( r + 90 ) ) ) * d )
y = y - ( ( math.sin ( math.rad ( r + 90 ) ) ) * d )
-- Set a few timers for setting interiors, dimensions and positions
setTimer ( setElementInterior, 800, 1, sourcePlayer, interior )
setTimer ( setElementDimension, 900, 1, sourcePlayer, dimension )
setTimer ( setElementPosition, 1000, 1, sourcePlayer, x, y, z )
setTimer ( setPlayerRotation, 1000, 1, sourcePlayer, r )
-- Fade the camera to make it look nicer
fadeCamera ( sourcePlayer, false, 1, 0, 0, 0 )
-- Fade it back once it's all complete!
setTimer ( fadeCamera, 1000, 1, sourcePlayer, true, 1 )
end
else
-- No player by the specified name was found, tell the warper this.
outputChatBox ( "No such player.", sourcePlayer )
end
end
addCommandHandler ( "warpto", consoleWarpTo )
</syntaxhighlight>
</section>

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

GetElementID

2015-09-23T00:23:39Z

Emiliano Castro:

__NOTOC__
{{Server client function}}
This function gets the ID of an element. This is the "id" attribute of the element and is a string, NOT a number like a model ID, weapons ID or similar.

==Syntax==
<syntaxhighlight lang="lua">
string getElementID ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getID|id|setElementID}}

===Required Arguments===
*'''theElement:''' the element from which to retrieve the ID.

===Returns===
This returns a ''string'' containing the element ID. It will return an empty ''string'' if it has no ID. It will return ''false'' if the element is invalid.

==Example==
To get the ID of the following element:
<syntaxhighlight lang="xml"><flag id="northflag" posX="2365" posY="215" posZ="32" /></syntaxhighlight>
You could use the following code:
<syntaxhighlight lang="lua">
-- assume flag refers to the flag element in the above XML code
idstring = getElementID ( flag ) -- get the id of the flag element
outputChatBox ( "The flag's ID is: " .. idstring ) -- output: The flag's ID is: northflag
</syntaxhighlight>

==See Also==
{{Element_functions}}
[[de:GetElementID]]

SetElementID

2015-09-23T00:23:15Z

Emiliano Castro:

{{Server client function}}
__NOTOC__
This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.
You can only change the ID of an element clientside if that element has been created clientside as well.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementID ( element theElement, string name )
</syntaxhighlight>
{{OOP|[[element]]:setID|id||getElementID}}

===Required Arguments===
*'''theElement:''' The [[element]] you want to set the ID of.
*'''name:''' The new ID for theElement.

===Returns===
This returns ''true'' if successful. It will return ''false'' if '''theElement''' is invalid, or does not exist, or if '''name''' is invalid, or is not a string.

==Example==
<syntaxhighlight lang="lua">
local players = getElementsByType( "player" )

for i=1,#players do
setElementID( players[i], "player" .. i ) -- Change element IDs to 'player1', 'players2', 'players3'...
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output all the new element IDs
end

-- Could also be --

for i=1,#players do
setElementID( players[i], getPlayerName( players[i] ) ) -- Change the element ID to the players name.
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) )
end
</syntaxhighlight>

==See Also==
{{element_functions}}

SetElementID

2015-09-23T00:22:46Z

Emiliano Castro:

{{Server client function}}
__NOTOC__
This function sets the ID of an element to a string. This can be anything from an identifying number, to a name.
You can only change the ID of an element clientside if that element has been created clientside as well.
==Syntax==
<syntaxhighlight lang="lua">
bool setElementID ( element theElement, string name )
</syntaxhighlight>
{{OOP|[[element]]:setID|id|getElementID}}

===Required Arguments===
*'''theElement:''' The [[element]] you want to set the ID of.
*'''name:''' The new ID for theElement.

===Returns===
This returns ''true'' if successful. It will return ''false'' if '''theElement''' is invalid, or does not exist, or if '''name''' is invalid, or is not a string.

==Example==
<syntaxhighlight lang="lua">
local players = getElementsByType( "player" )

for i=1,#players do
setElementID( players[i], "player" .. i ) -- Change element IDs to 'player1', 'players2', 'players3'...
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) ) -- Output all the new element IDs
end

-- Could also be --

for i=1,#players do
setElementID( players[i], getPlayerName( players[i] ) ) -- Change the element ID to the players name.
outputDebugString( "Player[" .. i .. "] = " .. getElementID( players[i] ) )
end
</syntaxhighlight>

==See Also==
{{element_functions}}

SetElementData

2015-09-23T00:20:03Z

Emiliano Castro:

{{Server client function}}
__NOTOC__
This function stores [[element data]] under a certain key, attached to an element. Element data set using this is then synced with all clients and the server. The data can contain server created elements, but you should avoid passing data that is not able to be synced such as xmlnodes, acls, aclgroups etc.

As element data is synced to all clients, it can generate a lot of network traffic and consume server CPU. Events are much more efficient for sending data from a client to the server only, or from the server to a specific client.

{{Tip|A simple and efficient way to make a variable known to the server and clients is to use setElementData on the [[root]] element.}}
{{Note|See [[Script security]] for tips on preventing cheaters when using events and element data}}

==Syntax==

<syntaxhighlight lang="lua">
bool setElementData ( element theElement, string key, var value [, bool synchronize = true ] )
</syntaxhighlight>
{{OOP||[[element]]:setData||getElementData}}

===Required Arguments===
*'''theElement:''' The [[element]] you wish to attach the data to.
*'''key:''' The key you wish to store the data under. (Maximum 31 characters.)
*'''value:''' The value you wish to store. See [[element data]] for a list of acceptable datatypes.

===Optional Arguments===
*'''synchronize:''' Determines whether or not the data will be synchronized with the server (client-side variation) and remote clients (both variations).

===Returns===
Returns ''true'' if the data was set succesfully, ''false'' otherwise.

===Issues===
{{Issues|
{{Issue|7389|[Fixed in 1.3.5-7389] Problem with floating numbers}}
}}

==Example==
<section name="Server" class="server" show="true">
This example allows a player to add a custom tag onto their nickname, and also reverts it back to normal if they wish.
<syntaxhighlight lang="lua">
function addPlayerCustomTag ( thePlayer, command, newTag )
--Let's make sure the newTag param has been entered...
if ( newTag ) then
--Grab their current playername for saving.
local sPlayerNickname = getPlayerName ( thePlayer )
--Create their new nickname with their tag
local sNewPlayerNickname = newTag .. " " .. sPlayerNickname

--Let's first load the element data, see if it's there already
--The reason for this is that if a player were to do /addtag twice,
--the tag would be prepended a second time
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick == false ) then
--Save their orignal nickname in their element data
setElementData ( thePlayer, "tempdata.originalnick", sPlayerNickname )
end

--Set their new nickname globally
setPlayerName ( thePlayer, sNewPlayerNickname )

--Tell them it's done
outputChatBox ( "Your new nickname has been set, to put it back to its original state you can use /deltag", thePlayer )
else
--The newTag param was not entered, give an error message
outputChatBox ( "/addtag - Incorrect syntax, Correct: /addtag <newtag>", thePlayer )
end
end
addCommandHandler ( "addtag", addPlayerCustomTag )

function removePlayerCustomTag ( thePlayer, command )
--We first need to check that they have already used /addtag, let's do that now
local sOldNick = getElementData( thePlayer, "tempdata.originalnick" )
if ( sOldNick ) then
--Great, they have a tag added, let's reset them

--First we will want to reset the element data back to its default (that being false)
setElementData ( thePlayer, "tempdata.originalnick", false )

--Now set the client name back
setPlayerName( thePlayer, sOldNick )

--Notify them
outputChatBox ( "Your old nickname has been set", thePlayer )
end
end
addCommandHandler ( "deltag", removePlayerCustomTag )
</syntaxhighlight>
</section>

==See Also==
{{Element_functions}}

GetAccountData

2015-09-23T00:19:31Z

Emiliano Castro:

{{Server function}}
__NOTOC__
{{Note_box|It is strongly recommended that you use the standard ''module.key'' naming for your keys, as shown in the example below. This prevents collisions between different scripts.}}
This function retrieves a string that has been stored using [[setAccountData]]. Data stored as account data is persistent across user's sessions and maps, unless they are logged into a guest account.

==Syntax==
<syntaxhighlight lang="lua">
string getAccountData ( account theAccount, string key )
</syntaxhighlight>
{{OOP||[[account]]:getData||setAccountData}}
===Required Arguments===
*'''theAccount:''' The account you wish to retrieve the data from.
*'''key:''' The key under which the data is stored

===Returns===
Returns a [[string]] containing the stored data or ''false'' if no data was stored under that key.

==Example==
For a pirate roleplaying gametype, the amount of money a player has is made persistent by storing it in his account. Note the code uses "piraterpg.money" as key instead of just "money", as the player may be participating in other gametypes that also save his money amount to his account. If both gametypes would use "money" as the account key, they'd overwrite each other's data.
<syntaxhighlight lang="lua">
function onPlayerQuit()
local playerAccount = getPlayerAccount(source) -- get his account
if (playerAccount) then -- if we got the account then
local playerMoney = getPlayerMoney(source) -- get his money amount
setAccountData(playerAccount, "piraterpg.money", playerMoney) -- store his current money amount in his account data
end
end
addEventHandler("onPlayerQuit", getRootElement(), onPlayerQuit) -- add an event handler

function onPlayerLogin()
-- when a player logins, retrieve his money amount from his account data and set it
local playerAccount = getPlayerAccount(source) -- get his account
if (playerAccount) then -- if we got the account then
local playerMoney = getAccountData(playerAccount, "piraterpg.money") -- get the money amount was store in his account data
-- make sure there was actually a value saved under this key (check if playerMoney is not false).
-- this will for example not be the case when a player plays the gametype for the first time
if (playerMoney) then
setPlayerMoney(source, playerMoney)
end
end
end
addEventHandler("onPlayerLogin", getRootElement(), onPlayerLogin) -- add an event handler
</syntaxhighlight>

==See Also==
{{Account_functions}}

[[ru:getAccountData]]
[[ar:getAccountData]]

SetAccountData

2015-09-23T00:19:18Z

Emiliano Castro:

{{Server function}}
__NOTOC__
{{Note_box|It is strongly recommended that you use the standard ''module.key'' naming for your keys, as shown in the example below. This prevents collisions between different scripts.}}
This function sets a string to be stored in an [[account]]. This can then be retrieved using [[getAccountData]]. Data stored as account data is persistent across user's sessions and maps, unless they are logged into a guest account. Even if logged into a guest account, account data can be useful as a way to store a reference to your own account system, though it's persistence is equivalent to that of using [[setElementData]] on the player's element.

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountData ( account theAccount, string key, string value )
</syntaxhighlight>
{{OOP||[[account]]:setData||getAccountData}}
===Required Arguments===
*'''theAccount:''' The account you wish to retrieve the data from.
*'''key:''' The key under which you wish to store the data
*'''value:''' The value you wish to store. Set to false to remove the data. '''NOTE:''' you cannot store tables as values, but you can use [[toJSON]] strings.

===Returns===
Returns a ''true'' if the account data was set, ''false'' if an invalid argument was specified.

==Example==
For a pirate roleplaying gametype, the amount of money a player has is made persistent by storing it in his account. Note the code uses "piraterpg.money" as key instead of just "money", as the player may be participating in other gametypes that also save his money amount to his account. If both gametypes would use "money" as the account key, they'd overwrite each other's data.
<syntaxhighlight lang="lua">
function onPlayerQuit ( )
-- when a player leaves, store his current money amount in his account data
local playeraccount = getPlayerAccount ( source )
if ( playeraccount ) and not isGuestAccount ( playeraccount ) then -- if the player is logged in
local playermoney = getPlayerMoney ( source ) -- get the player money
setAccountData ( playeraccount, "piraterpg.money", playermoney ) -- save it in his account
end
end

function onPlayerLogin (_, playeraccount )
-- when a player logins, retrieve his money amount from his account data and set it
if ( playeraccount ) then
local playermoney = getAccountData ( playeraccount, "piraterpg.money" )
-- make sure there was actually a value saved under this key (check if playermoney is not false).
-- this will for example not be the case when a player plays the gametype for the first time
if ( playermoney ) then
setPlayerMoney ( source, playermoney )
end
end
end

addEventHandler ( "onPlayerQuit", getRootElement ( ), onPlayerQuit )
addEventHandler ( "onPlayerLogin", getRootElement ( ), onPlayerLogin )
</syntaxhighlight>

==Issues==
{{Issues|
{{Issue|7757|[Fixed in 1.3.4-7757] setAccountData clips the digits after the decimal point}}
}}
===Workaround for issue 7757===
Convert your floating point number to a string.
<syntaxhighlight lang="lua">
setAccountData(account, "myKey", tostring(0.123))
</syntaxhighlight>

==See Also==
{{Account_functions}}

[[ar:setAccountData]]
[[es:setAccountData]]

GetElementData

2015-09-23T00:18:44Z

Emiliano Castro:

__NOTOC__
{{Server client function}}
This function retrieves [[element data]] attached to an element under a certain key.

==Syntax==
<syntaxhighlight lang="lua">var getElementData ( element theElement, string key [, inherit = true] )</syntaxhighlight>
{{OOP||[[element]]:getData||setElementData}}

===Required Arguments===
*'''theElement:''' This is the element with data you want to retrieve.
*'''key:''' The name of the element data entry you want to retrieve. (Maximum 31 characters.)

===Optional Arguments===
*'''inherit:''' - toggles whether or not the function should go up the hierarchy to find the requested key in case the specified element doesn't have it.

===Returns===
This function returns a ''variable'' containing the requested element data, or ''false'' if the element or the element data does not exist. When getting data corresponding to a XML attribute, this is always a ''string''.

==Example==
This example stores the tick count when a player joins and then allows players to see how long they are connected using a console function 'joinTime'.
<section show="true" name="Server" class="server">
<syntaxhighlight lang="lua">
function joinTime ( )
setElementData ( source, "joinTime", getTickCount() ) -- Store the current tick count in the player's data with the key 'joinTime'
end
-- Make our 'joinTime' function be called when a player joins
addEventHandler ( "onPlayerJoin", root, joinTime )

function showJoinTime ( source, commandName, playerName )
if ( playerName ) then -- see if a player was specified
thePlayer = getPlayerFromName ( playerName ) -- get the player element for the specified player
if ( thePlayer ) then -- if one was found...
local timeOnline = (getTickCount() - getElementData ( thePlayer, "joinTime" )) / 1000 -- calculates the time since join
outputChatBox ( getPlayerName ( thePlayer ).." joined "..timeOnline.." seconds ago", source ) -- output the player's join time
else
outputChatBox ( "Couldn't find '" .. playerName .. "'", source ) -- display an error
end
else
-- display when the player who used the function joined and inform how to see other people's join time
local timeOnline = (getTickCount() - getElementData ( source, "joinTime" )) / 1000 -- calculate the time since join
outputChatBox ( "You joined " ..timeOnline.." seconds ago", source )
outputChatBox ( "Use 'join_time <player name>' to see other people's join time", source )
end
end
-- Add a console command joinTime, that takes an optional parameter of a player's name
addCommandHandler ( "joinTime", showJoinTime )
</syntaxhighlight>
</section>

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

SetBrowserProperty

2015-09-18T22:16:32Z

Emiliano Castro:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function sets a given property of a specified browser.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setBrowserProperty ( browser theBrowser, string key, string value )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:setProperty||getBrowserProperty}}

===Required arguments===
*'''theBrowser:''' The browser element you want to set a property of
*'''key:''' The browser property key. It can be:
**'''mobile:''' Surfing the web as mobile
*'''value:''' A value indicating whether to enable ("1") the property or not ("0")

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

==Example==
{{Example}}

==See also==
{{CEF_functions}}

SetBrowserProperty

2015-09-15T01:13:34Z

Emiliano Castro:

GetOnlineAdmins

2015-09-12T23:59:02Z

Emiliano Castro:

{{Useful Function}}
<lowercasetitle></lowercasetitle>
__NOTOC__
This function will give the online admins

==Syntax==
<syntaxhighlight lang="lua">table getOnlineAdmins()</syntaxhighlight>

==Code==
<section name="Function source" class="server" show="true">
<syntaxhighlight lang="lua">
function getOnlineAdmins()
local t = {}
for k,v in ipairs ( getElementsByType("player") ) do
local acc = getPlayerAccount(v)
if acc and not isGuestAccount(acc) then
local accName = getAccountName(acc)
local isAdmin = isObjectInACLGroup("user."..accName,aclGetGroup("Admin"))
if isAdmin then
table.insert(t,v)
end
end
end
return t
end
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("admins",function(p)
local Admins = getOnlineAdmins() -- the function will return 1 table
if #Admins ~= 0 then -- if the admins table not empty then
outputChatBox("Online Admins",p,255,0,0,true)
for k,v in ipairs ( Admins ) do -- loop the table
outputChatBox("- "..getPlayerName(v),p,255,0,0,true) -- output the player name
end
end
end )
</syntaxhighlight>
</section>

Function created by '''Al3grab'''.

==See Also==
{{Useful_Functions}}

FileGetPath

2015-09-12T23:43:16Z

Emiliano Castro: Little mistake

__NOTOC__
{{Server client function}}
{{Needs Example}}
{{New feature/item|3.0160|1.6|7446|
Use this function to get file's path.
}}

==Syntax==
<syntaxhighlight lang="lua">
string fileGetPath ( file theFile )
</syntaxhighlight>

===Required Arguments===
*'''theFile:''' The file you want to get the path.

===Returns===
Returns a ''string'' with the path, ''false'' if there's something wrong with the file in the argument.

==Example==

<syntaxhighlight lang="lua">
--TODO
</syntaxhighlight>

==See Also==
{{File functions}}

Template:Client vehicle functions

2015-09-12T23:42:30Z

Emiliano Castro: Little mistake

*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getHeliBladeCollisionsEnabled]]
*[[getHelicopterRotorSpeed]]
*[[getOriginalHandling]]
*[[getTrainDirection]]
*[[getTrainSpeed]]
*[[getVehicleAdjustableProperty]]
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleComponents]]
*[[getVehicleComponentPosition]]
*[[getVehicleComponentRotation]]
*[[getVehicleComponentVisible]]
*[[getVehicleController]]
*[[getVehicleDoorOpenRatio]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleGravity]]
*[[getVehicleHandling]]
*[[getVehicleHeadLightColor]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleModelFromName]]
*[[getVehicleName]]
*[[getVehicleNameFromModel]]
*[[getVehicleNitroCount]]
*[[getVehicleNitroLevel]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleCurrentGear]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
*[[getVehicleSirens]]
*[[getVehicleSirensOn]]
*[[getVehicleSirenParams]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehicleType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleVariant]]
*[[getVehicleWheelStates]]
*[[isTrainChainEngine]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleDamageProof]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleNitroRecharging]]
*[[isVehicleNitroActivated]]
*[[isVehicleOnGround]]
*[[isVehicleTaxiLightOn]]
*[[removeVehicleUpgrade]]
*[[resetVehicleComponentPosition]]
*[[resetVehicleComponentRotation]]
*[[setHeliBladeCollisionsEnabled]]
*[[setHelicopterRotorSpeed]]
*[[setVehicleAdjustableProperty]]
*[[setVehicleColor]]
*[[setVehicleComponentPosition]]
*[[setVehicleComponentRotation]]
*[[setVehicleComponentVisible]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorOpenRatio]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleGravity]]
*[[setVehicleHeadLightColor]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleNitroActivated]]
*[[setVehicleNitroCount]]
*[[setVehicleNitroLevel]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehiclePlateText]]
*[[setVehicleSirens]]
*[[setVehicleSirensOn]]
*[[setVehicleTurretPosition]]
*[[setVehicleTaxiLightOn]]
*[[setVehicleTurnVelocity]]
*[[setVehicleWheelStates]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainSpeed]]
{{New items|3.0160|1.6|
*[[isVehicleWindowOpen]]
*[[getTrainTrack]]
*[[setTrainTrack]]
*[[setVehicleWindowOpen]]
|}}
<noinclude>[[Category:Functions templates]]</noinclude>

SetTrainTrack

2015-09-12T23:39:42Z

Emiliano Castro: Little mistake

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6|7485|
Sets the track of a train
}}

==Syntax==
<syntaxhighlight lang="lua">bool setTrainTrack ( vehicle train, int track )</syntaxhighlight>
{{OOP||[[vehicle]]:setTrack|track|setTrainTrack}}
===Required Arguments===
*'''train:''' the train of which to set the track
*'''track:''' the track where you want to set the train. It can be 1, 2 or 3.

===Returns===
Returns ''true'' if the track was set to the train, ''false'' otherwise.

==Example==

<syntaxhighlight lang="lua">
addCommandHandler("setTrain",
function (cmd,train)
local thePlayer = getLocalPlayer()
local theVehicle = getPedOccupiedVehicle(thePlayer)
local cc = getElementModel(theVehicle)
if cc == 449 or cc == 537 or cc == 538 or cc == 570 or cc == 569 or cc == 590 then
setTrainTrack(theVehicle, train)
end
end)
</syntaxhighlight>

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

GetTrainTrack

2015-09-12T23:39:29Z

Emiliano Castro: Little mistake

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6|7485|
Gets the track of a train
}}

==Syntax==
<syntaxhighlight lang="lua">int getTrainTrack ( vehicle train )</syntaxhighlight>
{{OOP||[[vehicle]]:getTrack|track|getTrainTrack}}
===Required Arguments===
*'''train:''' the train of which to get the track.

===Returns===
Returns an ''intenger'' which means the track of the train, ''false'' if there is problem with train element.

==Example==

<syntaxhighlight lang="lua">
addCommandHandler("getTrain",
function ()
local thePlayer = getLocalPlayer()
local theVehicle = getPedOccupiedVehicle(thePlayer)
train = getTrainTrack(theVehicle)
outputChatBox("Train Track is "..train)
end)

</syntaxhighlight>

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

SetTrainTrack

2015-09-12T23:18:21Z

Emiliano Castro:

__NOTOC__
{{Client function}}
{{New feature/item|3.0151|1.6|7485|
Sets the track of a train
}}

==Syntax==
<syntaxhighlight lang="lua">bool setTrainTrack ( vehicle train, int track )</syntaxhighlight>
{{OOP||[[vehicle]]:setTrack|track|setTrainTrack}}
===Required Arguments===
*'''train:''' the train of which to set the track
*'''track:''' the track where you want to set the train. It can be 1, 2 or 3.

===Returns===
Returns ''true'' if the track was set to the train, ''false'' otherwise.

==Example==

<syntaxhighlight lang="lua">
addCommandHandler("setTrain",
function (cmd,train)
local thePlayer = getLocalPlayer()
local theVehicle = getPedOccupiedVehicle(thePlayer)
local cc = getElementModel(theVehicle)
if cc == 449 or cc == 537 or cc == 538 or cc == 570 or cc == 569 or cc == 590 then
setTrainTrack(theVehicle, train)
end
end)
</syntaxhighlight>

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

GetTrainTrack

2015-09-12T23:13:45Z

Emiliano Castro:

__NOTOC__
{{Client function}}
{{New feature/item|3.0151|1.6|7485|
Gets the track of a train
}}

==Syntax==
<syntaxhighlight lang="lua">int getTrainTrack ( vehicle train )</syntaxhighlight>
{{OOP||[[vehicle]]:getTrack|track|getTrainTrack}}
===Required Arguments===
*'''train:''' the train of which to get the track.

===Returns===
Returns an ''intenger'' which means the track of the train, ''false'' if there is problem with train element.

==Example==

<syntaxhighlight lang="lua">
addCommandHandler("getTrain",
function ()
local thePlayer = getLocalPlayer()
local theVehicle = getPedOccupiedVehicle(thePlayer)
train = getTrainTrack(theVehicle)
outputChatBox("Train Track is "..train)
end)

</syntaxhighlight>

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

Changes in 1.5.8

2015-09-11T22:13:16Z

Emiliano Castro: /* Client */

{{Changelogs}}

== Main Additions / Changes ==
* None yet

== Scripting ==

=== Scripting: New functions ===

====Client====
*[[getTrainTrack]]
*[[isVehicleWindowOpen]]
*[[setTrainTrack]]
*[[setVehicleWindowOpen]]

==== Server ====
* None yet

==== Shared (''Client & Server side'') ====
* None yet

=== Scripting: New Events ===

==== Client ====
* None yet

==== Server ====
* None yet

=== Scripting: Changes, Bugfixes and Additions ===
* None yet

== Client ==

=== Client: Additions ===
* None yet

=== Client: Bugfixes & Changes ===
* None yet

== Server ==

=== Server: Additions ===
* None yet

=== Server: Bugfixes & Changes ===
* None yet

== Resources ==
* None yet

== Editor ==
* None yet

== Extra information ==
''More detailed information available on [https://bugs.multitheftauto.com/changelog_page.php Bug tracker Changelog] and GitHub repositories:
:* [https://github.com/multitheftauto/mtasa-blue MTA: SA Blue]
:* [https://github.com/multitheftauto/mtasa-resources MTA: SA Official Resources]

[[Category:Changelog]]
[[Category:Incomplete]]

Template:Client vehicle functions

2015-09-11T22:12:24Z

Emiliano Castro:

*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getHeliBladeCollisionsEnabled]]
*[[getHelicopterRotorSpeed]]
*[[getOriginalHandling]]
*[[getTrainDirection]]
*[[getTrainSpeed]]
*[[getVehicleAdjustableProperty]]
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleComponents]]
*[[getVehicleComponentPosition]]
*[[getVehicleComponentRotation]]
*[[getVehicleComponentVisible]]
*[[getVehicleController]]
*[[getVehicleDoorOpenRatio]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleGravity]]
*[[getVehicleHandling]]
*[[getVehicleHeadLightColor]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleModelFromName]]
*[[getVehicleName]]
*[[getVehicleNameFromModel]]
*[[getVehicleNitroCount]]
*[[getVehicleNitroLevel]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleCurrentGear]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
*[[getVehicleSirens]]
*[[getVehicleSirensOn]]
*[[getVehicleSirenParams]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehicleType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleVariant]]
*[[getVehicleWheelStates]]
*[[isTrainChainEngine]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleDamageProof]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleNitroRecharging]]
*[[isVehicleNitroActivated]]
*[[isVehicleOnGround]]
*[[isVehicleTaxiLightOn]]
*[[removeVehicleUpgrade]]
*[[resetVehicleComponentPosition]]
*[[resetVehicleComponentRotation]]
*[[setHeliBladeCollisionsEnabled]]
*[[setHelicopterRotorSpeed]]
*[[setVehicleAdjustableProperty]]
*[[setVehicleColor]]
*[[setVehicleComponentPosition]]
*[[setVehicleComponentRotation]]
*[[setVehicleComponentVisible]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorOpenRatio]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleGravity]]
*[[setVehicleHeadLightColor]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleNitroActivated]]
*[[setVehicleNitroCount]]
*[[setVehicleNitroLevel]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehiclePlateText]]
*[[setVehicleSirens]]
*[[setVehicleSirensOn]]
*[[setVehicleTurretPosition]]
*[[setVehicleTaxiLightOn]]
*[[setVehicleTurnVelocity]]
*[[setVehicleWheelStates]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainSpeed]]
{{New items|3.0151|1.6|
*[[isVehicleWindowOpen]]
*[[getTrainTrack]]
*[[setTrainTrack]]
*[[setVehicleWindowOpen]]
|}}
<noinclude>[[Category:Functions templates]]</noinclude>

Template:Client vehicle functions

2015-09-11T22:10:27Z

Emiliano Castro:

*[[addVehicleUpgrade]]
*[[attachTrailerToVehicle]]
*[[blowVehicle]]
*[[createVehicle]]
*[[detachTrailerFromVehicle]]
*[[fixVehicle]]
*[[getHeliBladeCollisionsEnabled]]
*[[getHelicopterRotorSpeed]]
*[[getOriginalHandling]]
*[[getTrainDirection]]
*[[getTrainSpeed]]
*[[getVehicleAdjustableProperty]]
*[[getVehicleColor]]
*[[getVehicleCompatibleUpgrades]]
*[[getVehicleComponents]]
*[[getVehicleComponentPosition]]
*[[getVehicleComponentRotation]]
*[[getVehicleComponentVisible]]
*[[getVehicleController]]
*[[getVehicleDoorOpenRatio]]
*[[getVehicleDoorState]]
*[[getVehicleEngineState]]
*[[getVehicleGravity]]
*[[getVehicleHandling]]
*[[getVehicleHeadLightColor]]
*[[getVehicleLandingGearDown]]
*[[getVehicleLightState]]
*[[getVehicleMaxPassengers]]
*[[getVehicleModelFromName]]
*[[getVehicleName]]
*[[getVehicleNameFromModel]]
*[[getVehicleNitroCount]]
*[[getVehicleNitroLevel]]
*[[getVehicleOccupant]]
*[[getVehicleOccupants]]
*[[getVehicleCurrentGear]]
*[[getVehicleOverrideLights]]
*[[getVehiclePaintjob]]
*[[getVehiclePanelState]]
*[[getVehiclePlateText]]
*[[getVehicleSirens]]
*[[getVehicleSirensOn]]
*[[getVehicleSirenParams]]
*[[getVehicleTowedByVehicle]]
*[[getVehicleTowingVehicle]]
*[[getVehicleTurnVelocity]]
*[[getVehicleTurretPosition]]
*[[getVehicleType]]
*[[getVehicleUpgradeOnSlot]]
*[[getVehicleUpgrades]]
*[[getVehicleUpgradeSlotName]]
*[[getVehicleVariant]]
*[[getVehicleWheelStates]]
*[[isTrainChainEngine]]
*[[isTrainDerailable]]
*[[isTrainDerailed]]
*[[isVehicleBlown]]
*[[isVehicleDamageProof]]
*[[isVehicleFuelTankExplodable]]
*[[isVehicleLocked]]
*[[isVehicleNitroRecharging]]
*[[isVehicleNitroActivated]]
*[[isVehicleOnGround]]
*[[isVehicleTaxiLightOn]]
*[[removeVehicleUpgrade]]
*[[resetVehicleComponentPosition]]
*[[resetVehicleComponentRotation]]
*[[setHeliBladeCollisionsEnabled]]
*[[setHelicopterRotorSpeed]]
*[[setVehicleAdjustableProperty]]
*[[setVehicleColor]]
*[[setVehicleComponentPosition]]
*[[setVehicleComponentRotation]]
*[[setVehicleComponentVisible]]
*[[setVehicleDamageProof]]
*[[setVehicleDirtLevel]]
*[[setVehicleDoorOpenRatio]]
*[[setVehicleDoorState]]
*[[setVehicleDoorsUndamageable]]
*[[setVehicleEngineState]]
*[[setVehicleFuelTankExplodable]]
*[[setVehicleGravity]]
*[[setVehicleHeadLightColor]]
*[[setVehicleLandingGearDown]]
*[[setVehicleLightState]]
*[[setVehicleLocked]]
*[[setVehicleNitroActivated]]
*[[setVehicleNitroCount]]
*[[setVehicleNitroLevel]]
*[[setVehicleOverrideLights]]
*[[setVehiclePaintjob]]
*[[setVehiclePanelState]]
*[[setVehiclePlateText]]
*[[setVehicleSirens]]
*[[setVehicleSirensOn]]
*[[setVehicleTurretPosition]]
*[[setVehicleTaxiLightOn]]
*[[setVehicleTurnVelocity]]
*[[setVehicleWheelStates]]
*[[setTrainDerailable]]
*[[setTrainDerailed]]
*[[setTrainDirection]]
*[[setTrainSpeed]]
{{New items|3.0151|1.6|
*[[isVehicleWindowOpen]]
*[[getTrainTrack]]
*[[setTrainTrack]]
|}}
<noinclude>[[Category:Functions templates]]</noinclude>

IsVehicleWindowOpen

2015-09-11T21:31:15Z

Emiliano Castro:

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.6|7405|This function gets the vehicle window state.}}

==Syntax==
<syntaxhighlight lang="lua">
bool isVehicleWindowOpen ( vehicle theVehicle, int window )
</syntaxhighlight>

=== Required arguments ===
* '''theVehicle:''' The vehicle that you wish to get the window state.
* '''window:''' An [[int|integer]] representing a vehicle window. It can be:
** '''0:''' motorbike shield
** '''1:''' rear window
** '''2:''' right front window
** '''3:''' right back window
** '''4:''' left front (driver) window
** '''5:''' left back window
** '''6:''' windshield

== Returns ==
This function returns a boolean which represents window open state.

== Example ==
With this example, you can use /Window_vehicle to open, or close if it is open, the window of the local player's current seat.
<syntaxhighlight lang="lua">table = { 4, 2, 5, 3 }

addCommandHandler ("Window_vehicle", function ( )
if ( isPedInVehicle ( localPlayer ) ) then
local vehicle = getPedOccupiedVehicle( localPlayer )
local window = getPedOccupiedVehicleSeat( localPlayer )
setVehicleWindowOpen( vehicle, table[window], not isVehicleWindowOpen( vehicle, table[window] ) )
end
end
)</syntaxhighlight>

== See also ==
{{Client vehicle functions}}