Multi Theft Auto: Wiki - User contributions [en]

OutputServerLog

2017-10-17T14:06:44Z

Developer: /* Example */

{{Server function}}
__NOTOC__
This outputs a line of text to the server's log. This could be useful for debugging.

==Syntax==
<syntaxhighlight lang="lua">
bool outputServerLog ( string text )
</syntaxhighlight>

===Required Arguments===
*'''text:''' The text to be output to the log.

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

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example outputs client logins to the server log.
<syntaxhighlight lang="lua">
function logClientLogin ( previous_account, current_account )
outputServerLog ( "Client " .. getPlayerName ( source ) .. " logged in as " .. getAccountName ( current_account ) )
end
addEventHandler ( "onPlayerLogin", getRootElement(), logClientLogin )
</syntaxhighlight>

'''Example 2:''' This example outputs the clients position to the server
<syntaxhighlight lang="lua">
function outputPosition(source)
outputServerLog( table.concat({getElementPosition(source)}, ", ") )
end
addCommandHandler("op", outputPosition)
</syntaxhighlight>
</section>

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

OutputServerLog

2017-10-16T09:36:58Z

Developer: /* Example */

{{Server function}}
__NOTOC__
This outputs a line of text to the server's log. This could be useful for debugging.

==Syntax==
<syntaxhighlight lang="lua">
bool outputServerLog ( string text )
</syntaxhighlight>

===Required Arguments===
*'''text:''' The text to be output to the log.

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

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example outputs client logins to the server log.
<syntaxhighlight lang="lua">
function logClientLogin ( previous_account, current_account )
outputServerLog ( "Client " .. getPlayerName ( source ) .. " logged in as " .. getAccountName ( current_account ) )
end
addEventHandler ( "onClientLogin", getRootElement(), logClientLogin )
</syntaxhighlight>

'''Example 2:''' This example outputs the clients position to the server
<syntaxhighlight lang="lua">
local function outputPosition(source)
outputServerLog( table.concat({getElementPosition(source)}, ", ") )
end
addCommandHandler("op", outputPosition)
</syntaxhighlight>
</section>

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

OutputServerLog

2017-10-16T09:36:27Z

Developer: /* Example */

{{Server function}}
__NOTOC__
This outputs a line of text to the server's log. This could be useful for debugging.

==Syntax==
<syntaxhighlight lang="lua">
bool outputServerLog ( string text )
</syntaxhighlight>

===Required Arguments===
*'''text:''' The text to be output to the log.

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

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example outputs client logins to the server log.
<syntaxhighlight lang="lua">
function logClientLogin ( previous_account, current_account )
outputServerLog ( "Client " .. getPlayerName ( source ) .. " logged in as " .. getAccountName ( current_account ) )
end
addEventHandler ( "onClientLogin", getRootElement(), logClientLogin )
</syntaxhighlight>

'''Example 2:''' This example outputs the clients position to the server
<syntaxhighlight lang="lua">
function outputPosition(source)
outputServerLog( table.concat({getElementPosition(source)}, ", ") )
end
addCommandHandler("op",outputPosition)
</syntaxhighlight>
</section>

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

OutputServerLog

2017-10-16T09:36:12Z

Developer: /* Example */

{{Server function}}
__NOTOC__
This outputs a line of text to the server's log. This could be useful for debugging.

==Syntax==
<syntaxhighlight lang="lua">
bool outputServerLog ( string text )
</syntaxhighlight>

===Required Arguments===
*'''text:''' The text to be output to the log.

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

==Example==
<section name="Server" class="server" show="true">
'''Example 1:''' This example outputs client logins to the server log.
<syntaxhighlight lang="lua">
function logClientLogin ( previous_account, current_account )
outputServerLog ( "Client " .. getPlayerName ( source ) .. " logged in as " .. getAccountName ( current_account ) )
end
addEventHandler ( "onClientLogin", getRootElement(), logClientLogin )
</syntaxhighlight>

'''Example 2:''' This example outputs the clients position to the server
<syntaxhighlight lang="lua">
function outputPosition(source)
local x,y,z = getElementPosition(source)
outputServerLog( table.concat({getElementPosition(source)}, ", ") )
end
addCommandHandler("op",outputPosition)
</syntaxhighlight>
</section>

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

GetBanFromName

2017-09-22T15:01:17Z

Developer: /* Example */

{{Useful_Function}}
<lowercasetitle/>
__NOTOC__
This function returns the ban of the given playername (if the player got banned) otherwise false.
<br/><br/>'''Important Note:''' Case sensitivity of the playername is important!
<br/>Example: If 'SomeGuy' got banned, and you will try 'someguy' you will get false.

==Syntax==
<syntaxhighlight lang="lua">ban getBanFromName( string playername )</syntaxhighlight>

===Required Arguments===
* '''playername''': The name of the player which got banned.

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function getBanFromName (name)
for key, ban in ipairs(getBans()) do -- for every ban do following
if (getBanNick(ban) == name) then -- if the name of the banned player is equal to our name then
return ban -- return the ban
end
end
return false -- else return false
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example gets the IP of the ban which has been returned from getBanFromName().
<syntaxhighlight lang="lua">
addEventHandler("onPlayerBan", root, function(_, banner)
outputChatBox(("%s has banned %s"):format(getPlayerName(banner), getPlayerName(source)), root, 255, 0, 0)
local ban = getBanFromName( getPlayerName(source) )
local ip = getBanIP(ban) -- Getting the IP of the ban which has been returned from getBanFromName() -- Here you have the ip :)
end)
</syntaxhighlight>
</section>

Author: StiviK

==See Also==
{{Useful_Functions}}

IsElementMoving

2017-09-19T15:57:58Z

Developer: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__

This function checks if an element is moving.

==Syntax==
<syntaxhighlight lang="lua"> bool isElementMoving ( element theElement ) </syntaxhighlight>

===Returns===
Returns true if the element is moving, false otherwise.

===Code===
<syntaxhighlight lang="lua">
function isElementMoving (theElement )
if isElement ( theElement ) then -- First check if the given argument is an element
return Vector3( getElementVelocity( theElement ) ).length ~= 0
end
return false
end
</syntaxhighlight>

===Example===
<section name="Client" class="client" show="true">
This script tells the moving state to the client on the bottom left of their screen.
<syntaxhighlight lang="lua">
local screenWidth, screenHeight = guiGetScreenSize () -- Get the screen resolution (width and height)

function idleCheck ()
local state = "Unknown"
local element = getPedOccupiedVehicle ( localPlayer ) or localPlayer

-- Check whether the player is moving or not.
if isElementMoving ( element ) then
state = "moving"
else
state = "idling"
end

-- Write our state string to the lower left corner of the screen
dxDrawText ( "You are " .. state .. "!", 40, screenHeight - 40, screenWidth, screenHeight, tocolor ( 255, 255, 255, 255 ), 1, "default" )
end

-- Keep the text visible with onClientRender.
addEventHandler ( "onClientRender", root, idleCheck )
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

IsElementMoving

2017-09-19T15:57:46Z

Developer: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__

This function checks if an element is moving.

==Syntax==
<syntaxhighlight lang="lua"> bool isElementMoving ( element theElement ) </syntaxhighlight>

===Returns===
Returns true if the element is moving, false otherwise.

===Code===
<syntaxhighlight lang="lua">
function isElementMoving (theElement )
if isElement ( theElement ) then -- First check if the given argument is an element
local x, y, z = getElementVelocity( theElement )
return Vector3( getElementVelocity( theElement ) ).length ~= 0
end
return false
end
</syntaxhighlight>

===Example===
<section name="Client" class="client" show="true">
This script tells the moving state to the client on the bottom left of their screen.
<syntaxhighlight lang="lua">
local screenWidth, screenHeight = guiGetScreenSize () -- Get the screen resolution (width and height)

function idleCheck ()
local state = "Unknown"
local element = getPedOccupiedVehicle ( localPlayer ) or localPlayer

-- Check whether the player is moving or not.
if isElementMoving ( element ) then
state = "moving"
else
state = "idling"
end

-- Write our state string to the lower left corner of the screen
dxDrawText ( "You are " .. state .. "!", 40, screenHeight - 40, screenWidth, screenHeight, tocolor ( 255, 255, 255, 255 ), 1, "default" )
end

-- Keep the text visible with onClientRender.
addEventHandler ( "onClientRender", root, idleCheck )
</syntaxhighlight>
</section>

==See Also==
{{Useful_Functions}}

GetVehiclesCountByType

2017-09-11T21:43:47Z

Developer: /* Example */

GetVehiclesCountByType

2017-09-11T21:40:52Z

Developer: /* Example 2 */

GetVehiclesCountByType

2017-09-11T21:40:07Z

Developer: /* Example */

__NOTOC__
{{Useful Function}}
This function returns the amount of vehicles by the given type (see [[GetVehicleType]]) as an integer value.

===Authors===
* '''EnternalEnvy''': Original code and idea
* '''Necktrox''': Code quality and performance edits

==Syntax==
<syntaxhighlight lang="lua">
int getVehiclesCountByType ( string vehicleType )
</syntaxhighlight>

===Required arguments===
* '''vehicleType''': The vehicle type string (see list below).

===Vehicle type list===
{{VehicleTypes}}

===Return===
Returns an ''integer'' with the count of the vehicles with the type (returns ''0'' if the type is not supported), otherwise returns ''nil''.

==Code==
<section name="Function source" class="both" show="true">
<syntaxhighlight lang="lua">
function getVehiclesCountByType(vehicleType)
assert(type(vehicleType) == "string", "expected string at argument 1, got ".. type(vehicleType))

local getVehicleType = getVehicleType -- Localize
local vehicleList = getElementsByType("vehicle")
local vehicleCount = #vehicleList
local typeCount = 0

for index = 1, vehicleCount do
if getVehicleType(vehicleList[index]) == vehicleType then
typeCount = typeCount + 1
end
end

return typeCount
end
</syntaxhighlight>
</section>

==Example==
<section name="Server" class="server" show="true">
This example writes the amount of each vehicle type into the server log every minute.
<syntaxhighlight lang="lua">
local types = {
"Automobile",
"Plane",
"Bike",
"Helicopter",
"Boat",
"Train",
"Trailer",
"BMX",
"Monster Truck",
"Quad"
}

function outputVehicleCountToServerLog()
for index, typeName in ipairs(types) do
local count = getVehiclesCountByType(typeName)
outputServerLog(("Amount of '%s' vehicles: %d"):format(typeName, count))
end
end

addEventHandler("onResourceStart", resourceRoot,
function ()
outputVehicleCountToServerLog()
setTimer(outputVehicleCountToServerLog, 6e4, 0)
end,
false)
</syntaxhighlight>
</section>

==Example 2==
<section name="Server" class="server" show="true">
This example writes the amount of vehicles on the specified type, and sends the results to the server console.
<syntaxhighlight lang="lua">
function getVehiclesCountByType(vehicleType)
assert(type(vehicleType) == "string", "expected string at argument 1, got ".. type(vehicleType))

local getVehicleType = getVehicleType -- Localize
local vehicleList = getElementsByType("vehicle")
local vehicleCount = #vehicleList
local typeCount = 0

for index = 1, vehicleCount do
if getVehicleType(vehicleList[index]) == vehicleType then
typeCount = typeCount + 1
end
end

return typeCount
end

function IfElse(condition, resultTrue, resultFalse)
if (not condition) then
return resultFalse
else
return resultTrue
end
end

local stringType = { ["Automobile"] = true,
["Plane"] = true,
["Bike"] = true,
["Helicopter"] = true,
["Boat"] = true,
["Train"] = true,
["Trailer"] = true,
["BMX"] = true,
["Monster Truck"] = true,
["Quad"] = true
}

addCommandHandler("amountvehicle", function(aElement, commandName, typevehicle)
if (getElementType(aElement) == "console") then
if (type(typevehicle) ~= "string") or (tostring(typevehicle) == nil) or (tostring(typevehicle) == "") or (string.len(typevehicle) < 3) then
outputServerLog("Correct syntax: amountvehicle <Type Vehicle>")
return
end
if stringType[tostring(typevehicle)] then
outputServerLog(("[Vehicles By Type - '%s'] - "..IfElse(getVehiclesCountByType(typevehicle) < 1, " Not found!", "Found '%s'")):format(typevehicle, getVehiclesCountByType(typevehicle)))
else
outputServerLog("#ERROR! The entered this syntax - '"..tostring(typevehicle).."' isn't correct")
end
end
end)
</syntaxhighlight>
</section>

==See also==
{{Useful Functions}}

IsPlayerInACL

2017-09-03T12:51:41Z

Developer: /* Code */

{{Useful Function}}
__NOTOC__
This function returns true if the player is in the ACL group, false if otherwise.<br>

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInACL ( player thePlayer, string ACLGroup )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player element that you want to check
* '''ACLGroup''': The name of the ACL group that you want to check

'''Important Note''': This function will only work on the server-side.

===Returns===
Returns true if the player's account is in the ACL, false if otherwise.

==Code==
<syntaxhighlight lang="lua">
function isPlayerInACL(player, acl)
local accountName = getAccountName( getPlayerAccount(player) )
if accountName ~= "guest" and type( aclGetGroup(acl) ) == "userdata" then
return isObjectInACLGroup( "user."..accountName, aclGetGroup(acl) )
end
return false
end
</syntaxhighlight>

==Example==
This is an example of the function.
<syntaxhighlight lang="lua">function checkAccess(thePlayer)
if isPlayerInACL(thePlayer, "Console") then
outputChatBox("Access Granted!")
else
outputChatBox("Access Denied!")
end
end
addCommandHandler("myaccess", checkAccess)</syntaxhighlight>
<br>
xXMADEXx <br>

==See Also==
{{Useful_Functions}}

IsPlayerInACL

2017-09-02T19:08:59Z

Developer: /* Example */

{{Useful Function}}
__NOTOC__
This function returns true if the player is in the ACL group, false if otherwise.<br>

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInACL ( player thePlayer, string ACLGroup )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player element that you want to check
* '''ACLGroup''': The name of the ACL group that you want to check

'''Important Note''': This function will only work on the server-side.

===Returns===
Returns true if the player's account is in the ACL, false if otherwise.

==Code==
<syntaxhighlight lang="lua">
function isPlayerInACL(player, acl)
local accountName = getAccountName( getPlayerAccount(player) )
if accountName ~= "guest" then
return isObjectInACLGroup( "user."..accountName, aclGetGroup(acl) )
end
return false
end
</syntaxhighlight>

==Example==
This is an example of the function.
<syntaxhighlight lang="lua">function checkAccess(thePlayer)
if isPlayerInACL(thePlayer, "Console") then
outputChatBox("Access Granted!")
else
outputChatBox("Access Denied!")
end
end
addCommandHandler("myaccess", checkAccess)</syntaxhighlight>
<br>
xXMADEXx <br>

==See Also==
{{Useful_Functions}}

IsPlayerInACL

2017-09-02T19:07:48Z

Developer: /* Code */

{{Useful Function}}
__NOTOC__
This function returns true if the player is in the ACL group, false if otherwise.<br>

==Syntax==
<syntaxhighlight lang="lua">bool isPlayerInACL ( player thePlayer, string ACLGroup )</syntaxhighlight>

===Required Arguments===
* '''thePlayer''': The player element that you want to check
* '''ACLGroup''': The name of the ACL group that you want to check

'''Important Note''': This function will only work on the server-side.

===Returns===
Returns true if the player's account is in the ACL, false if otherwise.

==Code==
<syntaxhighlight lang="lua">
function isPlayerInACL(player, acl)
local accountName = getAccountName( getPlayerAccount(player) )
if accountName ~= "guest" then
return isObjectInACLGroup( "user."..accountName, aclGetGroup(acl) )
end
return false
end
</syntaxhighlight>

==Example==
This is an example of the function.
<syntaxhighlight lang="lua">function checkAccess(thePlayer)
if isPlayerInACL(thePlayer, "Console") then
outputChatBox("Access Granted!")
else
outputChatBox("Access Denied!")
end
end
addCommandHandler("myaccess", checkAccess)</syntaxhighlight>
<br>
xXMADEXx <br>

==See Also==
{{Useful_Functions}}

RenameAclGroup

2017-09-02T19:01:18Z

Developer: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is used to rename an [[Aclgroup|ACL group]].

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup ( string old, string new )</syntaxhighlight>

==Required Arguments==
* '''old:''' name of the ACL group you want to change
* '''new:''' the name we want the group to be changed to

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

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup(oldACLName, newACLName)
if oldACLName == nil then
error( "Bad argument @ 'renameAclGroup' [Expected string at argument 1, got "..type(oldACLName).."]")
return false
end
if newACLName == nil then
error( "Bad argument @ 'renameAclGroup' [Expected string at argument 2, got "..type(newACLName).."]")
return false
end
local oldACLGroup = aclGetGroup(oldACLName)
if type(oldACLGroup) ~= "userdata" then
error("Bad argument 1 @ renameAclGroup [ no acl group found with this name ]")
return false
end
local oldACL = aclGroupListACL(oldACLGroup)
local oldObjects = aclGroupListObjects(oldACLGroup)
local newACLGroup = aclCreateGroup(newACLName)
if newACLGroup == false and aclGetGroup(newACLName) then
error("Bad argument 2 @ renameAclGroup [ there is already a group with this name ]")
return false
end
aclGroupAddACL( newACLGroup, unpack(oldACL) )
aclGroupAddObject( newACLGroup, unpack(oldObjects) )
aclDestroyGroup(oldACLGroup)
aclSave()
aclReload()
return true
end
</syntaxhighlight>
</section>

*Original author: ''Has[S]oN''
*Skype: ''hassan.saad2000''

*Code quality and performance edits by: ''Developer''

==Example==
This example changes a group named ''Moderator'' to ''HassoN'' when the script is loaded.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", resourceRoot,
function( )
renameAclGroup( "Moderator", "HassoN" )
end
)
</syntaxhighlight>
</section>

==See also==
{{Useful Functions}}

RenameAclGroup

2017-09-02T18:58:16Z

Developer: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is used to rename an [[Aclgroup|ACL group]].

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup ( string old, string new )</syntaxhighlight>

==Required Arguments==
* '''old:''' name of the ACL group you want to change
* '''new:''' the name we want the group to be changed to

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

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup(oldACLName, newACLName)
if oldACLName == nil then
error( "Bad argument @ 'renameAclGroup' [Expected string at argument 1, got "..type(oldACLName).."]")
return false
end
if newACLName == nil then
error( "Bad argument @ 'renameAclGroup' [Expected string at argument 2, got "..type(newACLName).."]")
return false
end
local oldACLGroup = aclGetGroup(oldACLName)
if type(oldACLGroup) ~= "userdata" then
error("Bad argument 1 @ renameAclGroup [ no acl group found with this name ]")
return false
end
local oldACL = aclGroupListACL(oldACLGroup)
local oldObjects = aclGroupListObjects(oldACLGroup)
local newACLGroup = aclCreateGroup(newACLName)
if newACLGroup == false then
error("Bad argument 2 @ renameAclGroup [ there is already a group with this name ]")
return false
end
aclGroupAddACL( newACLGroup, unpack(oldACL) )
aclGroupAddObject( newACLGroup, unpack(oldObjects) )
aclDestroyGroup(oldACLGroup)
aclSave()
aclReload()
return true
end
</syntaxhighlight>
</section>

*Original author: ''Has[S]oN''
*Skype: ''hassan.saad2000''

*Code quality and performance edits by: ''Developer''

==Example==
This example changes a group named ''Moderator'' to ''HassoN'' when the script is loaded.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", resourceRoot,
function( )
renameAclGroup( "Moderator", "HassoN" )
end
)
</syntaxhighlight>
</section>

==See also==
{{Useful Functions}}

RenameAclGroup

2017-09-02T15:01:27Z

Developer: /* Code */

{{Useful Function}}
<lowercasetitle/>
__NOTOC__
This function is used to rename an [[Aclgroup|ACL group]].

==Syntax==
<syntaxhighlight lang="lua">bool renameAclGroup ( string old, string new )</syntaxhighlight>

==Required Arguments==
* '''old:''' name of the ACL group you want to change
* '''new:''' the name we want the group to be changed to

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

==Code==
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function renameAclGroup(oldACLName, newACLName)
if oldACLName and type(oldACLName) == "string" and newACLName and type(newACLName) == "string" then
if aclGetGroup(newACLName) then
outputDebugString("Bad argument 2 @ renameAclGroup [ there is already a group with this name ]", 2)
return false
end
local oldACLGroup = aclGetGroup(oldACLName)
local oldACL = aclGroupListACL(oldACLGroup)
local oldObjects = aclGroupListObjects(oldACLGroup)
local newACLGroup = aclCreateGroup(newACLName)
aclGroupAddACL( newACLGroup, unpack(oldACL) )
aclGroupAddObject( newACLGroup, unpack(oldObjects) )
aclDestroyGroup(oldACLGroup)
aclSave()
aclReload()
return true
end
return false
end
</syntaxhighlight>
</section>

*Original author: ''Has[S]oN''
*Skype: ''hassan.saad2000''

*Code quality and performance edits by: ''Developer''

==Example==
This example changes a group named ''Moderator'' to ''HassoN'' when the script is loaded.

<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
addEventHandler( "onResourceStart", resourceRoot,
function( )
renameAclGroup( "Moderator", "HassoN" )
end
)
</syntaxhighlight>
</section>

==See also==
{{Useful Functions}}

CreateEffect

2017-08-21T03:22:09Z

Developer: /* Example */

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

===Required Arguments===
*'''name:''' A string contains [[Element/Effect#Effects_list|effect name]].
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rX:''' A floating point number representing the rotation about the X axis in degrees.
*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.
{{New items|3.06892|1.4|
*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
|6892}}

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

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

--There are 82 effects

local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}

addCommandHandler("createEffect", function(_, effectIndex)
effectIndex = tonumber(effectIndex)
if effectIndex and type(effectIndex) == "number" then
if effectIndex > 0 and effectIndex <= #effectNames then
createEffect(effectNames[effectIndex], Vector3( getElementPosition( getLocalPlayer() ) ), 0, 0, 0)
end
end
end)

--Example Command: /createEffect 3

</syntaxhighlight>

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

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

CreateEffect

2017-08-21T03:21:15Z

Developer: /* Example */

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

===Required Arguments===
*'''name:''' A string contains [[Element/Effect#Effects_list|effect name]].
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rX:''' A floating point number representing the rotation about the X axis in degrees.
*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.
{{New items|3.06892|1.4|
*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
|6892}}

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

==Example==
<syntaxhighlight lang="lua">
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}

addCommandHandler("createEffect", function(_, effectIndex)
effectIndex = tonumber(effectIndex)
if effectIndex and type(effectIndex) == "number" then
if effectIndex > 0 and effectIndex <= #effectNames then
createEffect(effectNames[effectIndex], Vector3( getElementPosition( getLocalPlayer() ) ), 0, 0, 0)
end
end
end)

--Example Command: /createEffect 3

</syntaxhighlight>

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

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

CreateEffect

2017-08-21T03:19:48Z

Developer: /* Example */

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

===Required Arguments===
*'''name:''' A string contains [[Element/Effect#Effects_list|effect name]].
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rX:''' A floating point number representing the rotation about the X axis in degrees.
*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.
{{New items|3.06892|1.4|
*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
|6892}}

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

==Example==
<syntaxhighlight lang="lua">
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}

addCommandHandler("createEffect", function(_, effectIndex)
effectIndex = tonumber(effectIndex)
if effectIndex and type(effectIndex) == "number" then
if effectIndex > 0 and effectIndex < 83 then
createEffect(effectNames[effectIndex], Vector3( getElementPosition( getLocalPlayer() ) ), 0, 0, 0)
end
end
end)

--Example Command: /createEffect 3

</syntaxhighlight>

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

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

CreateEffect

2017-08-21T03:18:44Z

Developer: /* Example */

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

===Required Arguments===
*'''name:''' A string contains [[Element/Effect#Effects_list|effect name]].
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rX:''' A floating point number representing the rotation about the X axis in degrees.
*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.
{{New items|3.06892|1.4|
*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
|6892}}

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

==Example==
<syntaxhighlight lang="lua">
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}

addCommandHandler("createEffect", function(_, effectIndex)
effectIndex = tonumber(effectIndex)
if effectIndex and type(effectIndex) == "number" then
if effectIndex > 0 and effectIndex < 83 then
createEffect(effectNames[tonumber(effectIndex)], Vector3( getElementPosition( getLocalPlayer() ) ), 0, 0, 0)
end
end
end)

--Example Command: /createEffect 3

</syntaxhighlight>

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

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

CreateEffect

2017-08-21T03:17:42Z

Developer: /* Example */

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

===Required Arguments===
*'''name:''' A string contains [[Element/Effect#Effects_list|effect name]].
*'''x:''' A floating point number representing the X coordinate on the map.
*'''y:''' A floating point number representing the Y coordinate on the map.
*'''z:''' A floating point number representing the Z coordinate on the map.

===Optional Arguments===
{{OptionalArg}}
*'''rX:''' A floating point number representing the rotation about the X axis in degrees.
*'''rY:''' A floating point number representing the rotation about the Y axis in degrees.
*'''rZ:''' A floating point number representing the rotation about the Z axis in degrees.
{{New items|3.06892|1.4|
*'''drawDistance:''' A floating point number between 1 and 8191 which represents the draw distance of the effect, or 0 to use the default draw distance.
|6892}}

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

==Example==
<syntaxhighlight lang="lua">
local effectNames = {
"blood_heli","boat_prop","camflash","carwashspray","cement","cloudfast","coke_puff","coke_trail","cigarette_smoke",
"explosion_barrel","explosion_crate","explosion_door","exhale","explosion_fuel_car","explosion_large","explosion_medium",
"explosion_molotov","explosion_small","explosion_tiny","extinguisher","flame","fire","fire_med","fire_large","flamethrower",
"fire_bike","fire_car","gunflash","gunsmoke","insects","heli_dust","jetpack","jetthrust","nitro","molotov_flame",
"overheat_car","overheat_car_electric","prt_blood","prt_boatsplash","prt_bubble","prt_cardebris","prt_collisionsmoke",
"prt_glass","prt_gunshell","prt_sand","prt_sand2","prt_smokeII_3_expand","prt_smoke_huge","prt_spark","prt_spark_2",
"prt_splash","prt_wake","prt_watersplash","prt_wheeldirt","petrolcan","puke","riot_smoke","spraycan","smoke30lit","smoke30m",
"smoke50lit","shootlight","smoke_flare","tank_fire","teargas","teargasAD","tree_hit_fir","tree_hit_palm","vent","vent2",
"water_hydrant","water_ripples","water_speed","water_splash","water_splash_big","water_splsh_sml","water_swim","waterfall_end",
"water_fnt_tme","water_fountain","wallbust","WS_factorysmoke"
}

addCommandHandler("createEffect", function(_, effectIndex)
effectIndex = tonumber(effectIndex)
if effectIndex and type(effectIndex) == "number" then
if effectIndex > 0 and effectIndex < 83 then
local effectPosition = Vector3( getElementPosition( getLocalPlayer() ) )
createEffect(effectNames[tonumber(effectIndex)], effectPosition.x, effectPosition.y, effectPosition.z, 0, 0, 0)
end
end
end)

--Example Command: /createEffect 3

</syntaxhighlight>

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

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

SetPedLookAt

2017-08-19T19:34:28Z

Developer: /* Example */

__NOTOC__
{{Client function}}
{{Note|Avoid calling setPedLookAt every frame as this can cause bugs like being invincible to burning.}}
{{Note|For remote players, you have to use [https://wiki.multitheftauto.com/wiki/SetPedAimTarget setPedAimTarget] before setPedLookAt.}}
Makes a ped turn his head and look at a specific world position or element.
==Syntax==
<syntaxhighlight lang="lua">
bool setPedLookAt ( ped thePed, float x, float y, float z [, int time = 3000 [, int blend = 1000 ], element target = nil ] )
</syntaxhighlight>

===Required Arguments===
*'''thePed:''' the ped to change the lookat of.
*'''x:''' the x coordinate of the world position to look at.
*'''y:''' the y coordinate of the world position to look at.
*'''z:''' the z coordinate of the world position to look at.

===Optional Arguments===
*'''time:''' the time, in milliseconds, during which the ped will look at the target. Once this time has elapsed, he will look ahead again like before the function was applied. A time of 0 will immediately stop any lookat. A negative time will make the ped look at the target indefinitely.
*'''blend:''' the time, in milliseconds, during which the look will blend.
*'''target:''' if this argument is specified, the position arguments will be ignored and the ped's gaze will follow the specified element instead. Can be a player, a vehicle, another ped etc.

==Example==
This example makes the local player look at where the camera points at. If you want to sync this effect with other players you can use [[triggerLatentServerEvent]] and [[triggerLatentClientEvent]] functions.
<syntaxhighlight lang="lua">
local screenSize = Vector2( guiGetScreenSize() )

setTimer(
function()
setPedLookAt(getLocalPlayer(), Vector3( getWorldFromScreenPosition(screenSize.x/2, screenSize.y/2, 45) ), -1, 0)
end
, 50, 0)
</syntaxhighlight>

== Issues ==
{{Issues|
{{Issue|4325|setPedLookAt does not work for remote players}}
}}
==See Also==
{{Client ped functions}}