Server Scripting Functions

This page lists all the scripting functions that have been implemented and are available as native functions from the Deathmatch mod. To request a function or event, use Requested Functions and Events

Please note that the scripting functions can now be extended by loading in dynamic modules that provide new functionality, such as MySQL database access. These scripting functions are non-native and require the module to be loaded in order to work.

Head over to Module functions for a list of non-native functions and modules that are available.

Incomplete/Malfunctioning Functions

• Incomplete Function List: Category:Incomplete | Category:Needs_Checking | Category:Check works as specified

Note: To put a function on any of these lists, click edit and copy the and paste it into the function's page.

setPlayerRotation - Incomplete/Possibly not functional

Blip functions

• createBlip
• createBlipAttachedTo
• getBlipColor
• getBlipIcon
• getBlipOrdering
• getBlipSize
• getBlipVisibleDistance
• setBlipColor
• setBlipIcon
• setBlipOrdering
• setBlipSize
• setBlipVisibleDistance

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

Map functions

• loadMapData
• resetMapInfo
• saveMapData

Marker functions

• createMarker
• getMarkerColor
• getMarkerCount
• getMarkerIcon
• getMarkerSize
• getMarkerTarget
ADDED/UPDATED IN VERSION 1.6.0 r22620:
getMarkerTargetArrowProperties
• getMarkerType
• setMarkerColor
• setMarkerIcon
• setMarkerSize
• setMarkerTarget
ADDED/UPDATED IN VERSION 1.6.0 r22620:
setMarkerTargetArrowProperties
• setMarkerType
• isElementWithinMarker

Object functions

• createObject
ADDED/UPDATED IN VERSION 1.6.0 r22489:
breakObject
• getObjectScale
• moveObject
ADDED/UPDATED IN VERSION 1.6.0 r22708:
respawnObject
toggleObjectRespawn
isObjectRespawnable
• setObjectScale
ADDED/UPDATED IN VERSION 1.6.0 r22430:
isObjectMoving
ADDED/UPDATED IN VERSION 1.6.0 r21765:
isObjectBreakable
setObjectBreakable
• stopObject

Pickup functions

• createPickup
• getPickupAmmo
• getPickupAmount
• getPickupType
• setPickupType
• getPickupWeapon

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

Radar area functions

• createRadarArea
• getRadarAreaColor
• getRadarAreaSize
• isInsideRadarArea
• isRadarAreaFlashing
• setRadarAreaColor
• setRadarAreaFlashing
• setRadarAreaSize

Server functions

• getMaxPlayers
• getServerConfigSetting
• getServerHttpPort
• getServerName
• getServerPassword
• getServerPort
• isGlitchEnabled
• setGlitchEnabled
• setMaxPlayers
• setServerConfigSetting
• setServerPassword
• shutdown

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
• base64Decode
• base64Encode
• 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
ADDED/UPDATED IN VERSION 1.6.0 r22701:
isTimerPaused
setTimerPaused
• 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

Vehicle functions

• addVehicleUpgrade
• attachTrailerToVehicle
• blowVehicle
• createVehicle
• detachTrailerFromVehicle
• fixVehicle
• getOriginalHandling
• getTrainDirection
• getTrainPosition
• getTrainSpeed
• getTrainTrack
• getVehicleColor
• getVehicleCompatibleUpgrades
• getVehicleController
• getVehicleDoorOpenRatio
• getVehicleDoorState
• getVehicleEngineState
• getVehicleHandling
• getVehicleHeadLightColor
• getVehicleLandingGearDown
• getVehicleLightState
• getVehicleMaxPassengers
• getVehicleModelFromName
• getVehicleName
• getVehicleNameFromModel
• getVehicleOccupant
• getVehicleOccupants
• getVehicleOverrideLights
• getVehiclePaintjob
• getVehiclePanelState
• getVehiclePlateText
• getVehicleSirenParams
• getVehicleSirens
• getVehicleSirensOn
• getVehicleTowedByVehicle
• getVehicleTowingVehicle
• getVehicleTurretPosition
BEFORE VERSION 1.5.6 :
getVehicleTurnVelocity
• getVehicleType
• getVehicleUpgradeOnSlot
• getVehicleUpgradeSlotName
• getVehicleUpgrades
• getVehicleVariant
• getVehicleWheelStates
• isTrainDerailable
• isTrainDerailed
• isVehicleBlown
• isVehicleDamageProof
• isVehicleFuelTankExplodable
• isVehicleLocked
• isVehicleOnGround
• isVehicleTaxiLightOn
• removeVehicleUpgrade
• setTrainDerailable
• setTrainDerailed
• setTrainDirection
• setTrainPosition
• setTrainSpeed
• setTrainTrack
• setVehicleColor
• setVehicleDamageProof
• setVehicleDoorOpenRatio
• setVehicleDoorState
• setVehicleDoorsUndamageable
• setVehicleEngineState
• setVehicleFuelTankExplodable
• setVehicleHandling
• setVehicleHeadLightColor
• setVehicleLandingGearDown
• setVehicleLightState
• setVehicleLocked
• setVehicleOverrideLights
• setVehiclePaintjob
• setVehiclePanelState
• setVehiclePlateText
• setVehicleSirens
• setVehicleSirensOn
• setVehicleTaxiLightOn
BEFORE VERSION 1.5.6 :
setVehicleTurnVelocity
• setVehicleTurretPosition
• setVehicleVariant
• setVehicleWheelStates
ADDED/UPDATED IN VERSION 1.6.0 r22771:
spawnVehicleFlyingComponent

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
ADDED/UPDATED IN VERSION 1.6.0 r22195:
isWorldSpecialPropertyEnabled
• 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
ADDED/UPDATED IN VERSION 1.6.0 r22195:
setWorldSpecialPropertyEnabled
ADDED/UPDATED IN VERSION 1.6.0 r22741:
resetWorldProperties

XML functions

• xmlCopyFile
• xmlCreateChild
• xmlCreateFile
• xmlDestroyNode
• xmlFindChild
• xmlLoadFile
• xmlLoadString
• xmlNodeGetAttribute
• xmlNodeGetAttributes
• xmlNodeGetChildren
• xmlNodeGetName
• xmlNodeGetParent
• xmlNodeGetValue
• xmlNodeSetAttribute
• xmlNodeSetName
• xmlNodeSetValue
• xmlSaveFile
• xmlUnloadFile