Multi Theft Auto: Wiki - User contributions [en]

OnDgsMouseClickUp

2020-01-20T16:36:36Z

Loki: /* Parameters */ removed invalid parameter

{{Client event}}
__NOTOC__
This event happens when any dgs-element clicked ( Mouse up ).

And this event is for those who are converting gui to dgs.
{{Note|The '''player''' who clicked the dgs-element is always the [[localPlayer]].}}
{{Note|If you want to ask why everything is triggered... See the forth parameter of [[addEventHandler]]}}

==Parameters==
<syntaxhighlight lang="lua">
string button, int absoluteX, int absoluteY
</syntaxhighlight>
*'''button:''' the name of the button which will be clicked , it can be ''left'', ''right'', ''middle''
*'''absoluteX:''' the X position of the mouse cursor, in pixels, measured from the left side of the screen.
*'''absoluteY:''' the Y position of the mouse cursor, in pixels, measured from the top of the screen.

==Source==
The [[event system#Event source|source]] of this event is the DGS element that was clicked.

==Example==
This example creates an edit box alongside an "Output!" button. When the button is clicked with the left mouse button, it will output the message in the edit box into the chat box.
<syntaxhighlight lang="lua">
DGS = exports.dgs
-- When client's resource starts, create the GUI
function initGUI( )
-- Create our button
btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

-- And attach our button to the outputEditBox function
addEventHandler ( "onDgsMouseClickUp", btnOutput, outputEditBox )

-- Create an edit box and define it as "editBox".
editBox = DGS:dgsCreateEdit( 0.3, 0.1, 0.4, 0.1, "Type your message here!", true )
end
addEventHandler( "onClientResourceStart", getResourceRootElement( getThisResource( ) ), initGUI )

-- Setup our function to output the message to the chatbox
function outputEditBox ( button )
if button == "left" then
local text = DGS:dgsGetText( editBox )-- Get the text from the edit box
outputChatBox ( text ) -- Output that text
end
end
</syntaxhighlight>

===Clear Example===
<syntaxhighlight lang="lua">
DGS = exports.dgs

btnOutput = DGS:dgsCreateButton( 0.7, 0.1, 0.2, 0.1, "Output!", true )

function outputEditBox ( button )
if button == "left" then
outputChatBox ( "Hey bro, you clicked me, your state is "..state )
end
end
addEventHandler ( "onDgsMouseClickUp", btnOutput, outputEditBox )
</syntaxhighlight>

==See Also==
===DGS events===
{{DGSEVENTS}}

GuiGridListAddRow

2018-08-21T01:40:19Z

Loki: small QOL update

{{Client function}}
__NOTOC__
Adds a row to a grid list, and optionally add simple text items with your rows. Use [[guiGridListSetItemText]] to add row headers.

{{Deprecated feature|3.0153|1.5.2|
ATTENTION: Without [[guiGridListSetItemText]] there is no row added to the grid.
Look at the example, first you give the row a name with '''[[row =]]''' guiGridListAddRow ( playerList ), and then you use [[guiGridListSetItemText]]. }}

==Syntax==
{{New feature/item|3.0153|1.5.3||
<syntaxhighlight lang="lua">
int guiGridListAddRow ( element gridList [, int/string itemText1, int/string itemText2, ... ] )
</syntaxhighlight>
}}

{{OOP||[[Element/GUI/Gridlist|GuiGridList]]:addRow}}

===Required Arguments===
*'''gridList:''' The grid list you want to add a row to

===Optional Arguments===
{{New feature/item|3.0153|1.5.3||
*'''itemText1:''' The text for the first column item in the row. Either a string or a number can be passed (use numbers for sorting purposes).
*'''itemText2:''' The text for the second column item in the row. Either a string or a number can be passed (use numbers for sorting purposes).
*'''...:''' Item text for any other columns
}}

===Returns===
Returns the row id if it has been created, ''false'' otherwise.

==Example==
This example creates a player list on the right side of the screen and fills it with the names of the connected players.
<syntaxhighlight lang="lua">
function clientsideResourceStart ()
local playerList = guiCreateGridList ( 0.80, 0.10, 0.15, 0.60, true ) -- Create the grid list
local column = guiGridListAddColumn( playerList, "Player", 0.85 ) -- Create a 'players' column in the list
if ( column ) then -- If the column was successfully created
for id, playeritem in ipairs(getElementsByType("player")) do
--Loop through all the players, adding them to the table
guiGridListAddRow ( playerList, getPlayerName ( playeritem ) )
-- create a row and add the player's name to the first column
end
end
end
addEventHandler ( "onClientResourceStart", getRootElement(), clientsideResourceStart )
</syntaxhighlight>

==See Also==
{{GUI functions}}
{{GUI_events}}

SetTrainTrack

2018-07-07T17:02:11Z

Loki: /* Example */

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

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

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

==Example==
This server-side script allows the player to change the track of their train.
<section name="Procedural" class="server"><syntaxhighlight lang="lua">
addCommandHandler("trackies",
function (player, _, track)
local theVehicle = getPedOccupiedVehicle(player)
if not theVehicle then
outputChatBox("You are not in a vehicle!", player)
return
end

if getVehicleType(theVehicle) == "Train" then
setTrainTrack(theVehicle, track)
else
outputChatBox("You are not in a train!", player)
end
end
)
</syntaxhighlight></section>
<section name="Object Oriented" class="server"><syntaxhighlight lang="lua">
addCommandHandler("trackies",
function (player, _, track)
local veh = player.vehicle
if not veh then
return player:outputChat("You are not in a vehicle!")
end

if veh.vehicleType == "Train" then
veh.track = track
else
player:outputChat("You are not in a train!")
end
end
)
</syntaxhighlight></section>

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

IsVehicleLocked

2017-08-11T22:53:32Z

Loki: /* Syntax */

{{Server client function}}
__NOTOC__
This will tell you if a vehicle is locked.

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

{{OOP||[[vehicle]]:isLocked|locked|setVehicleLocked}}

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

===Returns===
Returns ''true'' if the vehicle specified is locked, ''false'' if is unlocked or the vehicle specified is invalid.

==Example==
<section name="Server" class="server" show="true">
This example allows a player to lock his vehicle when he is inside it.
<syntaxhighlight lang="lua">
function lockcar ( thePlayer )
playervehicle = getPlayerOccupiedVehicle ( thePlayer ) -- define 'playervehicle' as the vehicle the player is in
if ( playervehicle ) then -- if a player is in a vehicle
if isVehicleLocked ( playervehicle ) then -- and if the vehicle is already locked
setVehicleLocked ( playervehicle, false ) -- unlock it
else -- otherwise (if it isn't locked)
setVehicleLocked ( playervehicle, true ) -- lock it
end
end
end

function bindLockOnSpawn ( theSpawnpoint ) -- when a player spawns
bindKey ( source, "l", "down", "Lock car", lockcar ) -- bind the 'l' key to the 'lockcar' function
end
addEventHandler ( "onPlayerSpawn", getRootElement(), bindLockOnSpawn ) -- add an event handler for onPlayerSpawn
</syntaxhighlight>
</section>

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

IsVehicleLocked

2017-08-11T22:52:01Z

Loki: /* Syntax */

{{Server client function}}
__NOTOC__
This will tell you if a vehicle is locked.

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleLocked ( vehicle theVehicle )</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[vehicle]]:isLocked|locked|setVehicleLocked}}

{{OOP||[[vehicle]]:isLocked|locked|setVehicleLocked}}

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

===Returns===
Returns ''true'' if the vehicle specified is locked, ''false'' if is unlocked or the vehicle specified is invalid.

==Example==
<section name="Server" class="server" show="true">
This example allows a player to lock his vehicle when he is inside it.
<syntaxhighlight lang="lua">
function lockcar ( thePlayer )
playervehicle = getPlayerOccupiedVehicle ( thePlayer ) -- define 'playervehicle' as the vehicle the player is in
if ( playervehicle ) then -- if a player is in a vehicle
if isVehicleLocked ( playervehicle ) then -- and if the vehicle is already locked
setVehicleLocked ( playervehicle, false ) -- unlock it
else -- otherwise (if it isn't locked)
setVehicleLocked ( playervehicle, true ) -- lock it
end
end
end

function bindLockOnSpawn ( theSpawnpoint ) -- when a player spawns
bindKey ( source, "l", "down", "Lock car", lockcar ) -- bind the 'l' key to the 'lockcar' function
end
addEventHandler ( "onPlayerSpawn", getRootElement(), bindLockOnSpawn ) -- add an event handler for onPlayerSpawn
</syntaxhighlight>
</section>

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

IsVehicleLocked

2017-08-11T22:50:03Z

Loki: /* Syntax */

{{Server client function}}
__NOTOC__
This will tell you if a vehicle is locked.

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleLocked ( vehicle theVehicle )</syntaxhighlight>
</syntaxhighlight>
{{OOP||[[vehicle]]:isLocked|locked|setVehicleLocked}}

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

===Returns===
Returns ''true'' if the vehicle specified is locked, ''false'' if is unlocked or the vehicle specified is invalid.

==Example==
<section name="Server" class="server" show="true">
This example allows a player to lock his vehicle when he is inside it.
<syntaxhighlight lang="lua">
function lockcar ( thePlayer )
playervehicle = getPlayerOccupiedVehicle ( thePlayer ) -- define 'playervehicle' as the vehicle the player is in
if ( playervehicle ) then -- if a player is in a vehicle
if isVehicleLocked ( playervehicle ) then -- and if the vehicle is already locked
setVehicleLocked ( playervehicle, false ) -- unlock it
else -- otherwise (if it isn't locked)
setVehicleLocked ( playervehicle, true ) -- lock it
end
end
end

function bindLockOnSpawn ( theSpawnpoint ) -- when a player spawns
bindKey ( source, "l", "down", "Lock car", lockcar ) -- bind the 'l' key to the 'lockcar' function
end
addEventHandler ( "onPlayerSpawn", getRootElement(), bindLockOnSpawn ) -- add an event handler for onPlayerSpawn
</syntaxhighlight>
</section>

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

SetVehicleLocked

2017-08-11T20:25:34Z

Loki: /* Syntax */

__NOTOC__
{{Server client function}}
This function can be used to set a vehicle to be locked or unlocked. Locking a vehicle restricts access to all doors of a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleLocked ( vehicle theVehicle, bool locked )
</syntaxhighlight>
{{OOP||[[vehicle]]:setLocked|locked|isVehicleLocked}}

===Required Arguments===
*'''theVehicle:''' The vehicle which you wish to change the lock status of
*'''locked:''' Boolean for the status you wish to set. Set ''true'' to lock, ''false'' to unlock

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

==Example==
<section name="Server" class="server" show="true">
This example allows a player to lock his vehicle when he is inside it.
<syntaxhighlight lang="lua">
function lockcar ( thePlayer )
playervehicle = getPlayerOccupiedVehicle ( thePlayer ) -- define 'playervehicle' as the vehicle the player is in
if ( playervehicle ) then -- if a player is in a vehicle
if isVehicleLocked ( playervehicle ) then -- and if the vehicle is already locked
setVehicleLocked ( playervehicle, false ) -- unlock it
else -- otherwise (if it isn't locked)
setVehicleLocked ( playervehicle, true ) -- lock it
end
end
end

function bindLockOnSpawn ( theSpawnpoint ) -- when a player spawns
bindKey ( source, "l", "down", lockcar ) -- bind the 'l' key to the 'lockcar' function
end
addEventHandler ( "onPlayerSpawn", getRootElement(), bindLockOnSpawn ) -- add an event handler for onPlayerSpawn
</syntaxhighlight>
</section>

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

SetVehicleLocked

2017-08-11T20:20:57Z

Loki: /* Syntax */

__NOTOC__
{{Server client function}}
This function can be used to set a vehicle to be locked or unlocked. Locking a vehicle restricts access to all doors of a vehicle.

==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleLocked ( vehicle theVehicle, bool locked )
</syntaxhighlight>
{{OOP||[[vehicle]]:setLocked|locked}}

===Required Arguments===
*'''theVehicle:''' The vehicle which you wish to change the lock status of
*'''locked:''' Boolean for the status you wish to set. Set ''true'' to lock, ''false'' to unlock

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

==Example==
<section name="Server" class="server" show="true">
This example allows a player to lock his vehicle when he is inside it.
<syntaxhighlight lang="lua">
function lockcar ( thePlayer )
playervehicle = getPlayerOccupiedVehicle ( thePlayer ) -- define 'playervehicle' as the vehicle the player is in
if ( playervehicle ) then -- if a player is in a vehicle
if isVehicleLocked ( playervehicle ) then -- and if the vehicle is already locked
setVehicleLocked ( playervehicle, false ) -- unlock it
else -- otherwise (if it isn't locked)
setVehicleLocked ( playervehicle, true ) -- lock it
end
end
end

function bindLockOnSpawn ( theSpawnpoint ) -- when a player spawns
bindKey ( source, "l", "down", lockcar ) -- bind the 'l' key to the 'lockcar' function
end
addEventHandler ( "onPlayerSpawn", getRootElement(), bindLockOnSpawn ) -- add an event handler for onPlayerSpawn
</syntaxhighlight>
</section>

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

GuiGetBrowser

2017-08-10T01:54:41Z

Loki: OOP Syntax error

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function creates gets the browser element behind a gui-browser (a browser that has been created via [[guiCreateBrowser]]).
}}

==Syntax==
<syntaxhighlight lang="lua">
browser guiGetBrowser ( gui-browser theBrowser )</syntaxhighlight>
{{OOP||[[Element/gui-browser|guiBrowser]]:getBrowser|browser|}}

===Required Arguments===
*'''theBrowser:''' The gui-browser

===Returns===
Returns the [[Element/Browser|Browser]] element if a correct [[Element/gui-browser|gui-browser]] has been passed, ''false'' otherwise.

==Example==
This examples get's browser element from gui-browser and attach a webbrowser to a CEGUI window.
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

--Let's create a new browser in remote mode.
local window = guiCreateWindow(200, 200, 1024, 768, "Webbrowser", false)
local browser = guiCreateBrowser(0, 0, 800, 600, false, false, window)

-- The event onClientBrowserCreated will be triggered, after the browser has been initialized.
-- After this event has been triggered, we will be able to load our URL
local theBrowser = guiGetBrowser(browser) -- Get the browser element from gui-browser
addEventHandler("onClientBrowserCreated", theBrowser,
function()
-- After the browser has been initialized, we can load www.youtube.com
loadBrowserURL(source, "http://www.youtube.com")
end
)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

Control names

2017-08-10T01:14:38Z

Loki:

This page lists all the control names. These can be used as key arguments by the console commands ''bind'' and ''unbind'' as well as the script functions [[bindKey]], [[unbindKey]] etc.

Lua table of all the valid control names listed on this page:
<syntaxhighlight lang="lua">controlTable = { "fire", "aim_weapon", "next_weapon", "previous_weapon", "forwards", "backwards", "left", "right", "zoom_in", "zoom_out",
"change_camera", "jump", "sprint", "look_behind", "crouch", "action", "walk", "conversation_yes", "conversation_no",
"group_control_forwards", "group_control_back", "enter_exit", "vehicle_fire", "vehicle_secondary_fire", "vehicle_left", "vehicle_right",
"steer_forward", "steer_back", "accelerate", "brake_reverse", "radio_next", "radio_previous", "radio_user_track_skip", "horn", "sub_mission",
"handbrake", "vehicle_look_left", "vehicle_look_right", "vehicle_look_behind", "vehicle_mouse_look", "special_control_left", "special_control_right",
"special_control_down", "special_control_up" }</syntaxhighlight>

==GTA control list==
<div style="border:3px solid green;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">ON FOOT</div>
* '''fire''' Fire a player's weapon
* '''aim_weapon''' Aim the player's current weapon (if possible)
* '''next_weapon''' Switch to the next weapon
* '''previous_weapon''' Switch to the previous weapon
* '''forwards''' Move forwards
* '''backwards''' Move backwards
* '''left''' Move left
* '''right''' Move right
* '''zoom_in''' Zoom targeted weapon in (sniper/rocket launcher/camera etc)
* '''zoom_out''' Zoom targeted weapon out
* '''change_camera''' Change camera mode
* '''jump''' Make the player jump
* '''sprint''' Make the player sprint
* '''look_behind''' Make the player look behind (and allow the player to see behind them)
* '''crouch''' Make the player crouch/duck
* '''action''' Show the stats menu
* '''walk''' Make the player move slowly/quietly
* '''conversation_yes''' Answer yes to a question
* '''conversation_no''' Answer no to a question
* '''group_control_forwards''' Make the group you are controlling move forwards
* '''group_control_back''' Make the group you are controlling move backwards
* '''enter_exit''' Make the player enter a vehicle. Also used for alternative fighting styles.
</div>
<div style="border:3px solid red;margin-bottom:3px;"><div style="float:right;padding-right:5px;font-weight:bold;">IN VEHICLE</div>
* '''vehicle_fire''' Fire the player's vehicle's primary weapon (e.g. hunter's missiles) or shoot with driveby
* '''vehicle_secondary_fire''' Fire the player's vehicle's secondary weapon (e.g. hunter's minigun)
* '''vehicle_left''' Make the player's vehicle turn left
* '''vehicle_right''' Make the player's vehicle turn right
* '''steer_forward''' Make the player's vehicle turn down (lean forwards for helicopters/planes)
* '''steer_back''' Make the player's vehicle turn up (lean backwards for helicopters/planes)
* '''accelerate''' Make the player's vehicle accelerate
* '''brake_reverse''' Make the player's vehicle brake (slow down) and if stationary reverse
* '''radio_next''' Change to the next radio station (Doesn't work - use [[setRadioChannel]] and [[onClientPlayerRadioSwitch]] instead.)
* '''radio_previous''' Change to the previous radio station (Doesn't work - use [[setRadioChannel]] and [[onClientPlayerRadioSwitch]] instead.)
* '''radio_user_track_skip''' Skip the current track being played on the custom radio station
* '''horn''' Play the horn of the player's vehicle (if the vehicle has a horn) and can trigger the siren on emergency vehicles
* '''sub_mission''' Start a submission if one is avaliable (e.g. taxi missions)
* '''handbrake''' Apply the handbrake on the player's vehicle
* '''vehicle_look_left''' Look to the left
* '''vehicle_look_right''' Look to the right
* '''vehicle_look_behind''' Look behind
* '''vehicle_mouse_look'''
* '''special_control_left''' Move the some special vehicle component left (e.g. tank's turret)
* '''special_control_right''' Move the some special vehicle component right (e.g. tank's turret)
* '''special_control_down''' Move the some special vehicle component down (e.g. tank's turret)
* '''special_control_up''' Move the some special vehicle component up (e.g. tank's turret)
* '''enter_exit''' Make the player exit a vehicle
</div>

==MTA hard-coded commands==
The following are names of hard-coded MTA commands which do not use bindKey, but can act as bindKey by using them in an [[addCommandHandler]]. Other than that, this control list will '''only''' work with the functions [[toggleControl]] and [[toggleAllControls]]. Please note that [[toggleControl]] can't disable screenshot.

<div style="border:3px solid blue;margin-bottom:3px;"><div
style="float:right;padding-right:5px;font-weight:bold;">MTA COMMANDS</div>
* '''enter_passenger''' Enters the closest vehicle as passenger
* '''screenshot''' Takes a screenshot
* '''chatbox''' Opens the chatbox for input
* '''radar''' Toggles the radar-map showing
* '''radar_zoom_in''' Zooms in on the radar-map
* '''radar_zoom_out''' Zooms out on the radar-map
* '''radar_move_north''' Moves north on the radar-map
* '''radar_move_south''' Moves south on the radar-map
* '''radar_move_east''' Moves east on the radar-map
* '''radar_move_west''' Moves west on the radar-map
* '''radar_attach''' Attaches the view to the local-player on the radar-map
</div>
[[Category:Scripting Concepts]]

Animate

2017-07-20T13:00:17Z

Loki: /* Example */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function allows you to use interpolateBetween without render event and easily used.
==Syntax==
<syntaxhighlight lang="lua">animation animate(int/float from, int/float to, string/int easing, int duration, function onChange [ , function onEnd ])</syntaxhighlight>

===Required arguments===

* '''from''': the start value.
* '''to''': the end value.
* '''easing''': the [[Easing|easing function]] to use for the animation or can be used the easing number, e.g. "Linear" = 1, "InQuad" = 2, "OutQuad" = 3, ...
* '''duration''': the duration of animation.
* '''onChange''': the function to call when the animation value is changed.

===Optional arguments===
* '''onEnd''': the function to call when the animation End.

===Return===
Returns animation or false if invalid arguments were passed.

==Code==
<section name="Code" class="client" show="true">
<syntaxhighlight lang="lua">
local anims, builtins = {}, {"Linear", "InQuad", "OutQuad", "InOutQuad", "OutInQuad", "InElastic", "OutElastic", "InOutElastic", "OutInElastic", "InBack", "OutBack", "InOutBack", "OutInBack", "InBounce", "OutBounce", "InOutBounce", "OutInBounce", "SineCurve", "CosineCurve"}

function table.find(t, v)
for k, a in ipairs(t) do
if a == v then
return k
end
end
return false
end

function animate(f, t, easing, duration, onChange, onEnd)
assert(type(f) == "number", "Bad argument @ 'animate' [expected number at argument 1, got "..type(f).."]")
assert(type(t) == "number", "Bad argument @ 'animate' [expected number at argument 2, got "..type(t).."]")
assert(type(easing) == "string" or (type(easing) == "number" and (easing >= 1 or easing <= #builtins)), "Bad argument @ 'animate' [Invalid easing at argument 3]")
assert(type(duration) == "number", "Bad argument @ 'animate' [expected function at argument 4, got "..type(duration).."]")
assert(type(onChange) == "function", "Bad argument @ 'animate' [expected function at argument 5, got "..type(onChange).."]")
table.insert(anims, {from = f, to = t, easing = table.find(builtins, easing) and easing or builtins[easing], duration = duration, start = getTickCount( ), onChange = onChange, onEnd = onEnd})
return #anims
end

function destroyAnimation(a)
if anims[a] then
table.remove(anims, a)
end
end

addEventHandler("onClientRender", root, function( )
local now = getTickCount( )
for k,v in ipairs(anims) do
v.onChange(interpolateBetween(v.from, 0, 0, v.to, 0, 0, (now - v.start) / v.duration, v.easing))
if now >= v.start+v.duration then
if type(v.onEnd) == "function" then
v.onEnd( )
end
table.remove(anims, k)
end
end
end)
</syntaxhighlight>
</section>

==Example==
<section name="Example" class="client" show="true">
This example open/close with slide up/down effect.
<syntaxhighlight lang="lua">
--Slide Animation
local sx, sy = guiGetScreenSize( )
local window = guiCreateWindow((sx-300)/2, (sy-400)/2, 300, 400, "Test", false)
guiSetVisible(window, false)
bindKey("f2", "down", function( )
if anim then return end
local v = guiGetVisible(window)
if not v then guiSetVisible(window, true) end
anim = true
animate(v and 400 or 0, v and 0 or 400, 2, 1250, function(height)
if v and height == 0 then
guiSetVisible(window, false)
anim = false
elseif not v and height == 400 then
anim = false
end
local w, h = guiGetSize(window, false)
guiSetSize(window, w, height, false)
end)
end)
</syntaxhighlight>
</section>
Author : Mr.Tn6eL

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

CreateBrowser

2017-04-10T02:58:57Z

Loki: Undo revision 50622 by Joker (talk)

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

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

===Required Arguments===
*'''width:''' The browser's native width
*'''height:''' The browser's native height
*'''isLocal:''' Sets whether the browser can only show local content or content from the internet (see examples for more information)
''
===Optional Arguments===
*'''transparent:''' ''true'' if you want the browser transparent, ''false'' for opaque.

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

==Local Example==
{{Warning|The scheme for local files has changed. Please read [[Local_Scheme_Handler|Local Scheme Handler]] for details.|true}}
This example shows you how to create a fullscreen web browser (showing a local html file) without input-handling.
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

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

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

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

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

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

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

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

==See Also==
{{CEF_functions}}

CreateBrowser

2017-04-10T02:58:06Z

Loki: Undo revision 50623 by Joker (talk)

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

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

===المطلوب منك===
*'''عرض:''' The browser's native width
*'''ارتفاع:''' The browser's native height
*'''isLocal:''' Sets whether the browser can only show local content or content from the internet (see examples for more information)
''

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

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

==Local Example==
{{Warning|The scheme for local files has changed. Please read [[Local_Scheme_Handler|Local Scheme Handler]] for details.|true}}
This example shows you how to create a fullscreen web browser (showing a local html file) without input-handling.
<syntaxhighlight lang="lua">
--In order to render the browser on the full screen, we need to know the dimensions.
local screenWidth, screenHeight = guiGetScreenSize()

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

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

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

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

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

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

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

==See Also==
{{CEF_functions}}

Client Scripting Events

2017-04-09T16:37:39Z

Loki: Undo revision 50600 by LAGOWYPOLSKA (talk)

<pageclass class="client"></pageclass>
This page lists all '''client-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a function or event, use [[Requested Functions and Events]].

'''Server-side scripting events can be found here: [[Server Scripting Events]]

==Browser events==
{{CEF_events}}

==Colshape events==
{{Client_colshape_events}}

==Element events==
{{Client_element_events}}

==GUI events==
{{GUI_events}}

==Marker events==
{{Client_marker_events}}

==Ped events==
{{Client_ped_events}}

==Pickup events==
{{Client_pickup_events}}

==Player events==
{{Client_player_events}}

==Object events==
{{Client_object_events}}

==Projectile events==
{{Client_projectile_events}}

==Resource events==
{{Client_resource_events}}

==Sound events==
{{Sound_events}}

==Vehicle events==
{{Client_vehicle_events}}

==Weapon creation events==
{{Client_weapon_creation_events}}

==Other events==
{{Client_other_events}}

[[pl:Client Scripting Events]]
[[ru:Client Scripting Events]]
[[es:Client Scripting Events]]
[[fr:Client Scripting Events]]
[[tr:Client Taraflı Eventler]]
[[ar:Client Scripting Events]]

Server Scripting Events

2017-04-09T16:37:36Z

Loki: Undo revision 50602 by LAGOWYPOLSKA (talk)

<pageclass class="server"></pageclass>
This page lists all '''server-side''' scripting [[event]]s that have been implemented and are available in the Deathmatch mod.

To request a function or event, use [[Requested Functions and Events]].

'''Client-side scripting events can be found here: [[Client Scripting Events]]

==Client events==
{{Client_events}}

==Colshape events==
{{Colshape_events}}

==Element events==
{{Element_events}}

==Marker events==
{{Marker_events}}

==Pickup events==
{{Pickup_events}}

==Player events==
{{Player_events}}

==Ped events==
{{Ped_events}}

== Resource events==
{{Resource_events}}

==Server events==
{{Server_events}}

== Vehicle events ==
{{Vehicle_events}}

== Weapon events ==
{{Weapon_events}}

[[tr:Server Scripting Events]]
[[ru:Server Scripting Events]]
[[fr:Server Scripting Events]]

Useful Functions

2017-04-09T16:37:29Z

Loki: Undo revision 50603 by LAGOWYPOLSKA (talk)

<pageclass class="#228B22"></pageclass>
{{MessageBox|
bordercolorhex = 000000 |
bordertype = dotted |
bgcolorhex = EFEFEF |
image = File:Package-x-generic.png |
title = Don't forget to check out the [[Useful Classes]] |
subtext = <span style="font-size: 85%;">''That page lists user-made classes that are not included by default in MTA. ''</span> |
}}
{{Adding_Pages_to_Categories_and_Templates}}

This page lists user-made Lua functions that are not included by default in MTA. Its purpose is to quickly provide some useful functions for scripters, so they do not waste time recreating them when needed.
<br/>
{{Useful_Functions}}
[[ES:Funciones Útiles]]
[[ru:Useful Functions]]
[[de:Nützliche_Funktionen]]
[[PL:Użyteczne Funkcje]]
[[Ar:وظائف مفيدة]]

Where to buy GTASA

2017-04-09T16:37:21Z

Loki: Undo revision 50607 by LAGOWYPOLSKA (talk) trolling

This page outlines some of the places Grand Theft Auto San Andreas can be bought digitally and played with MTASA (sometimes with an automatic downgrade step). Not all of these have been tested, but all should work correctly. If not, please contact support.

All disc (DVD) versions of Windows GTASA are known to function fine. If you are planning on buying a DVD of GTASA, you should try to obtain a "Standard" version rather than "Second Edition" or "Greatest Hits" editions, though all will work fine.

{| class="wikitable" style="width: 900px; text-align: center; table-layout: fixed;"
|-
!Retailer
!Notes
!Verified to work with MTA: SA?
|-
|[http://store.steampowered.com/app/12120/ Steam]
|Specialized Steam version of the game. MTA installer will downgrade this for you.
|{{Yes}}
|-
| rowspan="2" |[http://www.amazon.com/Grand-Theft-Auto-Andreas-Download/dp/B006YVXGJQ Amazon]
| For the '''Standard''' edition of the game, if MTA is incompatible, try obtaining a GTA SA 1.00 No CD - any HOODLUM release will function correctly.
| {{Partial|Unconfirmed (Standard)}}
|-
| Steam version and disc copies of GTASA will function fine
| {{Yes| Yes (Steam/Boxed DVD)}}
|-
|[http://www.gamersgate.co.uk/DD-GTASAS/grand-theft-auto-san-andreas GamersGate]
|rowspan=6|This is the Steam version of the game, and will function similarly.
|rowspan="6" {{Yes}}
|-
|[http://www.game.co.uk/en/grand-theft-auto-san-andreas-301403 Game UK]
|-
|[http://digital.gamefly.co.uk/#!/download-grand-theft-auto-san-andreas/5006365 GameFly Digital]
|-
|[http://www.greenmangaming.com/s/gb/en/pc/games/action/grand-theft-auto-san-andreas/ GreenManGaming]
|-
|[http://www.gamestop.com/pc/games/grand-theft-auto-san-andreas/37409 GameStop]
|-
|[http://www.walmart.com/ip/Take-Two-GTASAESD-Grand-Theft-Auto-San-Andreas-PC/36754297 Walmart]
|-
|-
|Windows App Store
|This is a mobile version of the game ported to PC. '''Will never work with MTA'''.
|{{No}}
|-

[[pl:Where to buy GTASA]]
[[es:Dónde comprar GTA: SA]]
[[tr:GTA:SA Nerden Alınır]]
[[zh-cn:在那里可以购买GTASA]]

MTA Classes

2017-04-09T16:35:10Z

Loki: Undo revision 50604 by LAGOWYPOLSKA (talk)

In order to perform operations on MTA objects via scripting, pointers to internal classes are exported to scripts as Lua userdata. Each of these classes has a number of exported scripting functions associated to them.

Elements that have a physical representation in the game are also known as [[entity|Entities]].

The complete list of classes to be found in scripts follows:

* [[account|Account]]
* [[acl|ACL]]
* [[aclgroup|ACL group]]
* [[Ban]]
* [[element|Element]]
<ul>{{Elements}}</ul>
* [[resource|Resource]]
* [[textdisplay|Text display]]
* [[textitem|Text item]]
* [[timer|Timer]]
* [[xmlnode|XML node]]
* [[connection|Connection]]
[[Category:Scripting Concepts]]
[[es:Clases MTA]]
[[it:Classi di MTA]]
[[ru:Классы MTA]]

Element

2017-04-09T16:34:39Z

Loki: Undo revision 50605 by LAGOWYPOLSKA (talk)

An '''element''' is a generic class that can represent almost all in-game [[entity|entities]]. The built-in element types are:

{{Elements}}

Any other element type can be created as an abstract element, not referring to any game [[entity]]. For example, '''resource''' and '''map''' elements are created when resources and maps are loaded to group entities they create as their children.

Elements share common functions such as type and list retrieval, a destroy operation to remove both the element and the game entity it is linked to (except for some elements which can't be destroyed, for example client elements), [[element data]] storing and retrieval, and many more common operations.

All elements are stored internally in a [[Element tree|tree structure]], and as such every element except the '''root''' element has a parent element, that can be the '''root''' element, a '''resource''', '''map''' or another element. This is purely for declaring the scope of function calls.

==Related scripting functions==
===Client===
{{Client element functions}}
===Server===
{{Element functions}}
[[Category:Scripting Concepts]]

[[it:Elemento]]
[[ru:Element]]
[[es:Elemento]]

Element tree

2017-04-09T16:34:08Z

Loki: Undo revision 50606 by LAGOWYPOLSKA (talk)

[[File:Tre.png|frame|Element tree]]
MTA uses a so-called ''element tree'' to store all the elements that exist on the server and the client. This is directly related to the set of running [[resources]] and their map files' XML layout, although it can be changed at run-time by scripts.

If you are familiar with the concept of ''trees'' in computer-science, this should be easy to understand. If you are not, think of it like a family tree - except everyone only has a single parent. Every [[element]] has a ''parent'' element.

All elements that are created within scripts or from .map files are child elements of the resource they belong to. Thus, most elements (except for [[client]]s) exist only within resources and are also destroyed as soon as their resource is stopped.

==Tree elements==
* '''root''': This is at the very base of the tree - all elements are children (or descendants) of this element.
<syntaxhighlight lang="lua">
getRootElement()
</syntaxhighlight>
* '''resource''': These are direct children of the root element - with one for each ''running'' resource. This element is called the ''resource root''. Its ID holds the name of the resource.
<syntaxhighlight lang="lua">
getResourceRootElement()
</syntaxhighlight>
* '''map''': Each resource element contains at least one map element, representing either a ".map" file in the resource or the one containing the elements created by scripts (this is called the ''dynamic'' map). Their IDs contain the maps' filenames, or ''dynamic'' for the dynamic map.
** Map files can contain a number of other [[element]]s as well as an unlimited number of custom elements.

==Example==
This in an example of a serverside tree dumped to XML from a running server.
''Please note that it is shortened on some places for the sake of overview.''
<syntaxhighlight lang="xml">
<root>
<console/>
<player dontRespawn="false"/>
<player dontRespawn="false" lastSpawnarea=""/>
<resource id="resourcebrowser"/>
<resource id="ajax"/>
<resource id="resourcemanager"/>
<resource id="spawnmanager"/>
<resource id="mapmanager"/>
<resource id="runcode"/>
<resource id="fr">
<map id="dynamic">
<vehicle/>
</map>
</resource>
<resource id="elementbrowser"/>
<resource id="assault">
<map id="dynamic">
<team/>
<team/>
<blip/>
<marker/>
<colshape/>
<blip/>
<blip/>
</map>
</resource>
<resource id="as-farm">
<map id="dynamic"/>
<map id="as-farm.map">
<spawngroup req="" type="attacker">
<spawnarea posY="-8.3976354598999" posX="20.182683944702" skins="9" ... />
</spawngroup>
<spawngroup req="" type="attacker">
<spawnarea posY="32.166355133057" posX="-46.90763092041" skins="9" ... />
</spawngroup>
<spawngroup req="" type="attacker">
<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />
</spawngroup>
<spawngroup req="" type="attacker">
<spawnarea posY="35.214984893799" posX="-33.486911773682" skins="9" ... />
</spawngroup>
<objective id="first" type="checkpoint" description="Breach into the farm" ... />
<pickup type="weapon" ... />
</map>
</resource>
</root>
</syntaxhighlight>
===Explanation===
This tree consists of a number of resource root elements, the [[Element/Console|server console]] and two [[player]] elements, that are direct children of the '''root''' element. All these resources have a ''dynamic map'' as child element (it is just not shown for most of them). These contain the elements that are created dynamically by this resource using scripts, for example a [[vehicle]]. If the resource has a map file, it is also a child element, itself containing all the elements in the .map file.

Let's have a closer look at the '''assault''' resource: This contains just one ''dynamic'' map that has 2 teams, 3 blips, 1 marker and 1 colshape as child elements. These are the elements that are created by the script, for example the marker, the colshape and one of the blips are probably used for the objective.

The '''as-farm''' resource's function on the contrary is to be a map for the '''assault''' gamemode. The dynamic map is empty (it could contain elements if there was a script in it though), while there is a map called 'as-farm.map', that contains a number of elements. These are mostly custom elements (like spawngroup, spawnarea, objective) but also a few elements that MTA creates automactically after loading the map (like pickup). In the brackets after the element type, you can see the element data it contains. These are identical with the attributes the .map file contains within these elements, while you can also set and get element data for any other elements (e.g. players) with [[setElementData]] and [[getElementData]].

==Pratical application==
Elements can have as many children as they like. This does not directly affect the map in any way, but it comes in to its own when combined with the scripting system.

===Setting data for elements===
If you call a set... function on a node of the element tree, the function will affect every element within it (that it can work on).

So, the following code would set the size of every marker (the only type of element the setMarkerSize function can work on) that is below the root element to ''2.5''.
<syntaxhighlight lang="lua">
setMarkerSize ( getRootElement(), 2.5 )
</syntaxhighlight>

The same can be done on any element, it is not restricted to the root element.

===Map manager===
The [[#Example|example above]] shows the way the [[map manager]] uses different resources. The 'assault' resource is the gamemode, that manages what happens on the server using scripts and thus by creating elements in the tree dynamically. When a map resource is started, the gamemode receives a [[resource|resource pointer]] referring to the started resource - in this case ''as-farm'' - from which you can retrieve and store the resource root element. Using this element in conjunction with functions like [[getElementsByType]], [[getElementData]] and various others, you can access any of the information that was loaded into the tree from the 'as-farm.map'-file through scripts in the gamemode resource.

Another thing that has to be considered related to the tree of elements is the fact that when you change the map, you don't have to remove any elements you created within the map resource, while you '''do''' have to remove elements that are created within the gamemode resource, '''if''' they are specific to the map (which will be probably the case for those items you create based on information read from the map resource's .map files).

==Element browser==
You can start the resource ''elementbrowser'' to see a live view of the element tree on your server. Just start the resource and browser to your server's web page and choose the ''Element browser'' option in the sidebar (firefox only currently).
[[Category:Scripting Concepts]]
[[es:Árbol de elementos]]
[[ru:Element tree]]

Client Scripting Functions

2017-04-09T16:30:36Z

Loki: Undo revision 50599 by LAGOWYPOLSKA (talk) trolling

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

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

==Audio functions==
{{Client_audio_functions}}

==Blip functions==
{{Client_blip_functions}}

==Browser functions==
{{CEF_functions}}

==Camera functions==
{{Client_camera_functions}}

==Clothes and body functions==
{{Client_Clothes and body functions}}

==Collision shape functions==
{{Client_collision_shape_functions}}

==Cursor functions==
{{Client_cursor_functions}}

==Drawing functions==
{{Drawing_functions}}

==Effects functions==
{{Client_Effects_functions}}

==Element functions==
{{Client_element_functions}}

==Engine functions==
{{Engine_functions}}

==Event functions==
{{Client_event_functions}}

==Explosion functions==
{{Client_explosion_functions}}

==File functions==
{{Client file functions}}

==Fire functions==
{{Client fire functions}}

==GUI functions==
{{GUI_functions}}

==Input functions==
{{Client_input_functions}}

==Light functions==
{{Client_light_functions}}

==Marker functions==
{{Client_marker_functions}}

==Matrix functions==
{{Shared_matrix_functions}}

==Object functions==
{{Client_object_functions}}

==Output functions==
{{Client_output_functions}}

==Ped functions==
{{Client_ped_functions}}

==Pickup functions==
{{Client_pickup_functions}}

==Player functions==
{{Client_player_functions}}

==Projectile functions==
{{Client_projectile_functions}}

==Radar area functions==
{{Client_radar-area_functions}}

==Resource functions==
{{Client_resource_functions}}

==Searchlight functions==
{{Client_searchlight_functions}}

==Team functions==
{{Client_team_functions}}

==Utility functions==
{{Client_utility_functions}}

==UTF8 Library==
{{UTF8 functions}}

==Vehicle functions==
{{Client_vehicle_functions}}

==Water functions==
{{Client_water_functions}}

==Weapon functions==
{{Client_weapon_functions}}

==Weapon Creation functions==
<strike>Documentation can be found [http://code.google.com/p/mtasa-blue/source/detail?r=4555 here] [https://github.com/multitheftauto/mtasa-blue/commit/c0ac461867e24fe5fc471fe373ec6212e8736c01 (GitHub)] and [http://code.google.com/p/mtasa-blue/source/detail?r=4557 here] [https://github.com/multitheftauto/mtasa-blue/commit/9c2464b5e0c7d0f2915a9b46273832cd950af48e (GitHub)]</strike>
{{Client_weapon_creation_functions}}

==World functions==
{{Client_world_functions}}

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

[[ar:Client Scripting Functions]]
[[pl:Funkcje po stronie klienta]]
[[it:Funzioni Client-side]]
[[ru:Client Scripting Functions]]
[[es:Funciones del cliente]]
[[de:Clientseitige_Funktionen]]
[[tr:Client Taraflı Fonksiyonlar]]
[[zh-cn:客户端脚本函数]]

How you can help

2017-04-09T16:26:18Z

Loki: Undo revision 50598 by LAGOWYPOLSKA (talk) (trolling)

__NOTOC__
Multi Theft Auto has loads of areas in which you can help us. In turn, we'll be more than happy to help you get started with any ideas you have, help test them and - if they're good enough - release them to the whole community. This page outlines the key areas you could do something in, of course, there are many things we've not thought of, so think outside the box!

==Coding for MTA:SA==
* Create pull requests for the mod, containing requested features or bugfixes. ([[Coding guidelines]])
* Translate MTA:SA to your native language - http://translate.multitheftauto.com/

==Scripting==
* Create a gamemode
**[[Scripting Introduction]]
**[http://www.lua.org/pil/index.html "Programming in Lua" Manual]
* Create an administration page on the HTTP server.
**[[Resource Web Access]]
* Make a general purpose resource that provides useful functions to other resources.

==Mapping==
* Create a map with the map editor for an existing gamemode.
**[[Resource:Editor|Map Editor Manual]]

==Web development==
* Work with lil_Toady to add new features and improvements to community.mtasa.com.
* Create your own system for statistics - using the [[PHP SDK]] as a basis. Contact eAi or jbeta for help.

==Documentation==
Before you make changes check out: [[Help:Editing Guidelines|Editing Guidelines]] and [[Help:MTA Wiki Specific Templates|Specific Templates]]
* Finish documentation for [[:Category:Incomplete|Incomplete functions]] - ask in #mta.scripting if you're not sure of something.
* Add examples to [[:Category:Needs Example|functions & events missing examples]] - please '''test''' them, and again, ask if you need help.
* Review and verify [[:Category:Needs Checking|pages that need checking]] - make sure highlighted issues are solved before removing pages from the category.
* Expand the pages that explain [[:Category:Scripting_Concepts|MTA core concepts]].
* Write tutorials to help new people.
* Translate the wiki pages so people from other countries can get started in MTA too.
* Create documentation for undocumented functions and events [[Undocumented Items]]

==Specific tasks==
* Create a fuzzer to check for crashes in our scripting functions.
* Help develop/fix existing gamemodes. Contact the original author on IRC (or ask a developer) to tell the author so you can work together.
* The web interface resources (resourcemanager, resourcebrowser and webadmin chiefly) are really only compatible with Firefox. Someone could put in some time to make these work on Internet Explorer, Opera and Safari. See [[User_talk:EAi|eAi]] for help.

==Grant==
You can donate MTA:SA [https://mtasa.com/donate/manage.php here]

[[pl:Jak możesz pomóc]]
[[ru:How you can help]]
[[es:Cómo puedes ayudar]]
[[hu:How you can help]]
[[tr:Nasıl yardımcı olabilirsiniz]]

Vector/Vector3

2016-12-22T19:00:53Z

Loki: /* Example */

[[Category:Incomplete]]
The '''vector3''' class represents a three-dimensional [[vector]].

==Methods==
===create===
This is default constructor for the Vector3 class and returns a Vector3 object.

====Syntax====
<syntaxhighlight lang="lua">vector3 Vector3 ( [ float x = 0, float y = 0, float z = 0 ] )</syntaxhighlight>

=====Optional arguments=====
* '''x''', '''y''' and '''z''': coordinates for the vector. If not specified, they default to 0.
* Instead of these three coordinates, a single Vector3 object may be inserted to clone it.

====Example====
This example sorts all players in a nice line on the center of the map.
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
local players = getElementsByType("player")
local newPlayerPosition = Vector3(-#players - 1, 0, 10) -- Initialize the position vector for the first player in the list
for _, player in ipairs(players) do
-- Move each player 1 unit forward in X from the previous one
newPlayerPosition.x = newPlayerPosition.x + 1
setElementPosition(player, newPlayerPosition)
end
</syntaxhighlight>
</section>

===cross===
Calculates the cross product of two vectors, A and B, and is written as A × B. The result is another vector which:

* Is orthogonal to both A and B.
* Its direction is determined by the [https://upload.wikimedia.org/wikipedia/commons/d/d2/Right_hand_rule_cross_product.svg right-hand rule].
* Its length is equal to the area of the parallelogram that A and B form (which in turn is equal to A's length by B's length by the sine of the minimum angle between A and B).

====Syntax====
<syntaxhighlight lang="lua">vector3 Vector3:cross ( vector3 vector )</syntaxhighlight>

=====Required arguments=====
* '''vector''': a vector3 object to get the cross product with.

====Example====
This example creates a tiny sun which is always at the right of the vehicle the local player drives. By default it will draw the vectors used to compute the position where it should be, so you can understand what does this function do. Note that the code could be made simpler by simply getting the right component of the vehicle matrix. '''Make sure that you put this code in a resource which has OOP enabled, or it won't work'''.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">-- OPTIONS --
local debugMode = true -- If true, the script will draw the vectors used to compute the effect

-- EFFECT CONTROL FUNCTIONS --
local playerVehicle, lightMarker, light
local function applyDrivingLightEffect()
-- Get the vehicle matrix and use it to get the vehicle and vehicle base position
local vehicleMatrix = playerVehicle.matrix
local vehiclePosition = vehicleMatrix:getPosition()
-- Get the vehicle upwards vector and vehicle forward direction vector
local vehicleUpwardsVector, vehicleForwardVector = vehicleMatrix:getUp(), vehicleMatrix:getForward()
-- Get the normalized cross product of the vehicle forward vector and the vehicleUpwardsVector vector
local crossVector = vehicleForwardVector:cross(vehicleUpwardsVector):getNormalized()
-- Draw all the interesting vectors we have now
if debugMode then
local forwardPoint = vehiclePosition + vehicleForwardVector
dxDrawLine3D(vehiclePosition, forwardPoint, tocolor(255, 0, 0))
local sx, sy = getScreenFromWorldPosition(forwardPoint)
if sx then
dxDrawText("F", sx, sy)
end

local vehicleUpwardsVectorPoint = vehiclePosition + vehicleUpwardsVector
dxDrawLine3D(vehiclePosition, vehicleUpwardsVectorPoint, tocolor(0, 255, 0))
local sx, sy = getScreenFromWorldPosition(vehicleUpwardsVectorPoint, 1.1)
if sx then
dxDrawText("U", sx, sy)
end

local crossPoint = vehiclePosition + crossVector
dxDrawLine3D(vehiclePosition, crossPoint, tocolor(0, 0, 255))
local sx, sy = getScreenFromWorldPosition(crossPoint)
if sx then
dxDrawText("C", sx, sy)
end
end
-- Calculate the half length of the vehicle based in its bounding box, and use it to position the light effects at the right
local _, bmy, _, _, bMy = playerVehicle:getBoundingBox()
local newEffectPosition = vehiclePosition + crossVector * (bMy - bmy) / 2
lightMarker.position = newEffectPosition
light.position = newEffectPosition
end

local function startDrivingLightEffect()
-- Create the effects and start updating them every frame
addEventHandler("onClientPreRender", root, applyDrivingLightEffect)
playerVehicle, lightMarker, light = localPlayer.vehicle, createMarker(0, 0, 0, "corona", 0.5, 255, 255, 0), createLight(0, 0, 0, 0, 8, 255, 255)
-- If we are in debug mode, render the vehicle invisible to see the vectors clearly
if debugMode then
playerVehicle.alpha = 0
end
end

local function stopDrivingLightEffect()
-- Stop applyDrivingLightEffect from being called and destroy everything created
removeEventHandler("onClientPreRender", root, applyDrivingLightEffect)
destroyElement(lightMarker)
destroyElement(light)
-- If we are in debug mode, reset the vehicle alpha to normal again
if debugMode then
playerVehicle.alpha = 255
end
playerVehicle, lightMarker, light = nil, nil, nil
end

-- FUNCTIONS THAT MANAGE THE EFFECT --
-- Start or stop the effect when the player is driving a car
local function manageDrivingLightEffectStatus(_, seat)
if eventName == "onClientPlayerVehicleEnter" then
if seat == 0 then
-- The player has just entered a vehicle as the driver. Start the effect
startDrivingLightEffect()
end
elseif playerVehicle then
-- The player has just exited a vehicle and we were applying the effect. Stop it
stopDrivingLightEffect()
end
end
addEventHandler("onClientPlayerVehicleEnter", localPlayer, manageDrivingLightEffectStatus)
addEventHandler("onClientPlayerVehicleExit", localPlayer, manageDrivingLightEffectStatus)

-- Start the effect when the resource starts if the player is driving a vehicle, and reset vehicle alpha back to normal if necessary
local function handleResourceStartStop()
if eventName == "onClientResourceStart" then
playerVehicle = localPlayer.vehicle or nil
if playerVehicle then
startDrivingLightEffect()
end
elseif playerVehicle then
-- It is not necessary to call this function to just reset the car alpha, but it is a good practise to ALWAYS clean up everything nevertheless
stopDrivingLightEffect()
end
end
addEventHandler("onClientResourceStart", resourceRoot, handleResourceStartStop)
addEventHandler("onClientResourceStop", resourceRoot, handleResourceStartStop)</syntaxhighlight></section>

===dot===
Calculates the (standard) dot/scalar product of two vectors. If we call that vectors A and B, the dot product is written as A · B. This can be used to calculate the angle between them. If the standard scalar product is 0, both vectors are orthogonal.

====Syntax====
<syntaxhighlight lang="lua">float Vector3:dot ( vector3 vector )</syntaxhighlight>

=====Required arguments=====
* '''vector''': a vector3 object to get the dot product with.

====Example====
This examples illustrates the concept of dot/scalar product and implements a useful function which can be used to get the angle between two vectors.
<section name="Shared" class="both" show="true">
<syntaxhighlight lang="lua">
local vec1 = Vector3(1, 0, 0)
local vec2 = Vector3(0, 0, 0)
local dotproduct = vec1:dot(vec2)

if dotproduct == 0 then
outputDebugString("vec1 is orthogonal to vec2")
end

-- Calculate angle between vec1 and vec2
function angle(vec1, vec2)
-- Calculate the angle by applying law of cosines
return math.acos(vec1:dot(vec2)/(vec1.length*vec2.length))
end

outputDebugString("Angle between vec1 and vec2: "..math.deg(angle(vec1, vec2)).."°")
</syntaxhighlight>
</section>

===normalize===
Converts a vector to a unit vector (a vector of length 1).

====Syntax====
<syntaxhighlight lang="lua">bool Vector3:normalize ( )</syntaxhighlight>

====Example====
This example slowly moves all the players' camera to look at the Mount Chilliad.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local targetPosition = Vector3(-2627.32, -1083.2, 433.35) -- Somewhere in Mount Chilliad

local function moveCameraToTarget(deltaTime)
local currentPosition = Vector3(getCameraMatrix())
local direction = targetPosition - currentPosition
direction:normalize() -- Get a direction vector by normalizing the vector from the current position to the target position
setCameraMatrix(currentPosition + direction * deltaTime * 0.05, -2589.45, -1174.49, 418.09)
end
addEventHandler("onClientPreRender", root, moveCameraToTarget)
</syntaxhighlight>
</section>

===getX and setX===
===getY and setY===
===getZ and setZ===
===getNormalized===
Returns a normalized vector (of length 1) of the vector it's used on. Differently from the ''Vector3:normalize'' method, this one returns a ''vector3'' and doesn't modify the original vector.

====Syntax====
<syntaxhighlight lang="lua">vector3 Vector3:getNormalized ( )</syntaxhighlight>

====Example====
This example slowly moves all the players' camera to look at the Mount Chilliad with a shorter code than the previous example.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
local targetPosition = Vector3(-2627.32, -1083.2, 433.35) -- Somewhere in Mount Chilliad

local function moveCameraToTarget(deltaTime)
local currentPosition = Vector3(getCameraMatrix())
local direction = (targetPosition - currentPosition):getNormalized() -- Get a direction vector by normalizing the vector from the current position to the target position
setCameraMatrix(currentPosition + direction * deltaTime * 0.05, -2589.45, -1174.49, 418.09)
end
addEventHandler("onClientPreRender", root, moveCameraToTarget)
</syntaxhighlight>
</section>

===getSquaredLength===
===getLength===

[[ru:Vector/Vector3]]

CanBrowserNavigateForward

2016-12-18T00:16:21Z

Loki:

__NOTOC__
{{Client function}}
{{New feature/item|3.0153|1.5.3|9912|
This function checks if the browser can go to the next page.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool canBrowserNavigateForward( browser webBrowser )
</syntaxhighlight>

===Required Arguments===
*'''webBrowser:''' The browser you want check for a next page.

===Returns===
Returns ''true'' if the browser can go to the next page, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example creates a browser that can return to the last and previous pages and can also be refreshed:
<syntaxhighlight lang="lua">
window = guiCreateWindow(126, 122, 848, 674, "Firechrome", false)
guiWindowSetSizable(window, false)

navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
guiSetEnabled( addressBar, false )
reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
browser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)

-- Load our page on browser creation.
local theBrowser = guiGetBrowser(browser)
addEventHandler("onClientBrowserCreated", theBrowser,
function()
loadBrowserURL(source, "https://forum.mtasa.com/")
end
)

-- This checks to see if the browser can navigate in any direction and enables the back or forward buttons
addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( )
navigateForwardBtn.enabled = (canBrowserNavigateForward(theBrowser))
navigateBackBtn.enabled = (canBrowserNavigateBack(theBrowser))
guiSetText( addressBar, getBrowserURL( theBrowser ) )
end )

-- This part handles the GUI navigation buttons for the browser.
addEventHandler( "onClientGUIClick", resourceRoot, function ( )
if source == navigateBackBtn then
navigateBrowserBack(theBrowser)
elseif source == navigateForwardBtn then
navigateBrowserForward(theBrowser)
elseif source == reloadBtn then
reloadBrowserPage(theBrowser)
end
end )
</syntaxhighlight>
</section>

==See Also==
{{CEF_functions}}

CanBrowserNavigateBack

2016-12-18T00:14:45Z

Loki:

__NOTOC__
{{Client function}}
{{New feature/item|3.0153|1.5.3|9912|
This function checks if the browser can return to the previous page.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool canBrowserNavigateBack( browser webBrowser )
</syntaxhighlight>

===Required Arguments===
*'''webBrowser:''' The browser you want to check for a previous page.

===Returns===
Returns ''true'' if the browser can navigate back, ''false'' otherwise.

==Example==
<section name="Example" class="client" show="true">
This example creates a browser that can return to the last and previous pages and can also be refreshed:
<syntaxhighlight lang="lua">
window = guiCreateWindow(126, 122, 848, 674, "Firechrome", false)
guiWindowSetSizable(window, false)

navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
guiSetEnabled( addressBar, false )
reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
browser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)

-- Load our page on browser creation.
local theBrowser = guiGetBrowser(browser)
addEventHandler("onClientBrowserCreated", theBrowser,
function()
loadBrowserURL(source, "https://forum.mtasa.com/")
end
)

-- This checks to see if the browser can navigate in any direction and enables the back or forward buttons
addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( )
navigateForwardBtn.enabled = (canBrowserNavigateForward(theBrowser))
navigateBackBtn.enabled = (canBrowserNavigateBack(theBrowser))
guiSetText( addressBar, getBrowserURL( theBrowser ) )
end )

-- This part handles the GUI navigation buttons for the browser.
addEventHandler( "onClientGUIClick", resourceRoot, function ( )
if source == navigateBackBtn then
navigateBrowserBack(theBrowser)
elseif source == navigateForwardBtn then
navigateBrowserForward(theBrowser)
elseif source == reloadBtn then
reloadBrowserPage(theBrowser)
end
end )
</syntaxhighlight>
</section>

==See Also==
{{CEF_functions}}

ReloadBrowserPage

2016-12-18T00:11:42Z

Loki: Added page for ReloadBrowserPage

__NOTOC__
{{Client function}}
{{New feature/item|3.0153|1.5.3|9912|
This function reloads the current browser's page.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool reloadBrowserPage( browser webBrowser )
</syntaxhighlight>

===Required Arguments===
*'''webBrowser:''' The browser that you want to reload.

===Returns===
Returns ''true'' if the browser has reloaded, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example creates a browser that can return to the last and previous pages and can also be refreshed:
<syntaxhighlight lang="lua">
window = guiCreateWindow(126, 122, 848, 674, "Firechrome", false)
guiWindowSetSizable(window, false)

navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
guiSetEnabled( addressBar, false )
reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
browser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)

-- Load our page on browser creation.
local theBrowser = guiGetBrowser(browser)
addEventHandler("onClientBrowserCreated", theBrowser,
function()
loadBrowserURL(source, "https://forum.mtasa.com/")
end
)

-- This checks to see if the browser can navigate in any direction and enables the back or forward buttons
addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( )
navigateForwardBtn.enabled = (canBrowserNavigateForward(theBrowser))
navigateBackBtn.enabled = (canBrowserNavigateBack(theBrowser))
guiSetText( addressBar, getBrowserURL( theBrowser ) )
end )

-- This part handles the GUI navigation buttons for the browser.
addEventHandler( "onClientGUIClick", resourceRoot, function ( )
if source == navigateBackBtn then
navigateBrowserBack(theBrowser)
elseif source == navigateForwardBtn then
navigateBrowserForward(theBrowser)
elseif source == reloadBtn then
reloadBrowserPage(theBrowser)
end
end )
</syntaxhighlight>
</section>

==See Also==
{{CEF_functions}}

NavigateBrowserForward

2016-12-18T00:08:52Z

Loki: Added page for NavigateBrowserForward

__NOTOC__
{{Client function}}
{{New feature/item|3.0153|1.5.3|9912|
This function takes the browser to the next page.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool navigateBrowserForward( browser webBrowser )
</syntaxhighlight>

===Required Arguments===
*'''webBrowser:''' The browser that you want to take to the next page.

===Returns===
Returns ''true'' if the browser has gone to the next page, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example creates a browser that can return to the last and previous pages and can also be refreshed:
<syntaxhighlight lang="lua">
window = guiCreateWindow(126, 122, 848, 674, "Firechrome", false)
guiWindowSetSizable(window, false)

navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
guiSetEnabled( addressBar, false )
reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
browser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)

-- Load our page on browser creation.
local theBrowser = guiGetBrowser(browser)
addEventHandler("onClientBrowserCreated", theBrowser,
function()
loadBrowserURL(source, "https://forum.mtasa.com/")
end
)

-- This checks to see if the browser can navigate in any direction and enables the back or forward buttons
addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( )
navigateForwardBtn.enabled = (canBrowserNavigateForward(theBrowser))
navigateBackBtn.enabled = (canBrowserNavigateBack(theBrowser))
guiSetText( addressBar, getBrowserURL( theBrowser ) )
end )

-- This part handles the GUI navigation buttons for the browser.
addEventHandler( "onClientGUIClick", resourceRoot, function ( )
if source == navigateBackBtn then
navigateBrowserBack(theBrowser)
elseif source == navigateForwardBtn then
navigateBrowserForward(theBrowser)
elseif source == reloadBtn then
reloadBrowserPage(theBrowser)
end
end )
</syntaxhighlight>
</section>

==See Also==
{{CEF_functions}}

NavigateBrowserBack

2016-12-18T00:03:59Z

Loki: Added page for NavigateBrowserBack

__NOTOC__
{{Client function}}
{{New feature/item|3.0153|1.5.3|9912|
Returns the browser to the previous page.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool navigateBrowserBack( browser webBrowser )
</syntaxhighlight>

===Required Arguments===
*'''webBrowser:''' The browser that you want return to the previous page.

===Returns===
Returns ''true'' if the browser has returned to the previous page, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example creates a browser that can return to the last and previous pages and can also be refreshed:
<syntaxhighlight lang="lua">
window = guiCreateWindow(126, 122, 848, 674, "Firechrome", false)
guiWindowSetSizable(window, false)

navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
guiSetEnabled( addressBar, false )
reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
browser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)

-- Load our page on browser creation.
local theBrowser = guiGetBrowser(browser)
addEventHandler("onClientBrowserCreated", theBrowser,
function()
loadBrowserURL(source, "https://forum.mtasa.com/")
end
)

-- This checks to see if the browser can navigate in any direction and enables the back or forward buttons
addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( )
navigateForwardBtn.enabled = (canBrowserNavigateForward(theBrowser))
navigateBackBtn.enabled = (canBrowserNavigateBack(theBrowser))
guiSetText( addressBar, getBrowserURL( theBrowser ) )
end )

-- This part handles the GUI navigation buttons for the browser.
addEventHandler( "onClientGUIClick", resourceRoot, function ( )
if source == navigateBackBtn then
navigateBrowserBack(theBrowser)
elseif source == navigateForwardBtn then
navigateBrowserForward(theBrowser)
elseif source == reloadBtn then
reloadBrowserPage(theBrowser)
end
end )
</syntaxhighlight>
</section>

==See Also==
{{CEF_functions}}

CanBrowserNavigateForward

2016-12-17T23:58:48Z

Loki: Added page for CanBrowserNavigateFroward

__NOTOC__
{{Client function}}
{{New feature/item|3.0153|1.5.3|9912|
Checks if the browser can go to the next page.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool canBrowserNavigateForward( browser webBrowser )
</syntaxhighlight>

===Required Arguments===
*'''webBrowser:''' The browser you want navigate forward.

===Returns===
Returns ''true'' if the browser can navigate forward, ''false'' otherwise.

==Example==
<section name="Client" class="client" show="true">
This example creates a browser that can return to the last and previous pages and can also be refreshed:
<syntaxhighlight lang="lua">
window = guiCreateWindow(126, 122, 848, 674, "Firechrome", false)
guiWindowSetSizable(window, false)

navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
guiSetEnabled( addressBar, false )
reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
browser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)

-- Load our page on browser creation.
local theBrowser = guiGetBrowser(browser)
addEventHandler("onClientBrowserCreated", theBrowser,
function()
loadBrowserURL(source, "https://forum.mtasa.com/")
end
)

-- This checks to see if the browser can navigate in any direction and enables the back or forward buttons
addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( )
navigateForwardBtn.enabled = (canBrowserNavigateForward(theBrowser))
navigateBackBtn.enabled = (canBrowserNavigateBack(theBrowser))
guiSetText( addressBar, getBrowserURL( theBrowser ) )
end )

-- This part handles the GUI navigation buttons for the browser.
addEventHandler( "onClientGUIClick", resourceRoot, function ( )
if source == navigateBackBtn then
navigateBrowserBack(theBrowser)
elseif source == navigateForwardBtn then
navigateBrowserForward(theBrowser)
elseif source == reloadBtn then
reloadBrowserPage(theBrowser)
end
end )
</syntaxhighlight>
</section>

==See Also==
{{CEF_functions}}

CanBrowserNavigateBack

2016-12-17T23:55:28Z

Loki: Added page for CanBrowserNavigateBack

__NOTOC__
{{Client function}}
{{New feature/item|3.0153|1.5.3|9912|
Checks if the browser can return to the previous page.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool canBrowserNavigateBack( browser webBrowser )
</syntaxhighlight>

===Required Arguments===
*'''webBrowser:''' The browser you want navigate back.

===Returns===
Returns ''true'' if the browser can navigate back, ''false'' otherwise.

==Example==
<section name="Example" class="client" show="true">
This example creates a browser that can return to the last and previous pages and can also be refreshed:
<syntaxhighlight lang="lua">
window = guiCreateWindow(126, 122, 848, 674, "Firechrome", false)
guiWindowSetSizable(window, false)

navigateBackBtn = guiCreateButton(10, 19, 39, 36, "<", false, window)
navigateForwardBtn = guiCreateButton(98, 19, 39, 36, ">", false, window)
addressBar = guiCreateEdit(137, 19, 701, 36, "", false, window)
guiSetEnabled( addressBar, false )
reloadBtn = guiCreateButton(49, 19, 49, 36, "reload", false, window)
browser = guiCreateBrowser(10, 55, 828, 609, false, false, false, window)

-- Load our page on browser creation.
local theBrowser = guiGetBrowser(browser)
addEventHandler("onClientBrowserCreated", theBrowser,
function()
loadBrowserURL(source, "https://forum.mtasa.com/")
end
)

-- This checks to see if the browser can navigate in any direction and enables the back or forward buttons
addEventHandler( "onClientBrowserDocumentReady", theBrowser, function( )
navigateForwardBtn.enabled = (canBrowserNavigateForward(theBrowser))
navigateBackBtn.enabled = (canBrowserNavigateBack(theBrowser))
guiSetText( addressBar, getBrowserURL( theBrowser ) )
end )

-- This part handles the GUI navigation buttons for the browser.
addEventHandler( "onClientGUIClick", resourceRoot, function ( )
if source == navigateBackBtn then
navigateBrowserBack(theBrowser)
elseif source == navigateForwardBtn then
navigateBrowserForward(theBrowser)
elseif source == reloadBtn then
reloadBrowserPage(theBrowser)
end
end )
</syntaxhighlight>
</section>

==See Also==
{{CEF_functions}}

Template:CEF functions

2016-12-17T23:48:09Z

Loki: Added canBrowserNavigateBack, canBrowserNavigateForward, navigateBrowserBack, navigateBrowserForward, reloadBrowserPage to CEF_functions

{{New items|3.0150|1.5|
*[[createBrowser]]
*[[executeBrowserJavascript]]
*[[focusBrowser]]
{{New items|3.0153|1.5.3-9912|
*[[resizeBrowser]]
}}
*[[isBrowserDomainBlocked]]
*[[isBrowserFocused]]
*[[isBrowserLoading]]
*[[getBrowserProperty]]
*[[getBrowserSettings]]
*[[getBrowserTitle]]
*[[getBrowserURL]]
*[[injectBrowserMouseDown]]
*[[injectBrowserMouseMove]]
*[[injectBrowserMouseUp]]
*[[injectBrowserMouseWheel]]
{{New items|3.0153|1.5.3|
*[[isBrowserSupported]]
|}}
*[[loadBrowserURL]]
*[[canBrowserNavigateBack]]
*[[canBrowserNavigateForward]]
*[[navigateBrowserBack]]
*[[navigateBrowserForward]]
*[[reloadBrowserPage]]
*[[setBrowserProperty]]
*[[setBrowserRenderingPaused]]
*[[setBrowserVolume]]
*[[requestBrowserDomains]]
|}}
{{New items|3.0151|1.5.1|
*[[setBrowserAjaxHandler]]
*[[getBrowserSource]]
*[[toggleBrowserDevTools]]
|}}
===GUI Functions=== 
*[[guiCreateBrowser]]
*[[guiGetBrowser]]
<noinclude>[[Category:Functions templates]]</noinclude>

Inspect

2016-12-17T19:52:05Z

Loki: added image to example

{{Server client function}}
__NOTOC__
{{New items|3.0153|1.5.3|
This function returns human-readable representations of tables and MTA datatypes as a string.
}}

==Syntax==
<syntaxhighlight lang="lua">
string inspect ( mixed var )
</syntaxhighlight>

===Required Arguments===
*'''var:''' A variable of any datatype.

===Returns===
Always returns a string.

==Example==
<section name="Client" class="client" show="true">
This example draws the contents of a table and its data type:
<syntaxhighlight lang="lua">
local Table = {
["matrix"] = {position = {getElementPosition(localPlayer)},rotation = {getElementRotation( localPlayer )}},
["localplayer"] = getPlayerName(localPlayer),
}

addEventHandler("onClientRender",root,
function( )
dxDrawText(inspect(Table),10,250)
end
)
</syntaxhighlight>
This is an example of what it should look like:
[[File:InspectReturn.png|frame|none]]
</section>

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

File:InspectReturn.png

2016-12-17T19:40:10Z

Loki:

Inspect

2016-12-15T18:41:59Z

Loki: /* Example */

{{Server client function}}
__NOTOC__
{{New items|3.0153|1.5.3|
This function returns human-readable representations of tables and MTA datatypes as a string.
}}

==Syntax==
<syntaxhighlight lang="lua">
string inspect ( mixed var )
</syntaxhighlight>

===Required Arguments===
*'''var:''' A variable of any datatype.

===Returns===
Always returns a string.

==Example==
<section name="Client" class="client" show="true">
This example draws the contents of a table and its data type:
<syntaxhighlight lang="lua">
local Table = {
["matrix"] = {position = {getElementPosition(localPlayer)},rotation = {getElementRotation( localPlayer )}},
["localplayer"] = getPlayerName(localPlayer),
}

addEventHandler("onClientRender",root,
function( )
dxDrawText(inspect(Table),10,250)
end
)
</syntaxhighlight>
An example of what it should draw:
<pre>
{
localplayer = "Loki",
matrix= {
position = { 2496.3908691406, -1669.853515625, 13.335947036743 },
rotation = { -0, 0, 155.4147644043 }
}
}
</pre>
</section>

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

Inspect

2016-12-15T18:38:49Z

Loki: created page for Inspect

{{Server client function}}
__NOTOC__
{{New items|3.0153|1.5.3|
This function returns human-readable representations of tables and MTA datatypes as a string.
}}

==Syntax==
<syntaxhighlight lang="lua">
string inspect ( mixed var )
</syntaxhighlight>

===Required Arguments===
*'''var:''' A variable of any datatype.

===Returns===
Always returns a string.

==Example==
<section name="Client" class="client" show="true">
This example draws the contents of a table and its data type:
<syntaxhighlight lang="lua">
local Table = {
["position"] = {position = {getElementPosition(localPlayer)},rotation = {getElementRotation( localPlayer )}},
["localplayer"] = getPlayerName(localPlayer),
}

addEventHandler("onClientRender",root,
function( )
dxDrawText(inspect(Table),10,250)
end
)
</syntaxhighlight>
An example of what it should draw:
<pre>
{
localplayer = "Loki",
position = {
position = { 2496.3908691406, -1669.853515625, 13.335947036743 },
rotation = { -0, 0, 155.4147644043 }
}
}
</pre>
</section>
==See Also==
{{Utility functions}}