Multi Theft Auto: Wiki - User contributions [en]

GetVehicleTurnVelocity

2021-09-04T18:15:47Z

Toliak: Spacing fix

{{Server client function}}
{{Deprecated|getElementAngularVelocity|This function will be deprecated in '''1.5.6'''}}

__NOTOC__
This function is used to retrieve a vehicle's turning velocity for each axis.

==Syntax==
<syntaxhighlight lang="lua">
float float float getVehicleTurnVelocity ( vehicle theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getTurnVelocity|turnVelocity|setVehicleTurnVelocity}}
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get the turning velocities of.

===Returns===
Returns 3 ''floats'' that represent the vehicle's turning velocity on the x, y and z axis or ''false'' if wrong arguments were passed.

===Example===
<section name="Server" class="server" show="true">
This example shows the current turn velocity of the vehicle that you're in.

<syntaxhighlight lang="lua">
addCommandHandler("geturnvelocity", function(player)
if not isPedInVehicle(player) then return end
local veh = getPedOccupiedVehicle(player)
local vx, vy, vz = getVehicleTurnVelocity(veh)
outputChatBox("Vehicle's turn velocity is: X: "..vx.." Y: "..vy.." Z: "..vz, player, 0, 255, 0, false)
end)
</syntaxhighlight>
</section>

==See Also==

{{Vehicle functions}}

GetVehicleTurnVelocity

2021-09-04T18:15:06Z

Toliak: Used new deprecation notice template

{{Server client function}}
__NOTOC__
{{Deprecated|getElementAngularVelocity|This function will be deprecated in '''1.5.6'''}}
This function is used to retrieve a vehicle's turning velocity for each axis.

==Syntax==
<syntaxhighlight lang="lua">
float float float getVehicleTurnVelocity ( vehicle theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getTurnVelocity|turnVelocity|setVehicleTurnVelocity}}
===Required Arguments===
*'''theVehicle:''' The [[vehicle]] you wish to get the turning velocities of.

===Returns===
Returns 3 ''floats'' that represent the vehicle's turning velocity on the x, y and z axis or ''false'' if wrong arguments were passed.

===Example===
<section name="Server" class="server" show="true">
This example shows the current turn velocity of the vehicle that you're in.

<syntaxhighlight lang="lua">
addCommandHandler("geturnvelocity", function(player)
if not isPedInVehicle(player) then return end
local veh = getPedOccupiedVehicle(player)
local vx, vy, vz = getVehicleTurnVelocity(veh)
outputChatBox("Vehicle's turn velocity is: X: "..vx.." Y: "..vy.." Z: "..vz, player, 0, 255, 0, false)
end)
</syntaxhighlight>
</section>

==See Also==

{{Vehicle functions}}

IsObjectInACLGroup

2021-09-03T07:31:16Z

Toliak: Yes, my fault. What about to rename the argument to "theObjectName". It is more readable, isn't it?

__NOTOC__
{{Server function}}
{{Important Note|You must '''NOT''' to use this function to limit features to users that belong to specific groups. Instead you '''MUST''' use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}
This function is used to determine if an object is in a group.

==Syntax==
<syntaxhighlight lang="lua">
bool isObjectInACLGroup ( string theObjectName, aclgroup theGroup )
</syntaxhighlight>
{{New feature/item|3.0141|1.4.0|6994|{{OOP||[[aclgroup]]:doesContainObject||}}}}
===Required Arguments===
*'''theObjectName:''' the name of the object to check. Examples: "resource.ctf", "user.Jim".
*'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found.

===Returns===
Returns ''true'' if the object is in the specified group, ''false'' otherwise.

==Example==
''' Example 1:''' This example adds a ''jetpack'' command that is only available to admins. When entering the command, it will toggle the player's jetpack.
<syntaxhighlight lang="lua">
addCommandHandler ( "jetpack",
function ( thePlayer )
if doesPedHaveJetPack ( thePlayer ) then -- If the player have a jetpack already, remove it
removePedJetPack ( thePlayer ) -- Remove the jetpack
return -- And stop the function here
end

-- Otherwise, give him one if he has access

local accName = getAccountName ( getPlayerAccount ( thePlayer ) ) -- get his account name
if isObjectInACLGroup ("user."..accName, aclGetGroup ( "Admin" ) ) then -- Does he have access to Admin functions?
if not doesPedHaveJetPack ( thePlayer ) then -- If the player doesn't have a jetpack give it.
givePedJetPack ( thePlayer ) -- Give the jetpack
end
end
end
)
</syntaxhighlight>

'''Example 2:''' This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'admin'):
<syntaxhighlight lang="lua">
players = getElementsByType ( "player" )
admins = ""
for k,v in ipairs(players) do
local accountname = ""
if (isGuestAccount(getPlayerAccount(v)) == false) then
accountname = getAccountName (getPlayerAccount(v))
if isObjectInACLGroup ( "user." .. accountname, aclGetGroup ( "admin" ) ) then
if (admins == "") then
admins = getPlayerName(v)
else
admins = admins .. ", " .. getPlayerName(v)
end
end
end
end
outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)
outputChatBox( " " .. tostring ( admins ), getRootElement(), 255, 255, 0)
</syntaxhighlight>

==See Also==
{{ACL_functions}}
[[zh-cn:IsObjectInACLGroup]]

IsObjectInACLGroup

2021-09-01T19:46:37Z

Toliak: I believe that argument `theObject` has the `object` type instead of `string`

__NOTOC__
{{Server function}}
{{Important Note|You must '''NOT''' to use this function to limit features to users that belong to specific groups. Instead you '''MUST''' use [[hasObjectPermissionTo]]. Using this function forces the server owner to name their group a certain way, whereas using hasObjectPermissionTo allows the owner to give permission for whatever features you restrict to whatever groups they have set up in their ACL.}}
This function is used to determine if an object is in a group.

==Syntax==
<syntaxhighlight lang="lua">
bool isObjectInACLGroup ( object theObject, aclgroup theGroup )
</syntaxhighlight>
{{New feature/item|3.0141|1.4.0|6994|{{OOP||[[aclgroup]]:doesContainObject||}}}}
===Required Arguments===
*'''theObject:''' the name of the object to check. Examples: "resource.ctf", "user.Jim".
*'''theGroup:''' the [[ACL group]] pointer of the group from which the object should be found.

===Returns===
Returns ''true'' if the object is in the specified group, ''false'' otherwise.

==Example==
''' Example 1:''' This example adds a ''jetpack'' command that is only available to admins. When entering the command, it will toggle the player's jetpack.
<syntaxhighlight lang="lua">
addCommandHandler ( "jetpack",
function ( thePlayer )
if doesPedHaveJetPack ( thePlayer ) then -- If the player have a jetpack already, remove it
removePedJetPack ( thePlayer ) -- Remove the jetpack
return -- And stop the function here
end

-- Otherwise, give him one if he has access

local accName = getAccountName ( getPlayerAccount ( thePlayer ) ) -- get his account name
if isObjectInACLGroup ("user."..accName, aclGetGroup ( "Admin" ) ) then -- Does he have access to Admin functions?
if not doesPedHaveJetPack ( thePlayer ) then -- If the player doesn't have a jetpack give it.
givePedJetPack ( thePlayer ) -- Give the jetpack
end
end
end
)
</syntaxhighlight>

'''Example 2:''' This example displays a list of all the online admins in the chat box (assuming your administrator's group in your ACL is called 'admin'):
<syntaxhighlight lang="lua">
players = getElementsByType ( "player" )
admins = ""
for k,v in ipairs(players) do
local accountname = ""
if (isGuestAccount(getPlayerAccount(v)) == false) then
accountname = getAccountName (getPlayerAccount(v))
if isObjectInACLGroup ( "user." .. accountname, aclGetGroup ( "admin" ) ) then
if (admins == "") then
admins = getPlayerName(v)
else
admins = admins .. ", " .. getPlayerName(v)
end
end
end
end
outputChatBox( "Online Admins:", getRootElement(), 255, 255, 0)
outputChatBox( " " .. tostring ( admins ), getRootElement(), 255, 255, 0)
</syntaxhighlight>

==See Also==
{{ACL_functions}}
[[zh-cn:IsObjectInACLGroup]]

GetVehiclesOfType

2021-09-01T19:44:01Z

Toliak: OOP function getAllOfType is static

{{Server function}}
__NOTOC__
This function scans through all the current vehicles and returns the ones matching the given model.

==Syntax==
<syntaxhighlight lang="lua">table getVehiclesOfType ( int model )</syntaxhighlight>
{{OOP|This function is a static function underneath the Vehicle class.|[[Vehicle]].getAllOfType||}}
===Required Arguments===
*'''model''': The model of vehicles you want.

===Returns===
Returns a table of existing vehicles matching the specified model.

==Example==
This example finds all landstalkers on the map and moves them 5 units to the left.
<syntaxhighlight lang="lua">
-- Find all the vehicles with the model 400 (landstalker)
vehicles = getVehiclesOfType ( 400 )
-- Loop through the vehicle list
for vehicleKey, vehicleValue in ipairs ( vehicles ) do
-- Get the vehicle's position
x, y, z = getElementPosition ( vehicleValue )
-- Move the vehicle to the left
setElementPosition ( vehicleValue, x - 5, y, z )
end
</syntaxhighlight>

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

[[de:GetVehiclesOfType]]

OnClientObjectMoveStop

2021-07-20T18:56:46Z

Toliak: Add parameters section (without parameters)

__NOTOC__
{{Client event}}
{{New feature/item|3.0159|1.5.8|20811|This event is triggered when an object's movement stop.}}

==Parameters==
No parameters.

==Source==
The source of this event is the object which was moved.

==Example==
<syntaxhighlight lang="lua">
local obj = createObject(5239, -2417.22339, -606.70374, 132.56250)
moveObject(obj, 3000, -2417.22339, -606.70374, 137.56250)

addEventHandler("onClientObjectMoveStop", obj,
function()
outputChatBox("stopping moving object")
end
)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-rc20811|}}

==See Also==
===Client object events===
{{Client_object_events}}
===Client event functions===
{{Client_event_functions}}

OnClientObjectMoveStart

2021-07-20T18:56:25Z

Toliak: Add parameters section (without parameters)

__NOTOC__
{{Client event}}
{{New feature/item|3.0159|1.5.8|20811|This event is triggered when an object starts moving.}}

==Parameters==
No parameters.

==Source==
The source of this event is the object which was moved.

==Example==
<syntaxhighlight lang="lua">
local obj = createObject(5239, -2417.22339, -606.70374, 132.56250)
moveObject(obj, 3000, -2417.22339, -606.70374, 137.56250)

addEventHandler("onClientObjectMoveStart", obj,
function()
outputChatBox("started moving object")
end
)
</syntaxhighlight>

==Requirements==
{{Requirements|n/a|1.5.8-rc20811|}}

==See Also==
===Client object events===
{{Client_object_events}}
===Client event functions===
{{Client_event_functions}}

OnClientElementStreamOut

2021-07-20T18:30:55Z

Toliak: Add parameters section (without parameters)

{{Client event}}
__NOTOC__
This event is triggered whenever a physical element is streamed out. This is triggered for all elements that are streamable, such as players, peds, vehicles, objects and markers when the local player is leaving the element. When this event is triggered, that element is no longer physical and is now virtualized by MTA.

==Parameters==
No parameters.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that streamed out.

==Example==
This example shows you how to tell player that a marker was streamed out and the distance between player and the marker.
<syntaxhighlight lang="lua">
addEventHandler( "onClientElementStreamOut", root,
function ( )
if getElementType( source ) == "marker" then
local myPosTab = { getElementPosition( localPlayer ) };
local markerPosTab = { getElementPosition( source ) };
local distance = getDistanceBetweenPoints3D( unpack( myPosTab ), unpack( markerPosTab ) );
outputChatBox( "A marker has just streamed out. Distance to the marker: " .. tostring( distance ) .."." );
end
end
);
</syntaxhighlight>

==See Also==
===Client element events===
{{Client_element_events}}
===Client event functions===
{{Client_event_functions}}

OnClientElementStreamIn

2021-07-20T18:29:31Z

Toliak: Add parameters section (without parameters)

{{Client event}}
__NOTOC__
This event is triggered whenever a physical element is streamed in. This is triggered for all elements that are streamable, such as players, peds, vehicles, objects and markers. When this event is triggered, that element is guaranteed to be physically created as a GTA object.

==Parameters==
No parameters.

==Source==
The [[event system#Event source|source]] of this event is the [[element]] that streamed in.

==Example==
This example shows you how to tell player that a marker was streamed in and the distance between player and the marker.
<syntaxhighlight lang="lua">
addEventHandler( "onClientElementStreamIn", root,
function ( )
if getElementType( source ) == "marker" then
local myPosTab = { getElementPosition( localPlayer ) };
local markerPosTab = { getElementPosition( source ) };
local distance = getDistanceBetweenPoints3D( unpack( myPosTab ), unpack( markerPosTab ) );
outputChatBox( "A marker has just streamed in. Distance to the marker: " .. tostring( distance ) .."." );
end
end
);
</syntaxhighlight>
==See Also==
===Client element events===
{{Client_element_events}}
===Client event functions===
{{Client_event_functions}}

DxUpdateScreenSource

2021-05-14T16:52:08Z

Toliak: Fix class name in OOP

{{Client function}}
__NOTOC__
This function updates the contents of a screen source [[texture]] with the screen output from GTA

==Syntax==
<syntaxhighlight lang="lua">
bool dxUpdateScreenSource ( element screenSource [, bool resampleNow = false ] )
</syntaxhighlight>
{{OOP||[[DxScreenSource]]:update}}
===Required Arguments===
*'''screenSource:''' The screen source element whose pixels we want to fill with the screen capture

===Optional Arguments===
*'''resampleNow:''' A bool to indicate if the screen should be captured immediately. The default is ''false'' which means the screen from the end of the previous frame is used (better for performance and consistency). Use ''true'' for layering fullscreen effects.

===Returns===
Returns ''true'' if the screen was successfully captured, ''false'' otherwise.

==Example==
This example will update the screen capture when F7 is pressed
<syntaxhighlight lang="lua">
addEventHandler("onClientResourceStart", resourceRoot,
function()
myScreenSource = dxCreateScreenSource( 500, 500) -- Create a screen source texture which is 500 x 500 pixels
end
)

bindKey( "F7", "down",
function()
if myScreenSource then
dxUpdateScreenSource( myScreenSource ) -- Capture the screen
end
end
)

addEventHandler( "onClientRender", root,
function()
if myScreenSource then
dxDrawImage ( 0, 0, 300, 300, myScreenSource ) -- Draw the result in top left corner
end
end
)
</syntaxhighlight>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.03795|Added resample argument}}

==See Also==
{{Drawing_functions}}

GuiEditIsMasked

2021-05-14T16:44:54Z

Toliak: Undo revision 71069 by Toliak (talk). Due to https://github.com/multitheftauto/mtasa-blue/blob/c58c3678f263d810f61eb5aecba48e6c4b4dce0c/Client/mods/deathmatch/logic/luadefs/CLuaGUIDefs.cpp#L326 I cannot provide the method name, and therefore, the class name

{{Client function}}
__NOTOC__
{{New feature/item|3.0156|1.5.5|13814|This function checks if an edit box is masked.}}

==Syntax==
<syntaxhighlight lang="lua">
bool guiEditIsMasked ( gui-edit guiEdit )
</syntaxhighlight>
{{OOP|||masked|guiEditSetMasked}}

===Required Arguments===
*'''guiEdit:''' the edit box to check masked flag of.

===Returns===
Returns ''true'' if the edit box is masked, ''false'' if not, ''nil'' if an invalid edit box was provided.

==Example==
{{Client function}}
<syntaxhighlight lang="lua">
function createPasswordEdit( )
local password = guiCreateEdit( 0.845, 0.94, 0.15, 0.05, "password", true ) -- create edit box for a password
if password then -- if it was successfully created
guiEditSetMasked( password, true ) -- make it masked
end
addCommandHandler( "isMasked",
function( )
local masked = guiEditIsMasked( password ) -- check the edit box masked flag
outputChatBox( "Edit field is " .. ( masked and "masked" or "not masked" ) ) -- show info about edit box
end
)
end
addEventHandler( "onClientResourceStart", resourceRoot, createPasswordEdit )</syntaxhighlight>

==See Also==
{{GUI_functions}}
{{GUI_events}}

GuiEditIsMasked

2021-05-14T16:41:11Z

Toliak: Add OOP Class

{{Client function}}
__NOTOC__
{{New feature/item|3.0156|1.5.5|13814|This function checks if an edit box is masked.}}

==Syntax==
<syntaxhighlight lang="lua">
bool guiEditIsMasked ( gui-edit guiEdit )
</syntaxhighlight>
{{OOP||GuiEdit|masked|guiEditSetMasked}}

===Required Arguments===
*'''guiEdit:''' the edit box to check masked flag of.

===Returns===
Returns ''true'' if the edit box is masked, ''false'' if not, ''nil'' if an invalid edit box was provided.

==Example==
{{Client function}}
<syntaxhighlight lang="lua">
function createPasswordEdit( )
local password = guiCreateEdit( 0.845, 0.94, 0.15, 0.05, "password", true ) -- create edit box for a password
if password then -- if it was successfully created
guiEditSetMasked( password, true ) -- make it masked
end
addCommandHandler( "isMasked",
function( )
local masked = guiEditIsMasked( password ) -- check the edit box masked flag
outputChatBox( "Edit field is " .. ( masked and "masked" or "not masked" ) ) -- show info about edit box
end
)
end
addEventHandler( "onClientResourceStart", resourceRoot, createPasswordEdit )</syntaxhighlight>

==See Also==
{{GUI_functions}}
{{GUI_events}}

IsMainMenuActive

2021-05-14T16:25:33Z

Toliak: OOP Syntax fix

__NOTOC__
{{Client function}}
This function returns whether the user is in the mainmenu or not.

==Syntax==
<syntaxhighlight lang="lua">
bool isMainMenuActive ()
</syntaxhighlight>
{{OOP||[[GUI widgets|GuiElement]].isMainMenuActive|mainMenuActive|}}

===Returns===
Returns ''true'' if the mainmenu is visible, ''false'' if not.

==Example==
This example check if the player is afk.
<syntaxhighlight lang="lua">
function isLocalPlayerActive ()
if isMainMenuActive() then
setElementData(getLocalPlayer(),"status","afk")
else
setElementData(getLocalPlayer(),"status","playing")
end
end
</syntaxhighlight>

==See Also==
{{GUI_functions}}
{{GUI_events}}

AddAccount

2021-05-14T12:22:06Z

Toliak: OOP Definition fix (static method)

{{Server function}}
__NOTOC__
This function adds an account to the list of registered accounts of the current server.

==Syntax==
<syntaxhighlight lang="lua">account addAccount ( string name, string pass [, bool allowCaseVariations = false ] )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Account class.|[[Account]].add ||}}
===Required Arguments===
*'''name:''' The name of the account you wish to make, this normally is the player's name.
*'''pass:''' The password to set for this account for future logins.

===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 an [[account]] or ''false'' if the account already exists or an error occured.

===Limits===
*'''name:'''
** Minimal account name length is 1 character.
** Account names are case-sensitive if allowCaseVariations is ''true''.
** Account name can not be equal to "*****"
*'''pass:'''
** Minimal account password length is 1 character.
** Maximum account password length '''was''' 30 characters until version 1.5.4-11138. Currently there is no upper limit.
** Account password can not be equal to "*****"

==Example==
'''Example 1:''' This enables players to register on your server by using /register <password> in the chat window.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, password )
-- Check if the password field is blank or not (only blank if they didnt enter one)
if ( password ~= "" and password ~= nil ) then
--Attempt to add the account, and save its value in a var
local accountAdded = addAccount( getPlayerName(source), password )
if ( accountAdded ) then
-- Tell the user all is done
outputChatBox ( "Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login", source )
else
-- There was an error making the account, tell the user
outputChatBox ( "Error creating account, contact the server admin", source )
end
else
-- There was an error in the syntax, tell the user the correct syntax.
outputChatBox ( "Error creating account, correct syntax: /register <password>", source )
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>

'''This code differs by allowing the user to change their username that they wish to use.'''

'''Example 2:''' This enables players to register on your server by using /register <username> <password> in the chat window.
<syntaxhighlight lang="lua">
function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
else
outputChatBox("Error creating account, contact the server admin.",source)
end
else
outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
end
end
addCommandHandler ( "register", registerPlayer ) -- add the command handler
</syntaxhighlight>

'''Example 3:''' This code differs again so the user can only register once /register <username> <password>.
<syntaxhighlight lang="lua">
bRegisteredOnce = {}

function registerPlayer ( source, commandName, username, password )
if(password ~= "" and password ~= nil and username ~= "" and username ~= nil and not bRegisteredOnce[source]) then
local accountAdded = addAccount(username,password)
if(accountAdded) then
outputChatBox("Thank you " .. getPlayerName(source) .. ", you're now registed, you can login with /login",source)
bRegisteredOnce[source] = true
else
outputChatBox("Error creating account, contact the server admin.",source)
end
else
if bRegisteredOnce[source] == true then
outputChatBox("You already registered on this server!",source)
else
outputChatBox("Error creating account, correct syntax: /register <nick> <pass>",source)
end
end
end
</syntaxhighlight>

==See Also==

{{Account_functions}}

[[en:addAccount]]
[[ru:addAccount]]
[[es:addAcount]]
[[pl:addAccount]]
[[ZH-CN:addAccount]]
[[tr:addAccount]]

User:Toliak

2021-05-01T10:40:00Z

Toliak: Add page template

<pageclass class="#7666f5" subcaption="ToliakPurple"></pageclass>

Welcome 😀. I am an MTASA resources developer with Lua, C++, JavaScript (+TypeScript), Python and Java knowledge.

__TOC__

= Projects =

== ✅ MTASA TypeScript Transpiling ==

{{MessageBox|
bordercolorhex = bdd7ff|
bgcolorhex = e0edff|
message = '''Active project''' }}

The project allows anyone to develop a resource on TypeScript and to convert (transpile) it into the MTASA Lua.

TypeScript has an awesome features over the Lua:
* Static types linting support ''(no more "oops this function accepts Player instead of number")''.
* Hints ''(no more "how many arguments does the function have")''.
* Classes syntax ''(no more tables + metatables)''.

=== References ===

* Demo

[https://mtasa-typescript.github.io/ WebSite]

[https://github.com/mtasa-typescript MTASA TypeScript Group]

* Resources

[https://github.com/mtasa-typescript/resource-example TypeScript Resource Example]

[https://github.com/mtasa-typescript/resource-boilerplate TypeScript Resource Template]

* Utility

[https://github.com/mtasa-typescript/mtasa-lua-types MTASA Lua Types definitions (NPM)]

[https://github.com/mtasa-typescript/mtasa-lua-utils Utilities for the development (NPM)]

[https://github.com/mtasa-typescript/mtasa-wiki-parser MTASA Wiki parser & Types definitions generator]

== ⭐ NPC Ped Traffic Resource ==

NPC Pedestrian traffic resource -- adds synchronized walking peds into MTASA.
Currently working on LV routes and miscellaneous NPC behavior in the '''feature/las-venturas''' branch.

=== References ===

[https://www.youtube.com/watch?v=vWItG5lr2bU Demo/Trailer]

[https://github.com/Toliak/mtasa-resource-traffic/tree/master GitHub repository]

== ⭐ GTASA Vector Map ==

GTA San Andreas (MTA San Andreas) vector map.
Currently working on fully map redesign in the '''develop''' branch.

=== References ===

[https://github.com/Toliak/San-Andreas-vector-map GitHub repository]

== 🚫 Python Module ==

{{MessageBox|
bordercolorhex = ffbfbf |
bgcolorhex = ffe0e0 |
message = '''Frozen project. Extremely low chances for the further development''' }}

The module is a .dll/.so that adds server-side python language support for writing resources.

=== References ===

[https://github.com/Toliak/mtasa-module-python GitHub Repository]

= References =

[https://github.com/Toliak GitHub Profile]

[https://toliak.ru/ Website]

Email: a@toliak.ru

User:Toliak

2021-05-01T10:36:23Z

Toliak: Initial commit

Welcome 😀. I am an MTASA resources developer with Lua, C++, JavaScript (+TypeScript), Python and Java knowledge.

__TOC__

= Projects =

== ✅ MTASA TypeScript Transpiling ==

{{MessageBox|
bordercolorhex = bdd7ff|
bgcolorhex = e0edff|
message = '''Active project''' }}

The project allows anyone to develop a resource on TypeScript and to convert (transpile) it into the MTASA Lua.

TypeScript has an awesome features over the Lua:
* Static types linting support ''(no more "oops this function accepts Player instead of number")''.
* Hints ''(no more "how many arguments does the function have")''.
* Classes syntax ''(no more tables + metatables)''.

=== References ===

* Demo

[https://mtasa-typescript.github.io/ WebSite]

[https://github.com/mtasa-typescript MTASA TypeScript Group]

* Resources

[https://github.com/mtasa-typescript/resource-example TypeScript Resource Example]

[https://github.com/mtasa-typescript/resource-boilerplate TypeScript Resource Template]

* Utility

[https://github.com/mtasa-typescript/mtasa-lua-types MTASA Lua Types definitions (NPM)]

[https://github.com/mtasa-typescript/mtasa-lua-utils Utilities for the development (NPM)]

[https://github.com/mtasa-typescript/mtasa-wiki-parser MTASA Wiki parser & Types definitions generator]

== ⭐ NPC Ped Traffic Resource ==

NPC Pedestrian traffic resource -- adds synchronized walking peds into MTASA.
Currently working on LV routes and miscellaneous NPC behavior in the '''feature/las-venturas''' branch.

=== References ===

[https://www.youtube.com/watch?v=vWItG5lr2bU Demo/Trailer]

[https://github.com/Toliak/mtasa-resource-traffic/tree/master GitHub repository]

== ⭐ GTASA Vector Map ==

GTA San Andreas (MTA San Andreas) vector map.
Currently working on fully map redesign in the '''develop''' branch.

=== References ===

[https://github.com/Toliak/San-Andreas-vector-map GitHub repository]

== 🚫 Python Module ==

{{MessageBox|
bordercolorhex = ffbfbf |
bgcolorhex = ffe0e0 |
message = '''Frozen project. Extremely low chances for the further development''' }}

The module is a .dll/.so that adds server-side python language support for writing resources.

=== References ===

[https://github.com/Toliak/mtasa-module-python GitHub Repository]

= References =

[https://github.com/Toliak GitHub Profile]

[https://toliak.ru/ Website]

Email: a@toliak.ru

Utf8.fold

2021-04-30T13:12:40Z

Toliak: Split syntax into different boxes

__NOTOC__
{{Shared function}}
{{Note|You may want to read up on [https://www.w3.org/International/wiki/Case_folding case folding] for more information about the use of this function.}}
Converts a UTF-8 string to folded case (lowercase), which can be used to compare two strings. If ''input'' is an integer, it's treat as a codepoint and a convert codepoint (integer) is returned.

==Syntax==
<syntaxhighlight lang="lua">
string|int utf8.fold ( string|int input )
</syntaxhighlight>
<syntaxhighlight lang="lua">
string|int utf8.lower ( string|int input )
</syntaxhighlight>

===Required Arguments===
*'''input:''' A string character sequence OR an integer value

===Returns===
Returns a ''string'' in lowercase OR returns an ''integer'' (see description).

==Example==
<section name="Server" class="server" show="true">
This example shows how to convert a string to lowercase, which can be used to compare with other folded strings.
<syntaxhighlight lang="lua">
local output = utf8.lower( "WHAT ARE YOU UP TO? Do you like uppercase?" )
print( output ) -- what are you up to? do you like uppercase?

local value = utf8.fold( 1088 )
print( type( value ) ) -- number
</syntaxhighlight>
</section>

==See Also==
{{UTF8 functions}}

Utf8.title

2021-04-30T13:12:03Z

Toliak: Split syntax into different boxes

__NOTOC__
{{Shared function}}
{{Note|You may want to read up on [https://www.w3.org/International/wiki/Case_folding case folding] for more information about the use of this function.}}
Converts a UTF-8 string to title case (uppercase). If ''input'' is an integer, it is treated as a codepoint and a converted codepoint (integer) is returned.

==Syntax==
<syntaxhighlight lang="lua">
string utf8.title ( string|int input )
</syntaxhighlight>
<syntaxhighlight lang="lua">
string utf8.upper ( string|int input )
</syntaxhighlight>

===Required Arguments===
*'''input:''' A string character sequence OR an integer value

===Returns===
Returns a ''string'' in uppercase OR returns an ''integer'' (see description).

==Example==
<section name="Client" class="client" show="true">
This example shows how to convert a string to uppercase.
<syntaxhighlight lang="lua">
local output = utf8.upper( "WHAT ARE YOU UP TO? Do you like uppercase?" )
outputConsole( output ) -- WHAT ARE YOU UP TO? DO YOU LIKE UPPERCASE?

local value = utf8.title( 1088 )
outputConsole( value, type( value ) ) -- 1056, number
</syntaxhighlight>
</section>

==See Also==
{{UTF8 functions}}

AddVehicleSirens

2021-04-30T12:59:21Z

Toliak: /* Syntax */ syntax error

__NOTOC__
{{Server function}}
{{New feature/item|3.0130|1.3.0|3968|
This function adds sirens to a vehicle.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool addVehicleSirens ( vehicle theVehicle, int sirenCount, int sirenType [, bool flag360 = false, bool checkLosFlag = true, bool useRandomiser = true, bool silentFlag = false ] )
</syntaxhighlight>
{{OOP||[[vehicle]]:addSirens}}
===Required Arguments===
*'''theVehicle:''' The vehicle to add sirens
*'''sirenCount:''' The amount of siren points on the vehicle (8 maximum)
*'''sirenType:''' An integer between 1 and 6 (1: invisible, 2: single, 3+: dual)

===Optional Arguments===
*'''flag360:''' Visible from all directions (applies to single type only)
*'''checkLosFlag:''' Check line of sight between camera and light so it won't draw if blocked
*'''useRandomiser:''' Randomise the light order, false for sequential
*'''silentFlag:''' If you want the siren to be silent set this to true

===Returns===
Returns ''true'' if sirens were successfully added to the vehicle, ''false'' otherwise.

==Example==
This example adds a vehicle siren on entering a vehicle and removes a vehicle siren on exiting. (TESTED!)
<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter", root, function(player, seat)
if (player) and (seat == 0) then
addVehicleSirens(source, 1, 2)
end
end)

addEventHandler("onVehicleExit", root, function(player, seat)
if (player) and (seat == 0) then
removeVehicleSirens(source)
end
end)
</syntaxhighlight>

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

==See Also==
{{Vehicle_functions}}

IsVehicleWheelOnGround

2021-04-30T11:37:17Z

Toliak: Type unions are '/', not '|'. See triggerLatentClientEvent, hasObjectPermissionTo, banPlayer, etc.

__NOTOC__
{{Client function}}
{{New feature/item|3.0156|1.5.5|11854|
This function returns a [[boolean]] whether the [[vehicle]]'s wheel is on ground (true) or in air (false).
}}
{{Note|In vehicles with 3 wheels, the wheels are combined 2 in 1, in motorbikes only the left - <code>"front_left"</code> and <code>"rear_left"</code>}}

==Syntax==
<syntaxhighlight lang="lua">bool isVehicleWheelOnGround ( vehicle theVehicle, string/int wheel )</syntaxhighlight>
{{OOP||[[vehicle]]:isWheelOnGround}}
===Required Arguments===
*'''theVehicle''' The [[vehicle]], which you want to check.
*'''wheel''' The wheel name or number, see list below:
** <code>"front_left"</code> or 0
** <code>"rear_left"</code> or 1
** <code>"front_right"</code> or 2
** <code>"rear_right"</code> or 3

===Returns===
Returns ''true'' if the vehicle wheel is on ground/collided, ''false'' otherwise.

==Example==
This example displays four colored rectangles on the screen. If the wheel is colliding, the rectangle will be green, otherwise it will be red.
<syntaxhighlight lang="lua">
local Green = tocolor(0, 255, 0, 255)
local Red = tocolor(255, 0, 0, 255)

addEventHandler( "onClientRender", root,
function( )
local theVehicle = getPedOccupiedVehicle( localPlayer )

if isElement( theVehicle ) then
dxDrawRectangle( 100, 100, 20, 20, isVehicleWheelOnGround ( theVehicle, 0 ) and Green or Red )
dxDrawRectangle( 100, 140, 20, 20, isVehicleWheelOnGround ( theVehicle, 1 ) and Green or Red )
dxDrawRectangle( 140, 100, 20, 20, isVehicleWheelOnGround ( theVehicle, 2 ) and Green or Red )
dxDrawRectangle( 140, 140, 20, 20, isVehicleWheelOnGround ( theVehicle, 3 ) and Green or Red )
end
end
)
</syntaxhighlight>

==See Also==
{{Client_vehicle_functions}}

GetProjectileCounter

2021-04-29T14:09:50Z

Toliak: Style fix

__NOTOC__
{{Client function}}
Get the time left before a projectile detonates.

==Syntax==
<syntaxhighlight lang="lua">int getProjectileCounter ( projectile projectile )</syntaxhighlight>
{{OOP||[[projectile]]:getCounter|counter|setProjectileCounter}}

===Required Arguments===
* '''projectile''': the projectile to get the timer of.

===Returns===
Returns the the time in milliseconds to detonation which depending on the projectile type will do different things:
* Grenades will explode when it hits 0
* Teargas may be a duration timer
* Both types of rockets will explode when it hits 0
* Satchels restarts so I do not think it does anything

===Example===
<section name="Client" class="client" show="true">
With this example you can find out how long does it take for a projectile to explode/end
<syntaxhighlight lang="lua">
function getProjectileBoomTime()
outputChatBox("Time for "..getProjectileType(source).." to explode/end is "..getProjectileCounter(source).." miliseconds.",255,0,0)
end
addEventHandler("onClientProjectileCreation",root,getProjectileBoomTime)

</syntaxhighlight>
</section>

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

==See Also==
{{Client projectile functions}}

GetElementBoundingBox

2021-04-29T14:08:41Z

Toliak: List of args

{{Client function}}
__NOTOC__
This function returns the minimum and maximum coordinates of an element's bounding box.

It should be noted that the values returned are relative to the position of the element, and as such if you wish to get world coordinates for drawing, etc., you should retrieve the position of the element and add the returned values onto that.
{{Note|The element must be streamed in for this function to work.}}

==Syntax==
<syntaxhighlight lang="lua">
float, float, float, float, float, float getElementBoundingBox ( element theElement )
</syntaxhighlight>
{{OOP||[[element]]:getBoundingBox}}

===Required Arguments===
* '''theElement:''' the element whose bounding box we want to get.

===Returns===
*Returns ''min x, min y, min z, max x, max y, max z'' if the passed element is valid and streamed in, ''false'' otherwise.

==Example==
This example outputs to chatbox the minimum and the maximum coordinates of an element.
<syntaxhighlight lang="lua">
function minMaxOutput( theElement )
local x0, y0, z0, x1, y1, z1 = getElementBoundingBox( theElement )

if ( x0 ) then
outputChatBox( "The coords are: " .. x0 .. ", " .. y0 .. ", " .. z0 .. ", " .. x1 .. ", " .. y1 .. ", " .. z1 )
else
outputChatBox( "Failed to retrieve bounding box" )
end
end
</syntaxhighlight>

==See Also==
{{Client element functions}}

Template:Utility functions

2021-03-31T18:39:02Z

Toliak: Useful function should not be in ServerFunctions category. Undo revision 69565 by GalAnonim (talk)

*[[addDebugHook]]
*[[base64Decode]]
*[[base64Encode]]
{{Bit_functions}}
*[[debugSleep]]
{{New items|3.0156|1.5.5|
*[[decodeString]]
|11849}}
*[[deref]]
{{New items|3.0156|1.5.5|
*[[encodeString]]
|11849}}
*[[fromJSON]]
*[[getColorFromString]]
*[[getDevelopmentMode]]
*[[getDistanceBetweenPoints2D]]
*[[getDistanceBetweenPoints3D]]
*[[getEasingValue]]
*[[getFPSLimit]]
*[[getNetworkStats]]
*[[getNetworkUsageData]]
*[[getPerformanceStats]]
*[[getRealTime]]
*[[getServerConfigSetting]]
*[[getTickCount]]
*[[getTimerDetails]]
*[[getTimers]]
*[[gettok]]
*[[getUserdataType]]
*[[getVersion]]
*[[hash]]
*[[inspect]]
*[[interpolateBetween]]
*[[iprint]]
*[[isOOPEnabled]]
*[[isTimer]]
*[[killTimer]]
*[[md5]]
*[[passwordHash]]
*[[passwordVerify]]
*[[pregFind]]
*[[pregMatch]]
*[[pregReplace]]
*[[removeDebugHook]]
*[[ref]]
*[[resetTimer]]
*[[setDevelopmentMode]]
*[[setFPSLimit]]
*[[setServerConfigSetting]]
*[[setTimer]]
*[[sha256]]
*[[split]]
*[[teaDecode]]
*[[teaEncode]]
{{New items|3.0156|1.5.5|
*[[tocolor]]
|13977}}
*[[toJSON]]
*[[utfChar]]
*[[utfCode]]
*[[utfLen]]
*[[utfSeek]]
*[[utfSub]]

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

FromColor

2021-03-31T18:34:38Z

Toliak: Attempt to remove this function from Server Scripting Functions category

__NOTOC__
{{Useful Function}}
This function converts the hexadecimal numbers of the specified colors

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

===Required Arguments===
* '''color:''' Values representing colors.

===Returns===
Returns an array containing colors (red, green, blue)

==Example==
<section name="Client" class="client" show="true">
The following code inverts the tocolor function.
<syntaxhighlight lang="lua">
function fromColor(color)
if color then
local blue = bitExtract(color, 0, 8)
local green = bitExtract(color, 8, 8)
local red = bitExtract(color, 16, 8)
local alpha = bitExtract(color, 24, 8)

return { red, green, blue, alpha }
end
end

local color = tocolor(255, 0, 0, 255)
print(fromColor(color))
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

RemovePedClothes

2021-02-20T20:56:22Z

Toliak:

__NOTOC__
{{Server client function}}
This function is used to remove the current clothes of a certain type on a [[ped]]. It will remove them if the clothesTexture and clothesModel aren't specified, or if they match the current clothes on that slot.

==Syntax==
<syntaxhighlight lang="lua">
bool removePedClothes ( ped thePed, int clothesType [, string clothesTexture, string clothesModel ] )
</syntaxhighlight>
{{OOP||[[ped]]:removeClothes}}

===Required Arguments===
*'''thePed''': The [[ped]] you want to remove clothes from.
*'''clothesType''': the clothes slot/type to remove. See the [[CJ Clothes|clothes catalog]].

===Optional Arguments===
*'''clothesTexture''': (Server only) A string determining the clothes texture that will be removed. See the [[CJ Clothes|clothes catalog]].
*'''clothesModel''': (Server only) A string determining the clothes model that will be removed. See the [[CJ Clothes|clothes catalog]].

==Returns==
This function returns ''true'' if the clothes were successfully removed from the ped, ''false'' otherwise.

==Example==
<section name="Server" class="server" show="true">
This example adds a 'moto' helmet to a player when he gets on a nrg bike, and removes it when he gets off.
<syntaxhighlight lang="lua">
function addHelmetOnEnter ( vehicleEntered, seat, jacked )
if getElementModel ( vehicleEntered ) == 522 then -- if it's a nrg
addPedClothes ( source, "moto", "moto", 16 ) -- add the helmet
end
end
addEventHandler ( "onPlayerVehicleEnter", root, addHelmetOnEnter )

function removeHelmetOnExit ( vehicleExited, seat, jacked )
if getElementModel ( vehicleExited ) == 522 then -- if it's a nrg
removePedClothes ( source, 16, "moto", "moto" ) -- remove that helmet
end
end
addEventHandler ( "onPlayerVehicleExit", root, removeHelmetOnExit )
</syntaxhighlight>
</section>

==See Also==
{{Ped functions}}

[[hu:removePedClothes]]
[[pl:RemovePedClothes]]

SetMarkerTarget

2021-02-20T20:43:40Z

Toliak: /* Syntax */ OOP fixed definitions

{{Server client function}}
__NOTOC__
This function sets the 'target' for a marker. Only the ''checkpoint'' and ''ring'' marker types can have a target.

For ''checkpoint'' markers, the target is shown as an arrow aiming at the point specified.

For ''ring'' markers, the target is shown by rotating the whole ring so that it faces the point specified.

This function is most useful for setting up markers for races, where each marker points to the next one's position.
(This is mostly used in races!)

==Syntax==
<syntaxhighlight lang="lua">
bool setMarkerTarget ( marker theMarker, float x, float y, float z )
</syntaxhighlight>
{{OOP||[[Marker]]:setTarget|target|getMarkerTarget}}
===Required Arguments===
*'''theMarker:''' The marker to set the target of
*'''x:''' The x axis of the coordinate to target the marker at
*'''y:''' The y axis of the coordinate to target the marker at
*'''z:''' The z axis of the coordinate to target the marker at

===Returns===
Returns ''true'' if target was set, ''false'' otherwise.

==Example==
Creates a marker in the center of the map and points it north.
<syntaxhighlight lang="lua">
local marker = createMarker(0,0,0,"ring",7,255,0,0,255) --Creates a marker
setMarkerTarget(marker,3000,0,0) --Face the marker north
</syntaxhighlight>

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

Utf8.widthindex

2021-02-17T14:27:17Z

Toliak: /* Syntax */ function is withindex

__NOTOC__
{{Shared function}}

Returns the location, offset and width of the character at the given location in the UTF-8 string.

==Syntax==
<syntaxhighlight lang="lua">int, int, int utf8.widthindex ( string input, int location [, bool ambi_is_double = false, int default_width = 0 ] )</syntaxhighlight>

===Required Arguments===
*'''input:''' A string character sequence

===Optional Arguments===
{{OptionalArg}}
*'''ambi_is_double:''' A boolean, if set to ''true'', ambiguous character's width is 2 (see example).
*'''default_width:''' An integer, if given, is used as width for unprintable characters.

===Returns===
Returns the given location, the offset in UTF-8 encoding (if cursor is in the middle of the wide char - offset will be 2) and the width of the character, otherwise only the location as ''integer'' will be returned.

==Example==
<section name="Server" class="server" show="true">
This example
<syntaxhighlight lang="lua">
local input = "днём"
local raw_width = utf8.width( input, true )

for location = 1, raw_width do
print( utf8.widthindex( input, location, true ) )
end
</syntaxhighlight>
Output ''(enhanced, not raw)'':
{| class="prettytable" style="width:20%;text-align:center;"
|-
! Character || Location || Offset || Width
|-
| д || 1 || 1 || 2
|-
| д || 1 || 2 || 2
|-
| н || 2 || 1 || 2
|-
| н || 2 || 2 || 2
|-
| ё || 3 || 1 || 2
|-
| ё || 3 || 2 || 2
|-
| м || 4 || 1 || 2
|-
| м || 4 || 2 || 2
|}
</section>

==See Also==
{{UTF8 functions}}

SetLightRadius

2021-02-15T20:28:51Z

Toliak: anywhere else "light" start from lowercase letter

__NOTOC__
{{Client function}}

{{New feature/item|3.0150|1.5.0|7048|
This function sets the radius for a [[Element/Light|light]] element.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool setLightRadius ( light theLight, float radius )
</syntaxhighlight>
{{OOP||[[light]]:setRadius|radius|getLightRadius}}

===Required Arguments===
*'''theLight:''' The [[Element/Light|light]] that you wish to set the radius of.

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

===Example===
<syntaxhighlight lang="lua">
local light = createLight(0, 2, 3, 4)
addCommandHandler("setradiusoflight",
function(cmd, radius)
if radius then
if tonumber(radius) > 0 then
setLightRadius(light, tonumber(radius))
else
outputChatBox("Radius must be greater than 0.")
end
else
outputChatBox("You must specify a radius.")
end
end
)</syntaxhighlight>

==See also==
{{Client_light_functions}}

SetPedEnterVehicle

2021-02-15T19:59:19Z

Toliak: Syntax with types

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20740|This function makes a [[ped]] enter a [[vehicle]], similar to the enter_exit control state.}}

{{Note|For this function to work on peds, the server and all clients are required to be on version '''1.5.8 r20740''' or newer.}}
{{Note|This function only works on synced peds and vehicles (ie. created serverside).}}

==Syntax==
<syntaxhighlight lang="lua">
bool setPedEnterVehicle ( ped thePed [, vehicle theVehicle = nil, bool passenger = false ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' The [[player]] or [[ped]] to enter the vehicle.
**''Note: The player must be the local player.''
**''Note: The ped must be synced by the client. Use [[isElementSyncer]] clientside to check if the client is syncing. Use [[setElementSyncer]] serverside to change the syncer manually.''
*'''vehicle:''' The [[vehicle]] to enter. If no vehicle is set, the ped will enter the nearest vehicle within 20 m.
*'''passenger:''' If set to ''true'', the ped will enter as passenger in the nearest available seat, otherwise he will enter as driver.

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

When this function returns ''true'', the client will ask server for permission to enter a vehicle. Actually entering can still fail in the following cases
*The function is used on a ped, but another client is not on version '''1.5.8 r20740''' or newer.
*Another player or ped is already entering, exiting or jacking the same vehicle and seat.
*Movement input or damage can interrupt the task. Use [[getPedTask]] to monitor what the ped is doing.

This function returns ''false'' in the following cases
*Invalid arguments were parsed.
*The function is used on a ped, but the server is not on version '''1.5.8 r20740''' or newer.
*Time passed since last enter/exit for this ped is less than 1500 ms.
*[[onClientVehicleStartEnter]] was cancelled by a script.
*The ped has an active TASK_PRIMARY [[task]]. Use [[getPedTask]] to monitor what the ped is doing.

==Example==
Make ped Sweet enter his car
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
local sweet = createPed(270, 0, 0, 3)
setElementID(sweet , 'sweet')

local sweets_car = createVehicle(492, 3, 0, 3)
setElementID(sweets_car, 'sweets_car')
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
-- Code works only if client is syncing ped Sweet
addCommandHandler('sweet_enter_car',
function()
local sweet = getElementByID('sweet')

if isElementSyncer(sweet) then
setPedEnterVehicle(sweet, getElementByID('sweets_car'), true)
end
end)
</syntaxhighlight>
</section>

==See Also==
{{Client ped functions}}

GetChatboxLayout

2021-02-15T08:20:49Z

Toliak:

__NOTOC__
{{Client function}}
Returns information about how the chatbox looks.

These values come from the file called: [[Chatboxpresets.xml]] but it depends on what type of preset you currently have, which is chosen from your settings in the 'Interface' tab.

==Syntax==
<syntaxhighlight lang="lua">bool|int|table getChatboxLayout ( [ string CVar ] )</syntaxhighlight>

===Optional Arguments===
*'''CVar:''' the name of the property you want returned. Can be the following values:
**'''chat_font''' - Returns the chatbox font
**'''chat_lines''' - Returns how many lines the chatbox has
**'''chat_color''' - Returns the background color of the chatbox
**'''chat_text_color''' - Returns the chatbox text color
**'''chat_input_color''' - Returns the background color of the chatbox input
**'''chat_input_prefix_color''' - Returns the color of the input prefix text
**'''chat_input_text_color''' - Returns the color of the text in the chatbox input
**'''chat_scale''' - Returns the scale of the text in the chatbox
**'''chat_position_offset_x''' - Returns the x position offset setting
**'''chat_position_offset_y''' - Returns the y position offset setting
**'''chat_position_horizontal''' - Returns the horizontal alignment setting
**'''chat_position_vertical''' - Returns the vertical alignment setting
**'''chat_text_alignment''' - Returns the text alignment setting
**'''chat_width''' - Returns the scale of the background width
**'''chat_css_style_text''' - Returns whether text fades out over time
**'''chat_css_style_background''' - Returns whether the background fades out over time
**'''chat_line_life''' - Returns how long it takes for text to start fading out
**'''chat_line_fade_out''' - Returns how long takes for text to fade out
**'''chat_use_cegui''' - Returns whether CEGUI is used to render the chatbox
**'''text_scale''' - Returns text scale

===Returns===
*4 numbers if the CVar contains "color"
*2 numbers if '''chat_scale''' was entered
*1 number if any other CVar was specified
*a table of all CVar values, if CVar was not specified
*''false'' if an invalid CVar was specified

==Example==
This code makes the chatbox empty when you type /clear
<syntaxhighlight lang="lua" category="client">
addCommandHandler("clear",
function ()
local lines = getChatboxLayout()["chat_lines"]
for i = 1, lines do
outputChatBox("")
end
end
)
</syntaxhighlight>

This code makes the chatbox empty when you type /clear, but with a cleaner code
<syntaxhighlight lang="lua" category="client">
addCommandHandler("clear",
function ()
outputChatbox(('\n'):rep(getChatboxLayout("chat_lines")));
end
)
</syntaxhighlight>

==See Also==
{{GUI_functions}}
{{GUI_events}}

AddVehicleSirens

2021-02-14T19:35:55Z

Toliak: Number in the start of variable name looks not cool

__NOTOC__
{{Server function}}
{{New feature/item|3.0130|1.3.0|3968|
This function adds sirens to a vehicle.
}}

==Syntax==
<syntaxhighlight lang="lua">
bool addVehicleSirens ( vehicle theVehicle, int sirenCount, int sirenType [, bool flag360 = false, bool checkLosFlag = true, bool useRandomiser flag = true, bool silentFlag = false ] )
</syntaxhighlight>
{{OOP||[[vehicle]]:addSirens}}
===Required Arguments===
*'''theVehicle:''' The vehicle to add sirens
*'''sirenCount:''' The amount of siren points on the vehicle (8 maximum)
*'''sirenType:''' An integer between 1 and 6 (1: invisible, 2: single, 3+: dual)

===Optional Arguments===
*'''flag360:''' Visible from all directions (applies to single type only)
*'''checkLosFlag:''' Check line of sight between camera and light so it won't draw if blocked
*'''useRandomiser:''' Randomise the light order, false for sequential
*'''silentFlag:''' If you want the siren to be silent set this to true

===Returns===
Returns ''true'' if sirens were successfully added to the vehicle, ''false'' otherwise.

==Example==
This example adds a vehicle siren on entering a vehicle and removes a vehicle siren on exiting. (TESTED!)
<syntaxhighlight lang="lua">addEventHandler("onVehicleEnter", root, function(player, seat)
if (player) and (seat == 0) then
addVehicleSirens(source, 1, 2)
end
end)

addEventHandler("onVehicleExit", root, function(player, seat)
if (player) and (seat == 0) then
removeVehicleSirens(source)
end
end)
</syntaxhighlight>

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

==See Also==
{{Vehicle_functions}}

GetVehicleRespawnRotation

2021-02-14T18:37:48Z

Toliak: There are no commas in return types in other function syntax section

{{Server function}}
__NOTOC__
{{New feature/item|3.0156|1.5.5|14053|This function retrieves the respawn rotation of a [[vehicle]].}}

==Syntax==
<syntaxhighlight lang="lua">
float float float getVehicleRespawnRotation ( element theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getRespawnRotation|respawnRotation}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] which you'd like to retrieve the respawn rotation of.

===Returns===
Returns three [[float|floats]] indicating the respawn rotation of the [[vehicle]], ''x'', ''y'' and ''z'' respectively.

==Example==
{{Example}}

==See Also==
{{Vehicle_functions}}

GetVehicleRespawnPosition

2021-02-14T18:36:52Z

Toliak: There are no commas in return types in other function syntax section

{{Server function}}
__NOTOC__
{{New feature/item|3.0156|1.5.5|14053|This function retrieves the respawn coordinates of a [[vehicle]].}}

==Syntax==
<syntaxhighlight lang="lua">
float float float getVehicleRespawnPosition ( element theVehicle )
</syntaxhighlight>
{{OOP||[[vehicle]]:getRespawnPosition|respawnPosition|setVehicleRespawnPosition}}

===Required Arguments===
*'''theVehicle:''' The [[vehicle]] which you'd like to retrieve the respawn coordinates of.

===Returns===
Returns three [[float|floats]] indicating the respawn coordinates of the [[vehicle]], ''x'', ''y'' and ''z'' respectively.

==Example==
This example outputs the player's current vehicle respawn position.
<syntaxhighlight lang="lua">
function getRespawnPosition(plr)
if (not plr) then
return false
end
local veh = getPedOccupiedVehicle(plr)
if (not veh) then
return false
end
local x, y, z = getVehicleRespawnPosition(veh)
return x, y, z
end
</syntaxhighlight>

==See Also==
{{Vehicle_functions}}

XmlNodeGetName

2021-02-12T19:40:46Z

Toliak: Moved Example header to upper layer

__NOTOC__
{{Server client function}}
Gets the tag name of the specified XML node.

==Syntax==
<syntaxhighlight lang="lua">
string xmlNodeGetName ( xmlnode node )
</syntaxhighlight>
{{OOP||[[xmlnode]]:getName|name|xmlNodeSetName}}
===Required Arguments===
*'''node:''' the node to get the tag name of.

===Returns===
Returns the tag name of the node if successful, ''false'' otherwise.

==Example==
<section name="Example 1" class="both" show="true">
<syntaxhighlight lang="lua">
local xml = xmlCreateFile("test.xml","test")
local xmlNode = xmlCreateChild(xml,"nextTest")
local xmlNodeName = xmlNodeGetName(xmlNode)
xmlUnloadFile(xml)
outputConsole(xmlNodeName) --This should output "nextTest".
</syntaxhighlight>
</section>

==See Also==
{{XML functions}}
[[ru:xmlNodeGetName]]

SetPedCameraRotation

2021-02-12T18:42:28Z

Toliak:

{{Client function}}
__NOTOC__
{{Note|[[getPedCameraRotation]] may not return the value set by this function. Please refer to [[getPedCameraRotation]] for details.}}
This function sets the camera rotation of a ped, e.g. where its camera will look at. Don't confuse this with [[getCameraMatrix]], because that function is designed for fixed (scripted) camera moves.

==Syntax==
<syntaxhighlight lang="lua">
bool setPedCameraRotation ( ped thePed, float cameraRotation )
</syntaxhighlight>
{{OOP||[[ped]]:setCameraRotation|cameraRotation|getPedCameraRotation}}

===Required Arguments===
*'''thePed:''' The [[ped]] whose camera rotation is to be changed.
*'''cameraRotation:''' The new direction that the ped will walk if you set their forwards control state. If the ped is the local player, it will also change where his camera is looking at if it isn't fixed (i.e. camera target is the local player).

===Returns===
Returns ''true'' if the camera rotation was changed, ''false'' otherwise.

==Example==

The next code snippet adds a command called /rotatecam, which rotates the camera of the player who uses it.
<syntaxhighlight lang="lua">
function rotateLocalPlayerCamera()
--setPedCameraRotation(localPlayer, getPedCameraRotation(localPlayer) + 45) -- This would work if getPedCameraRotation returned non-transformed angles
setPedCameraRotation(localPlayer, -(getPedCameraRotation(localPlayer) + 45)) -- Tranform the angle returned and then add 45º to it
outputChatBox("Your camera was rotated 45 degrees counter clockwise.", 0, 255, 0)
end
addCommandHandler("rotatecam", rotateLocalPlayerCamera)
</syntaxhighlight>

==See Also==
{{Client ped functions}}

IsElementLowLOD

2021-02-12T18:27:11Z

Toliak: Add Example header

__NOTOC__
{{Server client function}}
This function reveals if an element is low LOD.

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

===Required Arguments===
*'''theElement:''' The [[element]] whose low LOD status we want to get.

===Returns===
Returns ''true'' if the element is low LOD, ''false'' otherwise.

==Example==
<section name="Clientside" class="client" show="true">
This example will show how many low lods objects is around you.
<syntaxhighlight lang="lua">
addCommandHandler("lowlod",function ()
local lowlods = 0
for i, obj in ipairs(getElementsByType("object",root,true)) do
if isElementLowLOD(obj) then
lowlods = lowlods + 1
end
end
outputChatBox("Was found "..lowlods.." lowlod objects around you.",255,255,0)
end)
</syntaxhighlight>
</section>

<section name="Serverside" class="server" show="false">
This example will show how many low lods objects is around all the world.
<syntaxhighlight lang="lua">
addCommandHandler("lowlod",function ()
local lowlods = 0
for i, obj in ipairs(getElementsByType("object")) do
if isElementLowLOD(obj) then
lowlods = lowlods + 1
end
end
outputChatBox("Was found "..lowlods.." lowlod objects around you.",root,255,255,0)
end)
</syntaxhighlight>
</section>

==Requirements==
{{Requirements|1.2|1.2}}
==See Also==
{{Element_functions}}

GetCameraInterior

2021-02-12T17:54:04Z

Toliak: Format fix

__NOTOC__
{{Server client function}}
Returns the interior of the local camera (independent of the interior of the local player).

==Procedural==
===Syntax===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
int getCameraInterior ( player thePlayer )
</syntaxhighlight>
{{OOP||[[player]]:getCameraInterior|cameraInterior|setCameraInterior}}

===Required Arguments===
*'''thePlayer''': The player whose camera interior you want to get.
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int getCameraInterior ( )
</syntaxhighlight>
{{OOP||Camera.getInterior|interior|setCameraInterior}}
</section>

===Returns===
Returns an ''integer'' indicating the camera's interior, ''false'' if the argument is invalid.

===Example===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function outputCameraInterior ( player, command )
local interior = getCameraInterior ( player )
outputChatBox ( "The camera is in the interior " .. interior, player, 255, 255, 0 )
end
addCommandHandler ( "camera", outputCameraInterior )
</syntaxhighlight>
</section>

{{New items|3.0140|1.4|
==Object-oriented==
===Syntax===
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
int player:getCameraInterior ( )
-- or
int player.cameraInterior -- to get the camera interior value
player.cameraInterior = int someValue -- to set the camera interior value
</syntaxhighlight>
</section>

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
int Camera.getInterior ( )
</syntaxhighlight>
</section>

Returns an ''integer'' indicating the camera's interior, ''false'' if the argument is invalid.

===Example===
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function outputCameraInterior ( command )
local interior = Camera.getInterior ( )
outputChatBox ( "The camera is in the interior " .. interior, localPlayer, 255, 255, 0 )
end
addCommandHandler ( "camera", outputCameraInterior )
</syntaxhighlight>
</section>
}}

==See Also==
{{Camera functions}}

[[hu:getCameraInterior]]
[[RO:getCameraInterior]]

IsSoundLooped

2021-02-12T17:49:33Z

Toliak: Add Example header

__NOTOC__
{{Client function}}
{{New feature/item|3.0160|1.5.8|20785|This function is used to return the current loop option of the [[sound]] [[element]].}}

==Syntax==
<syntaxhighlight lang="lua">bool isSoundLooped(element theSound)</syntaxhighlight>
{{OOP||[[sound]]:isLooped||setSoundLooped}}
===Required Arguments===
*'''theSound:''' The [[sound]] [[element]] which you want to get the loop state.

===Returns===
Returns ''true'' if the [[sound]] [[element]] is seted to loop, ''false'' otherwise.

==Example==
<syntaxhighlight lang="lua">
local mySound
addEventHandler('onClientResourceStart', resourceRoot, function()
mySound = playSound('sound.mp3')
setSoundLooped(mySound, true)
end)

addCommandHandler('loop', function()
if isElement(mySound) then
local newState = not isSoundLooped(mySound)
setSoundLooped(mySound, newState)
if newState then
outputChatBox('The sound will loop...')
else
outputChatBox('The sound will not loop anymore...')
end
end
end)
</syntaxhighlight>

==See Also==
{{Client_audio_functions}}

GetRadioChannel

2021-02-12T17:38:31Z

Toliak: Fixed description language

__NOTOC__
{{Client function}}
The function is used to retrieve the ID of the current radio channel.

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

===Returns===
Returns the ID of the radio channel.
{{SoundID}}

==Example==
This example prints out the name of your current radio station to the chat box.
<syntaxhighlight lang="lua">
addCommandHandler ( "getradio",
function ()
outputChatBox ( "You're currently listening to " .. getRadioChannelName ( getRadioChannel() ) .. "!" )
end
)
</syntaxhighlight>

==See Also==

{{Client_audio_functions}}
[[HU:GetRadioChannel]]
[[AR:getRadioChannel]]
[[RU:GetRadioChannel]]
[[PL:GetRadioChannel]]
[[RO:GetRadioChannel]]