Multi Theft Auto: Wiki - User contributions [en]

CreateBrowser

2015-07-27T19:53:20Z

Dmitry7zip: Fix returns

__NOTOC__
{{Client_function}}
{{New feature/item|3.0150|1.5||
This function creates a new web [[Element/Browser|browser]] element.
}}

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

===Required Arguments===
*'''width:''' The browser's native width
*'''height:''' The browser's native height
*'''isLocal:''' See examples
''
===Optional Arguments===
*'''transparent:''' ''true'' if you want the browser transparent, ''false'' for opaque.

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

==Local Example==
This example shows you how to create a fullscreen Webbrowser (showing a local html file) without input-handling.
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in local mode. We will not be able to load an external URL.
local webBrowser = createBrowser(screenWidth, screenHeight, true, false)

--This is the function to render the browser.
function webBrowserRender()
--Render the browser on the full size of the screen.
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser,
function()
--After the browser has been initialized, we can load our file.
loadBrowserURL(webBrowser, "html/site.html")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>

==Remote Example==
This example shows you how to create a fullscreen Webbrowser (showing youtube.com) without input-handling.<br>
Remember, that youtube.com is on the global whitelist. If you want to load a domain/page that is not on the global whitelist, you have to request it with [[requestBrowserDomains|requestBrowserDomains]].
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in remote mode.
local webBrowser = createBrowser(screenWidth, screenHeight, false, false)

--Function to render the browser.
function webBrowserRender()
--Render the browser on the full size of the screen.
dxDrawImage(0, 0, screenWidth, screenHeight, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

--The event onClientBrowserCreated will be triggered, after the browser has been initialized.
--After this event has been triggered, we will be able to load our URL and start drawing.
addEventHandler("onClientBrowserCreated", webBrowser,
function()
--After the browser has been initialized, we can load www.youtube.com
loadBrowserURL(webBrowser, "http://www.youtube.com")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

RU/dbConnect

2015-06-19T19:36:13Z

Dmitry7zip: Some translation

__NOTOC__
{{Translate}}
{{RU/Server function}}
Эта функция открывает подключение к базе данных и возвращает элемент, который может быть использован с [[RU/dbQuery|dbQuery]]. Для отключения используйте [[RU/destroyElement|destroyElement]].
{{RU/Note|Подсоединение и отсоединение много раз может негативно повлиять на производительность сервера. Для оптимальной производительности рекомендуется использовать dbConnect только один раз, когда ресурс запускается, и использовать это соединение во всем ресурсе.}}
{{RU/Note|dbConnect на Linux MySQL требует libmysqlclient.so.15 (для MTA 1.3), или libmysqlclient.so.16 (для MTA 1.4)}}
==Синтаксис==
<syntaxhighlight lang="lua">
element dbConnect ( string databaseType, string host [, string username = "", string password = "", string options = "" ] )
</syntaxhighlight>
{{RU/OOP||[[Connection]]}}
===Обязательные параметры===
*'''databaseType:''' Тип базы данных. Может быть ''sqlite'' или ''mysql''
*'''host:''' Цель для подключения. Формат зависит от типа базы данных.
** Для SQLite это [[filepath|путь]] к файлу SQLite базы данных. Если путь начинается с ":/" будет использоваться глобальный каталог баз данных сервера. Файл будет создан, если он не существует.
** Для MySQL это список формата ключ=значение, разделенный точкой с запятой. Поддерживаются следующие ключи:
*** '''dbname''': Имя базы данных для использования. Например: ''dbname=test''
*** '''host''': Адрес хоста. Например: ''host=127.0.0.1''
*** '''port''': Порт хоста. Например: ''port=1234'' (опционально, по умолчанию используется стандартный порт MySQL)
*** '''unix_socket''': Unix-сокет или именованный канал для использования (опционально)

===Необязательные параметры===
*'''username:''' Обычно требуется для MySQL, игнорируется для SQLite
*'''password:''' Обычно требуется для MySQL, игнорируется для SQLite
*'''options :''' List of key=value pairs separated by semicolons. Supported keys are:
**'''share''' which can be set to 0 or 1. (Default value for SQLite is "share=1", for MySQL is "share=0"). When set to 1, the connection is shared and will be used by other calls to dbConnect with the same host string. This is usually a good thing for SQLite connections, but not so good for MySQL unless care is taken.
**'''batch''' which can be set to 0 or 1. (Default is "batch=1"). When set to 1, queries called in the same frame are automatically batched together which can significantly speed up inserts/updates. The downside is you lose control of the feature that is used to achieve batching (For SQLite it is transactions, for MySQL it is autocommit mode). Therefore, if you use transactions, lock tables or control autocommit yourself, you may want to disable this feature.
**'''autoreconnect''' which can be set to 0 or 1. (Default value "autoreconnect=1"). When set to 1, dropped connections will automatically be reconnected. Note that session variables, user variables, table locks and temporary tables will be reset because of the reconnection. So if you use these fancy features, you will need to turn autoreconnect off and cope with dropped connections some other way.
**'''log''' which can be set to 0 or 1. (Default value "log<nowiki>=</nowiki>1"). When set to 0, activity from this connection will not be recorded in the [[Server_Commands#debugdb|database debug log file]].
**'''tag''' (Default value "tag<nowiki>=</nowiki>script"). A string which helps identify activity from this connection in the [[Server_Commands#debugdb|database debug log file]].
**'''suppress''' A comma separated list of error codes to ignore. (eg. "suppress<nowiki>=</nowiki>1062,1169").
**'''charset''' If you want to communicate with the server using a character set different from the default, you'll need to indicate which one. (eg. "charset<nowiki>=</nowiki>utf8"). (used only in MySQL)

===Возвращает===
Возвращает элемент подключения к базе данных, если проблем нет, в противном случае ''false''.

==Пример==
This example opens a connection to a SQLite database file in the current resource
<syntaxhighlight lang="lua">
test_db = dbConnect( "sqlite", "file.db" )
</syntaxhighlight>

This example opens a connection to a SQLite database file in another resource
<syntaxhighlight lang="lua">
test_db = dbConnect( "sqlite", ":resname/file.db" )
</syntaxhighlight>

This example opens a connection to a SQLite database file in the global databases directory
<syntaxhighlight lang="lua">
test_db = dbConnect( "sqlite", ":/file.db" )
</syntaxhighlight>

This example opens a connection to a SQLite database file in a sub directory of the global databases directory
<syntaxhighlight lang="lua">
test_db = dbConnect( "sqlite", ":/example/sub/dir/file.db" )
</syntaxhighlight>

This example opens a connection to a MySQL database called 'frank' at server ip 1.2.3.4 and allows the connection to be shared. Note that changing the database or other connection dependent settings affect all connections that are shared.
<syntaxhighlight lang="lua">
test_db = dbConnect( "mysql", "dbname=frank;host=1.2.3.4", "username", "password", "share=1" )
</syntaxhighlight>

This example opens a connection to a SQLite database is disallows sharing of the connection
<syntaxhighlight lang="lua">
test_db = dbConnect( "sqlite", "file.db", "", "", "share=0" )
</syntaxhighlight>

==Требования==
{{RU/Requirements|1.1.1-9.03328|n/a}}

==Список изменений==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04817|Добавлены опции 'log', 'tag' и 'suppress'}}
{{ChangelogItem|1.3.5-9.06386|Добавлена опция 'charset'}}

==Смотрите также==
{{RU/Registry_functions}}

[[en:dbConnect]]

BanPlayer

2015-06-07T14:38:27Z

Dmitry7zip: /* Returns */

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

GetVersion

2015-06-07T14:26:59Z

Dmitry7zip:

__NOTOC__
{{Server client function}}

This function gives you various version information about MTA and the operating system.

''Note:'' Clientside will return the version from the player, and the server-sided will return version from the server.

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

===Returns===
Returns a table with version information. Specifically these keys are present in the table:
*'''number:''' the MTA server or client version (depending where the function was called) in pure numerical form, e.g. ''"256"''
*'''mta:''' the MTA server or client version (depending where the function was called) in textual form, e.g. ''"1.0"''
*'''name:''' the full MTA product name, either ''"MTA:SA Server"'' or ''"MTA:SA Client"''.
*'''netcode:''' the netcode version number.
*'''os:''' returns the operating system on which the server or client is running
*'''type:''' the type of build. can be:
**'''"Nightly rX"''' - A nightly development build. '''X''' represents the nightly build revision.
**'''"Custom"''' - A build compiled manually
**'''"Release"''' - A build that is publicly released (provisional).
*'''tag:''' the build tag (from 1.0.3 onwards). Contains infomation about the underlying version used. i.e. The final version of 1.0.3 has the build tag of "1.0.3 rc-9". (This can be confirmed by using the console command 'ver'.)
*'''sortable:''' a 15 character sortable version string (from 1.0.4 onwards). Format of the string is described in [[getPlayerVersion]].

==Example==
'''Example 1:''' This example will make a script compatible only with version 1.0:
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function setHoboSkin ( playerSource )
local version = getVersion ( )
if version.number < 256 then -- MTA 1.0 version number is 0x0100
setPlayerSkin ( playerSource, 137 )
else
setElementModel ( playerSource, 137 )
end
end
addCommandHandler ( "hobo", setHoboSkin )
</syntaxhighlight>
</section>

'''Example 2:''' This client and server example will kick players that have anything earlier than the final released version of 1.0.3:
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function sendVersion ()
-- Send local player version to the server
triggerServerEvent ( "onNotifyPlayerVersion", getResourceRootElement(), getVersion() )
end
addEventHandler ( "onClientResourceStart", getResourceRootElement(), sendVersion )
</syntaxhighlight>
</section><section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function handlePlayerVersion( version )
if version.number > 256 + 3 then -- Allow anything above 1.0.3
return
end
if version.number == 256 + 3 then -- Check further if it is exactly 1.0.3
if version.type == "Release" then -- Check further if it is the "Release" type
local _,_,buildnumber = string.find( version.tag or "", "(%d)$" ) -- Extract the build number if there
buildnumber = tonumber(buildnumber) or 0
if buildnumber >= 9 then -- Allow 9 and above
return
end
end
end
outputConsole( "Kicking player as below 1.0.3 Release build 9" );
kickPlayer( client, "Upgrade your version at www.mtasa.com" )
end
addEvent ( "onNotifyPlayerVersion", true)
addEventHandler ( "onNotifyPlayerVersion", getResourceRootElement(), handlePlayerVersion )
</syntaxhighlight>
</section>

==See Also==
{{Server functions}}

GetVersion

2015-06-07T14:26:46Z

Dmitry7zip:

GetVehicleHeadLightColor

2015-06-07T14:21:32Z

Dmitry7zip:

__NOTOC__
{{Server client function}}
This function will get the headlight color of a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int getVehicleHeadLightColor ( vehicle theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getHeadLightColor||setVehicleHeadLightColor}}
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to set the headlight color of.

===Returns===
Returns three ''integers'' for the red, green and blue of the headlight color for the specified vehicle, ''false'' if an invalid vehicle was specified.

==Example==
This example outputs the player vehicle head lights color.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function getHeadLightsColor()
local vehicle = getPedOccupiedVehicle(localPlayer) -- We get the player vehicle..
if (vehicle) then -- We check if he's on a vehicle...
local r, g, b = getVehicleHeadLightColor(vehicle) -- We get the vehicle head lights color..
outputChatBox("Your vehicle lights color are: ".. r ..", ".. g ..", ".. b) -- We output them to the chatbox.
end
end
addCommandHandler("lightscolor",getHeadLightsColor) -- Add the command handler attached to the function "getHeadLightsColor".
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getHeadLightsColor(thePlayer)
local vehicle = getPedOccupiedVehicle(thePlayer) -- We get the player vehicle..
if (vehicle) then -- We check if he's on a vehicle...
local r, g, b = getVehicleHeadLightColor(vehicle) -- We get the vehicle head lights color..
outputChatBox("Your vehicle lights color are: ".. r ..", ".. g ..", ".. b, thePlayer) -- We output them to the chatbox.
end
end
addCommandHandler("lightscolor",getHeadLightsColor) -- Add the command handler attached to the function "getHeadLightsColor".
</syntaxhighlight>
</section>

==See Also==
{{Vehicle_functions}}

SetWeaponTarget

2015-06-06T21:30:51Z

Dmitry7zip:

__NOTOC__
{{Client function}}
This function sets the target of a [[Element/Weapon|custom weapon]]. There are 3 different targeting modes, which are explained below.
{{Note|[[Element/Weapon|Custom weapons]] target its target (assigned by this function) with no recoil. If you want a custom weapon to take into account recoil, you will have to script it by firing at fixed coordinates.}}

==Syntax==
Fires the weapon at a physical [[element]].

<syntaxhighlight lang="lua">bool setWeaponTarget ( weapon theWeapon, element theTarget [, int theComponent = 255] )</syntaxhighlight>

{{OOP|Variable is read only.|[[Element/Weapon|weapon]]:setTarget|target|getWeaponTarget}}

===Required arguments===
* '''theWeapon:''' The weapon to set the target of.
* '''theTarget:''' The [[element]] to shoot at. It can be a [[player]], [[ped]], [[vehicle]] or [[object]].

===Optional arguments===
* '''theComponent:''' The component of the target to shoot at. This argument is only relevant when used in the following element types:
** '''[[Vehicle|Vehicles]]''':
*** '''0''': front left tire.
*** '''1''': front right tire.
*** '''2''': rear left tire.
*** '''3''': rear right tire.
*** '''255''': center of the car (position returned by [[getElementPosition]]).
** '''[[Ped|Peds]]''' (players '''not''' included; see [[getPedBonePosition]] to know where is located each bone):
***'''1:''' ''BONE_PELVIS1'' position.
***'''2:''' ''BONE_PELVIS'' position.
***'''3:''' ''BONE_SPINE1'' position.
***'''4:''' ''BONE_UPPERTORSO'' position.
***'''5:''' ''BONE_NECK'' position.
***'''6:''' ''BONE_HEAD2'' position.
***'''7:''' ''BONE_HEAD1'' position.
***'''8:''' ''BONE_HEAD'' position.
***'''21:''' ''BONE_RIGHTUPPERTORSO'' position.
***'''22:''' ''BONE_RIGHTSHOULDER'' position.
***'''23:''' ''BONE_RIGHTELBOW'' position.
***'''24:''' ''BONE_RIGHTWRIST'' position.
***'''25:''' ''BONE_RIGHTHAND'' position.
***'''26:''' ''BONE_RIGHTTHUMB'' position.
***'''31:''' ''BONE_LEFTUPPERTORSO'' position.
***'''32:''' ''BONE_LEFTSHOULDER'' position.
***'''33:''' ''BONE_LEFTELBOW'' position.
***'''34:''' ''BONE_LEFTWRIST'' position.
***'''35:''' ''BONE_LEFTHAND'' position.
***'''36:''' ''BONE_LEFTTHUMB'' position.
***'''41:''' ''BONE_LEFTHIP'' position.
***'''42:''' ''BONE_LEFTKNEE'' position.
***'''43:''' ''BONE_LEFTANKLE'' position.
***'''44:''' ''BONE_LEFTFOOT'' position.
***'''51:''' ''BONE_RIGHTHIP'' position.
***'''52:''' ''BONE_RIGHTKNEE'' position.
***'''53:''' ''BONE_RIGHTANKLE'' position.
***'''54:''' ''BONE_RIGHTFOOT'' position.
*** '''255''': center of the ped (position returned by [[getElementPosition]]).

===Returns===
Returns ''true'' on success, ''false'' otherwise.

==Syntax (target a position)==
Fires the weapon at the specified position.

<syntaxhighlight lang="lua">bool setWeaponTarget ( weapon theWeapon, float targetX, float targetY, float targetZ )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to set the target of.
* '''targetX:''' The target X.
* '''targetY:''' The target Y.
* '''targetZ:''' The target Z.

===Returns===
Returns ''true'' on success, ''false'' otherwise.

==Syntax (rotational target)==
Sets the weapon back to rotation based targeting.

<syntaxhighlight lang="lua">bool setWeaponTarget ( weapon theWeapon, nil )</syntaxhighlight>

===Required Arguments===
* '''theWeapon:''' The weapon to clear the target of.

===Returns===
Returns ''true'' on success, ''false'' otherwise.

==Requirements==
{{Requirements|n/a|1.3.0-9.04555|}}

==See also==
{{Client weapon creation functions}}

RemoveWorldModel

2015-06-06T21:27:58Z

Dmitry7zip:

__NOTOC__
{{Server client function}}

This function is used to remove a world object.

==Syntax==
<syntaxhighlight lang="lua">bool removeWorldModel ( int modelID, float radius, float x, float y, float z [, int interior = 0 ] )</syntaxhighlight>

===Required Arguments===
*'''modelID:''' A whole integer specifying the GTASA object model ID.
*'''radius:''' A floating point number representing the radius that will be eliminated.
*'''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.

===Optional Arguments===
{{New items|3.0132|1.3.2|
*'''interior:''' The interior ID to apply the removal to ( some objects in interior 13 show in all interiors so if you want to remove everything in interior 0 also remove everything in interior 13 )
}}

===Returns===
Returns ''true'' if the [[object]] was removed, ''false'' if invalid arguments were passed.

==Requirements==
{{Requirements|1.2.0-9.03618|1.2.0-9.03618|}}

==Example==
This example will removes buildings on BigEar:
<syntaxhighlight lang="lua">
removeWorldModel(16617,1000,-300,1556,75) --lod
removeWorldModel(16616,1000,-300,1556,75) --lod
removeWorldModel(16615,1000,-300,1556,75) --lod
removeWorldModel(16138,1000,-300,1556,75) -- model
</syntaxhighlight>

This example removes CJ house:
<syntaxhighlight lang="lua">
for i=700,20000 do
removeWorldModel(i,10,2494,-1696,17)
end
</syntaxhighlight>

This server script example removes all models, everywhere:
<syntaxhighlight lang="lua">
for i=550,20000 do
removeWorldModel(i,10000,0,0,0)
end
setOcclusionsEnabled(false) -- Also disable occlusions when removing certain models
setWaterLevel(-5000) -- Also hide the default water as it will be full of holes
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04636|Added interior argument}}
{{ChangelogItem|1.3.1-9.04844|Everything streams out fine now.}}

==See Also==
{{Client_world_functions}}

RestoreAllWorldModels

2015-06-06T21:27:43Z

Dmitry7zip:

__NOTOC__
{{Server client function}}
This function allows restoring of all world objects,which were removed with [[RemoveWorldModel]].

==Syntax==
<syntaxhighlight lang="lua">
bool restoreAllWorldModels ( )
</syntaxhighlight>

==Returns==
Returns ''true'' if the world objects were restored, ''false'' otherwise.

==Requirements==
{{Requirements|1.2.0-9.03618|1.2.0-9.03618|}}

==Example==
This example adds command ''"restoreallworldobjects"'' that restores all world objects.
<syntaxhighlight lang="lua">
addCommandHandler("restoreallworldobjects",
function()
restoreAllWorldModels()
end
)
</syntaxhighlight>

==See Also==
{{Client_world_functions}}

RestoreWorldModel

2015-06-06T21:27:27Z

Dmitry7zip:

__NOTOC__
{{Server client function}}

This function allows restoring of world object,which was removed with [[RemoveWorldModel]].

==Syntax==
<syntaxhighlight lang="lua">
bool restoreWorldModel ( int modelID, float radius, float x, float y, float z [, int iInterior = -1 ] )
</syntaxhighlight>

===Required Arguments===
*'''modelID:''' A whole integer specifying the GTASA object model ID.
*'''radius:''' A floating point number representing the radius that will be eliminated.
*'''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.
{{New items|3.0132|1.3.2|
*'''iInterior:'''
}}

===Returns===
Returns ''true'' if the world object was restored, ''false'' otherwise.

==Requirements==
{{Requirements|1.2.0-9.03618|1.2.0-9.03618|}}

==Example==
Remove every lamp post (object 1226) besides Grove Street.
<syntaxhighlight lang="lua">
removeWorldModel(1226, 4000, 0, 0, 0, -1)
restoreWorldModel(1226, 50, 2489, -1665, 13, -1)

</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.1-9.04636|Added iInterior argument}}

==See Also==
{{Client_world_functions}}

TakeWeapon

2015-06-06T21:27:01Z

Dmitry7zip:

__NOTOC__
{{Server function}}
This function removes a specified weapon or ammo from a certain player's inventory.

==Syntax==
<syntaxhighlight lang="lua">bool takeWeapon ( player thePlayer, int weaponId [, int ammo ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer''': A player object referencing the specified player.
*'''weaponId''': An integer that refers to a [[weapon]] that you wish to remove.

===Optional Arguments===
*'''ammo''': If used, this amount of ammo will be taken instead and the weapon will not be removed.

===Returns===
Returns a ''true'' if the weapon/ammo was removed successfully, ''false'' otherwise.

==Example==
This example removes teargas from player.
<syntaxhighlight lang="lua">
addCommandHandler( 'rtear',
function( thePlayer )
takeWeapon( thePlayer, 17 )
end
)</syntaxhighlight>

==See Also==
{{Weapon functions}}
[[ru:takeWeapon]]

GetCursorAlpha

2015-06-06T20:56:10Z

Dmitry7zip:

{{Client function}}
This function is used to get alpha (transparency) from the client's cursor.

==Syntax==
<syntaxhighlight lang="lua">
int getCursorAlpha ( )
</syntaxhighlight>

===Returns===
Returns a int, 0-255, where 255 is fully opaque and 0 is fully transparent.

==Requirements==
{{Requirements|n/a|1.3.2}}

==Example==
<syntaxhighlight lang="lua">
-- Simple command to test the getCursorAlpha function
addCommandHandler( "cursorAlpha",
function ()
if ( isCursorShowing ( ) ) then
outputChatBox( "The cursor alpha: "..getCursorAlpha( ) )
else
outputChatBox( "The cursor is not showing!" )
end
end
)
</syntaxhighlight>

==See Also==
{{GUI_functions}}

GetCamera

2015-06-06T20:55:47Z

Dmitry7zip:

{{Client function}}
__NOTOC__
{{New items|3.0135|1.3.5|
This function returns an [[element]] that corresponds to the game camera
}}
{{Note|Using attachElements with the camera and the main player can interfere with movement}}
{{Note|Using setElementPosition/Rotation/Matrix on the camera element will automatically clear any target set with [[setCameraTarget]]}}
==Syntax==
<syntaxhighlight lang="lua">
element getCamera ()
</syntaxhighlight>

===Returns===
Returns an [[element]] that corresponds to the game camera

==Example==
This example attaches (fixes) the camera to a vehicle.
<syntaxhighlight lang="lua">
local cam = getCamera()
setElementPosition( cam, 0,0,0 ) -- Clear camera target
local myVehicle = getPedOccupiedVehicle(localPlayer)
attachElements( cam, myVehicle, 0,-4,2, -20,0,0 )
</syntaxhighlight>

==See Also==
{{Client camera functions}}

CreateVehicle

2015-06-02T15:03:00Z

Dmitry7zip: Fixed 'bDirection' arg name in description

{{Needs_Checking|
* Explain the direction parameter which should always be false and what is the point of having a parameter whose value need to be the same all the time. --[[User:MTA SE|MTA SE]] 20:05, 5 July 2012 (UTC)
}}
__NOTOC__
{{Server client function}}
{{note_box|Vehicles (and other elements) created client-side are only seen by the client that created them, aren't synced and players cannot enter them. They are essentially for display only.}}
This function creates a vehicle at the specified location.

Its worth noting that the position of the vehicle is the center point of the vehicle, not its base. As such, you need to ensure that the z value (vertical axis) is some height above the ground. You can find the exact height using the client side function [[getElementDistanceFromCentreOfMassToBaseOfModel]], or you can estimate it yourself and just spawn the vehicle so it drops to the ground.

==Syntax==
<syntaxhighlight lang="lua">
vehicle createVehicle ( int model, float x, float y, float z [, float rx, float ry, float rz, string numberplate, bool bDirection, int variant1, int variant2 ] )
</syntaxhighlight>
{{OOP||[[Vehicle]]||}}

===Required Arguments===
* '''model''': The [[Vehicle IDs|vehicle ID]] of the vehicle being created.
* '''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.

===Optional Arguments===
{{OptionalArg}}
* '''rx''': A floating point number representing the rotation about the X axis in degrees.
* '''ry''': A floating point number representing the rotation about the Y axis in degrees.
* '''rz''': A floating point number representing the rotation about the Z axis in degrees.
* '''numberplate''': A string that will go on the number plate of the car (max 8 characters). This is only applicable to cars.
* '''bDirection''': A boolean which should be set to false. *SERVER ONLY*
{{New feature/item|3.0120|1.2||
* '''variant1''': An integer for the first vehicle variant see [[Vehicle variants]]
* '''variant2''': An integer for the second vehicle variant see [[Vehicle variants]]
}}

===Returns===
Returns the [[vehicle]] element that was created. Returns ''false'' if the arguments are incorrect, or if the vehicle limit of 65535 is exceeded.

==Using trains==
Trains are created using the createVehicle function. They are placed at the nearest point of the GTASA train pathing (railroad tracks) from their spawning point.

==Example==
<section name="Example 1: Server" class="server" show="true">
This script spawns a Rhino on top of one lucky individual.
<syntaxhighlight lang="lua">
function scriptCreateTank ( player, command )
local luckyBugger = getRandomPlayer() -- get a random player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", luckyBugger )
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 2: Client" class="client" show="true">
This script spawns a Rhino on top of the local player.
<syntaxhighlight lang="lua">
function scriptCreateTank ( commandName )
local luckyBugger = getLocalPlayer() -- get the local player
local x, y, z = getElementPosition ( luckyBugger ) -- retrive the player's position
createVehicle ( 432, x, y, z + 10 ) -- create the tank 10 units above them
outputChatBox ( "You got Tank'd!", 255, 0, 0)
end
--Attach the 'scriptCreateTank' function to the "tank" command
addCommandHandler ( "tank", scriptCreateTank )
</syntaxhighlight>
</section>

<section name="Example 3: Server" class="server" show="false">
This example creates a vehicle five units to the right of a player when they type ''createvehicle'' and its name in the console:
<syntaxhighlight lang="lua">
local distance = 5 --units

-- define our handler (we'll take a variable number of parameters where the name goes, because there are vehicle names with more than one word)
function consoleCreateVehicle ( sourcePlayer, commandName, ... )
-- if a player triggered it, not the admin,
if ( sourcePlayer ) then
-- calculate the position of the vehicle based on the player's position and rotation:
local x, y, z = getElementPosition ( sourcePlayer ) -- get the player's position
local rotZ = getPedRotation ( sourcePlayer ) -- get the player's rotation around the Z axis in degrees
x = x + ( ( math.cos ( math.rad ( rotZ ) ) ) * distance ) -- calculate the X position of the vehicle
y = y + ( ( math.sin ( math.rad ( rotZ ) ) ) * distance ) -- calculate the Y position of the vehicle

-- get the complete vehicle name by joining all passed parameters using Lua function table.concat
local vehicleName = table.concat({...}, " ")
-- get the vehicle's model ID from the name
local vehicleID = getVehicleModelFromName ( vehicleName )
-- if vehicle ID is valid,
if vehicleID then
-- create the vehicle using the information gathered above:
local newVehicle = createVehicle ( vehicleID, x, y, z, 0, 0, rotZ )
-- if vehicle creation failed, give the player a message
if not newVehicle then
outputConsole ( "Failed to create vehicle.", sourcePlayer )
end
end
end
end

-- Attach the 'consoleCreateVehicle' function to the "createvehicle" command
addCommandHandler ( "createvehicle", consoleCreateVehicle )
</syntaxhighlight>
</section>

{{New items|4.0132|1.4|
This is an example of how this function is executed in an OOP environment.
<section name="OOP server" class="server" show="true">
This script will create an Infernus at the center (0, 0, 3) of San Andreas upon execution.
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", resourceRoot,
function()
infernus = Vehicle(411, Vector3(0, 0, 3)); -- Create an Infernus and spawn it at the middle of SA.
infernus:setColor(0, 0, 0); -- Set its color to black.
infernus.damageProof = true; -- Make it damage proof
end
)

addCommandHandler( "blowinfernus",
function(p)
if not infernus.blown then -- Check if the Infernus is blown up or not.
infernus:blow();
else -- Ouch, it's blown up, let's output an error to the player.
outputChatBox( "The Infernus has already been blown up by you.", p, 255, 0, 0, false );
end
end)
</syntaxhighlight>
</section>
}}
==See Also==

{{Vehicle functions}}

IsBrowserDomainBlocked

2015-05-31T19:28:19Z

Dmitry7zip: OOP fix

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function checks if the specified URL is blocked from being loaded.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isBrowserDomainBlocked ( string address [, bool isURL = false] )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:isDomainBlocked|isBrowserDomainBlocked|}}

===Required arguments===
*'''address:''' A website URL

===Optional arguments===
*'''isURL:''' ''true'' if ''address'' should be parsed as URL, ''false'' otherwise.

===Returns===
Returns ''true'' if the URL is able to be loaded, ''false'' if it is blocked.

==Example==
<syntaxhighlight lang="lua">
--Check the state of wiki.mtasa.com
if ( isBrowserDomainBlocked ( "wiki.mtasa.com" ) ) then
--If it is blocked.
outputChatBox("wiki.mtasa.com is blocked and can't be loaded right now!")
else
--If it is not blocked. (Was accepted by the user)
outputChatBox("wiki.mtasa.com is not blocked and ready to be loaded!")
end
</syntaxhighlight>

==See Also==
{{CEF_functions}}

IsBrowserDomainBlocked

2015-05-31T19:19:52Z

Dmitry7zip: Fix OOP

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function checks if the specified URL is blocked from being loaded.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isBrowserDomainBlocked ( string address [, bool isURL = false] )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:isDomainBlocked||isBrowserDomainBlocked}}

===Required arguments===
*'''address:''' A website URL

===Optional arguments===
*'''isURL:''' ''true'' if ''address'' should be parsed as URL, ''false'' otherwise.

===Returns===
Returns ''true'' if the URL is able to be loaded, ''false'' if it is blocked.

==Example==
<syntaxhighlight lang="lua">
--Check the state of wiki.mtasa.com
if ( isBrowserDomainBlocked ( "wiki.mtasa.com" ) ) then
--If it is blocked.
outputChatBox("wiki.mtasa.com is blocked and can't be loaded right now!")
else
--If it is not blocked. (Was accepted by the user)
outputChatBox("wiki.mtasa.com is not blocked and ready to be loaded!")
end
</syntaxhighlight>

==See Also==
{{CEF_functions}}

ToggleControl

2015-01-03T10:27:59Z

Dmitry7zip: Fixed arg name in "Required Arguments"

__NOTOC__
{{Server client function}}
{{Needs Checking|By enabling a control all bindings belonging to it seem to be deleted. (tested clientside) --[[User:NeonBlack|NeonBlack]] 16:48, 28 August 2009 (UTC)}}
Enables or disables the use of a GTA control for a specific player.

==Syntax==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">bool toggleControl ( player thePlayer, string control, bool enabled ) </syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to toggle the control ability of.
*'''control:''' The control that you want to toggle the ability of. See [[control names]] for a list of possible controls.
*'''enabled:''' A boolean value representing whether or not the key will be usable or not.
</section>
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">bool toggleControl ( string control, bool enabled ) </syntaxhighlight>

===Required Arguments===
*'''control:''' The control that you want to toggle the ability of. See [[control names]] for a list of possible controls.
*'''enabled:''' A boolean value representing whether or not the key will be usable or not.
</section>

==Returns==
This function ''true'' if the control was set successfully, ''false'' otherwise.

==Example==
<section name="Example 1" class="server" show="true">
This function will disable the use of the vehicle secondary-fire key for anyone in a Hydra, consequently removing the ability to fire rockets.
<syntaxhighlight lang="lua">
function disableFireForHydra ( theVehicle, seat, jacked )
if ( getElementModel ( theVehicle ) == 520 ) then -- if they entered a hydra
toggleControl ( source, "vehicle_secondary_fire", false ) -- disable their fire key
else -- if they entered another vehicle
toggleControl ( source, "vehicle_secondary_fire", true ) -- enable their fire key
end
end
addEventHandler ( "onPlayerVehicleEnter", getRootElement(), disableFireForHydra )
</syntaxhighlight>
</section>
<section name="Example 2" class="client" show="true">
This function will disable the use of the vehicle secondary-fire key for anyone in a Hydra, consequently removing the ability to fire rockets.
<syntaxhighlight lang="lua">
function disableFireForHydra ( theVehicle, seat )
if ( getElementModel ( theVehicle ) == 520 ) then -- if they entered a hydra
toggleControl ( "vehicle_secondary_fire", false ) -- disable their fire key
else -- if they entered another vehicle
toggleControl ( "vehicle_secondary_fire", true ) -- enable their fire key
end
end
addEventHandler ( "onClientPlayerVehicleEnter", getLocalPlayer(), disableFireForHydra )
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

BindKey

2015-01-03T10:10:56Z

Dmitry7zip: Added return type

{{Server client function}}
__NOTOC__
Binds a player's key to a handler function or command, which will be called when the key is pressed.

==Syntax==
<section name="Server - Syntax 1" class="server" show="true">
<syntaxhighlight lang="lua">bool bindKey ( player thePlayer, string key, string keyState, function handlerFunction, [ var arguments, ... ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( player keyPresser, string key, string keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''keyPresser:''' The player who pressed the key
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

{{New feature|3|1.0|
<section name="Server - Syntax 2" class="server" show="true">
This alternative syntax allows you to bind a key with a command. This will also allow users to customize the control in their Settings menu. Use in conjunction with [[addCommandHandler]] to add handler functions to the keybind.

<syntaxhighlight lang="lua">bool bindKey ( player thePlayer, string key, string keyState, string commandName, [ string arguments ] )</syntaxhighlight>

===Required Arguments===
*'''thePlayer:''' The player you wish to bind the key of.
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''commandName:''' The name of the command that the key should be binded to.
===Optional Arguments===
*'''arguments''' Space delimited arguments that are entered as if one was typing the command.
</section>
}}

<section name="Client - Syntax 1" class="client" show="true">
<syntaxhighlight lang="lua">bool bindKey ( string key, string keyState, function handlerFunction, [ var arguments, ... ] ) </syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys and [[control names]] for a list of possible controls.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released

*'''handlerFunction:''' The function that will be triggered when the player's key is pressed. This function should have the form:
:<syntaxhighlight lang="lua">function functionName ( string key, string keyState, [ var arguments, ... ] )</syntaxhighlight>
:The values passed to this function are:
:*'''key:''' The key that was pressed
:*'''keyState:''' The state of the key that was pressed, ''down'' if it was pressed, ''up'' if it was released.
:*'''arguments''' The optional arguments you specified when calling [[bindKey]] (see below).
</section>

{{New feature|3|1.0|
<section name="Client - Syntax 2" class="client" show="true">
This alternative syntax allows you to bind a key with a command. This will also allow users to customize the control in their Settings menu. Use in conjunction with [[addCommandHandler]] to add handler functions to the keybind.

<syntaxhighlight lang="lua">bool bindKey ( string key, string keyState, string commandName, [ string arguments ] )</syntaxhighlight>

===Required Arguments===
*'''key:''' The key or control you wish to bind to the command. See [[key names]] for a list of possible keys.
*'''keyState:''' A string that has one of the following values:
**'''"up":''' If the bound key should trigger the function when the key is released
**'''"down":''' If the bound key should trigger the function when the key is pressed
**'''"both":''' If the bound key should trigger the function when the key is pressed or released
*'''commandName:''' The name of the command that the key should be binded to.
*'''arguments''' Space delimited arguments that are entered as if one was typing the command.
</section>
}}

===Optional Arguments===
{{OptionalArg}}
*'''arguments:''' Any arguments you may want to pass to the function when the key is pressed by the user. Any number of arguments of can be specified, each being passed to the designated function. You may not pass functions.

===Returns===
Returns ''true'' if the key was bound, ''false'' otherwise.

===Issues===
{{Issues|
{{Issue|7948|bindKey using a command and control name doesn't work}}
}}

==Example==
Example 1
<section name="Server" class="server" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function.
<syntaxhighlight lang="lua">
function funcInput ( player, key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( getPlayerName ( player) .. " " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ( player, commandName )
bindKey ( player, "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey ( player, "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( player, "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

Example 2
<section name="Client" class="client" show="true">
This example will bind a player's 'F1' key and 'fire' control to 1 input function, clientside.
<syntaxhighlight lang="lua">
function funcInput ( key, keyState )
local state = "let go of"
if ( keyState == "down" ) then
state = "pressed"
end
outputChatBox ( "You " .. state .. " the " .. key .. " key!" )
end

function bindTheKeys ()
bindKey ( "F1", "down", funcInput ) -- bind the player's F1 down key
bindKey ( "F1", "up", funcInput ) -- bind the player's F1 up key
bindKey ( "fire", "both", funcInput ) -- bind the player's fire down and up control
end
addCommandHandler ( "bindme", bindTheKeys )
</syntaxhighlight>
</section>

<section name="Server" class="server" show="true">
This example says how cool is the MTA:SA is if players wants to move.
<syntaxhighlight lang="lua">
function fanFunction()
bindKey (source,"forwards","down",
function(player,key,state)
outputChatBox (getPlayerName (player) .. "#FFFF00 thinks MTA:SA is so cool.",getRootElement(),255,255,0,true)
end
)
end
addEventHandler ("onPlayerLogin",getRootElement(),fanFunction)
</syntaxhighlight>
</section>

==See Also==
{{Input functions}}

AclGroupGetName

2015-01-03T10:08:40Z

Dmitry7zip: Added arg type in syntax

__NOTOC__
{{Server function}}

This function is used to get the name of the given ACL group.

==Syntax==

<syntaxhighlight lang="lua">
string aclGroupGetName ( aclgroup aclGroup )
</syntaxhighlight>
{{OOP||[[aclgroup]]:getName|name|}}
===Required Arguments===

*'''aclGroup:''' The ACL group to get the name of

===Returns===

Returns the name of the given ACL group as a string if successfull, ''false''/''nil'' if the aclGroup is invalid or it fails for some other reason.

==Example==
This example outputs to the console that "Admin's are ready to watch".
<syntaxhighlight lang="lua">addEventHandler("onResourceStart",resourceRoot,function()
outputConsole(aclGroupGetName(aclGetGroup("Admin")).."'s are ready to watch :)",root)
end)
</syntaxhighlight>

==See Also==

{{ACL_functions}}

AclGroupAddObject

2015-01-03T10:06:29Z

Dmitry7zip: Fixed arg name in "Required Arguments"

__NOTOC__
{{Server function}}

This function adds an object to the given ACL group. An object can be a player's account, specified as:
''user.<accountname>''

Or a resource, specified as:
''resource.<resourcename>''

Objects are specified as strings. The ACL groups work for the user accounts and the resources that are specified in them.

==Syntax==

<syntaxhighlight lang="lua">
bool aclGroupAddObject ( aclgroup theGroup, string theObjectName )
</syntaxhighlight>
{{OOP||[[aclgroup]]:addObject||}}
===Required Arguments===

*'''theGroup:''' The group to add the object name string too.
*'''theObjectName:''' The object string to add to the given ACL

===Returns===

Returns ''true'' if the object was successfully added to the ACL, ''false'' if it already existed in the list.

==Example==

This example makes every player able to use a command named "giveAccountAdminRights" that will add a specific accountname as an ACL object to the "Admin" group.

<syntaxhighlight lang="lua">
function giveAdminRights (playerSource, commandName, accountName) --add the function giveAdminRights and specify its arguments
if accountName then --if there was an accountName entered then
aclGroupAddObject (aclGetGroup("Admin"), "user."..accountName) --add an ACL object using the form "user.[accountName]" to the ACL group "Admin"
outputChatBox ("Account '"..accountName.."' succesfully added to the admin group", playerSource) --output a notification to the player who entered the command that the acocunt was successfully added
else --else output an error message and the correct syntax of the command to the player who entered it
outputChatBox ("No account name specified.", playerSource)
outputChatBox ("Correct syntax: /giveAccountAdminRights [accountName]", playerSource)
end
end

addCommandHandler ("giveAccountAdminRights", giveAdminRights) --add a command "giveAccountAdminRights" and attch the function "giveAdminRights" to it
</syntaxhighlight>

==See Also==

{{ACL_functions}}

ClearElementVisibleTo

2015-01-02T20:46:58Z

Dmitry7zip: Fixed arg name in "Required Arguments"

__NOTOC__
{{Server function}}
This function clears any settings added by setElementVisibleTo and restores an element to its default visibility. This does not work with all entities - [[vehicle]]s, [[player]]s and [[object]]s are exempt. This is because these objects are required for accurate sync (they're physical objects). This function is particularily useful for changing the visibility of markers, radar blips and radar areas.

==Syntax==
<syntaxhighlight lang="lua">
bool clearElementVisibleTo ( element theElement )
</syntaxhighlight>
{{OOP|||[[element]]:clearVisibility||}}

===Required Arguments===
*'''theElement:''' The element in which you wish to restore to its default visibility

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

==Example==
This example clears any visibility settings after a player dies, so everyone can see his blip for a short period
<syntaxhighlight lang="lua">
-- specify the getBlipAttachedTo function
function getBlipAttachedTo( thePlayer )
local blips = getElementsByType( "blip" )
for k, theBlip in ipairs( blips ) do
if getElementAttachedTo( theBlip ) == thePlayer then
return theBlip
end
end
return false
end

function clearVisibilityWasted ( totalammo, killer, killerweapon, bodypart ) -- when a player dies
clearElementVisibleTo ( getBlipAttachedTo ( source ) ) -- clear any visiblity settings of his blip
end
addEventHandler ( "onPlayerWasted", getRootElement(), clearVisibilityWasted ) --add an event handler for onPlayerWasted
</syntaxhighlight>

==See Also==
{{Element_functions}}

GetPlayerCount

2015-01-01T14:53:40Z

Dmitry7zip: Link to russian page

{{Server function}}
__NOTOC__
This function returns the number of players currently connected to the server.
{{Note|#getElementsByType("player") works the same as this function but also works client side unlike this function.}}
==Syntax==
<syntaxhighlight lang="lua">
int getPlayerCount ( )
</syntaxhighlight>
{{OOP||[[Player]].getCount||}}
===Returns===
Returns the number of players connected to the server as an [[int]].

==Example==
This example displays a chat message with the number of players connected to the server when a player joins or quits.
<syntaxhighlight lang="lua">
function playerCount ( )
outputChatBox ( "There are now " .. getPlayerCount() .. " players on this server!" )
end
addEventHandler ( "onPlayerJoin", getRootElement(), playerCount )
addEventHandler ( "onPlayerQuit", getRootElement(), playerCount )
</syntaxhighlight>

==Shared implementation of getPlayerCount==
''getElementsByType("player")'' returns a regular-indexed table with every player connected to the server, so by counting how many entries has the table (by using the ''#'' operator) we can archieve the same result as this function, but also clientside. However, it's more efficient to use the built-in function serverside. The next function replaces this function accordingly serverside and clientside to work on both.
<section name="Shared (client and server)" class="both" show="true">
<syntaxhighlight lang="lua">
local originalGetPlayerCount = getPlayerCount -- Store the original getPlayerCount function to a variable

function getPlayerCount()
-- If originalGetPlayerCount is defined, that means that this function is executed serverside.
-- The next line returns the result of the original function if it's defined. If not, it counts the number of player elements (to also work clientside).
return originalGetPlayerCount and originalGetPlayerCount() or #getElementsByType("player")
end
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

[[ru:getPlayerCount]]

RU/getPlayerCount

2015-01-01T14:53:01Z

Dmitry7zip: Created page with "{{RU/Server function}} __NOTOC__ Эта функция возвращает количество игроков, подключенных к серверу. {{Примечан..."

{{RU/Server function}}
__NOTOC__
Эта функция возвращает количество игроков, подключенных к серверу.
{{Примечание|#getElementsByType("player") работает так же, как эта функция, но работает и на стороне клиента, в отличие от этой функции.}}
==Синтаксис==
<syntaxhighlight lang="lua">
int getPlayerCount ( )
</syntaxhighlight>
{{RU/OOP||[[Player]].getCount||}}
===Возвращает===
Возвращает количество игроков, подключенных к серверу в качестве [[int]].

==Пример==
В этом примере выводится сообщение в чате с количеством игроков, подключенных к серверу, когда игрок входит или выходит.
<syntaxhighlight lang="lua">
function playerCount ( )
outputChatBox ( "В данный момент " .. getPlayerCount() .. " игроков на сервере!" )
end
addEventHandler ( "onPlayerJoin", getRootElement(), playerCount )
addEventHandler ( "onPlayerQuit", getRootElement(), playerCount )
</syntaxhighlight>

==Общая реализация getPlayerCount==
''getElementsByType("player")'' возвращает таблицу со списком игроков, подключенных к серверу, поэтому подсчитывая количество записей в таблице (с помощью оператора ''#'') мы получим такой же результат, как и при использовании этой функции, но данный метод работает также в клиентской части. Однако, более эффективно использовать встроенные функции сервера.
<section name="Общая реализация (клиент и сервер)" class="both" show="true">
<syntaxhighlight lang="lua">
local originalGetPlayerCount = getPlayerCount -- Сохраняем оригинальную функцию getPlayerCount в переменную

function getPlayerCount()
-- Если переменная originalGetPlayerCount определена, это значит, что функция выполняется на стороне сервера
-- Следующая строка возвращает результат оригинальной функции, если она определена. Если нет, то подсчитывается количество элементов таблицы ''player'' (для работы на клиентской части)
return originalGetPlayerCount and originalGetPlayerCount() or #getElementsByType("player")
end
</syntaxhighlight>
</section>

==Смотрите также==
{{RU/Player functions}}

[[en:getPlayerCount]]

GetPlayerPing

2015-01-01T14:32:50Z

Dmitry7zip: Link to russian page

__NOTOC__
{{Server client function}}
This function returns the ping of a specified [[player]]. The ping is the number of milliseconds that data takes to travel from the player's client to the server or vice versa.

==Syntax==
<syntaxhighlight lang="lua">int getPlayerPing ( player thePlayer )</syntaxhighlight>
{{OOP||[[player]]:getPing|ping|}}
===Required Arguments===
*'''thePlayer''': The [[player]] whose ping you want to determine.

===Returns===
Returns the ping as an [[int]], or ''false'' if the player is invalid.

==Example==
<section name="Server" class="server" show="true">
This example checks every players ping every 5 seconds and if it's over 500 they get kicked.
<syntaxhighlight lang="lua">
function kickPing() -- Creates a function called kickPing
for i, player in ipairs(getElementsByType("player")) do -- Loop every player
if (getPlayerPing(player) >= 500) then -- If their ping is over 500
kickPlayer(player, "Ping over 500!") -- Kick them
end
end
end
setTimer(kickPing, 5000, 0) -- Every 5 seconds, the kickPing function is called.
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example checks the ping of every player entering the 'ping' command and warns him if it's over 100.
<syntaxhighlight lang="lua">
function checkPing()
local ping = getPlayerPing(getLocalPlayer()) -- get the ping from the source element (the player who joined)
if (ping > 100) then -- if it's higher than 100...
outputChatBox("Your ping is pretty high! Please try to lower it if possible.") -- output a message to the player
end
end
addCommandHandler("ping", checkPing)
</syntaxhighlight>
</section>

==See Also==
{{Player functions}}

[[ru:getPlayerPing]]

RU/getPlayerPing

2015-01-01T14:31:50Z

Dmitry7zip: Created page with "__NOTOC__ {{RU/Server client function}} Данная функция возвращает пинг определенного игрока. Пинг - это количеств..."

__NOTOC__
{{RU/Server client function}}
Данная функция возвращает пинг определенного игрока. Пинг - это количество миллисекунд, за которые информация доходит от клиента игрока до сервера и наоборот.

==Синтаксис==
<syntaxhighlight lang="lua">int getPlayerPing ( player thePlayer )</syntaxhighlight>
{{RU/OOP|Данная функция также является статической функцией класса Player.|[[player]].getPing||}}
===Обязательные аргументы===
*'''thePlayer''': [[игрок]], пинг которого нужно узнать

===Возвращает===
Возвращает пинг как [[int]] или ''false'', если указан некорректный игрок

==Пример==
<section name="Сервер" class="server" show="true">
Этот пример каждые 5 секунд получает пинг каждого игрока, и если он выше 500, то происходит отсоединение игрока от сервера
<syntaxhighlight lang="lua">
function kickPing() -- Создаем функцию для таймера
for i, player in ipairs(getElementsByType("player")) do -- Проходим всех игроков
if (getPlayerPing(player) >= 500) then -- Если пинг больше 500
kickPlayer(player, "Ваш пинг выше 500!") -- Отсоединяем игрока
end
end
end
setTimer(kickPing, 5000, 0) -- Создаем таймер, который будет вызывать функцию kickPing каждые 5 секунд
</syntaxhighlight>
</section>

<section name="Клиент" class="client" show="true">
Этот пример проверяет пинг игрока при вводе команды 'ping' и выводит предупреждение, если он выше 100
<syntaxhighlight lang="lua">
function checkPing()
local ping = getPlayerPing(getLocalPlayer()) -- получаем пинг
if (ping > 100) then -- если пинг выше 100...
outputChatBox("У Вас слишком высокий пинг! Пожалуйста, попробуйте снизить его.") -- выводим сообщение игроку
end
end
addCommandHandler("ping", checkPing)
</syntaxhighlight>
</section>

==Смотрите также==
{{RU/Player functions}}

[[en:getPlayerPing]]

SetFogDistance

2013-11-08T10:12:22Z

Dmitry7zip:

__NOTOC__
{{Server client function}}

{{Server client function}}
__NOTOC__
This function changes the visible distance of fog.

==Syntax==
<syntaxhighlight lang="lua">bool setFogDistance ( float distance )</syntaxhighlight>

===Returns===
Returns a ''bool''.

==Example==
<section name="Server and Client" class="both" show="true">
<syntaxhighlight lang="lua">
function fogdistance ( )
setFogDistance(1.0)
end
addCommandHandler ( "fog", fogdistance )
</syntaxhighlight>
</section>

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

SetFogDistance

2013-11-08T10:11:54Z

Dmitry7zip:

RU/Modules/Texturizer

2013-11-05T17:54:35Z

Dmitry7zip:

{{Module_Info|
name = Texturizer |
version = 0.91 |
author = [[User:Jyrno|Jyrno]] и JoRX |
module_website = ''Недоступен'' |
download_link = [http://www.mediafire.com/?65c339jt4wl21i5 Здесь] [http://www.multiupload.com/JW4SICQG57 Зеркало] |
license = ''Без лицензии'' |
written_in = C++ |
operating_system = Только Windows |
compatible_with = 1.0.4 |
}}

Texturizer - модуль, предоставляющий запись в библиотеки TXD и GD-функции для сервера MTASA. На данный момент он доступен только для Windows, но так как он основан на системе CMake, его использование на других платформах должно быть также достаточно несложным.

__TOC__

==Установка==
===Windows===

# Распакуйте файл Texturizer.dll в папку ''%PROGRAMFILES%\MTA San Andreas 1.3\server\mods\deathmatch\modules\'' вашего сервера.
# Распакуйте бинарные файлы библиотеки GD bgd.dll и libpng14.dll в папку ''%PROGRAMFILES%\MTA San Andreas 1.3\server\'' вашего сервера.
# Затем, добавьте следующую строку в mtaserver.conf вашего сервера:
<syntaxhighlight lang="xml">
<module src="Texturizer.dll" />
</syntaxhighlight>

Теперь все, что вам осталось - запустить сервер.

'''Также рекомендуется:'''
# Распаковать ресурс texturizer в папку ''%PROGRAMFILES%\MTA San Andreas 1.3\server\mods\deathmatch\resources\'' вашего сервера.
# Затем, добавить следующую строку в mtaserver.conf вашего сервера:
<syntaxhighlight lang="xml">
<resource src="texturizer" startup="1" protected="0" />
</syntaxhighlight>
Это предоставит функцию автоочистки памяти в случае, если вы забыли уничтожить картинки, используемые каким-либо ресурсом, при его выгрузке.

==Функции==
{{Modules/Texturizer/Functions}}

[[Category:RU/Modules]]

[[en:Modules/Texturizer]]