OOP server: Difference between revisions

From Multi Theft Auto: Wiki
Jump to navigation Jump to search
 
(32 intermediate revisions by 10 users not shown)
Line 1: Line 1:
{{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]].
The new OOP in MTA allows for better code organization and readability. This is a list of [[Server_Scripting_Functions|server-side functions]].


Line 65: Line 66:
  setRotation (function: [[setElementRotation]])
  setRotation (function: [[setElementRotation]])
  setSyncer (function: [[setElementSyncer]])
  setSyncer (function: [[setElementSyncer]])
setVelocity (function: [[setElementVelocity]])
  setVelocity (function: [[setElementVelocity]])
  setVelocity (function: [[setElementVelocity]])


==ACL==
==ACL==
   
   
addToGroup (function: [[aclGroupAddACL]])
  create (function: [[aclCreate]])
  create (function: [[aclCreate]])
  destroy (function: [[aclDestroy]])
  destroy (function: [[aclDestroy]])
Line 80: Line 79:
  listRights (function: [[aclListRights]])
  listRights (function: [[aclListRights]])
  reload (function: [[aclReload]])
  reload (function: [[aclReload]])
removeFromGroup (function: [[aclGroupRemoveACL]])
  removeRight (function: [[aclRemoveRight]])
  removeRight (function: [[aclRemoveRight]])
  save (function: [[aclSave]])
  save (function: [[aclSave]])
Line 89: Line 87:
  addACL (function: [[aclGroupAddACL]])
  addACL (function: [[aclGroupAddACL]])
  addObject (function: [[aclGroupAddObject]])
  addObject (function: [[aclGroupAddObject]])
addToGroup (function: [[aclGroupAddACL]])
  create (function: [[aclCreateGroup]])
  create (function: [[aclCreateGroup]])
  destroy (function: [[aclDestroyGroup]])
  destroy (function: [[aclDestroyGroup]])
Line 98: Line 97:
  listObjects (function: [[aclGroupListObjects]])
  listObjects (function: [[aclGroupListObjects]])
  removeACL (function: [[aclGroupRemoveACL]])
  removeACL (function: [[aclGroupRemoveACL]])
removeFromGroup (function: [[aclGroupRemoveACL]])
  removeObject (function: [[aclGroupRemoveObject]])
  removeObject (function: [[aclGroupRemoveObject]])


Line 103: Line 103:
   
   
  add (function: [[addAccount]])
  add (function: [[addAccount]])
copyDataFrom (function: [[copyAccountData]])
  copyDataTo (function: [[copyAccountData]])
  copyDataTo (function: [[copyAccountData]])
create (function: [[getAccount]])
getAll (function: [[getAccounts]])
getAllBySerial (function: [[getAccountsBySerial]])
getAllData (function: [[getAllAccountData]])
  getData (function: [[getAccountData]])
  getData (function: [[getAccountData]])
  getFromPlayer (function: [[getPlayerAccount]])
  getID (function: [[getAccountID]])
getIP (function: [[getAccountIP]])
  getName (function: [[getAccountName]])
  getName (function: [[getAccountName]])
  getPlayer (function: [[getAccountPlayer]])
  getPlayer (function: [[getAccountPlayer]])
getAllByData (function: [[getAccountsByData]])
getAllByIP (function: [[getAccountsByIP]])
getAllBySerial (function: [[getAccountsBySerial]])
  getSerial (function: [[getAccountSerial]])
  getSerial (function: [[getAccountSerial]])
getAll (function: [[getAccounts]])
create (function: [[getAccount]])
getAllData (function: [[getAllAccountData]])
getAccount (function: [[getPlayerAccount]])
  isGuest (function: [[isGuestAccount]])
  isGuest (function: [[isGuestAccount]])
  logIn (function: [[logIn]])
  logIn (function: [[logIn]])
  logPlayerOut (function: [[logOut]])
  logOut (function: [[logOut]])
  remove (function: [[removeAccount]])
  remove (function: [[removeAccount]])
  setData (function: [[setAccountData]])
  setData (function: [[setAccountData]])
setName (function: [[setAccountName]])
  setPassword (function: [[setAccountPassword]])
  setPassword (function: [[setAccountPassword]])


Line 136: Line 140:
==Blip==
==Blip==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
  create (function: [[createBlip]])
  create (function: [[createBlip]])
  createAttachedTo (function: [[createBlipAttachedTo]])
  createAttachedTo (function: [[createBlipAttachedTo]])
  getColor (function: [[getBlipColor]])
  getColor (function: [[getBlipColor]])
  getVisibleDistance (function: [[getBlipVisibleDistance]])
  getIcon (function: [[getBlipIcon]])
  getOrdering (function: [[getBlipOrdering]])
  getOrdering (function: [[getBlipOrdering]])
  getSize (function: [[getBlipSize]])
  getSize (function: [[getBlipSize]])
  getIcon (function: [[getBlipIcon]])
  getVisibleDistance (function: [[getBlipVisibleDistance]])
  setColor (function: [[setBlipColor]])
  setColor (function: [[setBlipColor]])
  setVisibleDistance (function: [[setBlipVisibleDistance]])
  setIcon (function: [[setBlipIcon]])
  setOrdering (function: [[setBlipOrdering]])
  setOrdering (function: [[setBlipOrdering]])
  setSize (function: [[setBlipSize]])
  setSize (function: [[setBlipSize]])
  setIcon (function: [[setBlipIcon]])
  setVisibleDistance (function: [[setBlipVisibleDistance]])
 
==ColShape==
==ColShape==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
  Circle (function: [[createColCircle]])
  Circle (function: [[createColCircle]])
  Cuboid (function: [[createColCuboid]])
  Cuboid (function: [[createColCuboid]])
getElementsWithin (function: [[getElementsWithinColShape]])
getShapeType (function: [[getColShapeType]])
isElementWithin (function: [[isElementWithinColShape]])
Polygon (function: [[createColPolygon]])
  Rectangle (function: [[createColRectangle]])
  Rectangle (function: [[createColRectangle]])
  Sphere (function: [[createColSphere]])
  Sphere (function: [[createColSphere]])
  Tube (function: [[createColTube]])
  Tube (function: [[createColTube]])
Polygon (function: [[createColPolygon]])
 
getElementsWithin (function: [[getElementsWithinColShape]])
isElementWithin (function: [[isElementWithinColShape]])
==File==
==File==
close (function: [[fileClose]])
copy (function: [[fileCopy]])
  create (function: [[fileOpen]])
  create (function: [[fileOpen]])
delete (function: [[fileDelete]])
  destroy (function: [[fileClose]])
  destroy (function: [[fileClose]])
close (function: [[fileClose]])
new (function: [[fileCreate]])
delete (function: [[fileDelete]])
  exists (function: [[fileExists]])
  exists (function: [[fileExists]])
  flush (function: [[fileFlush]])
  flush (function: [[fileFlush]])
Line 171: Line 179:
  getSize (function: [[fileGetSize]])
  getSize (function: [[fileGetSize]])
  isEOF (function: [[fileIsEOF]])
  isEOF (function: [[fileIsEOF]])
new (function: [[fileCreate]])
  read (function: [[fileRead]])
  read (function: [[fileRead]])
  rename (function: [[fileRename]])
  rename (function: [[fileRename]])
  setPos (function: [[fileSetPos]])
  setPos (function: [[fileSetPos]])
  write (function: [[fileWrite]])
  write (function: [[fileWrite]])
copy (function: [[fileCopy]])
 
==Marker==
==Marker==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
  create (function: [[createMarker]])
  create (function: [[createMarker]])
getColor (function: [[getMarkerColor]])
  getCount (function: [[getMarkerCount]])
  getCount (function: [[getMarkerCount]])
getType (function: [[getMarkerType]])
  getIcon (function: [[getMarkerIcon]])
  getIcon (function: [[getMarkerIcon]])
  getSize (function: [[getMarkerSize]])
  getSize (function: [[getMarkerSize]])
  getTarget (function: [[getMarkerTarget]])
  getTarget (function: [[getMarkerTarget]])
  getColor (function: [[getMarkerColor]])
  getType (function: [[getMarkerType]])
  setType (function: [[setMarkerType]])
  setColor (function: [[setMarkerColor]])
  setIcon (function: [[setMarkerIcon]])
  setIcon (function: [[setMarkerIcon]])
  setSize (function: [[setMarkerSize]])
  setSize (function: [[setMarkerSize]])
  setTarget (function: [[setMarkerTarget]])
  setTarget (function: [[setMarkerTarget]])
  setColor (function: [[setMarkerColor]])
  setType (function: [[setMarkerType]])
 
==Object==
==Object==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''


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


==Pickup==
==Pickup==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
  create (function: [[createPickup]])
  create (function: [[createPickup]])
use (function: [[usePickup]])
  getAmmo (function: [[getPickupAmmo]])
  getAmmo (function: [[getPickupAmmo]])
  getAmount (function: [[getPickupAmount]])
  getAmount (function: [[getPickupAmount]])
getWeapon (function: [[getPickupWeapon]])
  getRespawnInterval (function: [[getPickupRespawnInterval]])
  getRespawnInterval (function: [[getPickupRespawnInterval]])
  getType (function: [[getPickupType]])
  getType (function: [[getPickupType]])
getWeapon (function: [[getPickupWeapon]])
setRespawnInterval (function: [[setPickupRespawnInterval]])
  setType (function: [[setPickupType]])
  setType (function: [[setPickupType]])
  setRespawnInterval (function: [[setPickupRespawnInterval]])
  use (function: [[usePickup]])
 
==Player==
==Player==
''Inherited from [[#Ped|Ped]]''
''Inherited from [[#Ped|Ped]]''
Line 322: Line 334:
==RadarArea==
==RadarArea==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
  create (function: [[createRadarArea]])
  create (function: [[createRadarArea]])
getColor (function: [[getRadarAreaColor]])
getSize (function: [[getRadarAreaSize]])
isFlashing (function: [[isRadarAreaFlashing]])
  isInside (function: [[isInsideRadarArea]])
  isInside (function: [[isInsideRadarArea]])
  isFlashing (function: [[isRadarAreaFlashing]])
  setColor (function: [[setRadarAreaColor]])
  getSize (function: [[getRadarAreaSize]])
  setFlashing (function: [[setRadarAreaFlashing]])
getColor (function: [[getRadarAreaColor]])
  setSize (function: [[setRadarAreaSize]])
  setSize (function: [[setRadarAreaSize]])
setFlashing (function: [[setRadarAreaFlashing]])
 
setColor (function: [[setRadarAreaColor]])
==Resource==
==Resource==
call (function: [[call]])
copy (function: [[copyResource]])
create (function: [[createResource]])
getDynamicElementRoot (function: [[getResourceDynamicElementRoot]])
getAll (function: [[getResources]])
getFromName (function: [[getResourceFromName]])
getInfo (function: [[getResourceInfo]])
getMapRootElement (function: [[getResourceMapRootElement]])
getName (function: [[getResourceName]])
getRootElement (function: [[getResourceRootElement]])
getState (function: [[getResourceState]])
removeFile (function: [[removeResourceFile]])
restart (function: [[restartResource]])
start (function: [[startResource]])
stop (function: [[stopResource]])
setInfo (function: [[setResourceInfo]])
rename (function: [[renameResource]])
delete (function: [[deleteResource]])
==Connection==
==Connection==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
  create (function: [[dbConnect]])
  create (function: [[dbConnect]])
  exec (function: [[dbExec]])
  exec (function: [[dbExec]])
  query (function: [[dbQuery]])
  query (function: [[dbQuery]])
==QueryHandle==
==QueryHandle==
free (function: [[dbFree]])
  poll (function: [[dbPoll]])
  poll (function: [[dbPoll]])
free (function: [[dbFree]])
 
==Team==
==Team==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
countPlayers (function: [[countPlayersInTeam]])
  create (function: [[createTeam]])
  create (function: [[createTeam]])
getColor (function: [[getTeamColor]])
getFriendlyFire (function: [[getTeamFriendlyFire]])
  getFromName (function: [[getTeamFromName]])
  getFromName (function: [[getTeamFromName]])
  countPlayers (function: [[countPlayersInTeam]])
  getName (function: [[getTeamName]])
  getPlayers (function: [[getPlayersInTeam]])
  getPlayers (function: [[getPlayersInTeam]])
getFriendlyFire (function: [[getTeamFriendlyFire]])
getName (function: [[getTeamName]])
getColor (function: [[getTeamColor]])
setName (function: [[setTeamName]])
  setColor (function: [[setTeamColor]])
  setColor (function: [[setTeamColor]])
  setFriendlyFire (function: [[setTeamFriendlyFire]])
  setFriendlyFire (function: [[setTeamFriendlyFire]])
setName (function: [[setTeamName]])
==TextDisplay==
==TextDisplay==
addObserver (function: [[textDisplayAddObserver]])
addText (function: [[textDisplayAddText]])
  create (function: [[textCreateDisplay]])
  create (function: [[textCreateDisplay]])
  destroy (function: [[textDestroyDisplay]])
  destroy (function: [[textDestroyDisplay]])
  addObserver (function: [[textDisplayAddObserver]])
  getObservers (function: [[textDisplayGetObservers]])
isObserver (function: [[textDisplayIsObserver]])
  removeObserver (function: [[textDisplayRemoveObserver]])
  removeObserver (function: [[textDisplayRemoveObserver]])
addText (function: [[textDisplayAddText]])
  removeText (function: [[textDisplayRemoveText]])
  removeText (function: [[textDisplayRemoveText]])
isObserver (function: [[textDisplayIsObserver]])
 
getObservers (function: [[textDisplayGetObservers]])
==TextItem==
==TextItem==
  create (function: [[textCreateTextItem]])
  create (function: [[textCreateTextItem]])
  destroy (function: [[textDestroyTextItem]])
  destroy (function: [[textDestroyTextItem]])
Line 376: Line 415:
  setScale (function: [[textItemSetScale]])
  setScale (function: [[textItemSetScale]])
  setText (function: [[textItemSetText]])
  setText (function: [[textItemSetText]])
==Vehicle==
==Vehicle==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
  addSirens (function: [[addVehicleSirens]])
  addSirens (function: [[addVehicleSirens]])
  addUpgrade (function: [[addVehicleUpgrade]])
  addUpgrade (function: [[addVehicleUpgrade]])
Line 399: Line 439:
  getLandingGearDown (function: [[getVehicleLandingGearDown]])
  getLandingGearDown (function: [[getVehicleLandingGearDown]])
  getLightState (function: [[getVehicleLightState]])
  getLightState (function: [[getVehicleLightState]])
  getMaxPassenger (function: [[getVehicleMaxPassengers]])
  getMaxPassengers (function: [[getVehicleMaxPassengers]])
  getModelFromName (function: [[getVehicleModelFromName]])
  getModelFromName (function: [[getVehicleModelFromName]])
  getModelHandling (function: [[getModelHandling]])
  getModelHandling (function: [[getModelHandling]])
Line 473: Line 513:
==Water==
==Water==
''Inherited from [[#Element|Element]]''
''Inherited from [[#Element|Element]]''
 
  create (function: [[createWater]])
  create (function: [[createWater]])
getColor (function: [[getWaterColor]])
  getVertexPosition (function: [[getWaterVertexPosition]])
  getVertexPosition (function: [[getWaterVertexPosition]])
  getWaveHeight (function: [[getWaveHeight]])
  getWaveHeight (function: [[getWaveHeight]])
  getColor (function: [[getWaterColor]])
  resetColor (function: [[resetWaterColor]])
  setWaveHeight (function: [[setWaveHeight]])
  resetLevel (function: [[resetWaterLevel]])
  setColor (function: [[setWaterColor]])
  setColor (function: [[setWaterColor]])
setLevel (function: [[setWaterLevel]])
  setVertexPosition (function: [[setWaterVertexPosition]])
  setVertexPosition (function: [[setWaterVertexPosition]])
  setLevel (function: [[setWaterLevel]])
  setWaveHeight (function: [[setWaveHeight]])
resetColor (function: [[resetWaterColor]])
 
resetLevel (function: [[resetWaterLevel]])
==XML==
==XML==
  load (function: [[xmlLoadFile]])
   
destroy (function: [[xmlUnloadFile]])
  copy (function: [[xmlCopyFile]])
  copy (function: [[xmlCopyFile]])
  create (function: [[xmlCreateFile]])
  create (function: [[xmlCreateFile]])
createChild (function: [[xmlCreateChild]])
  destroy (function: [[xmlDestroyNode]])
  destroy (function: [[xmlDestroyNode]])
loadMapData (function: [[loadMapData]])
saveMapData (function: [[saveMapData]])
setValue (function: [[xmlNodeGetValue]])
setAttribute (function: [[xmlNodeSetAttribute]])
setValue (function: [[xmlNodeSetValue]])
saveFile (function: [[xmlSaveFile]])
createChild (function: [[xmlCreateChild]])
  findChild (function: [[xmlFindChild]])
  findChild (function: [[xmlFindChild]])
  setName (function: [[xmlNodeSetName]])
  getAttribute (function: [[xmlNodeGetAttribute]])
  getAttributes (function: [[xmlNodeGetAttributes]])
  getAttributes (function: [[xmlNodeGetAttributes]])
  getChildren (function: [[xmlNodeGetChildren]])
  getChildren (function: [[xmlNodeGetChildren]])
  getName (function: [[xmlNodeGetName]])
  getName (function: [[xmlNodeGetName]])
  getParent (function: [[xmlNodeGetParent]])
  getParent (function: [[xmlNodeGetParent]])
  getAttribute (function: [[xmlNodeGetAttribute]])
  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==
==Timer==
  create (function: [[setTimer]])
  create (function: [[setTimer]])
  destroy (function: [[killTimer]])
  destroy (function: [[killTimer]])
getDetails (function: [[getTimerDetails]])
isValid (function: [[isTimer]])
  reset (function: [[resetTimer]])
  reset (function: [[resetTimer]])
isValid (function: [[isTimer]])
 
getDetails (function: [[getTimerDetails]])
[[Category:OOP]]

Latest revision as of 05:29, 6 November 2023

Dialog-information.png This article needs checking.

Reason(s): This page is partially outdated.

The new OOP in MTA allows for better code organization and readability. This is a list of 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)
copyDataTo (function: copyAccountData)
getData (function: getAccountData)
getID (function: getAccountID)
getIP (function: getAccountIP)
getName (function: getAccountName)
getPlayer (function: getAccountPlayer)
getAllByData (function: getAccountsByData)
getAllByIP (function: getAccountsByIP)
getAllBySerial (function: getAccountsBySerial)
getSerial (function: getAccountSerial)
getAll (function: getAccounts)
create (function: getAccount)
getAllData (function: getAllAccountData)
getAccount (function: getPlayerAccount)
isGuest (function: isGuestAccount)
logIn (function: logIn)
logOut (function: logOut)
remove (function: removeAccount)
setData (function: setAccountData)
setName (function: setAccountName)
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

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

Circle (function: createColCircle)
Cuboid (function: createColCuboid)
getElementsWithin (function: getElementsWithinColShape)
getShapeType (function: getColShapeType)
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

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

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

Ped

Inherited from 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

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

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)

RadarArea

Inherited from 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

call (function: call)
copy (function: copyResource)
create (function: createResource)
getDynamicElementRoot (function: getResourceDynamicElementRoot)
getAll (function: getResources)
getFromName (function: getResourceFromName)
getInfo (function: getResourceInfo)
getMapRootElement (function: getResourceMapRootElement)
getName (function: getResourceName)
getRootElement (function: getResourceRootElement)
getState (function: getResourceState)
removeFile (function: removeResourceFile)
restart (function: restartResource)
start (function: startResource)
stop (function: stopResource)
setInfo (function: setResourceInfo)
rename (function: renameResource)
delete (function: deleteResource)

Connection

Inherited from Element

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

QueryHandle

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

Team

Inherited from 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

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)
getMaxPassengers (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

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)