Server Scripting Functions
This page lists all the server-side scripting functions that have been implemented and are available as native functions. To request a function, create an issue in our GitHub repository.
Please note that the scripting functions can also be extended by loading in dynamic modules that provide new functionality, such as utility functions. These scripting functions are non-native and require the module to be loaded in order to work.
Head over to Modules for a list of non-native serverside functions and modules that are available.
For more functions, check the useful functions page.
Client-side scripting functions can be found here: Client Scripting Functions.
Account functions
- addAccount
 - copyAccountData
 - getAccount
 - getAccountData
 - getAccountName
 - getAccountPlayer
 - getAccountSerial
 - getAccounts
 - getAccountsBySerial
 - getAllAccountData
 - getPlayerAccount
 - isGuestAccount
 - logIn
 - logOut
 - removeAccount
 - setAccountData
 - setAccountPassword
 - getAccountByID
 - getAccountID
 - getAccountIP
 - getAccountsByData
 - getAccountsByIP
 - setAccountName
 
ACL functions
- aclCreate
 - aclCreateGroup
 - aclDestroy
 - aclDestroyGroup
 - aclGet
 - aclGetGroup
 - aclGetName
 - aclGetRight
 - aclGroupAddACL
 - aclGroupAddObject
 - aclGroupGetName
 - aclGroupList
 - aclGroupListACL
 - aclGroupListObjects
 - aclGroupRemoveACL
 - aclGroupRemoveObject
 - aclList
 - aclListRights
 - aclReload
 - aclRemoveRight
 - aclSave
 - aclSetRight
 - hasObjectPermissionTo
 - isObjectInACLGroup
 
Admin functions
- addBan
 - banPlayer
 - getBanAdmin
 - getBanIP
 - getBanNick
 - getBanReason
 - getBanSerial
 - getBanTime
 - getBans
 - getUnbanTime
 - isBan
 - kickPlayer
 - setBanAdmin
 - setBanNick
 - setBanReason
 - setUnbanTime
 - reloadBans
 - removeBan
 
Audio functions
Announcement functions
Blip functions
- createBlip
 - createBlipAttachedTo
 - getBlipColor
 - getBlipIcon
 - getBlipOrdering
 - getBlipSize
 - getBlipVisibleDistance
 - setBlipColor
 - setBlipIcon
 - setBlipOrdering
 - setBlipSize
 - setBlipVisibleDistance
 
Camera functions
- fadeCamera
 - getCameraInterior
 - getCameraMatrix
 - getCameraTarget
 - setCameraInterior
 - setCameraMatrix
 - setCameraTarget
 
Clothes and body functions
- addPedClothes
 - getBodyPartName
 - getClothesByTypeIndex
 - getClothesTypeName
 - getPedClothes
 - getTypeIndexFromClothes
 - removePedClothes
 
Collision shape functions
- addColPolygonPoint
 - createColCircle
 - createColCuboid
 - createColPolygon
 - createColRectangle
 - createColSphere
 - createColTube
 - getColPolygonHeight
 - getColPolygonPoints
 - getColPolygonPointPosition
 - getColShapeType
 - getColShapeRadius
 - getColShapeSize
 - getElementColShape
 - getElementsWithinColShape
 - isElementWithinColShape
 - isInsideColShape
 - removeColPolygonPoint
 - setColPolygonHeight
 - setColPolygonPointPosition
 - setColShapeRadius
 - setColShapeSize
 
Cursor functions
Element functions
- attachElements
 - createElement
 - destroyElement
 - detachElements
 - getAttachedElements
 - getElementAlpha
 - getElementAttachedOffsets
 - getElementAttachedTo
 - getElementByIndex
 - getElementByID
 - getElementChild
 - getElementChildren
 - getElementChildrenCount
 - getElementCollisionsEnabled
 - getElementColShape
 - getElementData
 - getAllElementData
 - hasElementData
 - getElementDimension
 - getElementHealth
 - getElementID
 - getElementInterior
 - getElementMatrix
 - getElementModel
 - getElementParent
 - getElementPosition
 - getElementRotation
 - getElementsByType
 - getElementsWithinColShape
 - getElementsWithinRange
 - getElementType
 - getElementVelocity
 - getLowLODElement
 - getRootElement
 - isElement
 - isElementAttached
 - isElementCallPropagationEnabled
 - isElementDoubleSided
 - isElementFrozen
 - isElementInWater
 - isElementLowLOD
 - isElementWithinColShape
 - isElementWithinMarker
 - setElementAlpha
 - setElementAngularVelocity
 - getElementAngularVelocity
 - setElementAttachedOffsets
 - setElementCallPropagationEnabled
 - setElementCollisionsEnabled
 - setElementData
 - setElementDimension
 - setElementDoubleSided
 - setElementFrozen
 - setElementHealth
 - setElementID
 - setElementInterior
 - setElementModel
 - setElementParent
 - setElementPosition
 - setElementRotation
 - setElementVelocity
 - setLowLODElement
 - getPedContactElement
 - getResourceDynamicElementRoot
 - getResourceRootElement
 
Event functions
- addEvent
 - addEventHandler
 - cancelEvent
 - cancelLatentEvent
 - getEventHandlers
 - getLatentEventHandles
 - getLatentEventStatus
 - removeEventHandler
 - triggerEvent
 - wasEventCancelled
 
Explosion functions
File functions
- fileClose
 - fileCopy
 - fileCreate
 - fileDelete
 - fileExists
 - fileFlush
 - fileGetPath
 - fileGetPos
 - fileGetSize
 - fileIsEOF
 - fileOpen
 - fileRead
 - fileRename
 - fileSetPos
 - fileWrite
 
HTTP functions
These functions can only be used from within lua blocks in HTML pages hosted by the server
- httpClear
 - httpRequestLogin
 - httpSetResponseCode
 - httpSetResponseCookie
 - httpSetResponseHeader
 - httpWrite
 
Input functions
- addCommandHandler
 - bindKey
 - executeCommandHandler
 - getCommandHandlers
 - getFunctionsBoundToKey
 - getKeyBoundToFunction
 - isControlEnabled
 - removeCommandHandler
 - toggleAllControls
 - toggleControl
 - unbindKey
 
Map functions
Marker functions
- createMarker
 - getMarkerColor
 - getMarkerCount
 - getMarkerIcon
 - getMarkerSize
 - getMarkerTarget
 - getMarkerType
 - setMarkerColor
 - setMarkerIcon
 - setMarkerSize
 - setMarkerTarget
 - setMarkerType
 - isElementWithinMarker
 
Matrix functions
Module functions
Object functions
Output functions
Ped functions
- addPedClothes
 - getPedClothes
 - removePedClothes
 - createPed
 - getPedAmmoInClip
 - getPedArmor
 - getPedFightingStyle
 - getPedOccupiedVehicle
 - getPedOccupiedVehicleSeat
 - getPedStat
 - getPedTarget
 - getPedTotalAmmo
 - getPedWalkingStyle
 - getPedWeapon
 - getPedWeaponSlot
 - getPedContactElement
 - getValidPedModels
 - isPedChoking
 - isPedDead
 - isPedDoingGangDriveby
 - isPedDucked
 - isPedHeadless
 - isPedInVehicle
 - isPedOnGround
 - isPedReloadingWeapon
 - isPedWearingJetpack
 - killPed
 - removePedFromVehicle
 - setPedAnimation
 - setPedAnimationProgress
 - setPedAnimationSpeed
 - setPedArmor
 - setPedDoingGangDriveby
 - setPedFightingStyle
 - setPedHeadless
 - setPedStat
 - setPedWalkingStyle
 - setPedWeaponSlot
 - warpPedIntoVehicle
 
Pickup functions
Player functions
- getPlayerTeam
 - getPlayerBlurLevel
 - setPlayerBlurLevel
 - getPlayerSerial
 - forcePlayerMap
 - getPlayerScriptDebugLevel
 - getPlayerFromName
 - getPlayerMoney
 - getPlayerName
 - getPlayerNametagColor
 - getPlayerNametagText
 - getPlayerPing
 - getPlayerWantedLevel
 - givePlayerMoney
 - isPlayerMapForced
 - isPlayerNametagShowing
 - setPlayerHudComponentVisible
 - setPlayerMoney
 - setPlayerNametagColor
 - setPlayerNametagShowing
 - setPlayerNametagText
 - takePlayerMoney
 - countPlayersInTeam
 - getPlayersInTeam
 - isVoiceEnabled
 - setControlState
 - getControlState
 
Projectile functions
Radar area functions
- createRadarArea
 - getRadarAreaColor
 - getRadarAreaSize
 - isInsideRadarArea
 - isRadarAreaFlashing
 - setRadarAreaColor
 - setRadarAreaFlashing
 - setRadarAreaSize
 
Resource functions
- abortRemoteRequest
 - call
 - fetchRemote
 - getResourceConfig
 - getResourceDynamicElementRoot
 - getResourceExportedFunctions
 - getResourceFromName
 - getResourceName
 - getResourceRootElement
 - getResourceState
 - getThisResource
 - getRemoteRequests
 - getRemoteRequestInfo
 
Server functions
- getMaxPlayers
 - getServerConfigSetting
 - getServerHttpPort
 - getServerName
 - getServerPassword
 - getServerPort
 - isGlitchEnabled
 - setGlitchEnabled
 - setMaxPlayers
 - setServerConfigSetting
 - setServerPassword
 - shutdown
 
Settings registry functions
SQL functions
Team functions
- countPlayersInTeam
 - getPlayerTeam
 - getPlayersInTeam
 - getTeamColor
 - getTeamFriendlyFire
 - getTeamFromName
 - getTeamName
 
Text functions
- textCreateDisplay
 - textCreateTextItem
 - textDestroyDisplay
 - textDestroyTextItem
 - textDisplayAddObserver
 - textDisplayAddText
 - textDisplayGetObservers
 - textDisplayIsObserver
 - textDisplayRemoveObserver
 - textDisplayRemoveText
 - textItemGetColor
 - textItemGetPosition
 - textItemGetPriority
 - textItemGetScale
 - textItemGetText
 - textItemSetColor
 - textItemSetPosition
 - textItemSetPriority
 - textItemSetScale
 - textItemSetText
 
Utility functions
- addDebugHook
 - debugSleep
 - decodeString
 - encodeString
 - fromJSON
 - generateKeyPair
 - getColorFromString
 - getDevelopmentMode
 - getDistanceBetweenPoints2D
 - getDistanceBetweenPoints3D
 - getEasingValue
 - getNetworkStats
 - getNetworkUsageData
 - getPerformanceStats
 - getRealTime
 - getTickCount
 - getTimerDetails
 - getTimers
 - getFPSLimit
 - getUserdataType
 - getVersion
 - gettok
 - isTransferBoxVisible
 - setTransferBoxVisible
 - hash
 - inspect
 - interpolateBetween
 - iprint
 - isOOPEnabled
 - isTimer
 - killTimer
 - md5
 - passwordHash
 - passwordVerify
 - pregFind
 - pregMatch
 - pregReplace
 - removeDebugHook
 - resetTimer
 - setDevelopmentMode
 - setFPSLimit
 - setTimer
 - ref
 - deref
 - sha256
 - split
 - teaDecode
 - teaEncode
 - toJSON
 - tocolor
 - getProcessMemoryStats
 - utfChar
 - utfCode
 - utfLen
 - utfSeek
 - utfSub
 
- bitAnd
 - bitNot
 - bitOr
 - bitXor
 - bitTest
 - bitLRotate
 - bitRRotate
 - bitLShift
 - bitRShift
 - bitArShift
 - bitExtract
 - bitReplace
 
UTF8 Library
- utf8.byte
 - utf8.char
 - utf8.charpos
 - utf8.escape
 - utf8.find
 - utf8.fold
 - utf8.gmatch
 - utf8.gsub
 - utf8.insert
 - utf8.len
 - utf8.lower
 - utf8.match
 - utf8.ncasecmp
 - utf8.next
 - utf8.remove
 - utf8.reverse
 - utf8.sub
 - utf8.title
 - utf8.upper
 - utf8.width
 - utf8.widthindex
 
Vehicle functions
- addVehicleUpgrade
 - addVehicleSirens
 - attachTrailerToVehicle
 - blowVehicle
 - createVehicle
 - detachTrailerFromVehicle
 - fixVehicle
 - getOriginalHandling
 - getTrainDirection
 - getTrainPosition
 - getTrainSpeed
 - getVehicleColor
 - getVehicleCompatibleUpgrades
 - getVehicleController
 - getVehicleDoorOpenRatio
 - getVehicleDoorState
 - getVehicleEngineState
 - getVehicleHandling
 - getVehicleHeadLightColor
 - getVehicleLandingGearDown
 - getVehicleLightState
 - getVehicleMaxPassengers
 - getVehicleModelFromName
 - getVehicleName
 - getVehicleNameFromModel
 - setVehicleNitroActivated
 - getVehicleOccupant
 - getVehicleOccupants
 - getVehicleOverrideLights
 - getVehiclePaintjob
 - getVehiclePanelState
 - getVehiclePlateText
 - getVehicleSirenParams
 - getVehicleSirens
 - getVehicleSirensOn
 - getVehicleTowedByVehicle
 - getVehicleTowingVehicle
 - getVehicleTurretPosition
 - getVehicleType
 - getVehicleUpgradeOnSlot
 - getVehicleUpgradeSlotName
 - getVehicleUpgrades
 - getVehicleVariant
 - getVehicleWheelStates
 - isTrainDerailable
 - isTrainDerailed
 - isVehicleBlown
 - isVehicleDamageProof
 - isVehicleFuelTankExplodable
 - isVehicleLocked
 - isVehicleOnGround
 - isVehicleTaxiLightOn
 - removeVehicleUpgrade
 - removeVehicleSirens
 - setTrainDerailable
 - setTrainDerailed
 - setTrainDirection
 - setTrainPosition
 - setTrainSpeed
 - setVehicleColor
 - setVehicleDamageProof
 - setVehicleDoorOpenRatio
 - setVehicleDoorState
 - setVehicleDoorsUndamageable
 - setVehicleEngineState
 - setVehicleFuelTankExplodable
 - setVehicleHandling
 - setVehicleHeadLightColor
 - setVehicleLandingGearDown
 - setVehicleLightState
 - setVehicleLocked
 - setVehicleOverrideLights
 - setVehiclePaintjob
 - setVehiclePanelState
 - setVehiclePlateText
 - setVehicleSirens
 - setVehicleSirensOn
 - setVehicleTaxiLightOn
 - setVehicleTurretPosition
 - setVehicleVariant
 - setVehicleWheelStates
 
Water functions
- createWater
 - getWaterColor
 - getWaterVertexPosition
 - getWaveHeight
 - resetWaterColor
 - resetWaterLevel
 - setWaterColor
 - setWaterLevel
 - setWaterVertexPosition
 - setWaveHeight
 
Weapon functions
- getWeaponProperty
 - getPickupWeapon
 - getOriginalWeaponProperty
 - getSlotFromWeapon
 - getWeaponIDFromName
 - getWeaponNameFromID
 - setWeaponAmmo
 - setWeaponProperty
 
World functions
- areTrafficLightsLocked
 - getAircraftMaxHeight
 - getAircraftMaxVelocity
 - getCloudsEnabled
 - getFarClipDistance
 - getFogDistance
 - getGameSpeed
 - getGravity
 - getHeatHaze
 - getInteriorSoundsEnabled
 - getJetpackMaxHeight
 - getMinuteDuration
 - getMoonSize
 - getOcclusionsEnabled
 - getRainLevel
 - getSunColor
 - getSunSize
 - getTime
 - getTrafficLightState
 - getWeather
 - getWindVelocity
 - getSkyGradient
 - getPlayerBlurLevel
 - getZoneName
 - isGarageOpen
 - removeWorldModel
 - resetFarClipDistance
 - resetFogDistance
 - resetHeatHaze
 - resetMoonSize
 - resetRainLevel
 - resetSkyGradient
 - resetSunColor
 - resetSunSize
 - resetWindVelocity
 - restoreAllWorldModels
 - restoreWorldModel
 - setAircraftMaxHeight
 - setAircraftMaxVelocity
 - setCloudsEnabled
 - setFarClipDistance
 - setFogDistance
 - setGameSpeed
 - setGarageOpen
 - setGravity
 - setHeatHaze
 - setInteriorSoundsEnabled
 - setMinuteDuration
 - setMoonSize
 - setOcclusionsEnabled
 - setRainLevel
 - setSkyGradient
 - setSunColor
 - setSunSize
 - setTime
 - setTrafficLightState
 - setTrafficLightsLocked
 - setWeather
 - setWeatherBlended
 - setWindVelocity
 - setJetpackMaxHeight
 - setPlayerBlurLevel