Difference between revisions of "OOP server"

From Multi Theft Auto: Wiki
m (Vehicle: Organized Alphabetically using The Alphabetizer)
m (Ped: Organized Alphabetically using The Alphabetizer)
Line 194: Line 194:
 
''Inherited from [[#Element|Element]]''
 
''Inherited from [[#Element|Element]]''
  
getValidModels (function: [[getValidPedModels]])
+
  getValidModels (function: [[getValidPedModels]])
 
  create (function: [[createPed]])
 
  create (function: [[createPed]])
 
  kill (function: [[killPed]])
 
  kill (function: [[killPed]])
Line 244: Line 244:
 
  setAnimation (function: [[setPedAnimation]])
 
  setAnimation (function: [[setPedAnimation]])
 
  setAnimationProgress (function: [[setPedAnimationProgress]])
 
  setAnimationProgress (function: [[setPedAnimationProgress]])
 +
 
==Pickup==
 
==Pickup==
 
''Inherited from [[#Element|Element]]''
 
''Inherited from [[#Element|Element]]''

Revision as of 16:56, 10 August 2014

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)
setVelocity (function: setElementVelocity)

ACL

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

ACLGroup

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

Account

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

Ban

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

Blip

Inherited from Element

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

ColShape

Inherited from Element

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

File

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

Marker

Inherited from Element

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

Object

Inherited from Element

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

Ped

Inherited from Element

 getValidModels (function: getValidPedModels)
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)
isDead (function: isPedDead)
isDucked (function: isPedDucked)
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)
getAnalogControlState (function: getPedAnalogControlState)
getFightingStyle (function: getPedFightingStyle)
getGravity (function: getPedGravity)
getStat (function: getPedStat)
getWeaponSlot (function: getPedWeaponSlot)
getWalkingStyle (function: getPedWalkingStyle)
getAmmoInClip (function: getPedAmmoInClip)
getOccupiedVehicle (function: getPedOccupiedVehicle)
getWeapon (function: getPedWeapon)
getTarget (function: getPedTarget)
getOccupiedVehicleSeat (function: getPedOccupiedVehicleSeat)
getClothes (function: getPedClothes)
getContactElement (function: getPedContactElement)
getTotalAmmo (function: getPedTotalAmmo)
setOnFire (function: setPedOnFire)
setChoking (function: setPedChoking)
setDoingGangDriveBy (function: setPedDoingGangDriveby)
setFrozen (function: setPedFrozen)
setHeadless (function: setPedHeadless)
setArmor (function: setPedArmor)
setAnalogControlState (function: setPedAnalogControlState)
setFightingStyle (function: setPedFightingStyle)
setGravity (function: setPedGravity)
setStat (function: setPedStat)
setWeaponSlot (function: setPedWeaponSlot)
setWalkingStyle (function: setPedWalkingStyle)
setAnimation (function: setPedAnimation)
setAnimationProgress (function: setPedAnimationProgress)

Pickup

Inherited from Element

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

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)
isInside (function: isInsideRadarArea)
isFlashing (function: isRadarAreaFlashing)
getSize (function: getRadarAreaSize)
getColor (function: getRadarAreaColor)
setSize (function: setRadarAreaSize)
setFlashing (function: setRadarAreaFlashing)
setColor (function: setRadarAreaColor)

Resource

Connection

Inherited from Element

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

QueryHandle

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

Team

Inherited from Element

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

TextDisplay

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

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

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

XML

load (function: xmlLoadFile)
destroy (function: xmlUnloadFile)
copy (function: xmlCopyFile)
create (function: xmlCreateFile)
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)
setName (function: xmlNodeSetName)
getAttributes (function: xmlNodeGetAttributes)
getChildren (function: xmlNodeGetChildren)
getName (function: xmlNodeGetName)
getParent (function: xmlNodeGetParent)
getAttribute (function: xmlNodeGetAttribute)

Timer

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