Multi Theft Auto: Wiki - User contributions [en]

Template:Shared function

2015-04-28T16:13:53Z

Strix: Undo revision 45075 by Ahemnassar (talk)

<pageclass class="both" subcaption="Shared function"></pageclass>
<lowercasetitle></lowercasetitle>
<includeonly>[[Category:Server functions]][[Category:Client functions]]</includeonly>

RU/dbConnect

2015-03-12T21:44:44Z

Strix:

__NOTOC__
{{Translate}}
{{RU/Server function}}
Эта функция открывает подключение к базе данных и возвращает элемент, который может быть использован с [[RU/dbQuery|dbQuery]]. Для отключения используйте [[RU/destroyElement|destroyElement]].
{{RU/Note|Connecting and disconnecting many times can have a performance impact on the server. For optimal performance it is recommended that you use dbConnect only once when the resource starts, and share the connection element with the whole script.}}
{{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:''' The target to connect to. The format of this depends on the database type.
** Для SQLite it is a [[filepath]] to a SQLite database file. If the filepath starts with ":/" then the server's global databases directory is used. The file will be created if it does not exist.
** Для MySQL it is a list of key=value pairs separated by semicolons. Supported keys are:
*** '''dbname''': Name of the database to use e.g. ''dbname=test''
*** '''host''': Host address e.g. ''host=127.0.0.1''
*** '''port''': Host port e.g. ''port=1234'' (optional, defaults to standard MySQL port if not used)
*** '''unix_socket''': Unix socket or named pipe to use (optional, thankgoodness)

===Необязательные параметры===
*'''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]]

RU/dbConnect

2015-03-12T21:44:22Z

Strix:

__NOTOC__
{{Translate|RU}}
{{RU/Server function}}
Эта функция открывает подключение к базе данных и возвращает элемент, который может быть использован с [[RU/dbQuery|dbQuery]]. Для отключения используйте [[RU/destroyElement|destroyElement]].
{{RU/Note|Connecting and disconnecting many times can have a performance impact on the server. For optimal performance it is recommended that you use dbConnect only once when the resource starts, and share the connection element with the whole script.}}
{{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:''' The target to connect to. The format of this depends on the database type.
** Для SQLite it is a [[filepath]] to a SQLite database file. If the filepath starts with ":/" then the server's global databases directory is used. The file will be created if it does not exist.
** Для MySQL it is a list of key=value pairs separated by semicolons. Supported keys are:
*** '''dbname''': Name of the database to use e.g. ''dbname=test''
*** '''host''': Host address e.g. ''host=127.0.0.1''
*** '''port''': Host port e.g. ''port=1234'' (optional, defaults to standard MySQL port if not used)
*** '''unix_socket''': Unix socket or named pipe to use (optional, thankgoodness)

===Необязательные параметры===
*'''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]]

Introduction to Scripting the GUI

2015-03-10T09:02:03Z

Strix:

One important feature in MTA:SA is the ability to script customized GUI (Graphic User Interface). The GUI consists of windows, button, edit boxes, check boxes... Almost every standard form components in graphical environments. They can be displayed while the user is in game, and used for inputs and outputs in place of traditional commands.

[[Image:AdminGUI.png|thumb|Admin Console GUI]]

==A tutorial to make a login window==
In this tutorial we'll make a simple login window, with two input boxes and a button. The window appears when the player joins the game, and once the button is clicked, the player is spawned. The tutorial will continue the gamemode we made in [[Scripting Introduction|Introduction to Scripting]] ''(If you have used the [[Scripting Introduction|Introduction to Scripting]], you will need to remove or comment the [[spawnPlayer]] line in the "joinHandler" function in your code, as we will be replacing it with a gui alternative in this tutorial)''. We'll also take a look at client-side scripting.

===Draw the window===
All the GUI must be made client side. It is also a good practice to keep all the client scripts in a separate folder.

Browse to /Your MTA Server/mods/deathmatch/resources/myserver/ directory, and create a folder named "client". Under /client/ directory, create a text file and name it "gui.lua".

In this file we will write a funtion that draws the window. To create a window we will use [[guiCreateWindow]]:
<syntaxhighlight lang="lua">
function createLoginWindow()
-- define the X and Y positions of the window
local X = 0.375
local Y = 0.375
-- define the width and height of the window
local Width = 0.25
local Height = 0.25
-- create the window and save its element value into the variable 'wdwLogin'
-- click on the function's name to read its documentation
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)
end
</syntaxhighlight>

===Relative and Absolute===
Note that the final argument passed to guiCreateWindow in the above example is ''true''. This indicates that the coordinates and dimensions of the window are '''relative''', meaning they are a ''percentage'' of the total screen size. This means that if the far left side of the screen is 0, and the far right is 1, an X position of 0.5 would represent the centre point of the screen. Similarly, if the top of the screen is 0 and the bottom is 1, a Y position of 0.2 would be 20% of the way down the screen. The same principles apply to both Width and Height as well (with a Width value of 0.5 meaning the window will be half as wide as the screen).

The alternative to using relative values is using '''absolute''' (by passing ''false'' instead of true to guiCreateWindow). Absolute values are calculated as the total number of pixels from the top-left corner of the parent (if no gui element parent is specified, the parent is the screen itself). If we assume a screen resolution of 1920x1200, the far left side of the screen being 0 pixels and the far right being 1920 pixels, an X position of 960 will represent the centre point of the screen. Similarly, if the top of the screen is 0 pixels and the bottom is 1200, a Y position of 20 would be 20 pixels down from the top of the screen. The same principles apply to both Width and Height as well (with a Width value of 50 meaning the window will be 50 pixels wide). ''You can use [[guiGetScreenSize]] and a little maths to calculate certain absolute positions.''

The differences between using relative and absolute values is quite simple; gui created using absolute values will always remain exactly the same pixel size and position, while gui created using relative values will always be a percentage of its parent's size.

Absolute is generally easier to maintain when editing code by hand, however your choice of type depends on the situation you are using it for.

For the purposes of this introduction we will be using relative values.

===Adding the components===
Next, we'll add the text labels (saying "username:" and "password:"), edit boxes (for entering your data) and a button to log in.

To create buttons we use [[guiCreateButton]] and to create edit boxes use [[guiCreateEdit]]:

'''Note that we are now writing more code for our existing 'createLoginWindow' function. This is not a new function and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
function createLoginWindow()
local X = 0.375
local Y = 0.375
local Width = 0.25
local Height = 0.25
wdwLogin = guiCreateWindow(X, Y, Width, Height, "Please Log In", true)

-- define new X and Y positions for the first label
X = 0.0825
Y = 0.2
-- define new Width and Height values for the first label
Width = 0.25
Height = 0.25
-- create the first label, note the final argument passed is 'wdwLogin' meaning the window
-- we created above is the parent of this label (so all the position and size values are now relative to the position of that window)
guiCreateLabel(X, Y, Width, Height, "Username", true, wdwLogin)
-- alter the Y value, so the second label is slightly below the first
Y = 0.5
guiCreateLabel(X, Y, Width, Height, "Password", true, wdwLogin)

X = 0.415
Y = 0.2
Width = 0.5
Height = 0.15
edtUser = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
Y = 0.5
edtPass = guiCreateEdit(X, Y, Width, Height, "", true, wdwLogin)
-- set the maximum character length for the username and password fields to 50
guiEditSetMaxLength(edtUser, 50)
guiEditSetMaxLength(edtPass, 50)

X = 0.415
Y = 0.7
Width = 0.25
Height = 0.2
btnLogin = guiCreateButton(X, Y, Width, Height, "Log In", true, wdwLogin)

-- make the window invisible
guiSetVisible(wdwLogin, false)
end
</syntaxhighlight>
Note that every GUI component created is a child of the window, this is done by specifying the parent element (wdwLogin, in this case) when creating the component.

This is very useful because not only does it mean that all the components are attached to the window and will move with it, but also that any changes done to the parent window will be applied down the tree to these child components. For example, we can now hide all of the GUI we just created by simply hiding the window:
<syntaxhighlight lang="lua">
guiSetVisible(wdwLogin, false) --hides all the GUI we made so we can show them to the player at the appropriate moment.
</syntaxhighlight>

===Using the function we wrote===
The createLoginWindow function is now complete, but it won't do anything until we call it. It is recommended to create all GUI when the client resource starts, hide them, and show them to the player later when needed. Therefore, we'll write an event handler for "[[onClientResourceStart]]" to create the window:
<syntaxhighlight lang="lua">
-- attach the event handler to the root element of the resource
-- this means it will only trigger when its own resource is started
addEventHandler("onClientResourceStart", getResourceRootElement(),
function ()
createLoginWindow()
end
)
</syntaxhighlight>

As this is a log in window, we now need to show the window when the player joins the game.
This can be done using the same event, "[[onClientResourceStart]]", so we can modify the above code to include showing the window:

'''Note that we are now writing more code for our existing 'onClientResourceStart' handler. This is not a new event handler and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", getResourceRootElement(),
function ()
-- create the log in window and its components
createLoginWindow()

-- output a brief welcome message to the player
outputChatBox("Welcome to My MTA:SA Server, please log in.")

-- if the GUI was successfully created, then show the GUI to the player
if (wdwLogin ~= nil) then
guiSetVisible(wdwLogin, true)
else
-- if the GUI hasnt been properly created, tell the player
outputChatBox("An unexpected error has occurred and the log in GUI has not been created.")
end

-- enable the players cursor (so they can select and click on the components)
showCursor(true)
-- set the input focus onto the GUI, allowing players (for example) to press 'T' without the chatbox opening
guiSetInputEnabled(true)
end
)
</syntaxhighlight>

Note that we have a simple security check before making the window visible, so in the unlikely event that the window has not been created, meaning wdwLogin is not a valid element, we don't get an error and just inform the player what has happened.
In the next step, we will create the button functionality for the log in button.

==Scripting the button==
Now that we have created our GUI and shown it to the player, we need to make it work.

===Detecting the click===
When the player clicks on any part of the GUI, the event "[[onClientGUIClick]]" will be triggered for the GUI component you clicked on. This allows us to easily detect any clicks on the GUI elements we want to use.
For example, we can attach the event to the btnLogin button to catch any clicks on it:
<syntaxhighlight lang="lua">
-- attach the event onClientGUIClick to btnLogin and set it to trigger the 'clientSubmitLogin' function
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)
</syntaxhighlight>
'''Note the final argument passed is "false". This indicates that the event will only trigger directly on btnLogin, not if the event has propagated up or down the tree. Setting this to "true" while attaching to gui elements will mean that clicking on any element in the same branch will trigger this event.'''

This line of code can now be added inside the createLoginWindow function. It is a common mistake to try and attach events to non-existant GUI elements, so make sure you always attach your events '''after''' the gui element (in this case, the button) has been created:

'''Note that we are now writing more code for our existing 'createLoginWindow' function.'''
<syntaxhighlight lang="lua">
function createLoginWindow()
-- create all our GUI elements
...

-- now add our onClientGUIClick event to the button we just created
addEventHandler("onClientGUIClick", btnLogin, clientSubmitLogin, false)
</syntaxhighlight>

===Managing the click===
Now that we can detect when the player clicks on the button, we need to write code to manage what happens when they do.
In our [[onClientGUIClick]] event handle, we told it to call the function clientSubmitLogin whenever btnLogin is clicked.
Therefore, we can now use the function clientSubmitLogin to control what happens when the button is clicked:
<syntaxhighlight lang="lua">
-- create the function and define the 'button' and 'state' parameters
-- (these are passed automatically by onClientGUIClick)
function clientSubmitLogin(button,state)
-- if our login button was clicked with the left mouse button, and the state of the mouse button is up
if button == "left" and state == "up" then
-- move the input focus back onto the game (allowing players to move around, open the chatbox, etc)
guiSetInputEnabled(false)
-- hide the window and all the components
guiSetVisible(wdwLogin, false)
-- hide the mouse cursor
showCursor(false)
end
end
</syntaxhighlight>
Now, when the button is clicked, the window will be hidden and all controls will be returned to the player. Next, we will tell the server to allow the player to spawn.

===Triggering the server===
Triggering the server can be done using [[triggerServerEvent]]. This allows you to trigger a specified event on the server from the client. The same can be done in reverse using [[triggerClientEvent]].
Here, we use the [[triggerServerEvent]] function to call our own custom event on the server, named "submitLogin", which will then control the spawning of the player serverside.

'''Note that we are now writing more code for our existing 'clientSubmitLogin' function. This is not a new function and is meant to replace what you already have.'''
<syntaxhighlight lang="lua">
function clientSubmitLogin(button,state)
if button == "left" and state == "up" then
-- get the text entered in the 'username' field
local username = guiGetText(edtUser)
-- get the text entered in the 'password' field
local password = guiGetText(edtPass)

-- if the username and password both exist
if username and password then
-- trigger the server event 'submitLogin' and pass the username and password to it
triggerServerEvent("submitLogin", getRootElement(), username, password)

-- hide the gui, hide the cursor and return control to the player
guiSetInputEnabled(false)
guiSetVisible(wdwLogin, false)
showCursor(false)
else
-- otherwise, output a message to the player, do not trigger the server
-- and do not hide the gui
outputChatBox("Please enter a username and password.")
end
end
end
</syntaxhighlight>

===Creating the serverside event===
At this point we now have all the code needed on the client side, so open up your serverside 'script.lua' file (from the [[Scripting Introduction|Introduction to Scripting]]) or another suitable serverside file to work with.

On the server side, recall that we are spawning the player as soon as they login.
So, first of all, we will need to define the custom event that we used before on the client. This can be done using [[addEvent]] and [[addEventHandler]].
<syntaxhighlight lang="lua">
-- create our loginHandler function, with username and password parameters (passed from the client gui)
function loginHandler(username,password)

end

-- define our custom event, and allow it to be triggered from the client ('true')
addEvent("submitLogin",true)
-- add an event handler so that when submitLogin is triggered, the function loginHandler is called
addEventHandler("submitLogin",root,loginHandler)
</syntaxhighlight>

===Logging in===
Now we have a function that is called through the custom event 'submitLogin', we can start to work on logging in and spawning the player, using our 'loginHandler' function:
<syntaxhighlight lang="lua">
function loginHandler(username,password)
-- check that the username and password are correct
if username == "user" and password == "apple" then
-- the player has successfully logged in, so spawn them
if (client) then
spawnPlayer(client, 1959.55, -1714.46, 10)
fadeCamera(client, true)
setCameraTarget(client, client)
outputChatBox("Welcome to My Server.", client)
end
else
-- if the username or password are not correct, output a message to the player
outputChatBox("Invalid username and password. Please re-connect and try again.",client)
end
end

addEvent("submitLogin",true)
addEventHandler("submitLogin",root,loginHandler)
</syntaxhighlight>
'''For the purposes of this tutorial, a very basic username and password system is shown. For a more comprehensive alternative, you can use the Account System or a MySQL database.'''

Also note the use of the variable "client", it's an internal variable used by MTA to identify the player who triggered the event.

Finally, do not forget to include the new gui.lua file in the meta.xml of the main resource, and label it as a client script:
<syntaxhighlight lang="xml">
<script src="client/gui.lua" type="client" />
</syntaxhighlight>

At this point, we now have a basic login window that checks the player's username and password when the login button is clicked. If they are correct, the player is automatically spawned.

For further help with GUI, see the [[:Category:GUI_Tutorials|GUI tutorials]].

[[Category:GUI_Tutorials]]
[[it:Introduzione_allo_scripting_della_GUI]]
[[ru:Introduction to Scripting the GUI]]
[[es:Introducción a la Programación de GUI]]

EngineLoadTXD

2015-02-28T08:35:13Z

Strix:

{{Client function}}
__NOTOC__
{{Note box|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}

This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.

This is a client side function. Be sure to transfer your TXD file by including it in the meta file.

See here for [[Optimize_Custom_TXD|tips on reducing the size of TXD files]].

{{New feature/item|3.0141|1.4.1|7088|
==Syntax==
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file / string raw_data [, bool filteringEnabled = true ] )
</syntaxhighlight>
[[Image:Filtering.jpg|thumb|Difference between texture filtering modes (left = filtering disabled, right = filtering enabled).|284x230px]]
{{OOP||[[TXD|EngineTXD]]}}
===Required Arguments===
*'''txd_file / raw_data:''' The [[filepath]] to the TXD file you want to load or whole data buffer of the TXD file.
}}
===Optional Arguments===
*'''filteringEnabled:''' Whether to enable texture filtering.
===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.

==Example==
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 0 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>

'''Example 2:''' This example loads a combination of custom COL, TXD and DFF files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
col_floors = engineLoadCOL ( "models/office_floors.col" )
engineReplaceCOL ( col_floors, 3781 )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

Template:Admin functions

2015-02-28T08:29:57Z

Strix:

*[[addBan]]
*[[banPlayer]]
*[[getBanAdmin]]
*[[getBanIP]]
*[[getBanNick]]
*[[getBanReason]]
*[[getBans]]
*[[getBanSerial]]
*[[getBanTime]]
*[[getBanUsername]]
*[[getUnbanTime]]
*[[isBan]]
*[[kickPlayer]]
*[[setBanAdmin]]
*{{New items|3.0141|1.4.1 r7093|[[setBanNick]]}}
*[[setBanReason]]
*[[setUnbanTime]]
*[[removeBan]]
*[[reloadBans]]
<noinclude>[[Category:Functions templates]]</noinclude>

SetBanNick

2015-02-28T08:28:17Z

Strix:

__NOTOC__
{{Server function}}
{{Needs Example}}

{{New feature/item|3.0141|1.4.1|7093|This function sets a new nick for a [[ban]].}}

==Syntax==
<syntaxhighlight lang="lua">bool setBanNick ( ban theBan, string theNick )</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] you want to change the nick of.
*'''theNick:''' A string representing the nick you want to set the ban to.

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

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

== See Also ==
{{Admin_functions}}

Template:Admin functions

2015-02-26T10:31:43Z

Strix:

*[[addBan]]
*[[banPlayer]]
*[[getBanAdmin]]
*[[getBanIP]]
*[[getBanNick]]
*[[getBanReason]]
*[[getBans]]
*[[getBanSerial]]
*[[getBanTime]]
*[[getBanUsername]]
*[[getUnbanTime]]
*[[isBan]]
*[[kickPlayer]]
*[[setBanAdmin]]
*{{New items|3.0150|1.5.0 r7089|[[setBanNick]]}}
*[[setBanReason]]
*[[setUnbanTime]]
*[[removeBan]]
*[[reloadBans]]
<noinclude>[[Category:Functions templates]]</noinclude>

EngineLoadCOL

2015-02-26T07:15:48Z

Strix:

{{Client function}}
__NOTOC__
{{Note box|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}

This function loads a RenderWare Collision (COL 1/2/3) file into GTA. The collisions can then be used to provide collisions for in-game objects.

For vehicles, please omit this function by embedding your [[COL]] file into your [[DFF]] file. This way, you can be sure that the COL file is correctly (and automatically) loaded when calling [[engineLoadDFF]].

This is a client side function. Be sure to transfer your COL file by including it in the meta file.

'''Note:''' collision libraries (.col files containing multiple collision models) are not supported. See [[COL]] for details.

==Syntax==
<syntaxhighlight lang="lua">
col engineLoadCOL ( string col_file )
</syntaxhighlight>
{{OOP||[[COL|EngineCOL]]}}
===Required Arguments===
*'''col_file:''' The [[filepath]] to the [[COL]] file you want to load

===Returns===
Returns a [[COL]] if the file was loaded, ''false'' otherwise.

{{New feature/item|3.0150|1.4.1|7088|
==Syntax==
<syntaxhighlight lang="lua">
col engineLoadCOL ( string col_file / string raw_data )
</syntaxhighlight>
===Required Arguments===
*'''col_file / raw_data:''' The [[filepath]] to the [[COL]] file you want to load or whole data buffer of the COL file.
===Returns===
Returns a [[COL]] if the file was loaded, ''false'' otherwise.
}}

==Example==
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 0 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>

'''Example 2:''' This example loads a combination of custom COL, TXD and DFFfiles to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
col_floors = engineLoadCOL ( "models/office_floors.col" )
engineReplaceCOL ( col_floors, 3781 )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineLoadTXD

2015-02-26T07:15:00Z

Strix: This function automatically determines raw data

{{Client function}}
__NOTOC__
{{Note box|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}

This function loads a RenderWare Texture Dictionary (TXD) file into GTA. The texture dictionary can then be used to provide textures.

This is a client side function. Be sure to transfer your TXD file by including it in the meta file.

See here for [[Optimize_Custom_TXD|tips on reducing the size of TXD files]].

==Syntax==
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file [, bool filteringEnabled = true ] )
</syntaxhighlight>
[[Image:Filtering.jpg|thumb|Difference between texture filtering modes (left = filtering disabled, right = filtering enabled).|284x230px]]
{{OOP||[[TXD|EngineTXD]]}}
===Required Arguments===
*'''txd_file:''' The [[filepath]] to the txd file you want to load

===Optional Arguments===
*'''filteringEnabled:''' Whether to enable texture filtering.

===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.

{{New feature/item|3.0150|1.4.1|7088|
==Syntax==
<syntaxhighlight lang="lua">
txd engineLoadTXD ( string txd_file / string raw_data [, bool filteringEnabled = true ] )
</syntaxhighlight>
===Required Arguments===
*'''txd_file / raw_data:''' The [[filepath]] to the TXD file you want to load or whole data buffer of the TXD file.
===Optional Arguments===
*'''filteringEnabled:''' Whether to enable texture filtering.
===Returns===
Returns a [[TXD]] if the file was loaded, ''false'' otherwise.
}}

==Example==
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 0 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>

'''Example 2:''' This example loads a combination of custom COL, TXD and DFF files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
col_floors = engineLoadCOL ( "models/office_floors.col" )
engineReplaceCOL ( col_floors, 3781 )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineLoadDFF

2015-02-26T07:13:16Z

Strix:

{{Client function}}
__NOTOC__
{{Note box|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}

This function loads a RenderWare Model (DFF) file into GTA.

* To successfully load vehicle models, it is necessary to pass the vehicle model id to the function so any embedded DFF extensions (such as collisions) will be loaded correctly.
* To successfully load your model with textures, be sure to use [[engineLoadTXD]] and [[engineImportTXD]] before calling this function.

This is a client side function. Be sure to transfer your DFF file by including it in the meta file.

The returned [[DFF]] element is an element in the element tree, just like vehicles and objects. When the dff is destroyed, ie on resource unload or using [[destroyElement]], any elements that use the DFF, such as vehicles or objects will be reset.

==Syntax==
<syntaxhighlight lang="lua">
dff engineLoadDFF ( string dff_file, int model_id )
</syntaxhighlight>
{{OOP||[[DFF|EngineDFF]]}}
===Required Arguments===
*'''dff_file:''' The [[filepath]] to the DFF file you want to load
*'''model_id:''' The model id that should be associated with the dff. (This value is ignored after 1.3.1 and can be set to zero for all models)

===Returns===
Returns a [[DFF]] element if the dff file loaded, ''false'' otherwise.

{{New feature/item|3.0150|1.4.1|7088|
==Syntax==
<syntaxhighlight lang="lua">
dff engineLoadDFF ( string dff_file / string raw_data )
</syntaxhighlight>
===Required Arguments===
*'''dff_file / raw_data:''' The [[filepath]] to the DFF file you want to load or whole data buffer of the DFF file.
===Returns===
Returns a [[DFF]] element if the dff file loaded, ''false'' otherwise.
}}

==Example==
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 0 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>

'''Example 2:''' This example loads a combination of custom TXD, COL and DFF files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
col_floors = engineLoadCOL ( "models/office_floors.col" )
engineReplaceCOL ( col_floors, 3781 )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

EngineLoadDFF

2015-02-26T07:12:50Z

Strix:

{{Client function}}
__NOTOC__
{{Note box|Please note the loading order that is used in the examples as other orders can cause collisions, textures or the DFF not to load due to technical limitations}}

This function loads a RenderWare Model (DFF) file into GTA.

* To successfully load vehicle models, it is necessary to pass the vehicle model id to the function so any embedded DFF extensions (such as collisions) will be loaded correctly.
* To successfully load your model with textures, be sure to use [[engineLoadTXD]] and [[engineImportTXD]] before calling this function.

This is a client side function. Be sure to transfer your DFF file by including it in the meta file.

The returned [[DFF]] element is an element in the element tree, just like vehicles and objects. When the dff is destroyed, ie on resource unload or using [[destroyElement]], any elements that use the DFF, such as vehicles or objects will be reset.

==Syntax==
<syntaxhighlight lang="lua">
dff engineLoadDFF ( string dff_file, int model_id )
</syntaxhighlight>
{{OOP||[[DFF|EngineDFF]]}}
===Required Arguments===
*'''dff_file:''' The [[filepath]] to the DFF file you want to load
*'''model_id:''' The model id that should be associated with the dff. (This value is ignored after 1.3.1 and can be set to zero for all models)

===Returns===
Returns a [[DFF]] element if the dff file loaded, ''false'' otherwise.

{{New feature/item|3.0150|1.4.1|7088|
==Syntax==
<syntaxhighlight lang="lua">
dff engineLoadDFF ( string dff_file / string raw_data, int model_id [, bool is_raw = false ] )
</syntaxhighlight>
===Required Arguments===
*'''dff_file / raw_data:''' The [[filepath]] to the DFF file you want to load or whole data buffer of the DFF file.
===Returns===
Returns a [[DFF]] element if the dff file loaded, ''false'' otherwise.
}}

==Example==
'''Example 1:''' This example loads a combination of a custom DFF and TXD file to replace the Euros vehicle in-game. The collisions are embedded inside the DFF file.
<syntaxhighlight lang="lua">
outputChatBox ( "> replacing the euros vehicle" )

txd = engineLoadTXD ( "data/euros.txd" )
engineImportTXD ( txd, 587 )
dff = engineLoadDFF ( "data/euros.dff", 0 )
engineReplaceModel ( dff, 587 )
</syntaxhighlight>

'''Example 2:''' This example loads a combination of custom TXD, COL and DFF files to replace an in-game model of a set of floors.
<syntaxhighlight lang="lua">
outputChatBox ( "> loading floor objects" )
col_floors = engineLoadCOL ( "models/office_floors.col" )
engineReplaceCOL ( col_floors, 3781 )
txd_floors = engineLoadTXD ( "models/office_floors.txd" )
engineImportTXD ( txd_floors, 3781 )
dff_floors = engineLoadDFF ( "models/office_floors.dff", 0 )
engineReplaceModel ( dff_floors, 3781 )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

SetSoundVolume

2015-02-17T19:14:17Z

Strix: removed unnecessary section

__NOTOC__
{{Client function}}
This function is used to change the volume level of the specified [[sound]] [[element]].
Use a player element to control a players voice with this function.

==Syntax==
<syntaxhighlight lang="lua">bool setSoundVolume ( element theSound, float volume )</syntaxhighlight>
{{OOP||[[sound]]:setVolume|volume|getSoundVolume}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] which volume you want to modify.
*'''volume:''' A [[float]]ing point number representing the desired volume level. Range is from '''0.0''' to '''1.0'''

===Returns===
Returns ''true'' if the [[sound]] [[element]] volume was successfully changed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
function wasted (killer, weapon, bodypart)
local sound = playSound("sounds/wasted.mp3") --Play wasted.mp3 from the sounds folder
setSoundVolume(sound, 0.5) -- set the sound volume to 50%
end

addEventHandler("onClientPlayerWasted", getLocalPlayer(), wasted) --add the event handler
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element for voice control}}

==See Also==
{{Client_audio_functions}}
[[AR:setSoundVolume]]

IsMTAWindowActive

2015-02-11T18:05:33Z

Strix:

__NOTOC__
{{Client function}}
This function returns whether any system windows that take focus are active. This includes:
* Chatbox input
* Console window
* Main menu
* Transferbox
To get the status of the debug view, see [[isDebugViewActive]].

==Syntax==
<syntaxhighlight lang="lua">
bool isMTAWindowActive ()
</syntaxhighlight>
{{OOP|[[GUI_widgets|GuiElement]].isMTAWindowActive|mtaWindowsActive}}

===Returns===
Returns ''true'' if the focus is on the MTA window, ''false'' if it isn't.

==Example==
This piece of script will kill a player if he has any of the above system windows open
<syntaxhighlight lang="lua">
function dontAllowAnyOpenWindow ()
if isMTAWindowActive () then
setElementHealth ( getLocalPlayer(), 0.0 )
end
end
setTimer ( dontAllowAnyOpenWindow, 50, 0 )
</syntaxhighlight>
==See Also==
{{GUI_functions}}
[[ru:isMTAWindowActive]]

RU/isMTAWindowActive

2015-02-11T18:04:44Z

Strix: Created page with "__NOTOC__ {{RU/Client function}} Эта функция проверяет, активно ли какое-либо системное окно. Системные окна: ..."

__NOTOC__
{{RU/Client function}}
Эта функция проверяет, активно ли какое-либо системное окно.

Системные окна:
* Поле ввода чата
* Консоль
* Главное меню
* Прогресс передачи
Чтобы проверить состояние отладчика, смотрите [[isDebugViewActive]].

==Syntax==
<syntaxhighlight lang="lua">
bool isMTAWindowActive ()
</syntaxhighlight>
{{RU/OOP|[[GUI_widgets|GuiElement]].isMTAWindowActive|mtaWindowsActive}}

===Возвращает===
* ''true'', если какое-либо из MTA окон активно;
* ''false'', если это не так.

==Пример==
Этот код убивает игрока, если он откроет какое-либо системное окно.
<syntaxhighlight lang="lua">
function dontAllowAnyOpenWindow ()
if isMTAWindowActive () then
setElementHealth ( getLocalPlayer(), 0.0 )
end
end
setTimer ( dontAllowAnyOpenWindow, 50, 0 )
</syntaxhighlight>

==Смотрите также==
{{RU/GUI_functions}}
[[en:isMTAWindowActive]]

IsMTAWindowActive

2015-02-11T17:57:06Z

Strix:

__NOTOC__
{{Client function}}
This function returns whether any system windows that take focus are active. This includes:
* Chatbox input
* Console window
* Main menu
* Transferbox
To get the status of the debug view, see [[isDebugViewActive]].

==Syntax==
<syntaxhighlight lang="lua">
bool isMTAWindowActive ()
</syntaxhighlight>
{{OOP|[[GUI_widgets|GuiElement]].isMTAWindowActive|mtaWindowsActive}}

===Returns===
Returns ''true'' if the focus is on the MTA window, ''false'' if it isn't.

==Example==
<section name="Client" class="client" show="true">
This piece of script will kill a player if he has any of the above system windows open
<syntaxhighlight lang="lua">
function dontAllowAnyOpenWindow ()
if isMTAWindowActive () then
setElementHealth ( getLocalPlayer(), 0.0 )
end
end
setTimer ( dontAllowAnyOpenWindow, 50, 0 )
</syntaxhighlight>
</section>
==See Also==
{{GUI_functions}}
[[ru:isMTAWindowActive]]

GuiCreateButton

2015-02-11T17:53:28Z

Strix:

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Button|GuiButton]]}}

===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all ''x, y, width'' and ''height'' floats must be between 0 and 1, representing sizes relative to the parent.

===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui button is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an [[element]] of the created [[Element/GUI/Button|button]] if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
--create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[ru:guiCreateButton]]

RU/guiCreateButton

2015-02-11T17:49:58Z

Strix:

__NOTOC__
{{RU/Client function}}
Эта функция позволяет создавать GUI кнопки.

==Синтаксис==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>
{{RU/OOP||[[Element/GUI/Button|GuiButton]]}}

===Обязательные аргументы===
[[Image:Button.png|thumb|Пример кнопки.]]
*'''x:''' Позиция GUI кнопки по оси X на экране игрока. Зависит от аргумента ''relative''.
*'''y:''' Позиция GUI кнопки по оси Y на экране игрока. Зависит от аргумента ''relative''.
*'''width:''' Ширина GUI кнопки. Зависит от аргумента ''relative''.
*'''height:''' Высота GUI кнопки. Зависит от аргумента ''relative''.
*'''text:''' Текст, который будет отображаться на кнопке.
*'''relative:''' Определяет, относительны ли позиция и размер. Если указано ''true'', то значения аргументов ''x, y, width'' и ''height'' должны быть между 0 и 1, относительны к размеру родителя.

===Необязательные аргументы===
{{RU/OptionalArg}}
*'''parent:''' Родитель, к которому прикреплена GUI кнопка. Если значение аргумента ''relative'' – ''true'', размеры и позиция будут относительны к родителю. Если ''relative'' – ''false'', позиция кнопки будет количеством пикселей от позиции родителя. Если родитель не был указан, родителем станет сам экран – соответственно позиция и размеры будут относительны ему.

===Возвращает===
[[Элемент]] созданной кнопки, если она была успешно создана, иначе ''false''.

==Пример==
Данный пример создаёт поле ввода рядом с кнопкой "Отправить!". При нажатии на кнопку, сообщение из поля ввода выводится в чат.
<syntaxhighlight lang="lua">
-- создадим нашу кнопку
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Отправить!", true )
-- создадим поле ввода и определим его как "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Введите своё сообщение здесь!", true )
-- прикрепим нашу кнопку к функции outputEditBox
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) -- максимальная длина сообщения в чате 128, поэтому ограничим поле ввода

--настроим нашу функцию так, чтобы она отправляла сообщения в чат
function outputEditBox ()
local text = guiGetText ( editBox ) -- получим текст из поля ввода
outputChatBox ( text ) -- выводим этот текст
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==Смотрите также==
{{RU/GUI_functions}}
[[en:guiCreateButton]]

Template:RU/GUI functions

2015-02-11T17:48:31Z

Strix: /* Кнопки */

__NOTOC__
* [[getChatboxLayout]]
* [[guiBringToFront]]
* [[guiCreateFont]]
* [[guiGetAlpha]]
* [[guiGetEnabled]]
* [[guiGetFont]]
* [[guiGetInputEnabled]]
* [[guiGetInputMode]]
* [[guiGetPosition]]
* [[guiGetProperties]]
* [[guiGetProperty]]
* [[guiGetScreenSize]]
* [[guiGetSize]]
* [[guiGetText]]
* [[guiGetVisible]]
* [[guiMoveToBack]]
* [[guiSetAlpha]]
* [[guiSetEnabled]]
* [[guiSetFont]]
* [[guiSetInputEnabled]]
* [[guiSetInputMode]]
* [[guiSetPosition]]
* [[guiSetProperty]]
* [[guiSetSize]]
* [[guiSetText]]
* [[guiSetVisible]]
* [[isChatBoxInputActive]]
* [[isConsoleActive]]
* [[isDebugViewActive]]
* [[isMainMenuActive]]
* [[isMTAWindowActive]]
* [[isTransferBoxActive]]

===Кнопки===
* [[RU/guiCreateButton|guiCreateButton]]

===Флажки===
* [[guiCheckBoxGetSelected]]
* [[guiCheckBoxSetSelected]]
* [[guiCreateCheckBox]]

===Списки===
* [[guiCreateComboBox]]
* [[guiComboBoxAddItem]]
* [[guiComboBoxClear]]
* [[guiComboBoxGetItemText]]
* [[guiComboBoxSetItemText]]
* [[guiComboBoxRemoveItem]]
* [[guiComboBoxGetSelected]]
* [[guiComboBoxSetSelected]]

===Редактируемые поля===
* [[guiCreateEdit]]
* [[guiEditSetMasked]]
* [[guiEditSetMaxLength]]
* [[guiEditSetReadOnly]]
* [[guiEditSetCaretIndex]]
{{New feature/item|3.0135|1.3.5|6054|
* [[guiEditGetCaretIndex]]
}}
===Таблицы===
* [[guiCreateGridList]]
* [[guiGridListAddColumn]]
* [[guiGridListAddRow]]
* [[guiGridListAutoSizeColumn]]
* [[guiGridListClear]]
* [[guiGridListGetItemData]]
* [[guiGridListGetItemText]]
* [[guiGridListGetRowCount]]
* [[guiGridListGetSelectedItem]]
* [[guiGridListInsertRowAfter]]
* [[guiGridListRemoveColumn]]
* [[guiGridListRemoveRow]]
* [[guiGridListSetItemData]]
* [[guiGridListSetItemText]]
* [[guiGridListSetScrollBars]]
* [[guiGridListSetSelectedItem]]
* [[guiGridListSetSelectionMode]]
* [[guiGridListSetSortingEnabled]]
* [[guiGridListGetSelectedCount]]
* [[guiGridListGetSelectedItems]]
* [[guiGridListSetColumnWidth]]
* [[guiGridListGetColumnCount]]
* [[guiGridListGetItemColor]]
* [[guiGridListSetItemColor]]
{{New feature/item|3.0132|1.3.1|4944|
* [[guiGridListGetColumnTitle]]
* [[guiGridListSetColumnTitle]]
}}
{{New feature/item|3.0132|1.3.1|5087|
* [[guiGridListGetHorizontalScrollPosition]]
* [[guiGridListSetHorizontalScrollPosition]]
* [[guiGridListGetVerticalScrollPosition]]
* [[guiGridListSetVerticalScrollPosition]]
}}

===Памятки===
* [[guiCreateMemo]]
* [[guiMemoSetReadOnly]]
* [[guiMemoSetCaretIndex]]
{{New feature/item|3.0135|1.3.5|6054|
* [[guiMemoGetCaretIndex]]
}}

===Прогресс бары===
* [[guiCreateProgressBar]]
* [[guiProgressBarGetProgress]]
* [[guiProgressBarSetProgress]]

===Переключатели===
* [[guiCreateRadioButton]]
* [[guiRadioButtonGetSelected]]
* [[guiRadioButtonSetSelected]]

===Полосы прокрутки===
* [[guiCreateScrollBar]]
* [[guiScrollBarGetScrollPosition]]
* [[guiScrollBarSetScrollPosition]]

===Панели прокрутки===
* [[guiCreateScrollPane]]
* [[guiScrollPaneGetHorizontalScrollPosition]]
* [[guiScrollPaneGetVerticalScrollPosition]]
* [[guiScrollPaneSetHorizontalScrollPosition]]
* [[guiScrollPaneSetScrollBars]]
* [[guiScrollPaneSetVerticalScrollPosition]]

===Статические изображения===
* [[guiCreateStaticImage]]
* [[guiStaticImageGetNativeSize]]
* [[guiStaticImageLoadImage]]

===Панели вкладок===
* [[guiCreateTabPanel]]
* [[guiGetSelectedTab]]
* [[guiSetSelectedTab]]

===Вкладки===
* [[guiCreateTab]]
* [[guiDeleteTab]]

===Текстовые метки===
* [[guiCreateLabel]]
* [[guiLabelGetFontHeight]]
* [[guiLabelGetTextExtent]]
* [[guiLabelSetColor]]
* [[guiLabelSetHorizontalAlign]]
* [[guiLabelSetVerticalAlign]]
{{New feature/item|3.0132|1.3.1|4670|
* [[guiLabelGetColor]]
}}

===Окна===
* [[guiCreateWindow]]
* [[guiWindowSetMovable]]
* [[guiWindowSetSizable]]

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

GuiCreateButton

2015-02-11T17:46:34Z

Strix:

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>
{{OOP||[[Element/GUI/Button|GuiButton]]}}

===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.


===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui button is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an element of the created button if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
--create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[ru:guiCreateButton]]

RU/guiCreateButton

2015-02-11T17:46:22Z

Strix: Created page with "__NOTOC__ {{RU/Client function}} Эта функция позволяет создавать GUI кнопки. ==Синтаксис== <syntaxhighlight lang="lua"> element guiCreateButton ..."

__NOTOC__
{{RU/Client function}}
Эта функция позволяет создавать GUI кнопки.

==Синтаксис==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>
{{RU/OOP||[[Element/GUI/Button|GuiButton]]}}

===Обязательные аргументы===
[[Image:Button.png|thumb|Пример кнопки.]]
*'''x:''' Позиция GUI кнопки по оси X на экране игрока. Зависит от аргумента ''relative''.
*'''y:''' Позиция GUI кнопки по оси Y на экране игрока. Зависит от аргумента ''relative''.
*'''width:''' Ширина GUI кнопки. Зависит от аргумента ''relative''.
*'''height:''' Высота GUI кнопки. Зависит от аргумента ''relative''.
*'''text:''' Текст, который будет отображаться на кнопке.
*'''relative:''' Определяет, относительны ли позиция и размер. Если указано ''true'', то значения аргументов ''x, y, width'' и ''height'' должны быть между 0 и 1, относительны к размеру родителя.

===Необязательные аргументы===
{{RU/OptionalArg}}
*'''parent:''' Родитель, к которому прикреплена GUI кнопка. Если значение аргумента ''relative'' – ''true'', размеры и позиция будут относительны к родителю. Если ''relative'' – ''false'', позиция кнопки будет количеством пикселей от позиции родителя. Если родитель не был указан, родителем станет сам экран – соответственно позиция и размеры будут относительны ему.

===Возвращает===
[[Элемент]] созданной кнопки, если она была успешно создана, иначе ''false''.

==Пример==
Данный пример создаёт поле ввода рядом с кнопкой "Отправить!". При нажатии на кнопку, сообщение из поля ввода выводится в чат.
<syntaxhighlight lang="lua">
-- создадим нашу кнопку
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Отправить!", true )
-- создадим поле ввода и определим его как "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Введите своё сообщение здесь!", true )
-- прикрепим нашу кнопку к функции outputEditBox
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) -- максимальная длина сообщения в чате 128, поэтому ограничим поле ввода

--настроим нашу функцию так, чтобы она отправляла сообщения в чат
function outputEditBox ()
local text = guiGetText ( editBox ) -- получим текст с поля ввода
outputChatBox ( text ) -- выводим этот текст
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==Смотрите также==
{{RU/GUI_functions}}
[[en:guiCreateButton]]

GuiCreateButton

2015-02-11T17:43:33Z

Strix: Added OOP syntax and link to the ru page

__NOTOC__
{{Client function}}
This function allows creation of a GUI Button, which is a clickable item as part of GUI.

==Syntax==
<syntaxhighlight lang="lua">
element guiCreateButton ( float x, float y, float width, float height, string text, bool relative, [ element parent = nil ] )
</syntaxhighlight>
{{OOP||GuiButton}}

===Required Arguments===
[[Image:Button.png|thumb|GUI Test Button]]
*'''x:''' A float of the 2D x position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''y:''' A float of the 2D y position of the GUI button on a player's screen. This is affected by the ''relative'' argument.
*'''width:''' A float of the width of the GUI button. This is affected by the ''relative'' argument.
*'''height:''' A float of the height of the GUI button. This is affected by the ''relative'' argument.
*'''text:''' A string of the text that will be displayed as a label on the button.
*'''relative:''' This is whether sizes and positioning are relative. If this is ''true'', then all x,y,width,height floats must be between 0 and 1, representing sizes relative to the parent.


===Optional Arguments===
{{OptionalArg}}
*'''parent:''' This is the parent that the gui button is attached to. If the ''relative'' argument is true, sizes and positioning will be made relative to this parent. If the ''relative'' argument is false, positioning will be the number of offset pixels from the parent's origin. If no parent is passed, the parent will become the screen - causing positioning and sizing according to screen positioning.

===Returns===
Returns an element of the created button if it was successfully created, false otherwise.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked, it will output the message in the edit box into the Chat Box.
<syntaxhighlight lang="lua">
--create our button
button = guiCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )
--Create an edit box and define it as "editBox".
editBox = guiCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
-- and attach our button to the outputEditBox function
addEventHandler ( "onClientGUIClick", editBox, outputEditBox )
guiEditSetMaxLength ( editBox, 128 ) --the max chatbox length is 128, so force this

--setup our function to output the message to the chatbox
function outputEditBox ()
local text = guiGetText ( editBox )--get the text from the edit box
outputChatBox ( text ) --output that text
end
addEventHandler ( "onClientGUIClick", button, outputEditBox )
</syntaxhighlight>

==See Also==
{{GUI_functions}}
[[ru:guiCreateButton]]

SetMarkerType

2015-02-11T10:11:43Z

Strix: Fix OOP

__NOTOC__
{{Server client function}}
This function changes a marker's type. The type controls how the marker is displayed in the game. It's important that you use marker types that users are used to from the single player game. For example, checkpoints are used in races, rings are used for aircraft races, arrows are used for entering buildings etc.

==Syntax==
<syntaxhighlight lang="lua">bool setMarkerType ( marker theMarker, string markerType )</syntaxhighlight>
{{OOP||[[Marker]]:setMarkerType|markerType|getMarkerType}}
===Required Arguments===
* '''theMarker''': A [[marker]] element referencing the specified marker.
* '''markerType''': A string denoting the marker type. Valid values are:
{{Marker types}}

==Returns==
Returns ''true'' if the marker type was changed, ''false'' if it wasn't or marker values were invalid.

==Example==
This function changes all existing markers' type to the specified one.
<syntaxhighlight lang="lua">
function changeAllMarkersType ( newMarkerType )
-- we store a table with all markers
local allMarkers = getElementsByType( "marker" )
-- for each marker in it,
for index, aMarker in ipairs(allMarkers) do
-- set its type to the one passed to this function
setMarkerType( aMarker, newMarkerType )
end
end
</syntaxhighlight>

==See Also==
{{Marker functions}}

GetMarkerType

2015-02-11T10:10:55Z

Strix: Fix OOP

__NOTOC__
{{Server client function}}
This function returns a marker's type.

==Syntax==
<syntaxhighlight lang="lua">string getMarkerType ( marker theMarker )</syntaxhighlight>
{{OOP||[[Marker]]:getMarkerType|markerType|setMarkerType}}
===Required Arguments===
* '''theMarker''': A [[marker]] element referencing the specified marker.

===Returns===
* Returns one of the following strings:
{{Marker_types}}

If an invalid marker is specified, ''false'' is returned.

==Example==
<section name="Client and server" class="both" show="true">
This function creates a default marker at a given position and outputs its type.
<syntaxhighlight lang="lua">
function createMarkerAndOutputType ( x, y, z )
-- we create the marker
local theMarker = createMarker ( x, y, z )
-- if the marker was created,
if ( theMarker ) then
-- then get its type,
local markerType = getMarkerType ( theMarker )
-- and output it.
outputChatBox ( "It's a " .. markerType .. " marker!" )
end
-- return the created marker element (or false) where this function was called
return theMarker
end
</syntaxhighlight> </section>

==See Also==
{{Marker functions}}

RU/getEffectDensity

2015-02-09T10:43:36Z

Strix: fix syntax

__NOTOC__
{{RU/Client function}}
{{New items|3.014|1.4 r6208|
Получает текущий уровень концентрации (плотности) эффекта.
}}

==Синтаксис==
<syntaxhighlight lang="lua">
float getEffectDensity ( effect theEffect )
</syntaxhighlight>
{{RU/OOP||[[effect]]:getDensity|density|setEffectDensity}}

===Обязательные аргументы===
*'''theEffect:''' [[Эффект]], плотность которого нужно получить.

===Пример===
<syntaxhighlight lang="lua">
addCommandHandler("ges",
function (cmd)
local x, y, z = getElementPosition (localPlayer)
local effect = createEffect ("smoke30lit", x, y, z)
setEffectSpeed (effect, 2)
getEffectDensity (effect)
end)
</syntaxhighlight>

== Смотрите также ==
{{RU/Client_Effects_functions}}
[[en:getEffectDensity]]

RU/getEffectDensity

2015-02-09T10:42:33Z

Strix:

__NOTOC__
{{RU/Client function}}
{{New items|3.014|1.4 r6208|
Получает текущий уровень концентрации (плотности) эффекта.
}}

==Синтаксис==
<syntaxhighlight lang="lua">
float getEffectDenstity( effect theEffect )
</syntaxhighlight>
{{RU/OOP||[[effect]]:getDensity|density|setEffectDensity}}

===Обязательные аргументы===
*'''theEffect:''' [[Эффект]], плотность которого нужно получить.

===Пример===
<syntaxhighlight lang="lua">
addCommandHandler("ges",
function (cmd)
local x, y, z = getElementPosition (localPlayer)
local effect = createEffect ("smoke30lit", x, y, z)
setEffectSpeed (effect, 2)
getEffectDensity (effect)
end)
</syntaxhighlight>

== Смотрите также ==
{{RU/Client_Effects_functions}}
[[en:getEffectDensity]]

ES/AddAccount

2015-02-09T10:41:54Z

Strix:

{{Server function}}
__NOTOC__
Esta función agrega una cuenta a la lista de cuentas registradas del servidor.

==Sintaxis==
{{New feature/item|3|1.0|848|
<syntaxhighlight lang="lua">
account addAccount ( string nombre, string contraseña )
</syntaxhighlight>
}}

===Argumentos Requeridos===
*'''nombre:''' El nombre de la cuenta que deseas crear, normalmente se hace coincidir con el nombre del jugador(no es obligatorio que coincida).
*'''contraseña:''' La contraseña con la cual se va a acceder a la cuenta.

===Devuelve===
{{New feature/item|3|1.0|848|
Devuelve el elemento ''account'' (cuenta) si la cuenta fue creada satisfactoriamente, ''false'' si la cuenta ya existía o si ocurrió un error.
}}

==Ejemplo==
<section name="Server" class="server" show="true">
'''Ejemplo 1:''' Esto permite que los jugadores se registren usando el comando /register <contraseña>.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, password )
-- Revisar si el campo de contraseña es válido
if ( password ~= "" and password ~= nil ) then
-- Crear una cuenta, y guardar la variable cuenta de forma local.
local accountAdded = addAccount( getPlayerName(source), password )
if ( accountAdded ) then
-- Si todo funcionó, entonces al jugador se le anuncia.
outputChatBox ( "Gracias, " .. getPlayerName(source) .. ", ahora que estas registrado, logueate con /login", source )
else
-- Si algo salió mal, al jugador se le anuncia también.
outputChatBox ( "Error creando cuenta, contacta al administrador del servidor.", source )
end
else
-- Si hubo error en el sintaxis, anunciarlo también.
outputChatBox ( "Error creando cuenta, sintaxis correcto: /register <contrasena>", source )
end
end
addCommandHandler ( "register", registerPlayer ) -- Agrega un comando para registrarse.
</syntaxhighlight>

'''A diferencia del primero, el código siguiente permite a los jugadores crear una cuenta con un nombre distinto a su actual nick.'''

'''Ejemplo 2:''' Esto permite a los jugadores registrarse en el servidor usando el comando /register <nombre> <contraseña>.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Gracias, " .. getPlayerName(source) .. ", ahora que estas registrado, logueate con /login",source)
else
outputChatBox("Error creando cuenta, contacta al administrador del servidor.",source)
end
else
outputChatBox("Error creando cuenta, sintaxis correcto: /register <nombre> <contrasena>",source)
end
end
addCommandHandler ( "register", registerPlayer ) -- Agrega un comando para registrarse.
</syntaxhighlight>

'''Ejemplo 3:''' Este código permite a los jugadores registrarse(crear una cuenta) sólo una sola vez usando /register <nombre> <contraseña>.
<syntaxhighlight lang="lua">
local bRegisteredOnce = false

function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil and bRegisteredOnce == false) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Gracias, " .. getPlayerName(source) .. ", ahora que estas registrado, logueate con /login",source)
bRegisteredOnce = true
else
outputChatBox("Error creando cuenta, contacta al administrador del servidor.",source)
end
else
if bRegisteredOnce == true then
outputChatBox("Ya registraste una cuenta en este servidor!",source)
else
outputChatBox("Error creando cuenta, sintaxis correcto: /register <nombre> <contrasena>",source)
end
end
end
addCommandHandler ( "register", registerPlayer ) -- Agrega un comando para registrarse.
</syntaxhighlight>
</section>

==Ver También==

{{Funciones_de_Cuenta}}

[[en:addAccount]]
[[pl:addAccount]]
[[ru:addAccount]]

RU/addAccount

2015-02-09T10:41:32Z

Strix:

{{RU/Server function}}
__NOTOC__
Данная функция добавляет [[аккаунт]] на сервер.

==Синтаксис==
<syntaxhighlight lang="lua">
account addAccount ( string name, string pass )
</syntaxhighlight>
{{RU/OOP|Данная функция является статической функцией класса Account.|[[Account]].add||}}
===Обязательные аргументы===
*'''name:''' Имя аккаунта, который вы хотите добавить, обычно это имя игрока.
*'''pass:''' Пароль от аккаунта.

===Возвращает===
Возвращает [[аккаунт]] или ''false'', если аккаунт уже существует.

===Ограничения===
*'''name:'''
** Минимальная длина имени аккаунта - 1 символ.
** Имена аккаунтов чувствительны к регистру.
** Имя аккаунта не может быть "*****"
*'''pass:'''
** Минимальная длина пароля аккаунта - 1 символ.
** Максимальная длина пароля аккаунта - 30 символов.
** Пароль от аккаунта не может быть "*****"

==Пример==
'''Пример 1:''' Этот пример показывает регистрацию на сервере командой /register <password>.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, password )
-- Проверим не пустой ли пароль
if ( password ~= "" and password ~= nil ) then
-- Попытаемся добавить учетную запись
local accountAdded = addAccount( getPlayerName(source), password )
if ( accountAdded ) then
-- Сообщим пользователю
outputChatBox ( "Спасибо, " .. getPlayerName(source) .. ", теперь вы зарегистрированы, вы можете войти используя /login", source )
else
-- Сообщим пользователю то, что он ошибся при вводе
outputChatBox ( "Ошибка в создании аккаунта, свяжитесь с администратором.", source )
end
else
-- Покажем пользователю как нужно вводить
outputChatBox ( "Ошибка в создании аккаунта, правильный синтаксис: /register <пароль>", source )
end
end
addCommandHandler ( "register", registerPlayer ) -- создадим команду /register
</syntaxhighlight>
'''Пример 2:''' Этот пример показывает регистрацию на сервере командой /register <password>.
'''Этот пример отличается от первого тем, что в нем пользователь может задать себе имя.'''
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Спасибо, " .. getPlayerName(source) .. ", теперь вы зарегистрированы, вы можете войти используя /login",source)
else
outputChatBox("Ошибка в создании аккаунта, свяжитесь с администратором.",source)
end
else
outputChatBox("Ошибка в создании аккаунта, правильный синтаксис: /register <nick> <pass>",source)
end
end
addCommandHandler ( "register", registerPlayer ) -- создадим команду /register
</syntaxhighlight>

'''Пример 3:''' Этот пример показывает регистрацию на сервере командой /register <password>.
<syntaxhighlight lang="lua">
local bRegisteredOnce = false

function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil and bRegisteredOnce == false) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Спасибо, " .. getPlayerName(source) .. ", теперь вы зарегистрированы, вы можете войти используя /login",source)
bRegisteredOnce = true
else
outputChatBox("Ошибка в создании аккаунта, свяжитесь с администратором.",source)
end
else
if bRegisteredOnce == true then
outputChatBox("Вы уже зарегистрированы на сервере!",source)
else
outputChatBox("Ошибка в создании аккаунта, правильный синтаксис: /register <nick> <pass>",source)
end
end
end
addCommandHandler ( "register", registerPlayer ) -- создадим команду /register
</syntaxhighlight>

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

[[en:addAccount]]
[[es:addAccount]]
[[pl:addAccount]]

RU/addAccount

2015-02-09T10:41:06Z

Strix:

GetEffectDensity

2015-02-09T10:37:31Z

Strix:

__NOTOC__
{{Client function}}
{{New items|3.014|1.4 r6208|
This function gets the density of certain [[effect]].
}}

==Syntax==
<syntaxhighlight lang="lua">
float getEffectDensity ( effect theEffect )
</syntaxhighlight>
{{OOP||[[effect]]:getDensity|density|setEffectDensity}}

===Required Arguments===
*'''theEffect:''' The [[effect]] to get density of.

===Example===
<syntaxhighlight lang="lua">[Lua]
addCommandHandler("ses",
function (cmd)
local density = 4
local x, y, z = getElementPosition (localPlayer)
local effect = createEffect ("cement", x, y, z)
setEffectDensity (effect, density)
getEffectDensity (effect)
end)
</syntaxhighlight>

==See also==
{{Client_Effects_functions}}
[[ru:getEffectDensity]]

Template:RU/Client Effects functions

2015-02-09T10:34:59Z

Strix: Created page with "*createEffect *fxAddBlood *fxAddBulletImpact *fxAddBulletSplash *RU/fxAddDebris|fxAdd..."

CreateEffect

2015-02-09T10:34:50Z

Strix:

__NOTOC__
{{Client function}}
{{New items|3.0140|1.4|
Creates an [[Element/Effect|effect]] on specified position.
}}
{{Note|Not all effects support rotation (e.g. the "fire" - effect doesn't).}}
==Syntax==
<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0 ] )</syntaxhighlight>
{{OOP||[[Effect]]}}

===Required Arguments===
*'''name:''' A string contains [[Element/Effect#Effects_list|effect name]].
*'''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.
{{New items|3.06892|1.4 r6892|
*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
}}

=== Returns ===
Returns the [[Element/Effect|effect]] element if creation was successful, ''false'' otherwise.

== Example ==
<syntaxhighlight lang="lua">
addCommandHandler("effect",
function(cmd, name)
local x, y, z = getElementPosition(localPlayer)
if createEffect(name, x, y, z) then
outputChatBox("Effect created!")
else
outputChatBox("Bad effect name.")
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.4.0-9.06892|Added drawDistance argument}}

== See Also ==
{{Client_Effects_functions}}
[[ru:createEffect]]

RU/CreateEffect

2015-02-09T10:34:43Z

Strix: Strix moved page RU/CreateEffect to RU/createEffect

#REDIRECT [[RU/createEffect]]

RU/createEffect

2015-02-09T10:34:43Z

Strix: Strix moved page RU/CreateEffect to RU/createEffect

__NOTOC__
{{RU/Client function}}
{{New items|3.0140|1.4|
Создает [[Element/Effect|эффект]] на указанной позиции.
}}
{{RU/Note|Не все эффекты поворачиваются (например, эффект "fire").}}
==Синтаксис==
<syntaxhighlight lang="lua">effect createEffect ( string name, float x, float y, float z [, float rX, float rY, float rZ, float drawDistance = 0 ] )</syntaxhighlight>
{{RU/OOP||[[Effect]]}}

===Обязательные аргументы===
*'''name:''' [[Element/Effect#Effects_list|Название эффекта]].
*'''x:''' Число с плавающей точкой, представляющее координату X на карте.
*'''y:''' Число с плавающей точкой, представляющее координату Y на карте.
*'''z:''' Число с плавающей точкой, представляющее координату Z на карте.

===Необязательные аргументы===
{{RU/OptionalArg}}
*'''rX:''' Число с плавающей точкой, представляющее вращение по оси X в градусах.
*'''rY:''' Число с плавающей точкой, представляющее вращение по оси Y в градусах.
*'''rZ:''' Число с плавающей точкой, представляющее вращение по оси Z в градусах.
{{New items|3.06892|1.4 r6892|
*'''drawDistance:''' Число с плавающей точкой от 1 до 8191, представляющее дистанцию прорисовки эффекта. Укажите 0, чтобы использовать дистанцию прорисовки по умолчанию.
}}

=== Возвращает ===
Возвращает элемент [[Element/Effect|эффекта]], если создание было успешным, иначе ''false''.

== Пример ==
<syntaxhighlight lang="lua">
addCommandHandler("effect",
function(cmd, name)
local x, y, z = getElementPosition(localPlayer)
if createEffect(name, x, y, z) then
outputChatBox("Эффект создан!")
else
outputChatBox("Неверное название эффекта.")
end
end
)
</syntaxhighlight>

Этот пример синхронизирует эффект вспышки камеры (без этого только локальные игроки могут видеть её).
<syntaxhighlight lang="lua">
addEventHandler("onClientPlayerWeaponFire", root,
function(weapon)
if weapon == 43 and source ~= localPlayer then
local x, y, z = getPedWeaponMuzzlePosition(source)
createEffect("camflash", x, y, z)
end
end
)
</syntaxhighlight>

== Смотрите также ==
{{RU/Client_Effects_functions}}
[[en:createEffect]]

Element/Effect

2015-02-09T10:32:07Z

Strix:

{{New items|3.0140|1.4|
The Effect class represents custom effect elements in the game world such as smoke, sparks, fire etc.

The element type of this class is '''"effect"'''.
}}

__TOC__
== Effects list ==
There are 82 effects.
<syntaxhighlight lang="lua">--A table containing all effect names.
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}</syntaxhighlight>
{|class="wikitable" style="text-align: center; font-size: 12px;"
|-
!width="150"|Name
!width="300"|Description


|-
|blood_heli
|bloody explosion
|-
|boat_prop
|a surf
|-
|camflash
|small flare
|-
|carwashspray
|steam, as on a carwash
|-
|cement
|cement
|-
|cloudfast
|fast clouds

|-
|coke_puff
|puff of a coke
|-
|coke_trail
|a pouring water
|-
|cigarette_smoke
|a smoke from a cigarette
|-
|explosion_barrel
|explosion and splinters of a box
|-
|explosion_crate
|explosion and splinters of the large box
|-
|explosion_door
|a smoke with sparks
|-
|exhale
|a small smoke
|-
|explosion_fuel_car
|explosion, as from the machine
|-
|explosion_large
|the large explosion
|-
|explosion_medium
|average explosion
|-
|explosion_molotov
|explosion, as from a molotov cocktail
|-
|explosion_small
|small explosion
|-
|explosion_tiny
|very small explosion
|-
|extinguisher
|foam of the fire extinguisher
|-
|flame
|small fire
|-
|fire
|fire
|-
|fire_med
|average fire
|-
|fire_large
|large fire
|-
|flamethrower
|fire of the flamethrower
|-
|fire_bike
|fire, as from a burning motorcycle
|-
|fire_car
|fire, as from the burning machine
|-
|gunflash
|as the bullet from a trunk takes off
|-
|gunsmoke
|a smoke from a gun
|-
|insects
|insects
|-
|heli_dust
|a dust, as from the helicopter
|-
|jetpack
|a jetpacks fire
|-
|jetthrust
|fire from the muffler of the machine, as during use of nitrogen
|-
|nitro
|nitro
|-
|molotov_flame
|fire from a Molotov Cocktail
|-
|overheat_car
|smoke from damaged car
|-
|overheat_car_electric
|wrecked electro-machine
|-
|prt_blood
|spark? maybe meant to be a mini red blood splash
|-
|prt_boatsplash
|foam
|-
|prt_bubble
|bubble
|-
|prt_cardebris
|splinters from a box
|-
|prt_collisionsmoke
|a dense white smoke
|-
|prt_glass
|a crashing glass
|-
|prt_gunshell
|shells
|-
|prt_sand
|sand, which was scattered
|-
|prt_sand2
|there is less sand, than in previous animation
|-
|prt_smokeII_3_expand
|a grey smoke
|-
|prt_smoke_huge
|there is a lot of grey smoke
|-
|prt_spark
|of a spark
|-
|prt_spark_2
|the large sparks
|-
|prt_splash
|burst
|-
|prt_wake
|a wave
|-
|prt_watersplash
|sparks
|-
|prt_wheeldirt
|sparks from wheels of the car
|-
|petrolcan
|a jet
|-
|puke
|belch
|-
|riot_smoke
|there is a lot of smoke
|-
|spraycan
|spray
|-
|smoke30lit
|a smoke
|-
|smoke30m
|a rich smoke
|-
|smoke50lit
|more richer smoke
|-
|shootlight
|a light being shot out (used for searchlights), sparks and glass
|-
|smoke_flare
|a light being shot out, sparks and glass, it makes a good firework effect
|-
|tank_fire
|a shot from the tank
|-
|teargas
|gas, as from gas grenade
|-
|teargasAD
|gas, as from small gas grenade
|-
|tree_hit_fir
|leaf falling
|-
|tree_hit_palm
|falling of pair large leafs
|-
|vent
|slowly dissipating a smoke
|-
|vent2
|practically too most
|-
|water_hydrant
|the large flow of water
|-
|water_ripples
|circles on water
|-
|water_speed
|the large sparks from water
|-
|water_splash
|small sparks from water
|-
|water_splash_big
|average sparks
|-
|water_splsh_sml
|sparks, only them it is not visible almost
|-
|water_swim
|small sparks at navigation
|-
|waterfall_end
|there is a lot of pair
|-
|water_fnt_tme
|the large flow of water
|-
|water_fountain
|water of a fountain
|-
|wallbust
|a disappearing heap pair
|-
|WS_factorysmoke
|smoke
|}

==Related scripting functions==
===Client===
* [[createEffect]]
* [[setEffectSpeed]]
* [[getEffectSpeed]]
* [[setEffectDensity]]
* [[setEffectDensity]]

[[Category:Element Types]]
[[ru:Element/Effect]]

RU/Эффект

2015-02-09T10:31:51Z

Strix: Blanked the page

RU/Element/Effect

2015-02-09T10:31:46Z

Strix: Redirected page to Элемент/Эффект

#REDIRECT [[Элемент/Эффект]]

RU/Эффект

2015-02-09T10:30:17Z

Strix: Redirected page to Элемент/Эффект

#REDIRECT [[Элемент/Эффект]]

Эффект

2015-02-09T10:29:51Z

Strix: Strix moved page Эффект to Элемент/Эффект

#REDIRECT [[Элемент/Эффект]]

Category:Эффект

2015-02-09T10:29:51Z

Strix: Strix moved page Эффект to Элемент/Эффект

{{New items|3.0140|1.4|
Класс Effect представляет такие элементы эффектов в игровом мире, как дым, искры огонь и так далее.

Тип элементов этого класса — '''"effect"'''.
}}

__TOC__
== Список эффектов ==
Всего существует 82 эффекта.
<syntaxhighlight lang="lua">--Таблица, содержащая названия всех эффектов.
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}</syntaxhighlight>
{|class="wikitable" style="text-align: center; font-size: 12px;"
|-
!width="150"|Name
!width="300"|Description


|-
|blood_heli
|кровавый взрыв
|-
|boat_prop
|a surf
|-
|camflash
|небольшая вспышка
|-
|carwashspray
|пар, как на автомойке
|-
|cement
|цемент
|-
|cloudfast
|fast clouds

|-
|coke_puff
|puff of a coke
|-
|coke_trail
|льющаяся вода
|-
|cigarette_smoke
|дым от сигареты
|-
|explosion_barrel
|explosion and splinters of a box
|-
|explosion_crate
|explosion and splinters of the large box
|-
|explosion_door
|дым с щепками
|-
|exhale
|маленький дым
|-
|explosion_fuel_car
|взрыв машины
|-
|explosion_large
|большой взрыв
|-
|explosion_medium
|средний взрыв
|-
|explosion_molotov
|взрыв от коктейля Молотова
|-
|explosion_small
|маленький взрыв
|-
|explosion_tiny
|очень маленький взрыв
|-
|extinguisher
|пена огнетушителя
|-
|flame
|небольшой огонь
|-
|fire
|огонь
|-
|fire_med
|средний огонь
|-
|fire_large
|большой огонь
|-
|flamethrower
|fire of the flamethrower
|-
|fire_bike
|fire, as from a burning motorcycle
|-
|fire_car
|fire, as from the burning machine
|-
|gunflash
|as the bullet from a trunk takes off
|-
|gunsmoke
|дым от оружия
|-
|insects
|насекомые
|-
|heli_dust
|пыль, как от вертолёта
|-
|jetpack
|пламя джетпака
|-
|jetthrust
|пламя из глушителя машины
|-
|nitro
|нитро
|-
|molotov_flame
|огонь от коктейля Молотова
|-
|overheat_car
|smoke from damaged car
|-
|overheat_car_electric
|wrecked electro-machine
|-
|prt_blood
|маленький всплеск крови
|-
|prt_boatsplash
|пена
|-
|prt_bubble
|пузырь
|-
|prt_cardebris
|осколки от ящика
|-
|prt_collisionsmoke
|плотный белый дым
|-
|prt_glass
|ломающееся стекло
|-
|prt_gunshell
|shells
|-
|prt_sand
|рассеянный песок
|-
|prt_sand2
|чуть меньше песка
|-
|prt_smokeII_3_expand
|серый дым
|-
|prt_smoke_huge
|много серого дыма
|-
|prt_spark
|искры
|-
|prt_spark_2
|большие искры
|-
|prt_splash
|взрыв
|-
|prt_wake
|волна
|-
|prt_watersplash
|всплеск
|-
|prt_wheeldirt
|искры от колёс машины
|-
|petrolcan
|струя
|-
|puke
|рвота
|-
|riot_smoke
|there is a lot of smoke
|-
|spraycan
|spray
|-
|smoke30lit
|a smoke
|-
|smoke30m
|a rich smoke
|-
|smoke50lit
|more richer smoke
|-
|shootlight
|a light being shot out (used for searchlights), sparks and glass
|-
|smoke_flare
|a light being shot out, sparks and glass, it makes a good firework effect
|-
|tank_fire
|a shot from the tank
|-
|teargas
|gas, as from gas grenade
|-
|teargasAD
|gas, as from small gas grenade
|-
|tree_hit_fir
|leaf falling
|-
|tree_hit_palm
|falling of pair large leafs
|-
|vent
|slowly dissipating a smoke
|-
|vent2
|practically too most
|-
|water_hydrant
|the large flow of water
|-
|water_ripples
|круги на воде
|-
|water_speed
|the large sparks from water
|-
|water_splash
|small sparks from water
|-
|water_splash_big
|average sparks
|-
|water_splsh_sml
|sparks, only them it is not visible almost
|-
|water_swim
|small sparks at navigation
|-
|waterfall_end
|there is a lot of pair
|-
|water_fnt_tme
|the large flow of water
|-
|water_fountain
|фонтан воды
|-
|wallbust
|a disappearing heap pair
|-
|WS_factorysmoke
|дым
|}

==Связанные функции скриптинга==
===Клиент===
* [[RU/createEffect]]
* [[RU/setEffectSpeed]]
* [[RU/getEffectSpeed]]
* [[RU/setEffectDensity]]
* [[RU/setEffectDensity]]

[[Category:Element Types]]
[[en:Element/Effect]]

Element/Effect

2015-02-09T10:29:07Z

Strix:

Category:Эффект

2015-02-09T10:28:29Z

Strix:

Category:Игрок

2015-02-09T10:27:46Z

Strix:

__NOTOC__
Класс player представляет людей, контролируемых клиентами. Объект клиента, создается когда клиент подключается к серверу, и уничтожается когда отключается. Игроков нельзя создать или уничтожить, каким-либо другим способом.

Тип элементов этого класса - '''"player"'''.

==Связанные функции скриптинга==
===Клиентские===
{{RU/Client player functions}}
===Серверные===
{{RU/Player functions}}
[[Category:Типы элементов]]

[[de:Element/Player]]
[[en:Element/Player]]
[[es:Elemento/Player]]
[[it:Elemento Player]]
[[pl:Gracz]]

Category:Эффект

2015-02-09T10:27:40Z

Strix:

Category:Эффект

2015-02-09T10:27:29Z

Strix: Created page with "{{New items|3.0140|1.4| Класс Effect представляет такие элементы эффектов в игровом мире, как дым, искры огон..."

{{New items|3.0140|1.4|
Класс Effect представляет такие элементы эффектов в игровом мире, как дым, искры огонь и так далее.

Тип элементов этого класса — '''"effect"'''.
}}

__TOC__
== Список эффектов ==
Всего существует 82 эффекта.
<syntaxhighlight lang="lua">--Таблица, содержащая названия всех эффектов.
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}</syntaxhighlight>
{|class="wikitable" style="text-align: center; font-size: 12px;"
|-
!width="150"|Name
!width="300"|Description


|-
|blood_heli
|кровавый взрыв
|-
|boat_prop
|a surf
|-
|camflash
|небольшая вспышка
|-
|carwashspray
|пар, как на автомойке
|-
|cement
|цемент
|-
|cloudfast
|fast clouds

|-
|coke_puff
|puff of a coke
|-
|coke_trail
|льющаяся вода
|-
|cigarette_smoke
|дым от сигареты
|-
|explosion_barrel
|explosion and splinters of a box
|-
|explosion_crate
|explosion and splinters of the large box
|-
|explosion_door
|дым с щепками
|-
|exhale
|маленький дым
|-
|explosion_fuel_car
|взрыв машины
|-
|explosion_large
|большой взрыв
|-
|explosion_medium
|средний взрыв
|-
|explosion_molotov
|взрыв от коктейля Молотова
|-
|explosion_small
|маленький взрыв
|-
|explosion_tiny
|очень маленький взрыв
|-
|extinguisher
|пена огнетушителя
|-
|flame
|небольшой огонь
|-
|fire
|огонь
|-
|fire_med
|средний огонь
|-
|fire_large
|большой огонь
|-
|flamethrower
|fire of the flamethrower
|-
|fire_bike
|fire, as from a burning motorcycle
|-
|fire_car
|fire, as from the burning machine
|-
|gunflash
|as the bullet from a trunk takes off
|-
|gunsmoke
|дым от оружия
|-
|insects
|насекомые
|-
|heli_dust
|пыль, как от вертолёта
|-
|jetpack
|пламя джетпака
|-
|jetthrust
|пламя из глушителя машины
|-
|nitro
|нитро
|-
|molotov_flame
|огонь от коктейля Молотова
|-
|overheat_car
|smoke from damaged car
|-
|overheat_car_electric
|wrecked electro-machine
|-
|prt_blood
|маленький всплеск крови
|-
|prt_boatsplash
|пена
|-
|prt_bubble
|пузырь
|-
|prt_cardebris
|осколки от ящика
|-
|prt_collisionsmoke
|плотный белый дым
|-
|prt_glass
|ломающееся стекло
|-
|prt_gunshell
|shells
|-
|prt_sand
|рассеянный песок
|-
|prt_sand2
|чуть меньше песка
|-
|prt_smokeII_3_expand
|серый дым
|-
|prt_smoke_huge
|много серого дыма
|-
|prt_spark
|искры
|-
|prt_spark_2
|большие искры
|-
|prt_splash
|взрыв
|-
|prt_wake
|волна
|-
|prt_watersplash
|всплеск
|-
|prt_wheeldirt
|искры от колёс машины
|-
|petrolcan
|струя
|-
|puke
|рвота
|-
|riot_smoke
|there is a lot of smoke
|-
|spraycan
|spray
|-
|smoke30lit
|a smoke
|-
|smoke30m
|a rich smoke
|-
|smoke50lit
|more richer smoke
|-
|shootlight
|a light being shot out (used for searchlights), sparks and glass
|-
|smoke_flare
|a light being shot out, sparks and glass, it makes a good firework effect
|-
|tank_fire
|a shot from the tank
|-
|teargas
|gas, as from gas grenade
|-
|teargasAD
|gas, as from small gas grenade
|-
|tree_hit_fir
|leaf falling
|-
|tree_hit_palm
|falling of pair large leafs
|-
|vent
|slowly dissipating a smoke
|-
|vent2
|practically too most
|-
|water_hydrant
|the large flow of water
|-
|water_ripples
|круги на воде
|-
|water_speed
|the large sparks from water
|-
|water_splash
|small sparks from water
|-
|water_splash_big
|average sparks
|-
|water_splsh_sml
|sparks, only them it is not visible almost
|-
|water_swim
|small sparks at navigation
|-
|waterfall_end
|there is a lot of pair
|-
|water_fnt_tme
|the large flow of water
|-
|water_fountain
|фонтан воды
|-
|wallbust
|a disappearing heap pair
|-
|WS_factorysmoke
|дым
|}

==Связанные функциии скриптинга==
===Клиент===
* [[RU/createEffect]]
* [[RU/setEffectSpeed]]
* [[RU/getEffectSpeed]]
* [[RU/setEffectDensity]]
* [[RU/setEffectDensity]]

[[Category:Element Types]]

RU/createEffect

2015-02-09T10:04:16Z

Strix:

InjectBrowserMouseWheel

2015-02-06T20:15:37Z

Strix:

__NOTOC__
{{Client_function}}
This function injects mouse scrolling.

==Syntax==
<syntaxhighlight lang="lua">
bool injectBrowserMouseWheel ( browser webBrowser, int verticalScroll, int horizontalScroll )
</syntaxhighlight>

===Required arguments===
*'''webBrowser:''' The web browser
*'''verticalScroll''': Amount of units you want the browser to scroll along the Y-axe.
*'''horizontalScroll''': Amount of units you want the browser to scroll along the X-axe.

===Returns===
Returns ''true'' if the mouse action was successfully injected, ''false'' otherwise.

==Example==
Todo

==See Also==
Todo

==See also==
{{CEF_functions}}

Talk:OnClientExplosion

2015-01-20T10:23:24Z

Strix: Created page with "Yes, it is. Also, this event is triggered only for server-side explosions. - ~~~~"

Yes, it is. Also, this event is triggered only for server-side explosions. - [[User:Strix|Strix]] ([[User talk:Strix|talk]]) 10:23, 20 January 2015 (UTC)

GetResourceFromName

2015-01-05T12:16:09Z

Strix: add oop syntax

__NOTOC__
{{Server client function}}
This function is used to retrieve a resource from its name. A resource's name is the same as its folder or file archive name on the server (without the extension).

==Syntax==
<syntaxhighlight lang="lua">
resource getResourceFromName ( string resourceName )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Resource class.|[[Resource]].getFromName}}
===Required Arguments===
*'''resourceName:''' the name of the resource you wish to get.

===Returns===
Returns the ''resource'' with the specified name, or ''false'' if no resource of that name exists.

==Example==
<section name="Server" class="server" show="true">
This example prints out a message to the chatbox when a resource named ''playerblips'' is started.
<syntaxhighlight lang="lua">
function onStart( theResource )
local blipsResource = getResourceFromName ( "playerblips" ) -- get the resource of name "playerblips"
if ( blipsResource and theResource == blipsResource ) then -- check if the resource started was it
outputChatBox ( "Blips resource started!" )
end
end
addEventHandler ( "onResourceStart", getRootElement(), onStart )
</syntaxhighlight>
</section>

==See Also==
{{Resource_functions}}

DeleteResource

2015-01-05T12:14:28Z

Strix: fix oop syntax

__NOTOC__
{{Server function}}
{{Note|This function only works properly from 1.3.0-3912 (r3912). In case you are below r3912 you need to create a directory called "trash" inside of the "resources-cache" folder.}}
This function deletes a resource from the MTA memory and moves it to the "/resources-cache/trash/" directory.
==Syntax==
<syntaxhighlight lang="lua">
bool deleteResource ( string resourceName )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Resource class.|[[Resource]].delete}}
===Required Arguments===
*'''resourceName:''' The name of resource to delete.

===Returns===
Returns ''true'' if the resource has been deleted successfully, ''false'' otherwise.

==Example==
This example adds a command to delete a certain resource (admins only, no spaces in resource name allowed).
<syntaxhighlight lang="lua">
addCommandHandler ( "removeresource",
function ( playerSource, commandName, name )
--Check if it is an admin using this command
if not isObjectInACLGroup ( "user." .. getAccountName ( getPlayerAccount ( playerSource ) ), aclGetGroup ( "Admin" ) ) then
outputChatBox ( "You are not allowed to use this command", playerSource )
return
end
--Did the user pass a valid resource name?
if not name or name == "" or name == " " then
outputChatBox ( "An invalid resource name has been passed (/removeresource <name>)", playerSource )
return
end
--Let us check if the resource name exists
--Get all resources
local resourceTable = getResources ( )
for resourceKey, resourceValue in ipairs ( resourceTable ) do
local resourceName = getResourceName ( resourceValue )
--Does the resource exist?
if name == resourceName then
--Stop the resource (maybe it is running)
stopResource ( resourceValue )
--Delete it
local deleted = deleteResource ( name )
if deleted then
outputChatBox ( "Resource " .. name .. " has been successfully removed", playerSource )
else
outputChatBox ( "There is an unknown problem with the resource", playerSource )
end
--The function is finished and was successful, return to stop it
return
end
end
--If a resource with the specified name does not exist show an error message
outputChatBox ( "The specified resource does not exist", playerSource )
end )
</syntaxhighlight>

==Requirements==
{{Requirements|1.1.1-9.03316|n/a|}}

==See Also==
{{Resource_functions}}