Multi Theft Auto: Wiki - User contributions [en]

SetAccountName

2018-09-04T19:45:37Z

Miki785:

{{Server function}}
__NOTOC__
{{New feature/item|3.0160|1.5.5|11747|
This function sets the name of an [[account]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setAccountName ( account theAccount, string name [, bool allowCaseVariations = false] )
</syntaxhighlight>
{{OOP||[[account]]:setName||getAccountName}}
===Required Arguments===
*'''theAccount:''' The account you wish to change the name.
*'''name:''' The new name.

===Optional Arguments===
*'''allowCaseVariations:''' Whether the username is case sensitive (if this is set to true, usernames "Bob" and "bob" will refer to different accounts)

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

==Example==
Change the name of an account.
<syntaxhighlight lang="lua">
addCommandHandler("changeaccountname", function(player, _, oldname, newname)
if not oldname or not newname then
return
end
local account = getAccount(oldname)
if not account then
return
end
setAccountName(account, newname)
end)
</syntaxhighlight>

==See Also==
{{Account_functions}}

GetAccountIP

2018-09-04T19:42:14Z

Miki785:

{{Server function}}
__NOTOC__
{{New feature/item|3.0160|1.5.5|11747|
This function retrieves the IP address of an [[account]].
}}

==Syntax==
<syntaxhighlight lang="lua">
string getAccountIP ( account theAccount )
</syntaxhighlight>
{{OOP||[[account]]:getIP|ip|}}
===Required Arguments===
*'''theAccount:''' The [[account]] you wish to get the IP of.

===Returns===
Returns a string containing the account's IP, ''false'' if the account does not exist or an invalid argument was passed to the function.

==Example==
This example announces into the debugscript when a player logs into his account.
<syntaxhighlight lang="lua">
function outputOnLogin ( previous_account, current_account, auto_login ) --when a player logs in
outputDebugString(getPlayerName(source) .. " logged into his account with IP " .. getAccountIP(current_account)) -- announce it into the debugscript
end
addEventHandler("onPlayerLogin", getRootElement(), outputOnLogin) --add an event handler
</syntaxhighlight>

==See Also==
{{Account_functions}}

SetBrowserProperty

2017-07-15T22:44:41Z

Miki785: Added example

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

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

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

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

==Example==
This example will add a command handler for 'mobile' that will toggle mobile browsing for all browsers.
<syntaxhighlight lang="lua">
addCommandHandler("mobile",
function ()
for i, browser in pairs(getElementsByType("webbrowser")) do
setBrowserProperty(browser, "mobile", getBrowserProperty(browser, "mobile") == "1" and "0" or "1")
end
end)
</syntaxhighlight>

==See also==
{{CEF_functions}}

ExecuteBrowserJavascript

2017-07-15T22:34:12Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function executes a Javascript string to the specified [[Element/Browser|browser]]. Works only with local browsers.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool executeBrowserJavascript ( browser webBrowser, string jsCode )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:executeJavascript}}

===Required Arguments===
*'''webBrowser:''' The web browser which will execute the Javascript code
*'''jsCode:''' The Javascript code string

===Returns===
Returns ''true'' if executing Javascript is allowed in the current context, ''false'' otherwise.

==Example==
This example shows how to display the name (nick) of the local player on the webpage.
<syntaxhighlight lang="lua">
local browser = guiGetBrowser(guiCreateBrowser(200, 200, 400, 200, true, false, false))

addEventHandler("onClientBrowserCreated", browser,
function ()
loadBrowserURL(source, "http://mta/local/example.html") --Containing <span id="nick"></span> somewhere in the file
end)

--The page has to load first
addEventHandler("onClientBrowserDocumentReady", browser,
function ()
executeBrowserJavascript(source, "document.getElementById('nick').innerHTML = '" .. getPlayerName(localPlayer) .. "'");
end)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

ExecuteBrowserJavascript

2017-07-15T22:33:51Z

Miki785: Added example

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function executes a Javascript string to the specified [[Element/Browser|browser]]. Works only with local browsers.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool executeBrowserJavascript ( browser webBrowser, string jsCode )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:executeJavascript}}

===Required Arguments===
*'''webBrowser:''' The web browser which will execute the Javascript code
*'''jsCode:''' The Javascript code string

===Returns===
Returns ''true'' if executing Javascript is allowed in the current context, ''false'' otherwise.

==Example==
This example shows how to display the name (nick) of the local player on the webpage.
<syntaxhighlight lang="lua">
local browser = guiCreateBrowser(200, 200, 400, 200, true, false, false)

addEventHandler("onClientBrowserCreated", browser,
function ()
loadBrowserURL(source, "http://mta/local/example.html") --Containing <span id="nick"></span> somewhere in the file
end)

--The page has to load first
addEventHandler("onClientBrowserDocumentReady", browser,
function ()
executeBrowserJavascript(source, "document.getElementById('nick').innerHTML = '" .. getPlayerName(localPlayer) .. "'");
end)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

Template:Resource functions

2017-07-15T22:04:07Z

Miki785: Sorted alphabetically

*[[addResourceConfig]]
*[[addResourceMap]]
*[[call]]
*[[callRemote]]
*[[copyResource]]
*[[createResource]]
*[[deleteResource]]
*[[fetchRemote]]
*[[getResourceACLRequests]]
*[[getResourceConfig]]
*[[getResourceDynamicElementRoot]]
*[[getResourceExportedFunctions]]
*[[getResourceFromName]]
*[[getResourceInfo]]
*[[getResourceLastStartTime]]
*[[getResourceLoadFailureReason]]
*[[getResourceLoadTime]]
*[[getResourceMapRootElement]]
*[[getResourceName]]
*[[getResourceOrganizationalPath]]
*[[getResourceRootElement]]
*[[getResourceState]]
*[[getResources]]
*[[getThisResource]]
{{New items|3.0155|1.5.5|
*[[isResourceArchived]]
|11533}}
*[[refreshResources]]
*[[removeResourceFile]]
*[[renameResource]]
*[[restartResource]]
*[[setResourceInfo]]
*[[startResource]]
*[[stopResource]]
*[[updateResourceACLRequest]]
<noinclude>[[Category:Functions templates]]</noinclude>

GetResourceOrganizationalPath

2017-06-28T05:32:00Z

Miki785: Added example

{{Server function}}
__NOTOC__
This function returns the organizational file path (e.g. ''[admin]'') of a resource.

==Syntax==
<syntaxhighlight lang="lua">
string getResourceOrganizationalPath ( resource theResource )
</syntaxhighlight>
{{OOP||[[resource]]:getOrganizationalPath }}

===Required Arguments===
*'''theResource:''' the [[resource]] of which you want to know the organizational path

===Returns===
Returns the organizational path of the [[resource]].

==Example==
This example outputs the path of the current resource when it is started.
<syntaxhighlight lang="lua">
addEventHandler("onResourceStart", resourceRoot,
function ()
outputChatBox(getResourceName(resource) .. "'s path: " .. getResourceOrganizationalPath(resource))
end)
</syntaxhighlight>

==See Also==
{{Resource_functions}}

GetPlayerName

2017-06-28T05:22:48Z

Miki785:

__NOTOC__
{{Server client function}}
This function returns a string containing the name of the specified player.

==Syntax==
<syntaxhighlight lang="lua">
string getPlayerName ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getName|name|setPlayerName}}
===Required Arguments===
* '''thePlayer:''' the [[player]] you want to get the name of

===Returns===
Returns a string containing the requested player's name, or ''false'' if the player passed to the function is invalid.

===Limits===
* Player name can consist of ASCII characters between 33 and 126 are allowed (basic latin):
<nowiki>!"#$%&'()*+,-./0123456789:;<=>?@ABCDEFGHIJKLMNOPQRSTUVWXYZ[\]^_`abcdefghijklmnopqrstuvwxyz{|}~</nowiki>
* Minimal player name length is 1 character.
* Maximum player name length is 22 characters.
* Player names are case-insensitive. It is not possible to have two clients with same name but different character case.

==Example==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addCommandHandler("myname",
function(playerSource)
outputChatBox("Your name: "..getPlayerName(playerSource), playerSource)
end
)
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
This example outputs the local player name to the chatbox.
<syntaxhighlight lang="lua">
addCommandHandler("myname",
function()
local localPlayerName = getPlayerName(getLocalPlayer())
--and we output it to the chatbox
outputChatBox(localPlayerName)
end
)
</syntaxhighlight>
</section>

==See Also==
{{Client player functions}}
[[es:getPlayerName]]

GetResourceOrganizationalPath

2017-06-25T05:20:12Z

Miki785:

{{Server function}}
{{Needs_Example}}
__NOTOC__
This function returns the organizational file path (e.g. ''[admin]'') of a resource.

==Syntax==
<syntaxhighlight lang="lua">
string getResourceOrganizationalPath ( resource theResource )
</syntaxhighlight>
{{OOP||[[resource]]:getOrganizationalPath }}

===Required Arguments===
*'''theResource:''' the [[resource]] of which you want to know the organizational path

===Returns===
Returns the organizational path of the [[resource]].

==Example==

==See Also==
{{Resource_functions}}

GuiGetCursorType

2017-05-18T22:18:36Z

Miki785:

{{Client function}}
__NOTOC__
{{New feature/item|3.0155|1.5.5|11350|
This function is used to get the type of the current cursor image.
}}

==Syntax==
<syntaxhighlight lang="lua">
string guiGetCursorType ( )
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]]:getCursorType|cursorType|}}

===Returns===
Returns a string containing the cursor type:
* '''"none"''' // cursor has no image
* '''"arrow"''' // default cursor
* '''"sizing_ns"''' // N-S (up-down) sizing cursor
* '''"sizing_ew"''' // E-W (left-right) sizing cursor
* '''"sizing_nwse"''' // NW-SE diagonal sizing cursor
* '''"sizing_nesw"''' // NE-SW diagonal sizing cursor
* '''"sizing_eswe"''' // ES-WE horizontal sizing cursor
* '''"move"''' // move cursor
* '''"container_drag"''' // drag container cursor (note: not in use)
* '''"segment_moving"''' // segment moving cursor (note: not in use)
* '''"segment_sizing"''' // segment sizing cursor (note: not in use)

==Example==
This example prints the current cursor type in the console.
<syntaxhighlight lang="lua">
outputConsole( guiGetCursorType( ) )
</syntaxhighlight>

==See Also==
{{GUI_functions}}

Base64Decode

2016-03-10T01:46:19Z

Miki785:

__NOTOC__
{{Server client function}}
This function returns the decrypted data from [https://en.wikipedia.org/wiki/Base64 base64] representation of the encrypted block

==Syntax==
<syntaxhighlight lang="lua">
string base64Decode(string data)
</syntaxhighlight>

===Required arguments===
*'''data:''' The block of data you want to decrypt

===Returns===
Returns the decrypted data from [https://en.wikipedia.org/wiki/Base64 base64] representation of the encrypted block if the decryption process was successfully completed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
local k = base64Decode("SGVsbG8sIHdvcmxkIQ==")
outputConsole(k)
--Output: Hello, world!
</syntaxhighlight>

==See Also==
{{Utility_functions}}

Base64Encode

2016-03-10T01:46:09Z

Miki785:

__NOTOC__
{{Server client function}}
This function returns the [https://en.wikipedia.org/wiki/Base64 base64] representation of the encrypted block of data

==Syntax==
<syntaxhighlight lang="lua">
string base64Encode ( string data )
</syntaxhighlight>

===Required arguments===
*'''data:''' The block of data you want to encrypt

===Returns===
Returns the [https://en.wikipedia.org/wiki/Base64 base64] representation of the encrypted data if the encryption process was successfully completed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
local k = base64Encode("Hello, world!")
outputConsole(k)
--Output: SGVsbG8sIHdvcmxkIQ==
</syntaxhighlight>

==See Also==
{{Utility_functions}}

IsVoiceEnabled

2016-02-27T17:32:53Z

Miki785:

__NOTOC__
{{Server client function}}
{{New feature/item|3.0140|1.4|4639|
Added to client side.
}}
This function allows you to make the server reveal whether or not voice is currently enabled.

==Syntax==
<syntaxhighlight lang="lua">
bool isVoiceEnabled ( )
</syntaxhighlight>
{{OOP||[[Player]].isVoiceEnabled}}
===Returns===
Returns ''true'' if the voice is enabled on the server, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example shows how to forbid use voice for muted (in chat) players
<syntaxhighlight lang="lua">
-- only if voice enabled
if isVoiceEnabled() then
-- adding handler for voice start event
addEventHandler( 'onPlayerVoiceStart', root,
function()
-- if player is muted in chat
-- do not broadcast his voice to other players
if isPlayerMuted(source) then cancelEvent() end
end
)
end
</syntaxhighlight>
</section>

==See Also==
{{Player_functions}}

GetSearchLightEndRadius

2016-02-22T13:23:04Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs_Example}}

{{New feature/item|3.0160|1.6|7683|This function gets the end radius of a [[Element/Searchlight|searchlight]] element.}}

==Syntax==
<syntaxhighlight lang="lua">
searchlight getSearchLightEndRadius ( searchlight theSearchLight )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:getEndRadius|endRadius|setSearchLightEndRadius}}

===Required Arguments===
*'''theSearchLight''': the searchlight to get the radius of the searchlight's light cone in its end.

===Returns===
If the specified searchlight element is valid, this function will return one ''float'', which is the searchlight's end radius. If not, it will return ''false'' plus an error message.

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

==See also==
{{Client_searchlight_functions}}

GetSearchLightStartRadius

2016-02-22T13:22:57Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs_Example}}

{{New feature/item|3.0160|1.6|7683|This function gets the start radius of a [[Element/Searchlight|searchlight]] element.}}

==Syntax==
<syntaxhighlight lang="lua">
searchlight getSearchLightStartRadius ( searchlight theSearchLight )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:getStartRadius|startRadius|setSearchLightStartRadius}}

===Required Arguments===
*'''theSearchLight''': the searchlight to get the radius of the searchlight's light cone in its beginning.

===Returns===
If the specified searchlight element is valid, this function will return one ''float'', which is the searchlight's start radius. If not, it will return ''false'' plus an error message.

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

==See also==
{{Client_searchlight_functions}}

GetSearchLightEndPosition

2016-02-22T13:22:48Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs_Example}}

{{New feature/item|3.0160|1.6|7683|This function gets the end position of a [[Element/Searchlight|searchlight]] element.}}

==Syntax==
<syntaxhighlight lang="lua">
searchlight getSearchLightEndPosition ( searchlight theSearchLight )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:getEndPosition|endPosition|setSearchLightEndPosition}}

===Required Arguments===
*'''theSearchLight''': the searchlight to get the position where the searchlight's light cone ends.

===Returns===
If the specified searchlight element is valid, this function will return three ''float'', which are the three coordinates of searchlight's end position. If not, it will return ''false'' plus an error message.

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

==See also==
{{Client_searchlight_functions}}

GetSearchLightStartPosition

2016-02-22T13:22:37Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs_Example}}

{{New feature/item|3.0160|1.6|7683|This function gets the start position of a [[Element/Searchlight|searchlight]] element.}}

==Syntax==
<syntaxhighlight lang="lua">
searchlight getSearchLightStartPosition ( searchlight theSearchLight )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:getStartPosition|startPosition|setSearchLightStartPosition}}

===Required Arguments===
*'''theSearchLight''': the searchlight to get the position where the searchlight's light cone starts.

===Returns===
If the specified searchlight element is valid, this function will return three ''float'', which are the three coordinates of searchlight's start position. If not, it will return ''false'' plus an error message.

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

==See also==
{{Client_searchlight_functions}}

SetSearchLightEndRadius

2016-02-22T13:22:27Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs_Example}}

{{New feature/item|3.0160|1.6|7683|This function sets the end radius of a [[Element/Searchlight|searchlight]] element.}}

==Syntax==
<syntaxhighlight lang="lua">
searchlight setSearchLightEndRadius ( searchlight theSearchlight, float endRadius )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:setEndRadius|endRadius|getSearchLightEndRadius}}

===Required Arguments===
*'''theSearchLight''': the searchlight to modify the property of.
*'''endRadius''': the radius of the searchlight's light cone in its end.

===Returns===
If every argument is correct, this function returns ''true''. If not, it will return ''false'' plus an error message.

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

==See also==
{{Client_searchlight_functions}}

SetSearchLightStartRadius

2016-02-22T13:22:14Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs_Example}}

{{New feature/item|3.0160|1.6|7683|This function sets the start radius of a [[Element/Searchlight|searchlight]] element.}}

==Syntax==
<syntaxhighlight lang="lua">
searchlight setSearchLightStartRadius ( searchlight theSearchlight, float startRadius )
</syntaxhighlight>
{{OOP||[[Element/Searchlight|searchLight]]:setStartRadius|startRadius|getSearchLightStartRadius}}

===Required Arguments===
*'''theSearchLight''': the searchlight to modify the property of.
*'''startRadius''': the radius of the searchlight's light cone in its beginning.

===Returns===
If every argument is correct, this function returns ''true''. If not, it will return ''false'' plus an error message.

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

==See also==
{{Client_searchlight_functions}}

Undocumented Items

2016-02-22T13:19:24Z

Miki785:

This page lists all MTA SA functions and events which don't have the necessary documentation for scripters to allow them to use the functions or events. Documenting these will require looking through the source code, which is available in the [https://github.com/multitheftauto/mtasa-blue MTA SA GitHub repository], to get the necessary parameters.
__NOTOC__
== Client functions that need documenting ==
(None)

== Server functions that need documenting ==
(None)

== Client Events that need documenting ==
*[[onClientBrowserLoadingStart]]
*[[onClientBrowserTooltip]]
*[[onClientPlayerVoiceResumed]]

== Server Events that need documenting ==
(None)

== Other undocumented pages ==
(None)

GetBans

2015-11-24T13:31:58Z

Miki785:

__NOTOC__
{{Server function}}
This function will return a table containing all the [[ban]]s present in the server's banlist.xml.

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

===Returns===
Returns a [[table]] containing all the [[ban]]s.

==Example==
<section name="Example 1: Server" class="server" show="true">
This example lists every ban when somebody types "/bans". WARNING: This will spam chat (for the player that executed the command) if the server has a lot of bans.
<syntaxhighlight lang="lua">
function listBans ( playerSource )
local banList = getBans() -- Return a table of all the bans.
--
for banID, ban in ipairs ( banList ) do -- For every ban do the following...
--
local nick = getBanNick ( ban ) -- Get the IP of the ban
--
if nick then
outputChatBox ( "Ban #" .. banID .. ": " .. nick, playerSource , 255, 0, 0, true ) -- Output the ban.
end
--
end
--
end
addCommandHandler ( "bans", listBans ) -- Add "/bans" as the trigger for the function.
</syntaxhighlight>
</section>
==See Also==
{{Admin functions}}
[[ru:getBans]]

IsBan

2015-11-24T13:28:43Z

Miki785:

__NOTOC__
{{Server function}}
{{New items|3.014|1.4|
This function checks whether the passed value is valid [[ban]] or not.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool isBan ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The value to check

===Returns===
Returns ''true'' if the value is a ban, ''false'' otherwise.

==Example==
<section name="Example1" class="server" show="true">
This example chechks if the passed argument is a ban or not.
<syntaxhighlight lang="lua">
function banRecieve ( ban )
if ban and isBan(ban) == true then
outputChatBox("this is a ban!")--Valid ban is recieved!
else
outputChatBox("this is not a ban, this is a "..getElementType(ban))--if the argument is not a ban, then checks its type and output it into the chat box.
end
end

function onBan ( ban ) -- This function will be triggered every time a player is banned.
banRecieve(ban)
end
addEventHandler ( "onPlayerBan", getRootElement(), onBan )

function sendWrongBanArguement()
vehicle = createVehicle(411,0,5,3)
object = createObject(2600,0,0,0)
ped = createPed(61,0,0,3)
banRecieve(vehicle)--sends a vehicle as an argument.
banRecieve(object)--sends an object as an argument.
banRecieve(ped)--sends a ped as an argument.
end
addCommandHandler("sendWrongArgument",sendWrongBanArguement)
</syntaxhighlight>
</section>

==See Also==
{{Admin_functions}}
[[ru:isBan]]

IsBan

2015-11-24T13:28:29Z

Miki785:

GetBanTime

2015-11-24T13:25:50Z

Miki785:

__NOTOC__
{{Server function}}
This function will return the time the specified [[ban]] was created, in '''seconds'''.

==Syntax==
<syntaxhighlight lang="lua">
int getBanTime ( ban theBan )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] of which you wish to retrieve the time of.

===Returns===
* Returns an integer of the banning time in the format of seconds from the year 1970. Use in conjunction with [[getRealTime]] in order to retrieve detailed information.
* Returns '''false''' if invalid arguments were specified or if there was no banning time specified for the [[ban]].

==Example==
<syntaxhighlight lang="lua">
function retrieveBan(theBan)
local ban = getBanTime(theBan)
if ban then
outputChatBox("The time of the ban is: " .. ban, root, 255, 255, 255, false)
end
end
</syntaxhighlight>

==See Also==
{{Admin functions}}
[[ru:getBanTime]]

SetUnbanTime

2015-11-24T13:24:09Z

Miki785:

__NOTOC__
{{Server function}}
{{Needs_Example}}
{{New items|3.014|1.4|
This function sets a new unban time of a given [[ban]] using unix timestamp (seconds since Jan 01 1970).
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setUnbanTime( ban theBan, int theTime )
</syntaxhighlight>

===Required Arguments===
*'''theBan:''' The [[ban]] of which to change the unban time of
*'''theTime:''' the new unban time

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

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

==See Also==
{{Admin_functions}}
[[ru:setUnbanTime]]

GetPlayerNametagColor

2015-11-13T00:59:20Z

Miki785:

__NOTOC__
{{Server client function}}

This function gets the current color of a player's name tag as RGB values. These are in the range 0-255.

==Syntax==
<syntaxhighlight lang="lua">
int, int, int getPlayerNametagColor ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getNametagColor||setPlayerNametagColor}}
===Required Arguments===
*'''thePlayer:''' The player whose name tag RGB color values you wish to retrieve.

===Returns===
Returns ''red'', ''green'' and ''blue'' values if an existent player was specified, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This console command will tell the player what his tag color is. The color is composed of a red, a green and a blue component, each ranging from 0-255.
<syntaxhighlight lang="lua">
function tagInfoCommand ( thePlayer, commandName )
-- store the RGB data about the player who activated the command handler into the local variables r, g, b.
local r, g, b = getPlayerNametagColor ( thePlayer )
-- Display the RGB values in the chatbox
outputChatBox ( "Your tag color is: R:" .. r .. " G:" .. g .. " B:" .. b, thePlayer )
end
addCommandHandler ( "retrievetagcolor", tagInfoCommand )
</syntaxhighlight>
</section>

==See Also==

{{Player_functions}}

GetFPSLimit

2015-11-13T00:55:54Z

Miki785: Lua converts numbers automatically

{{Server client function}}
__NOTOC__
This function retrieves the maximum [http://en.wikipedia.org/wiki/Frame_rate FPS (Frames per second)] that players on the server can run their game at.

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

===Returns===
Returns an integer between '''25''' and '''100''' of the maximum FPS that players can run their game at.

==Example==
This example displays a message in the chatbox showing the current fps limit.
<syntaxhighlight lang="lua">
function fpsLim()
outputChatBox ( "The FPS limit is: " .. getFPSLimit () )
end

-- Add console command "fpslimit" which calls the function fpsLim
addCommandHandler ( "fpslimit", fpsLim )
</syntaxhighlight>

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

LoadBrowserURL

2015-11-07T14:19:16Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function loads the specified URL.
}}

==Syntax==
<syntaxhighlight lang="lua">bool loadBrowserURL ( browser webBrowser, string url [, string postData = "", bool urlEncoded = true ] )</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:loadURL||loadBrowserURL}}

===Required arguments===
*'''webBrowser:''' The [[Element/Browser|browser]] element which will load the URL
*'''url:''' The url you want to load. It can either contain a remote website ("http://" prefix) or a website stored within a local resource ("http://mta/local/gui.html" for example).
*'''postData:''' The post data passed to the website. Its content type can be any type (e.g. JSON) if urlEncoded is set to ''false''
*'''urlEncoded:''' If set to ''true'', it will be available f.e. in PHP's $_POST variable (the content type is: ''application/x-www-form-urlencoded'')

{{Warning|The scheme for local files was changed recently. Please read [[Local_Scheme_Handler|Local Scheme Handler]] for details.|true}}

===Returns===
Returns ''true'' if the URL was successfully loaded.

==Example==
<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, false, 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 website.
loadBrowserURL(webBrowser, "https://www.youtube.com/")

-- Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>

==See also==
{{CEF_functions}}

SetVehicleColor

2015-09-19T23:28:13Z

Miki785:

__NOTOC__
{{Server client function}}
This function will set the color of a vehicle. Colors are in RGB format, vehicles can have up to 4 colors. Most vehicles have 2 colors only.

{{New feature|3.0110|1.1|
==Syntax==
<syntaxhighlight lang="lua">
bool setVehicleColor ( vehicle theVehicle, int r1, int g1, int b1, [int r2, int g2, int b2, int r3, int g3, int b3, int r4, int g4, int b4] )
</syntaxhighlight>

{{OOP||[[vehicle]]:setColor}}
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] that you wish to set the color of.
*'''r1, g1, b1:''' Three integers indicating the red, green and blue components of the first (main) color for the vehicle
===Optional Arguments===
*'''r2, g2, b2:''' Three integers indicating the red, green and blue components of the second color for the vehicle
*'''r3, g3, b3:''' Three integers indicating the red, green and blue components of the third color for the vehicle
*'''r4, g4, b4:''' Three integers indicating the red, green and blue components of the fourth color for the vehicle
}}
===Returns===
Returns ''true'' if vehicle's color was set, ''false'' if an invalid vehicle or invalid colors were specified.

==Example==
<section name="Example 1" class="server" show="true">
This example implements a serverside ''random_color'' console command.
<syntaxhighlight lang="lua">
addCommandHandler( 'random_color',
function( uPlayer )
if isPedInVehicle( uPlayer ) then
local uVehicle = getPedOccupiedVehicle( uPlayer )
if uVehicle then
local r, g, b = math.random( 255 ), math.random( 255 ), math.random( 255 )
setVehicleColor( uVehicle, r, g, b )
end
end
end
)
</syntaxhighlight>
</section>

==See Also==
{{Vehicle_functions}}

Changes in 1.5.8

2015-09-19T23:21:38Z

Miki785:

{{Changelogs}}

== Main Additions / Changes ==
* None yet

== Scripting ==

=== Scripting: New functions ===

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

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

==== Shared (''Client & Server side'') ====
*[[fileGetPath]]

=== Scripting: New Events ===

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

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

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

== Client ==

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

=== Client: Bugfixes & Changes ===
* Fixed team members not fully synced until re-set by setPlayerTeam or respawn.

== Server ==

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

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

== Resources ==
* None yet

== Editor ==
* None yet

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

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

SetBanAdmin

2015-09-15T20:59:54Z

Miki785:

__NOTOC__
{{Server function}}
{{New items|3.014|1.4|
This function sets a new admin for a [[ban]].
}}

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

===Required Arguments===
*'''theBan:''' The [[ban]] you want to change the admin of.
*'''theAdmin:''' The new admin.

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

==Example==
This example changes the ban admin to the admin's IP (If it's a player), when someone gets banned.
<syntaxhighlight lang="lua">
function banHappened(theBan)
if getElementType(source) == "player" then
local adminIP = getPlayerIP(source)
setBanAdmin(theBan,adminIP)
end
end

addEventHandler( "onBan", getRootElement(), banHappened )
</syntaxhighlight>

==See Also==
{{Admin_functions}}
[[ru:setBanAdmin]]

SetBanAdmin

2015-09-15T20:58:42Z

Miki785:

Changes in 1.5.8

2015-09-15T20:44:02Z

Miki785:

{{Changelogs}}

== Main Additions / Changes ==
* None yet

== Scripting ==

=== Scripting: New functions ===

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

==== Server ====
*[[fileGetPath]]

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

=== Scripting: New Events ===

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

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

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

== Client ==

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

=== Client: Bugfixes & Changes ===
* Fixed team members not fully synced until re-set by setPlayerTeam or respawn.

== Server ==

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

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

== Resources ==
* None yet

== Editor ==
* None yet

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

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

GetBrowserSource

2015-09-15T20:19:14Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0151|1.5.1|7392|
This function can be used to retrieve the source code of a website (asynchronously). The size of the source code is limited to 2 MiB (remaining bytes are cut).
}}

==Syntax==
<syntaxhighlight lang="lua">
table getBrowserSource ( function callback )
</syntaxhighlight>
====Callback syntax====
<syntaxhighlight lang="lua">
function ( string code )
</syntaxhighlight>

{{OOP||[[Element/Browser|Browser]].getSource}}

==Returns==
Returns ''true'' if valid arguments have been passed, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">local browser = createBrowser(...)

-- Assuming a website has already been loaded
getBrowserSource(function(code)
-- Output code
outputChatBox(code)
end)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

SetBrowserAjaxHandler

2015-09-15T20:18:52Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0151|1.5.1||
This function provides a requestable ajax resource for Lua/Javascript communication for a [[Element/Browser|browser]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setBrowserAjaxHandler ( browser webBrowser, string url [, function handler] )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:setAjaxHandler}}

===Required Arguments===
*'''webBrowser:''' The web browser which will execute the Javascript code
*'''url:''' The URL endpoint to handle
{{Warning|Do not use the same path as an existing file as url parameter. Ajax handlers have a higher priority than regular files, which will lead to inaccesibility of the original file if an ajax handler is attached to the same path. }}

===Optional Arguments===
*'''handler:''' The function to call if the webBrowser attempts to open the ajax endpoint. If this parameter is nil or omitted, the ajax handler for the url will be deleted.

===Additional Information===
The handling function (if given), will be called with two tables, representing GET and POST parameters. The handling function may return a string which will be provided to the browser as file content.

==Example==
This example will output all GET Parameters as well the number of requests made to the ajax endpoint.
<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

local counter = 0
setBrowserAjaxHandler(webBrowser, "ajax.html",
function(get, post)
counter = counter+1
local output = string.format("<pre>You have requested this page %d times.\n", counter)
-- List Parameters
local getParameters = "Get Parameters: \n"
for k, v in pairs(get) do
getParameters = getParameters..string.format("[%s] = %s\n", k, v)
end

output = output..getParameters.."</pre>"
return output
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/ajax.html?hello=world")
--Now we can start to render the browser.
addEventHandler("onClientRender", root, webBrowserRender)
end
)
</syntaxhighlight>
===Returns===
Returns ''true'' if the ajax handler could be created/removed.

==See Also==
{{CEF_functions}}

RequestBrowserDomains

2015-09-15T20:18:08Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function opens a request window in order to accept the requested remote URLs.
}}

==Syntax==
<syntaxhighlight lang="lua">bool requestBrowserDomains ( table pages [, bool parseAsURL = false] )</syntaxhighlight>
{{OOP||[[Element/Browser|Browser]].requestDomains}}

===Required Arguments===
*'''pages:''' A table containing all domains

===Optional Arguments===
*'''parseAsURL:''' ''true'' if the passed addresses should be converted from URLs, ''false'' otherwise.

===Returns===
Returns '''true''', if the string was successfully read, '''false''' otherwise.

==Example==
<syntaxhighlight lang="lua">requestBrowserDomains({ "mtasa.com" }) -- request browser domain
showCursor(true) -- show cursor
addEventHandler("onClientBrowserWhitelistChange", root,
function(newDomains)
if newDomains[1] == "mtasa.com" then
local browser = createBrowser(1280, 720, false, false) -- create browser
loadBrowserURL(browser, "http://mtasa.com/") -- load browser url
end
end
)
</syntaxhighlight>

==See also==
{{CEF_functions}}

SetBrowserVolume

2015-09-15T20:17:52Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function sets either a specific [[Element/Browser|browser]]'s volume, or the overall volume for browsers.
}}

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

===Required Arguments===
*'''volume:''' A [[float|floating]] point number representing the desired volume level. Range is from '''0.0''' to '''1.0'''

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

==Example==
<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(0, 0, screenWidth, screenHeight, "Webbrowser", false)
local browser = guiCreateBrowser(0, 0, 800, 600, false, 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
)

addCommandHandler ("volume", -- Add command named 'value'
function (player, command, value)
if tonumber (value) then -- checking if the value is a number
setBrowserVolume (theBrowser, value) -- setting the volume value
else -- if there is no value
outputChatBox ("You must enter a value.", player)
end
end
)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

SetBrowserRenderingPaused

2015-09-15T20:17:28Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function sets the rendering state of a browser.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setBrowserRenderingPaused ( browser webBrowser, bool paused )
</syntaxhighlight>
{{OOP||[[browser]]:setRenderingPaused}}

===Required Arguments===
*'''webBrowser:''' The browser
*'''paused:''' ''true'' to pause rendering, ''false'' to continue

===Returns===
Returns ''true'' if the state was successfully changed

==Example==
<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(0, 0, screenWidth, screenHeight, "Webbrowser", false)
local browser = guiCreateBrowser(0, 0, 800, 600, false, 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
)

addCommandHandler ("pause", -- Add command named 'pause'
function (player, command, value)
if (value) then -- checking for a value
setBrowserRenderingPaused (theBrowser, value)
else -- if there is no value
outputChatBox ("You must enter a value.", player)
end
end
)
</syntaxhighlight>

==See also==
{{CEF_functions}}

InjectBrowserMouseWheel

2015-09-15T20:15:55Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function injects mouse wheel events.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool injectBrowserMouseWheel ( browser webBrowser, int verticalScroll, int horizontalScroll )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:injectMouseWheel||injectBrowserMouseWheel}}

===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==
<syntaxhighlight lang="lua">local webBrowser = createBrowser(1000, 1000, false, false)
showCursor(true)

function webBrowserRender()
dxDrawImage(0, 0, 1000, 1000, webBrowser, 0, 0, 0, tocolor(255,255,255,255), true)
end

addEventHandler("onClientBrowserCreated", webBrowser,
function()
loadBrowserURL(webBrowser, "https://www.youtube.com/tv#/watch?mode=transport&v=jofNR_WkoCE")
addEventHandler("onClientRender", root, webBrowserRender)
addEventHandler("onClientKey", root, onKey)
end
)

function onKey(button)
if button == "mouse_wheel_down" then
injectBrowserMouseWheel(webBrowser, -40, 0)
elseif button == "mouse_wheel_up" then
injectBrowserMouseWheel(webBrowser, 40, 0)
end
end</syntaxhighlight>

==See Also==
Todo

==See also==
{{CEF_functions}}

InjectBrowserMouseUp

2015-09-15T20:15:46Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function injects a mouse click (state: up).
}}

==Syntax==
<syntaxhighlight lang="lua">
bool injectBrowserMouseUp ( browser webBrowser, string mouseButton )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:injectMouseUp||injectBrowserMouseUp}}

===Required arguments===
*'''webBrowser:''' The web browser
*'''mouseButton:''' The mouse button (Possible values: ''left'', ''middle'', ''right'')

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

==Example==
<syntaxhighlight lang="lua">addEventHandler("onClientClick", root,
function(button, state)
if state == "down" then
injectBrowserMouseDown(browser, button)
else
injectBrowserMouseUp(browser, button)
end
end
)</syntaxhighlight>

==See also==
{{CEF_functions}}

InjectBrowserMouseMove

2015-09-15T20:15:27Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function injects a mouse movement.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool injectBrowserMouseMove ( browser webBrowser, int posX, int posY )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:injectMouseMove||injectBrowserMouseMove}}

===Required arguments===
*'''webBrowser:''' The browser which will retrieve the mouse movement
*'''posX:''' Absolute X screen coordinate
*'''posY:''' Absolute Y screen coordinate

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

==Example==
<syntaxhighlight lang="lua">function onCursorMove ( relativeX , relativeY , absoluteX , absoluteY )
injectBrowserMouseMove ( browser , absoluteX , absoluteY )
end
addEventHandler ( "onClientCursorMove" , root , onCursorMove )</syntaxhighlight>

==See Also==
Todo

==See also==
{{CEF_functions}}

InjectBrowserMouseDown

2015-09-15T20:15:19Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function injects a mouse click (state: down).
}}

==Syntax==
<syntaxhighlight lang="lua">
bool injectBrowserMouseDown ( browser webBrowser, string mouseButton )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:injectMouseDown||injectBrowserMouseDown}}

===Required arguments===
*'''webBrowser:''' The web browser
*'''mouseButton:''' The mouse button (Possible values: ''left'', ''middle'', ''right'')

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

==Example==
<syntaxhighlight lang="lua">addEventHandler("onClientClick", root,
function(button, state)
if state == "down" then
injectBrowserMouseDown(browser, button)
else
injectBrowserMouseUp(browser, button)
end
end)
</syntaxhighlight>

==See also==
{{CEF_functions}}

GetBrowserURL

2015-09-15T20:15:11Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function returns the URL of the specified [[Element/Browser|browser]].
}}

==Syntax==
<syntaxhighlight lang="lua">
string getBrowserURL ( browser webBrowser )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:getURL||getBrowserURL}}

===Required Arguments===
*'''webBrowser:''' The browser

===Returns===
Returns the web browser URL.

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

==See Also==
{{CEF_functions}}

GetBrowserTitle

2015-09-15T20:15:02Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function returns the title of the passed [[Element/Browser|browser]].
}}

==Syntax==
<syntaxhighlight lang="lua">
string getBrowserTitle ( browser webBrowser )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:getTitle||getBrowserTitle}}

===Required arguments===
*'''webBrowser:''' The browser

===Returns===
Returns the title as a [[string]]. Returns false if invalid arguments were passed.

==Example==
<syntaxhighlight lang="lua">
addCommandHandler("browsers",
function()
outputChatBox("List of browser titles:")
for k, v in pairs( getElementByType("web-browser") ) do
outputChatBox(k .. ". " .. getBrowserTitle(v))
end
end
)
</syntaxhighlight>

==See Also==
{{CEF_functions}}

IsBrowserLoading

2015-09-15T20:14:35Z

Miki785:

__NOTOC__
{{Client function}}
{{New feature/item|3.0150|1.5||
This function checks if a browser is currently loading a website.
}}

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

===Required arguments===
*'''webBrowser:''' The browser

===Returns===
Returns ''true'' if the browser is loading a website, ''false'' otherwise and ''nil'' if invalid arguments were passed.

==Example==
This example will add an command /checkload to check if the site is loading or not.

<syntaxhighlight lang="lua">
local webbrowser = createBrowser(1000, 1000, false, false)
loadBrowserUrl(webbrowser, "https://www.youtube.com/watch?v=jofNR_WkoCE")
addCommandHandler("checkload",
function()
if isBrowserLoading(webbrowser) then
outputChatBox("Please wait, The site is loading!")
else
outputChatBox("This site was already loaded")
end
end
)</syntaxhighlight>

==See Also==
{{CEF_functions}}

IsBrowserFocused

2015-09-15T20:14:27Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs Example}}
This function checks if a browser is focused.

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

===Required arguments===
*'''webBrowser:''' The browser

===Returns===
Returns ''true'' if the browser is focused, ''false'' otherwise and ''nil'' if invalid arguments were passed.

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

==See Also==
{{CEF_functions}}

FocusBrowser

2015-09-15T20:14:06Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs Example}}
{{New feature/item|3.0150|1.5||
This function will attempt to focus the [[Element/Browser|browser]] or unfocus all browsers. The browser that is focused will retrieve keyboard input.
}}

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

===Required Arguments===
*'''webBrowser:''' The web browser to be focused - if this is '''nil''', it will unfocus all browsers.

===Returns===
Returns ''true'' if the browser was focused or if nil was passed, ''false'' if it failed to focus or the browser does not exist.

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

==See Also==
{{CEF_functions}}

ExecuteBrowserJavascript

2015-09-15T20:13:51Z

Miki785:

__NOTOC__
{{Client function}}
{{Needs Example}}
{{New feature/item|3.0150|1.5||
This function executes a Javascript string to the specified [[Element/Browser|browser]].
}}

==Syntax==
<syntaxhighlight lang="lua">
bool executeBrowserJavascript ( browser webBrowser, string jsCode )
</syntaxhighlight>
{{OOP||[[Element/Browser|browser]]:executeJavascript||executeBrowserJavascript}}

===Required Arguments===
*'''webBrowser:''' The web browser which will execute the Javascript code
*'''jsCode:''' The Javascript code string

===Returns===
Returns ''true'' if executing Javascript is allowed in the current context, ''false'' otherwise.

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

==See Also==
{{CEF_functions}}

GuiGetBrowser

2015-09-15T20:13:02Z

Miki785:

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

===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==
{{GUI_functions}}

GuiCreateBrowser

2015-09-15T20:11:29Z

Miki785:

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

==Syntax==
<syntaxhighlight lang="lua">gui-browser guiCreateBrowser( float x, float y, float width, float height, bool isLocal, bool isTransparent, bool isRelative [ , element parent = nil ] )</syntaxhighlight>
{{OOP||[[Element/gui-browser|GuiBrowser]]}}

===Required Arguments===
*'''x, y:''' The browser's position
*'''width:''' The browser's native width
*'''height:''' The browser's native height
*'''isLocal:''' See examples
*'''isTransparent:''' ''true'' if you want the browser to support transparency, ''false'' otherwise
*'''isRelative:''' 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 measures relative to the parent.

===Optional Arguments===
*'''parent:''' This is the parent that the radio 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 ''true'' if the [[gui-browser]] element was successfully created, ''false'' otherwise. Returns also ''false'', if the user disabled remote pages and ''isLocal'' was set to ''false''.

==Example==
This examples attached a webbrowser to a CEGUI window, '''not is tested'''
<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(0, 0, screenWidth, screenHeight, "Webbrowser", false)
local browser = guiCreateBrowser(0, 0, 800, 600, false, 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==
{{GUI_functions}}