Multi Theft Auto: Wiki - User contributions [en]

EngineLoadIFP

2018-07-22T15:34:27Z

GTX: Added raw data parameter

{{Client function}}
__NOTOC__
{{New feature/item|3.0156|1.5.5|12195|
This function loads an animation library (IFP) file into GTA with a custom block name. All three IFP formats are supported ANPK, ANP2, and ANP3. Unfortunately, GTA 3 animations are not supported, however, you can load GTA:VC IFP files using this function. You don't have to replace any animation to play a custom one, to play a custom animation, load the IFP file using this function, then use [[SetPedAnimation|setPedAnimation]].

If you wish to replace a GTA internal animation with a custom one, you can use [[EngineReplaceAnimation|engineReplaceAnimation]]. To unload the IFP file, use [[DestroyElement|destroyElement]], restarting or stopping the resource can also unload the IFP file automatically.}}
==Syntax==
<syntaxhighlight lang="lua">
ifp engineLoadIFP ( string ifp_file / string raw_data, string CustomBlockName )
</syntaxhighlight>

===Required Arguments===
*'''ifp_file / raw_data:''' the [[filepath|filepath]] to the IFP file you want to load or whole data buffer of the IFP file.
*'''CustomBlockName:''' the new block name for the IFP file. You cannot use the GTA default [[Animations|internal block]] names.

===Returns===
Returns an [[IFP]] element if the IFP file loaded, ''false'' otherwise.
{{Tip|If you want to synchronize animations, you can check [[https://drive.google.com/open?id=1L2NkQYuLS0YdoHECvxVRMdPBbEgaYUfH ifp_demo]] resource}}

==Example==
This example loads a custom IFP file ([https://drive.google.com/file/d/1XZNNCCn7xhBNbhaIbsBubky3BEj06zWp/view?usp=sharing parkour.ifp]), adds a command "animation" that takes 1 parameter as animation name for playing animations within that IFP.

<syntaxhighlight lang="lua">
--[[
credits to Paul_Cortez for the IFP file.
parkour.ifp has following animations:

BckHndSpingBTuck
BckHndSping
CartWheel
FrntHndSpring
HandPlant
]]

-- you can choose any name you want, do not choose a default GTA:SA block name
local customBlockName = "myNewBlock"

-- load the IFP file
local IFP = engineLoadIFP( "parkour.ifp", customBlockName )

-- let us know if IFP failed to load
if not IFP then
outputChatBox( "Failed to load 'parkour.ifp'" )
end

-- execute the command using /animation <NameOfCustomAnimation>
-- for example, /animation CartWheel
function setanimation( _, animationName )
-- check if IFP file has loaded
if IFP then
-- now play our custom animation
setPedAnimation( localPlayer, customBlockName, animationName )
end
end
addCommandHandler( "animation", setanimation )
</syntaxhighlight>

==See Also==
{{Engine_functions}}

AddDebugHook

2017-05-19T21:34:43Z

GTX:

__NOTOC__
{{Server client function}}
{{New feature/item|3.0136|1.3|5939|
This function allows tracing of MTA functions and events. It should only be used when debugging scripts as it may degrade script performance.

Debug hooks are not recursive, so functions and events triggered inside the hook callback will not be traced.
}}
==Syntax==
<syntaxhighlight lang="lua">
bool addDebugHook( string hookType, function callbackFunction[, table nameList ] )
</syntaxhighlight>

===Required Arguments===
*'''hookType:''' The type of hook to add. This can be:
** preEvent
** postEvent
** preFunction
** postFunction
*'''callbackFunction :''' The function to call
{{New feature/item|9.06054|1.5.2|7967|
* Returning the string "skip" from the callback function will cause the original function/event to be skipped
}}

===Optional Arguments===
*'''nameList:''' Table of strings for restricting which functions and events the hook will be triggered on
{{New feature/item|9.06054|1.5.2|7967|
* addDebugHook and removeDebugHook will only be hooked if they are specified in the name list
}}

===Returns===
Returns ''true'' if the hook was successfully added, or ''false'' otherwise.

==Callback parameters==
<syntaxhighlight lang="lua">
string preFunction( resource sourceResource, string functionName, bool isAllowedByACL, string luaFilename, int luaLineNumber, functionArguments )
postFunction( resource sourceResource, string functionName, bool isAllowedByACL, string luaFilename, int luaLineNumber, functionArguments )
string preEvent( resource sourceResource, string eventName, element eventSource, element eventClient, string luaFilename, int luaLineNumber, eventArguments )
postEvent( resource sourceResource, string eventName, element eventSource, element eventClient, string luaFilename, int luaLineNumber, eventArguments )
</syntaxhighlight>

==Example==
This example will dump info about all triggered events:
<syntaxhighlight lang="lua">
function onPreEvent( sourceResource, eventName, eventSource, eventClient, luaFilename, luaLineNumber, ... )
local args = { ... }
local srctype = eventSource and getElementType(eventSource)
local resname = sourceResource and getResourceName(sourceResource)
local plrname = eventClient and getPlayerName(eventClient)
outputDebugString( "preEvent"
.. " " .. tostring(resname)
.. " " .. tostring(eventName)
.. " source:" .. tostring(srctype)
.. " player:" .. tostring(plrname)
.. " file:" .. tostring(luaFilename)
.. "(" .. tostring(luaLineNumber) .. ")"
.. " numArgs:" .. tostring(#args)
.. " arg1:" .. tostring(args[1])
)
end
addDebugHook( "preEvent", onPreEvent )
</syntaxhighlight>
This example will dump info about all called MTA functions:
<syntaxhighlight lang="lua">
function onPreFunction( sourceResource, functionName, isAllowedByACL, luaFilename, luaLineNumber, ... )
local args = { ... }
local resname = sourceResource and getResourceName(sourceResource)
outputDebugString( "preFunction"
.. " " .. tostring(resname)
.. " " .. tostring(functionName)
.. " allowed:" .. tostring(isAllowedByACL)
.. " file:" .. tostring(luaFilename)
.. "(" .. tostring(luaLineNumber) .. ")"
.. " numArgs:" .. tostring(#args)
.. " arg1:" .. tostring(args[1])
)
end
addDebugHook( "preFunction", onPreFunction)
</syntaxhighlight>

This example adds a hook which will only be triggered for the named functions
<syntaxhighlight lang="lua">
addDebugHook( "preFunction", onPreFunction, {"setElementPosition","loadstring"} )
</syntaxhighlight>

{{New feature/item|9.06054|1.5.2|7967|
This example shows how to disable addDebugHook
<syntaxhighlight lang="lua">
addDebugHook( "preFunction", onPreFunction, {"addDebugHook"} )
function onPreFunction( sourceResource, functionName, isAllowedByACL, luaFilename, luaLineNumber, ... )
return "skip"
end
</syntaxhighlight>
}}
==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.5-9.06054|Added clientside}}
{{ChangelogItem|1.3.5-9.06142|Added option to restrict to specified functions and events }}
{{ChangelogItem|1.5.2-9.07957|Added option to skip original function/event <br/>Added ability to hook addDebugHook and removeDebugHook }}
==Requirements==
{{Requirements|1.3.4-9.05939|1.3.5-9.06054}}

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

SetObjectBreakable

2016-11-12T00:23:46Z

GTX: Undo revision 49841

__NOTOC__
{{Client function}}
This function sets an object to be breakable/unbreakable.

==Syntax==
<syntaxhighlight lang="lua">bool setObjectBreakable ( object theObject, bool breakable )</syntaxhighlight>
{{OOP||[[object]]:setBreakable|breakable|isObjectBreakable}}
===Required Arguments===
*'''object''' the [[object]] that's being set.
*'''breakable''' a boolean whether the object is breakable(true) or unbreakable (false).

===Returns===
* ''true'' if the object is now breakable.
* ''false'' if it can't or if invalid arguments are passed.

==Example==
This example creates an object when the resource starts and sets it to be breakable.
<syntaxhighlight lang="lua">function toggleObjectVulnerability()
local object = createObject(1337, 5540.6654, 1020.55122, 1240.545)
if isObjectBreakable(object) then
setObjectBreakable(object, false)
outputChatBox("The object is now not breakable.")
else
setObjectBreakable(object, true)
outputChatBox("The object is now breakable.")
end
end
addEventHandler("onClientResourceStart", resourceRoot, toggleObjectVulnerability)
</syntaxhighlight>
==Requirements==
{{Requirements|n/a|1.3.0-9.03783|}}
==See Also==
{{Client_object_functions}}

Talk:Object IDs

2016-11-09T15:02:22Z

GTX: Created page with "http://dev.prineside.com/gtasa_samp_model_id/ This is better. - GTX"

http://dev.prineside.com/gtasa_samp_model_id/ This is better. - GTX

OnChatMessage

2016-11-04T17:19:40Z

GTX: /* Example */

{{Server event}}
__NOTOC__
{{New feature/item|3.0120|1.2|3316|
}}
This event is triggered when a player uses say, teamsay, me successfully. Or when any message is output to chat using [[outputChatBox]] on the server side. It can be used to get the resource responsible for specific [[outputChatBox]] call via the second parameter.

==Parameters==
<syntaxhighlight lang="lua">
string theMessage, resource / element theElement
</syntaxhighlight>
*'''theMessage:''' The text that was output to the chatbox
*'''theElement:''' Player element if chatbox output was done via say, teamsay or me. Resource if it was done via [[outputChatBox]].

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

==Example==
This example outputs all chat messages to debug view.
<syntaxhighlight lang="lua">
function onChatMessageHandler(theMessage, thePlayer)
outputDebugString(theMessage)
end
addEventHandler("onChatMessage", root, onChatMessageHandler)
</syntaxhighlight>

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

{{See also/Server event|Server events}}

TriggerLatentClientEvent

2016-10-31T16:36:31Z

GTX: /* Example */

__NOTOC__
{{Server function}}
This function is the same as [[triggerClientEvent ]] except the transmission rate of the data contained in the arguments can be limited
and other network traffic is not blocked while the data is being transferred.
{{Note|You should avoid triggering events on the [[root element]] unless you really need to. Doing this triggers the event on every element in the [[element_tree | element tree]], which is potentially very CPU intensive. Use as specific (i.e. low down the tree) element as you can.}}

==Syntax==
<syntaxhighlight lang="lua">
bool triggerLatentClientEvent ( [table/element sendTo=getRootElement(),] string name, [int bandwidth=50000,] [bool persist=false,] element theElement, [arguments...] )
</syntaxhighlight>

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''theElement:''' The element that is the [[Event system#Event handlers|source]] of the event. This could be another player, or if this isn't relevant, use the root element.

===Optional Arguments===
*'''sendTo:''' The event will be sent to all [[player]]s that are children of the specified element. By default this is the root element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
*'''bandwidth:''' The bytes per second rate to send the data contained in the arguments.
*'''persist:''' A bool indicating whether the transmission should be allowed to continue even after the resource that triggered it has since stopped.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s. The total amount of data should not exceed 100MB.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Example==
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
addEvent("onClientReadFile",true)
addEventHandler("onClientReadFile",root,function(data)
local file = fileCreate("text.txt") --Save "data" into "text.txt"
fileWrite(file,data)
fileClose(file)
end)
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
if fileExists("text.txt") then
file = fileOpen("test.txt") --Open a file (you can create it yourself).
local data = fileRead(file,100*1024*1024) --Max 100 MB
fileClose(file) --Close File
triggerLatentClientEvent("onClientReadFile",5000,false,root,data) --trigger - Avoid triggering to root element (Read note above)
end
</syntaxhighlight>
</section>

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

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04570|Added option to use a list of player elements for the 'sendTo' argument}}

==See Also==
{{Event functions}}

OOP server

2016-10-31T02:43:44Z

GTX: /* Player */

{{Needs Checking|This page is partially outdated.}}
The new OOP in MTA allows for better code organization and readability. This is a list of [[Server_Scripting_Functions|server-side functions]].

''See also: [[OOP]]''

==Element==
areCollisionsEnabled (function: [[getElementCollisionsEnabled]])
attach (function: [[attachElements]])
clearVisibility (function: [[clearElementVisibleTo]])
clone (function: [[cloneElement]])
create (function: [[createElement]])
destroy (function: [[destroyElement]])
detach (function: [[detachElements]])
getAllByType (function: [[getElementsByType]])
getAllData (function: [[getAllElementData]])
getAlpha (function: [[getElementAlpha]])
getAttachedElements (function: [[getAttachedElements]])
getAttachedOffsets (function: [[getElementAttachedOffsets]])
getAttachedTo (function: [[getElementAttachedTo]])
getByID (function: [[getElementByID]])
getByIndex (function: [[getElementByIndex]])
getChild (function: [[getElementChild]])
getChildren (function: [[getElementChildren]])
getChildrenCount (function: [[getElementChildrenCount]])
getColShape (function: [[getElementColShape]])
getData (function: [[getElementData]])
getDimension (function: [[getElementDimension]])
getHealth (function: [[getElementHealth]])
getID (function: [[getElementID]])
getInterior (function: [[getElementInterior]])
getLowLOD (function: [[getLowLODElement]])
getModel (function: [[getElementModel]])
getParent (function: [[getElementParent]])
getPosition (function: [[getElementPosition]])
getRotation (function: [[getElementRotation]])
getSyncer (function: [[getElementSyncer]])
getType (function: [[getElementType]])
getVelocity (function: [[getElementVelocity]])
getZoneName (function: [[getElementZoneName]])
isAttached (function: [[isElementAttached]])
isCallPropagationEnabled (function: [[isElementCallPropagationEnabled]])
isDoubleSided (function: [[isElementDoubleSided]])
isFrozen (function: [[isElementFrozen]])
isInWater (function: [[isElementInWater]])
isLowLOD (function: [[isElementLowLOD]])
isVisibleTo (function: [[isElementVisibleTo]])
isWithinColShape (function: [[isElementWithinColShape]])
isWithinMarker (function: [[isElementWithinMarker]])
removeData (function: [[removeElementData]])
setAlpha (function: [[setElementAlpha]])
setAttachedOffsets (function: [[setElementAttachedOffsets]])
setCallPropagationEnabled (function: [[setElementCallPropagationEnabled]])
setCollisionsEnabled (function: [[setElementCollisionsEnabled]])
setData (function: [[setElementData]])
setDimension (function: [[setElementDimension]])
setDoubleSided (function: [[setElementDoubleSided]])
setFrozen (function: [[setElementFrozen]])
setHealth (function: [[setElementHealth]])
setID (function: [[setElementID]])
setInterior (function: [[setElementInterior]])
setMatrix (function: [[setElementMatrix]])
setModel (function: [[setElementModel]])
setParent (function: [[setElementParent]])
setPosition (function: [[setElementPosition]])
setRotation (function: [[setElementRotation]])
setSyncer (function: [[setElementSyncer]])
setVelocity (function: [[setElementVelocity]])

==ACL==

create (function: [[aclCreate]])
destroy (function: [[aclDestroy]])
get (function: [[aclGet]])
getName (function: [[aclGetName]])
getRight (function: [[aclGetRight]])
hasObjectPermissionTo (function: [[hasObjectPermissionTo]])
list (function: [[aclList]])
listRights (function: [[aclListRights]])
reload (function: [[aclReload]])
removeRight (function: [[aclRemoveRight]])
save (function: [[aclSave]])
setRight (function: [[aclSetRight]])

==ACLGroup==

addACL (function: [[aclGroupAddACL]])
addObject (function: [[aclGroupAddObject]])
addToGroup (function: [[aclGroupAddACL]])
create (function: [[aclCreateGroup]])
destroy (function: [[aclDestroyGroup]])
doesContainObject (function: [[isObjectInACLGroup]])
get (function: [[aclGetGroup]])
getName (function: [[aclGroupGetName]])
list (function: [[aclGroupList]])
listACL (function: [[aclGroupListACL]])
listObjects (function: [[aclGroupListObjects]])
removeACL (function: [[aclGroupRemoveACL]])
removeFromGroup (function: [[aclGroupRemoveACL]])
removeObject (function: [[aclGroupRemoveObject]])

==Account==

add (function: [[addAccount]])
copyDataFrom (function: [[copyAccountData]])
copyDataTo (function: [[copyAccountData]])
create (function: [[getAccount]])
getAll (function: [[getAccounts]])
getAllBySerial (function: [[getAccountsBySerial]])
getAllData (function: [[getAllAccountData]])
getData (function: [[getAccountData]])
getFromPlayer (function: [[getPlayerAccount]])
getName (function: [[getAccountName]])
getPlayer (function: [[getAccountPlayer]])
getSerial (function: [[getAccountSerial]])
isGuest (function: [[isGuestAccount]])
logIn (function: [[logIn]])
logPlayerOut (function: [[logOut]])
remove (function: [[removeAccount]])
setData (function: [[setAccountData]])
setPassword (function: [[setAccountPassword]])

==Ban==

create (function: [[addBan]])
getAdmin (function: [[getBanAdmin]])
getIP (function: [[getBanIP]])
getList (function: [[getBans]])
getNick (function: [[getBanNick]])
getReason (function: [[getBanReason]])
getSerial (function: [[getBanSerial]])
getTime (function: [[getBanTime]])
getUnbanTime (function: [[getUnbanTime]])
remove (function: [[removeBan]])

==Blip==
''Inherited from [[#Element|Element]]''

create (function: [[createBlip]])
createAttachedTo (function: [[createBlipAttachedTo]])
getColor (function: [[getBlipColor]])
getIcon (function: [[getBlipIcon]])
getOrdering (function: [[getBlipOrdering]])
getSize (function: [[getBlipSize]])
getVisibleDistance (function: [[getBlipVisibleDistance]])
setColor (function: [[setBlipColor]])
setIcon (function: [[setBlipIcon]])
setOrdering (function: [[setBlipOrdering]])
setSize (function: [[setBlipSize]])
setVisibleDistance (function: [[setBlipVisibleDistance]])

==ColShape==
''Inherited from [[#Element|Element]]''

Circle (function: [[createColCircle]])
Cuboid (function: [[createColCuboid]])
getElementsWithin (function: [[getElementsWithinColShape]])
isElementWithin (function: [[isElementWithinColShape]])
Polygon (function: [[createColPolygon]])
Rectangle (function: [[createColRectangle]])
Sphere (function: [[createColSphere]])
Tube (function: [[createColTube]])

==File==

close (function: [[fileClose]])
copy (function: [[fileCopy]])
create (function: [[fileOpen]])
delete (function: [[fileDelete]])
destroy (function: [[fileClose]])
exists (function: [[fileExists]])
flush (function: [[fileFlush]])
getPos (function: [[fileGetPos]])
getSize (function: [[fileGetSize]])
isEOF (function: [[fileIsEOF]])
new (function: [[fileCreate]])
read (function: [[fileRead]])
rename (function: [[fileRename]])
setPos (function: [[fileSetPos]])
write (function: [[fileWrite]])

==Marker==
''Inherited from [[#Element|Element]]''

create (function: [[createMarker]])
getColor (function: [[getMarkerColor]])
getCount (function: [[getMarkerCount]])
getIcon (function: [[getMarkerIcon]])
getSize (function: [[getMarkerSize]])
getTarget (function: [[getMarkerTarget]])
getType (function: [[getMarkerType]])
setColor (function: [[setMarkerColor]])
setIcon (function: [[setMarkerIcon]])
setSize (function: [[setMarkerSize]])
setTarget (function: [[setMarkerTarget]])
setType (function: [[setMarkerType]])

==Object==
''Inherited from [[#Element|Element]]''

create (function: [[createObject]])
getScale (function: [[getObjectScale]])
move (function: [[moveObject]])
setScale (function: [[setObjectScale]])
stop (function: [[stopObject]])

==Ped==
''Inherited from [[#Element|Element]]''

addClothes (function: [[addPedClothes]])
create (function: [[createPed]])
doesHaveJetpack (function: [[doesPedHaveJetPack]])
getAmmoInClip (function: [[getPedAmmoInClip]])
getAnalogControlState (function: [[getPedAnalogControlState]])
getArmor (function: [[getPedArmor]])
getClothes (function: [[getPedClothes]])
getContactElement (function: [[getPedContactElement]])
getFightingStyle (function: [[getPedFightingStyle]])
getGravity (function: [[getPedGravity]])
getOccupiedVehicle (function: [[getPedOccupiedVehicle]])
getOccupiedVehicleSeat (function: [[getPedOccupiedVehicleSeat]])
getStat (function: [[getPedStat]])
getTarget (function: [[getPedTarget]])
getTotalAmmo (function: [[getPedTotalAmmo]])
getValidModels (function: [[getValidPedModels]])
getWalkingStyle (function: [[getPedWalkingStyle]])
getWeapon (function: [[getPedWeapon]])
getWeaponSlot (function: [[getPedWeaponSlot]])
giveJetPack (function: [[givePedJetPack]])
isChoking (function: [[isPedChoking]])
isDead (function: [[isPedDead]])
isDoingGangDriveby (function: [[isPedDoingGangDriveby]])
isDucked (function: [[isPedDucked]])
isFrozen (function: [[isPedFrozen]])
isHeadless (function: [[isPedHeadless]])
isInVehicle (function: [[isPedInVehicle]])
isInWater (function: [[isPedInWater]])
isOnFire (function: [[isPedOnFire]])
isOnGround (function: [[isPedOnGround]])
kill (function: [[killPed]])
reloadWeapon (function: [[reloadPedWeapon]])
removeClothes (function: [[removePedClothes]])
removeFromVehicle (function: [[removePedFromVehicle]])
removeJetPack (function: [[removePedJetPack]])
setAnalogControlState (function: [[setPedAnalogControlState]])
setAnimation (function: [[setPedAnimation]])
setAnimationProgress (function: [[setPedAnimationProgress]])
setArmor (function: [[setPedArmor]])
setChoking (function: [[setPedChoking]])
setDoingGangDriveBy (function: [[setPedDoingGangDriveby]])
setFightingStyle (function: [[setPedFightingStyle]])
setFrozen (function: [[setPedFrozen]])
setGravity (function: [[setPedGravity]])
setHeadless (function: [[setPedHeadless]])
setOnFire (function: [[setPedOnFire]])
setStat (function: [[setPedStat]])
setWalkingStyle (function: [[setPedWalkingStyle]])
setWeaponSlot (function: [[setPedWeaponSlot]])
warpIntoVehicle (function: [[warpPedIntoVehicle]])

==Pickup==
''Inherited from [[#Element|Element]]''

create (function: [[createPickup]])
getAmmo (function: [[getPickupAmmo]])
getAmount (function: [[getPickupAmount]])
getRespawnInterval (function: [[getPickupRespawnInterval]])
getType (function: [[getPickupType]])
getWeapon (function: [[getPickupWeapon]])
setRespawnInterval (function: [[setPickupRespawnInterval]])
setType (function: [[setPickupType]])
use (function: [[usePickup]])

==Player==
''Inherited from [[#Ped|Ped]]''

ban (function: [[banPlayer]])
create (function: [[getPlayerFromName]])
forceMap (function: [[forcePlayerMap]])
getAccount (function: [[getPlayerAccount]])
getACInfo (function: [[getPlayerACInfo]])
getAllAlive (function: [[getAlivePlayers]])
getAllDead (function: [[getDeadPlayers]])
getAnnounceValue (function: [[getPlayerAnnounceValue]])
getBlurLevel (function: [[getPlayerBlurLevel]])
getCount (function: [[getPlayerCount]])
getIdleTime (function: [[getPlayerIdleTime]])
getIP (function: [[getPlayerIP]])
getMoney (function: [[getPlayerMoney]])
getName (function: [[getPlayerName]])
getNametagColor (function: [[getPlayerNametagColor]])
getNametagText (function: [[getPlayerNametagText]])
getPing (function: [[getPlayerPing]])
getRandom (function: [[getRandomPlayer]])
getSerial (function: [[getPlayerSerial]])
getTeam (function: [[getPlayerTeam]])
getVersion (function: [[getPlayerVersion]])
getWantedLevel (function: [[getPlayerWantedLevel]])
giveMoney (function: [[givePlayerMoney]])
isMapForced (function: [[isPlayerMapForced]])
isMuted (function: [[isPlayerMuted]])
isNametagShowing (function: [[isPlayerNametagShowing]])
isObservingDisplay (function: [[textDisplayIsObserver]])
isVoiceEnabled (function: [[isVoiceEnabled]])
kick (function: [[kickPlayer]])
logOut (function: [[logOut]])
observeDisplay (function: [[textDisplayAddObserver]])
redirect (function: [[redirectPlayer]])
resendModInfo (function: [[resendPlayerModInfo]])
setAnnounceValue (function: [[setPlayerAnnounceValue]])
setBlurLevel (function: [[setPlayerBlurLevel]])
setHudComponentVisible (function: [[setPlayerHudComponentVisible]])
setMoney (function: [[setPlayerMoney]])
setMuted (function: [[setPlayerMuted]])
setName (function: [[setPlayerName]])
setNametagColor (function: [[setPlayerNametagColor]])
setNametagShowing (function: [[setPlayerNametagShowing]])
setNametagText (function: [[setPlayerNametagText]])
setTeam (function: [[setPlayerTeam]])
setVoiceBroadcastTo (function: [[setPlayerVoiceBroadcastTo]])
setVoiceIgnoreFrom (function: [[setPlayerVoiceIgnoreFrom]])
setWantedLevel (function: [[setPlayerWantedLevel]])
showHudComponent (function: [[showPlayerHudComponent]])
spawn (function: [[spawnPlayer]])
stopObservingDisplay (function: [[textDisplayRemoveObserver]])
takeMoney (function: [[takePlayerMoney]])
takeScreenshot (function: [[takePlayerScreenShot]])
triggerEvent (function: [[triggerClientEvent]])

==RadarArea==
''Inherited from [[#Element|Element]]''

create (function: [[createRadarArea]])
getColor (function: [[getRadarAreaColor]])
getSize (function: [[getRadarAreaSize]])
isFlashing (function: [[isRadarAreaFlashing]])
isInside (function: [[isInsideRadarArea]])
setColor (function: [[setRadarAreaColor]])
setFlashing (function: [[setRadarAreaFlashing]])
setSize (function: [[setRadarAreaSize]])

==Resource==
==Connection==
''Inherited from [[#Element|Element]]''

create (function: [[dbConnect]])
exec (function: [[dbExec]])
query (function: [[dbQuery]])

==QueryHandle==

free (function: [[dbFree]])
poll (function: [[dbPoll]])

==Team==
''Inherited from [[#Element|Element]]''

countPlayers (function: [[countPlayersInTeam]])
create (function: [[createTeam]])
getColor (function: [[getTeamColor]])
getFriendlyFire (function: [[getTeamFriendlyFire]])
getFromName (function: [[getTeamFromName]])
getName (function: [[getTeamName]])
getPlayers (function: [[getPlayersInTeam]])
setColor (function: [[setTeamColor]])
setFriendlyFire (function: [[setTeamFriendlyFire]])
setName (function: [[setTeamName]])

==TextDisplay==

addObserver (function: [[textDisplayAddObserver]])
addText (function: [[textDisplayAddText]])
create (function: [[textCreateDisplay]])
destroy (function: [[textDestroyDisplay]])
getObservers (function: [[textDisplayGetObservers]])
isObserver (function: [[textDisplayIsObserver]])
removeObserver (function: [[textDisplayRemoveObserver]])
removeText (function: [[textDisplayRemoveText]])

==TextItem==

create (function: [[textCreateTextItem]])
destroy (function: [[textDestroyTextItem]])
getColor (function: [[textItemGetColor]])
getPosition (function: [[textItemGetPosition]])
getPriority (function: [[textItemGetPriority]])
getScale (function: [[textItemGetScale]])
getText (function: [[textItemGetText]])
setColor (function: [[textItemSetColor]])
setPosition (function: [[textItemSetPosition]])
setPriority (function: [[textItemSetPriority]])
setScale (function: [[textItemSetScale]])
setText (function: [[textItemSetText]])

==Vehicle==
''Inherited from [[#Element|Element]]''

addSirens (function: [[addVehicleSirens]])
addUpgrade (function: [[addVehicleUpgrade]])
areSirensOn (function: [[getVehicleSirensOn]])
attachTrailer (function: [[attachTrailerToVehicle]])
blow (function: [[blowVehicle]])
create (function: [[createVehicle]])
detachTrailer (function: [[detachTrailerFromVehicle]])
fix (function: [[fixVehicle]])
getAllOfType (function: [[getVehiclesOfType]])
getColor (function: [[getVehicleColor]])
getCompatibleUpgrades (function: [[getVehicleCompatibleUpgrades]])
getController (function: [[getVehicleController]])
getDirection (function: [[getTrainDirection]])
getDoorOpenRatio (function: [[getVehicleDoorOpenRatio]])
getDoorState (function: [[getVehicleDoorState]])
getEngineState (function: [[getVehicleEngineState]])
getHandling (function: [[getVehicleHandling]])
getHeadLightColor (function: [[getVehicleHeadLightColor]])
getLandingGearDown (function: [[getVehicleLandingGearDown]])
getLightState (function: [[getVehicleLightState]])
getMaxPassenger (function: [[getVehicleMaxPassengers]])
getModelFromName (function: [[getVehicleModelFromName]])
getModelHandling (function: [[getModelHandling]])
getName (function: [[getVehicleName]])
getNameFromModel (function: [[getVehicleNameFromModel]])
getOccupant (function: [[getVehicleOccupant]])
getOccupants (function: [[getVehicleOccupants]])
getOriginalHandling (function: [[getOriginalHandling]])
getOverrideLights (function: [[getVehicleOverrideLights]])
getPaintjob (function: [[getVehiclePaintjob]])
getPanelState (function: [[getVehiclePanelState]])
getPlateText (function: [[getVehiclePlateText]])
getSirenParams (function: [[getVehicleSirenParams]])
getSirens (function: [[getVehicleSirens]])
getSpeed (function: [[getTrainSpeed]])
getTowedByVehicle (function: [[getVehicleTowedByVehicle]])
getTowingVehicle (function: [[getVehicleTowingVehicle]])
getTurnVelocity (function: [[getVehicleTurnVelocity]])
getTurretPosition (function: [[getVehicleTurretPosition]])
getUpgradeOnSlot (function: [[getVehicleUpgradeOnSlot]])
getUpgrades (function: [[getVehicleUpgrades]])
getUpgradeSlotName (function: [[getVehicleUpgradeSlotName]])
getVariant (function: [[getVehicleVariant]])
getVehicleType (function: [[getVehicleType]])
getWheelStates (function: [[getVehicleWheelStates]])
isBlown (function: [[isVehicleBlown]])
isDamageProof (function: [[isVehicleDamageProof]])
isDerailable (function: [[isTrainDerailable]])
isDerailed (function: [[isTrainDerailed]])
isFuelTankExplodable (function: [[isVehicleFuelTankExplodable]])
isLocked (function: [[isVehicleLocked]])
isOnGround (function: [[isVehicleOnGround]])
isTaxiLightOn (function: [[isVehicleTaxiLightOn]])
removeSirens (function: [[removeVehicleSirens]])
removeUpgrade (function: [[removeVehicleUpgrade]])
resetExplosionTime (function: [[resetVehicleExplosionTime]])
resetIdleTime (function: [[resetVehicleIdleTime]])
respawn (function: [[respawnVehicle]])
setColor (function: [[setVehicleColor]])
setDamageProof (function: [[setVehicleDamageProof]])
setDerailable (function: [[setTrainDerailable]])
setDerailed (function: [[setTrainDerailed]])
setDirection (function: [[setTrainDirection]])
setDoorOpenRatio (function: [[setVehicleDoorOpenRatio]])
setDoorState (function: [[setVehicleDoorState]])
setDoorsUndamageable (function: [[setVehicleDoorsUndamageable]])
setEngineState (function: [[setVehicleEngineState]])
setFuelTankExplodable (function: [[setVehicleFuelTankExplodable]])
setHandling (function: [[setVehicleHandling]])
setHeadLightColor (function: [[setVehicleHeadLightColor]])
setIdleRespawnDelay (function: [[setVehicleIdleRespawnDelay]])
setLandingGearDown (function: [[setVehicleLandingGearDown]])
setLightState (function: [[setVehicleLightState]])
setLocked (function: [[setVehicleLocked]])
setModelHandling (function: [[setModelHandling]])
setOverrideLights (function: [[setVehicleOverrideLights]])
setPaintJob (function: [[setVehiclePaintjob]])
setPanelState (function: [[setVehiclePanelState]])
setPlateText (function: [[setVehiclePlateText]])
setRespawnDelay (function: [[setVehicleRespawnDelay]])
setRespawnPosition (function: [[setVehicleRespawnPosition]])
setSirens (function: [[setVehicleSirens]])
setSirensOn (function: [[setVehicleSirensOn]])
setSpeed (function: [[setTrainSpeed]])
setTaxiLightOn (function: [[setVehicleTaxiLightOn]])
setTurnVelocity (function: [[setVehicleTurnVelocity]])
setTurretPosition (function: [[setVehicleTurretPosition]])
setVariant (function: [[setVehicleVariant]])
setWheelStates (function: [[setVehicleWheelStates]])
spawn (function: [[spawnVehicle]])
toggleRespawn (function: [[toggleVehicleRespawn]])

==Water==
''Inherited from [[#Element|Element]]''

create (function: [[createWater]])
getColor (function: [[getWaterColor]])
getVertexPosition (function: [[getWaterVertexPosition]])
getWaveHeight (function: [[getWaveHeight]])
resetColor (function: [[resetWaterColor]])
resetLevel (function: [[resetWaterLevel]])
setColor (function: [[setWaterColor]])
setLevel (function: [[setWaterLevel]])
setVertexPosition (function: [[setWaterVertexPosition]])
setWaveHeight (function: [[setWaveHeight]])

==XML==

copy (function: [[xmlCopyFile]])
create (function: [[xmlCreateFile]])
createChild (function: [[xmlCreateChild]])
destroy (function: [[xmlDestroyNode]])
findChild (function: [[xmlFindChild]])
getAttribute (function: [[xmlNodeGetAttribute]])
getAttributes (function: [[xmlNodeGetAttributes]])
getChildren (function: [[xmlNodeGetChildren]])
getName (function: [[xmlNodeGetName]])
getParent (function: [[xmlNodeGetParent]])
load (function: [[xmlLoadFile]])
loadMapData (function: [[loadMapData]])
saveFile (function: [[xmlSaveFile]])
saveMapData (function: [[saveMapData]])
setAttribute (function: [[xmlNodeSetAttribute]])
setName (function: [[xmlNodeSetName]])
setValue (function: [[xmlNodeGetValue]])
setValue (function: [[xmlNodeSetValue]])
unload (function: [[xmlUnloadFile]])

==Timer==

create (function: [[setTimer]])
destroy (function: [[killTimer]])
getDetails (function: [[getTimerDetails]])
isValid (function: [[isTimer]])
reset (function: [[resetTimer]])

[[Category:OOP]]

OnVehicleWeaponFire

2016-10-31T02:34:01Z

GTX: Fixed syntax highlight

{{Useful Function}}
__NOTOC__
This code implements an '''event''' that is triggered when a player in a vehicle fires a vehicles weapon. A list of vehicles that have weapons are listed below:

* Hydra - Fighter Jet (ID: 520)
* Hunter - Assault Helicopter (ID: 425)
* Rustler - World War 2 style fighter (ID: 476)
* Predator - Police Boat with side guns (ID: 430)
* Rhino - Heavily armoured tank (ID: 432)
* Firetruck - Firetruck with sprayable hose (ID: 407)
* S.W.A.T. - Police tank with sprayable hose (ID: 601)
* RC Baron - A mini fighter (ID: 464)

==Parameters==
<syntaxhighlight lang="lua">string vehicleFireType, int vehicleModel</syntaxhighlight>

* vehicleFireType: this will be "primary" or "secondary" depending on which player the button pressed.
* vehicleModel: the model number the player is in when they triggered the event.

==Source==
The source of this event is the player who fired the vehicles gun(s).

==Code==
<section name="Clientside Script" class="client" show="true">
<syntaxhighlight lang="lua">
armedVehicles = {[425]=true, [520]=true, [476]=true, [447]=true, [430]=true, [432]=true, [464]=true, [407]=true, [601]=true}
function vehicleWeaponFire(key, keyState, vehicleFireType)
local vehModel = getElementModel(getPedOccupiedVehicle(localPlayer))
if (armedVehicles[vehModel]) then
triggerEvent("onClientVehicleWeaponFire", localPlayer, vehicleFireType, vehModel)
end
end
bindKey("vehicle_fire", "down", vehicleWeaponFire, "primary")
bindKey("vehicle_secondary_fire", "down", vehicleWeaponFire, "secondary")
</syntaxhighlight>
</section>
<section name="Serverside Script" class="server" show="true">
<syntaxhighlight lang="lua">
armedVehicles = {[425]=true, [520]=true, [476]=true, [447]=true, [430]=true, [432]=true, [464]=true, [407]=true, [601]=true}
function vehicleWeaponFire(thePresser, key, keyState, vehicleFireType)
local vehModel = getElementModel(getPedOccupiedVehicle(thePresser))
if (armedVehicles[vehModel]) then
triggerEvent("onVehicleWeaponFire", thePresser, vehicleFireType, vehModel)
end
end

function bindOnJoin()
bindKey(source, "vehicle_fire", "down", vehicleWeaponFire, "primary")
bindKey(source, "vehicle_secondary_fire", "down", vehicleWeaponFire, "secondary")
end
addEventHandler("onPlayerJoin", root, bindOnJoin)

function bindOnStart()
for index, thePlayer in pairs(getElementsByType("player")) do
bindKey(thePlayer, "vehicle_fire", "down", vehicleWeaponFire, "primary")
bindKey(thePlayer, "vehicle_secondary_fire", "down", vehicleWeaponFire, "secondary")
end
end
addEventHandler("onResourceStart", getResourceRootElement(), bindOnStart)
</syntaxhighlight>
</section>

==Example Code==
<section name="Clientside Example" class="client" show="true">
<syntaxhighlight lang="lua">
function eventVehicleFire(typeOfFire, theModel)
outputChatBox(getPlayerName(source).." fired his "..getVehicleNameFromModel(theModel).."'s weapon ("..typeOfFire..")")
end
addEvent("onClientVehicleWeaponFire", false)
addEventHandler("onClientVehicleWeaponFire", getLocalPlayer(), eventVehicleFire)
</syntaxhighlight>
</section>
<section name="Serverside Example" class="server" show="true">
<syntaxhighlight lang="lua">
function eventVehicleFire(typeOfFire, theModel)
outputChatBox(getPlayerName(source).." fired his "..getVehicleNameFromModel(theModel).."'s weapon ("..typeOfFire..")", root, 0, 255, 0)
end
addEvent("onVehicleWeaponFire", false)
addEventHandler("onVehicleWeaponFire", root, eventVehicleFire)
</syntaxhighlight>
</section>

'''Author: Tuna'''

==See Also==
{{Useful_Functions}}

IsSoundPaused

2016-10-30T00:20:06Z

GTX: Reversed (This is English section of wiki...)

__NOTOC__
{{Client function}}
This function is used to return the current pause state of the specified [[sound]] [[element]].

{{New feature/item|3.0132|1.3.2||
If the element is a [[player]], this function will use the players voice.
}}
==Syntax==
<syntaxhighlight lang="lua">bool isSoundPaused ( element theSound )</syntaxhighlight>
{{OOP||[[sound]]:isPaused|paused|setSoundPaused}}
===Required Arguments===
*'''theSound:''' the [[sound]] [[element]] which pause state you want to return.

===Returns===
Returns ''true'' if the [[sound]] [[element]] is paused, ''false'' if unpaused or invalid arguments were passed.

==Example==
This example will check and see if the sound is paused or not, and tell the player.
<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
theSound = playSound("music/song.mp3")
function checkSongPause()
local pause = isSoundPaused(theSound)
if(pause == true) then
outputChatBox("The sound is paused!")
else
outputChatBox("The sound is not paused!")
end
end
addCommandHandler("checkpause", checkSongPause)
</syntaxhighlight>
</section>

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.2|Added player element to use a players voice}}

==See Also==
{{Client_audio_functions}}

[[ar:isSoundPaused]]

OnClientChatMessage

2016-10-28T12:25:53Z

GTX: Typo in example

{{Client event}}
__NOTOC__
This event is triggered when any text is output to chatbox, including MTA's hardcoded messages.

==Parameters==
<syntaxhighlight lang="lua">
string text, int r, int g, int b
</syntaxhighlight>
*'''text:''' The text that was output to chatbox
*'''r:''' The amount of red in the color of the text.
*'''g:''' The amount of green in the color of the text.
*'''b:''' The amount of blue in the color of the text.

==Source==
The [[event system#Event source|source]] of this event is the root element.
==Cancel effect==
AS OF 1.3.2
If this event is [[Event system#Canceling|canceled]], the game's chat system won't deliver the posts. You may use [[outputChatBox]] to send the messages then.

==Example==
This example doesn't output anything to chatbox if it consists only of numbers
<syntaxhighlight lang="lua">
function onClientChatMessageHandler(text)
if string.match(text,"%d+") --[[string.match searches for pattern "%d+", means decimals]] == text then -- if string.match and text itself are the same
cancelEvent() -- don't output it
end
end
addEventHandler("onClientChatMessage", getRootElement(), onClientChatMessageHandler)
</syntaxhighlight>

==See Also==

===Client other events===
{{Client_other_events}}
===Client event functions===
{{Client_event_functions}}

GetResourceFromName

2016-10-27T15:56:08Z

GTX: Added link to resource wiki page

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

==Syntax==
<syntaxhighlight lang="lua">
resource getResourceFromName ( string resourceName )
</syntaxhighlight>
{{OOP|This function is a static function underneath the Resource class. {{New feature/item|3.0141|1.4.1|7005|OOP function available client side}}|[[Resource]].getFromName}}

===Required Arguments===
*'''resourceName:''' the name of the resource you wish to get.

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

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

==See Also==
{{Resource_functions}}

TriggerClientEvent

2016-10-27T10:31:42Z

GTX: Added OOP syntax (I added "table/element", not sure if that's how it should be added)

__NOTOC__
{{Server function}}
This function triggers an event previously registered on a client. This is the primary means of passing information between the server and the client. Clients have a similar [[triggerServerEvent]] function that can do the reverse. You can treat this function as if it was an asynchronous function call, using [[triggerServerEvent]] to pass back any returned information if necessary.

Almost any data types can be passed as expected, including [[element]]s and complex nested [[table]]s. Non-element MTA data types like xmlNodes or resource pointers will not be able to be passed as they do not necessarily have a valid representation on the client.

Events are sent reliably, so clients will receive them, but there may be (but shouldn't be) a significant delay before they are received. You should take this into account when using them.

Keep in mind the bandwidth issues when using events - don't pass a large list of arguments unless you really need to. It is marginally more efficient to pass one large event than two smaller ones.
==Syntax==
<syntaxhighlight lang="lua">
bool triggerClientEvent ( [table/element sendTo=getRootElement()], string name, element sourceElement, [arguments...] )
</syntaxhighlight>
{{OOP||[[table]]/[[element]]:triggerEvent||}}

===Required Arguments===
*'''name:''' The name of the event to trigger client side. You should register this event with [[addEvent]] and add at least one event handler using [[addEventHandler]].
*'''sourceElement:''' The element that is the [[Event system#Event handlers|source]] of the event.
{{Note|To save client CPU, you should avoid setting '''sourceElement''' to the [[root element]] where possible. Using [[GetThisResource|resourceRoot]] is usually sufficient if the event is handled by the same resource on the client.}}

===Optional Arguments===
{{OptionalArg}}
*'''sendTo:''' The event will be sent to all [[player]]s that are children of the specified element. By default this is the root element, and hence the event is sent to all players. If you specify a single player it will just be sent to that player. This argument can also be a table of player elements.
*'''arguments...:''' A list of arguments to trigger with the event. You can pass any lua data type (except functions). You can also pass [[element]]s.

===Returns===
Returns ''true'' if the event trigger has been sent, ''false'' if invalid arguments were specified.

==Example==
===Example 1===
This example shows how you can pass a simple "Hello World" message from the server to the all the clients using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommand ( playerSource, commandName )
triggerClientEvent ( playerSource, "onGreeting", playerSource, "Hello World!" )
end
addCommandHandler ( "greet", greetingCommand )
</syntaxhighlight>
</section>

When the command "greet" is executed (by typing it in the server console or the player's console), the server's ''greetingCommand'' function is called. This triggers the client side event ''onGreeting'' with the string ''"Hello World!"''. This event is then handled by the ''greetingHandler'' function client side which then displays the message.

===Example 2===
This example shows how you can pass a simple "Hello World" message from the server to '''a single''' client using an event.

<section name="Client" class="client" show="true">
<syntaxhighlight lang="lua">
function greetingHandler ( message )
outputChatBox ( "The server says: " .. message )
end
addEvent( "onGreeting", true )
addEventHandler( "onGreeting", localPlayer, greetingHandler )
</syntaxhighlight>
</section>
<section name="Server" class="server" show="true">
<syntaxhighlight lang="lua">
function greetingCommandOne ( playerSource, commandName, playerName )
if playerName then
local thePlayer = getPlayerFromName ( playerName )
if thePlayer then
triggerClientEvent ( thePlayer, "onGreeting", thePlayer, "Hello World!" )
else
-- invalid player name specified
end
else
-- No player name specified
end
end
addCommandHandler ( "greet_one", greetingCommandOne )
</syntaxhighlight>
</section>

This works like the first example except an extra ''thePlayer'' argument is specified for triggerClientEvent.

==Changelog==
{{ChangelogHeader}}
{{ChangelogItem|1.3.0-9.04570|Added option to use a list of player elements for the 'sendTo' argument}}

==See Also==
{{Event functions}}
[[ru:triggerClientEvent]]

FileClose

2016-10-22T11:55:34Z

GTX: Destroy method doesn't work anymore in 1.5.3.

__NOTOC__
{{Server client function}}
Closes a file handle obtained by [[fileCreate]] or [[fileOpen]].

==Syntax==
<syntaxhighlight lang="lua">
bool fileClose ( file theFile )
</syntaxhighlight>
{{OOP||[[file]]:close}}

===Required Arguments===
*'''theFile:''' The file handle to close.

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

==Example==
This example creates a text file and writes a string to it.
<syntaxhighlight lang="lua">
local newFile = fileCreate("test.txt") -- attempt to create a new file
if newFile then -- check if the creation succeeded
fileWrite(newFile, "This is a test file!") -- write a text line
fileClose(newFile) -- close the file once you're done with it
end
</syntaxhighlight>

It is important to remember to close a file after you've finished all your operations on it, especially if you've been writing to the file. If you don't close a file and your resource crashes, all changes to the file may be lost.

==See Also==
{{File functions}}