Client Scripting Functions

From Multi Theft Auto: Wiki

This page lists all the client-side 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

Contents 1 Audio functions 2 Blip functions 3 Camera functions 4 Clothes and body functions 5 Collision shape functions 6 Cursor functions 7 Drawing functions 8 Effects functions 9 Element functions 10 Engine functions 11 Event functions 12 Explosion functions 13 File functions 14 Fire functions 15 GUI functions 15.1 Buttons 15.2 Checkboxes 15.3 Comboboxes 15.4 Edit fields 15.5 Gridlists 15.6 Memos 15.7 Progress bars 15.8 Radio buttons 15.9 Scrollbars 15.10 Scroll panes 15.11 Static images 15.12 Tab panels 15.13 Tabs 15.14 Text labels 15.15 Windows 16 Input functions 17 Marker functions 18 Object functions 19 Output functions 20 Ped functions 21 Pickup functions 22 Player functions 23 Projectile functions 24 Radar-area functions 25 Resource functions 26 Serial functions 27 Team functions 28 Utility functions 29 Vehicle functions 30 Water functions 31 Weapon functions 32 World functions 33 XML functions

Audio functions

• playSoundFrontEnd
• getRadioChannel
• getRadioChannelName

• getSoundEffects
• getSoundLength
• getSoundMaxDistance

• getSoundMetaTags
• getSoundMinDistance
• getSoundPosition
• getSoundSpeed
• getSoundVolume
• isSoundPaused
• playSound
• playSound3D
• setRadioChannel

• setSoundEffectEnabled
• setSoundMaxDistance
• setSoundMinDistance
• setSoundPaused
• setSoundPosition
• setSoundSpeed
• setSoundVolume
• stopSound

Blip functions

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

• getBlipVisibleDistance
• setBlipVisibleDistance

Camera functions

• fadeCamera
• getCameraTarget
• setCameraTarget

• getCameraInterior
• getCameraMatrix
• setCameraInterior
• setCameraMatrix

• setCameraClip

• getCameraViewMode
• setCameraViewMode
• getCameraGoggleEffect
• setCameraGoggleEffect

Clothes and body functions

• addPedClothes
• getBodyPartName
• getClothesByTypeIndex
• getClothesTypeName
• getPedClothes
• getTypeIndexFromClothes
• removePedClothes

Collision shape functions

• createColCircle
• createColCuboid
• createColRectangle
• createColSphere
• createColTube

• createColPolygon

Cursor functions

• getCursorPosition
• isCursorShowing
• showCursor

Drawing functions

• dxDrawImage
• dxDrawImageSection
• dxDrawLine
• dxDrawLine3D
• dxDrawRectangle
• dxDrawText
• dxGetFontHeight
• dxGetTextWidth
• dxCreateFont
• dxCreateTexture
• dxCreateShader
• dxCreateRenderTarget
• dxCreateScreenSource
• dxGetMaterialSize
• dxSetShaderValue
• dxSetShaderTessellation
• dxSetShaderTransform
• dxSetRenderTarget
• dxUpdateScreenSource
• dxGetStatus
• dxSetTestMode

• dxGetTexturePixels
• dxSetTexturePixels
• dxGetPixelsSize
• dxGetPixelsFormat
• dxConvertPixels
• dxGetPixelColor
• dxSetPixelColor

Effects functions

• fxAddBlood
• fxAddBulletImpact
• fxAddBulletSplash
• fxAddDebris
• fxAddFootSplash
• fxAddGlass
• fxAddGunshot
• fxAddPunchImpact
• fxAddSparks
• fxAddTankFire
• fxAddTyreBurst
• fxAddWaterHydrant
• fxAddWaterSplash
• fxAddWood

Element functions

• createElement
• destroyElement
• getAttachedElements
• getElementAttachedOffsets
• getElementCollisionsEnabled
• getElementAttachedTo
• getElementBoundingBox
• getElementByID
• getElementChild
• getElementChildren
• getElementChildrenCount
• getElementData
• getElementDimension
• getElementDistanceFromCentreOfMassToBaseOfModel
• getElementHealth
• getElementID
• getElementInterior
• getElementParent
• getElementPosition
• getElementRadius
• getElementsByType
• getElementsWithinColShape
• getElementType
• getElementVelocity
• getRootElement
• isElement
• isElementAttached
• isElementLocal
• isElementOnScreen
• isElementStreamable
• isElementStreamedIn
• isElementWithinColShape
• setElementAlpha
• setElementCollisionsEnabled
• setElementData
• setElementDimension
• setElementDoubleSided
• setElementHealth
• setElementID
• setElementInterior
• setElementParent
• setElementPosition
• setElementStreamable
• setElementVelocity
• attachElements
• detachElements
• getElementColShape
• getElementMatrix
• getElementModel
• getElementRotation
• isElementInWater
• isElementSyncer
• setElementModel
• setElementRotation
• isElementCollidableWith
• setElementCollidableWith
• isElementDoubleSided
• setLowLODElement
• getLowLODElement
• isElementLowLOD
• attachElementToElement
• detachElementFromElement
• isElementFrozen
• setElementFrozen

Engine functions

• engineImportTXD
• engineLoadCOL
• engineLoadDFF
• engineLoadTXD
• engineReplaceCOL
• engineReplaceModel
• engineRestoreCOL
• engineRestoreModel
• engineSetAsynchronousLoading
• engineSetModelLODDistance
• engineApplyShaderToWorldTexture
• engineRemoveShaderFromWorldTexture
• engineGetModelNameFromID
• engineGetModelIDFromName
• engineGetVisibleTextureNames

Event functions

• addEvent
• addEventHandler
• cancelEvent
• removeEventHandler
• triggerEvent
• triggerServerEvent
• wasEventCanceled

Explosion functions

• createExplosion

File functions

• fileClose
• fileCreate
• fileDelete
• fileExists
• fileFlush
• fileGetPos
• fileGetSize
• fileIsEOF
• fileOpen
• fileRead
• fileRename
• fileSetPos
• fileWrite

Fire functions

• createFire

GUI functions

• getChatboxLayout
• guiBringToFront

• guiCreateFont
• guiGetAlpha
• guiGetEnabled
• guiGetFont
• guiGetInputEnabled

• guiGetInputMode
• guiGetPosition
• guiGetProperties
• guiGetProperty
• guiGetScreenSize
• guiGetSize
• guiGetText
• guiGetVisible
• guiMoveToBack
• guiSetAlpha
• guiSetEnabled
• guiSetFont
• guiSetInputEnabled

• guiSetInputMode
• guiSetPosition
• guiSetProperty
• guiSetSize
• guiSetText
• guiSetVisible
• isChatBoxInputActive
• isConsoleActive
• isDebugViewActive
• isMainMenuActive
• isMTAWindowActive
• isTransferBoxActive

Buttons

• guiCreateButton

Checkboxes

• guiCheckBoxGetSelected
• guiCheckBoxSetSelected
• guiCreateCheckBox

Comboboxes

• guiCreateComboBox
• guiComboBoxAddItem
• guiComboBoxClear
• guiComboBoxGetItemText
• guiComboBoxSetItemText
• guiComboBoxRemoveItem
• guiComboBoxGetSelected
• guiComboBoxSetSelected

Edit fields

• guiCreateEdit
• guiEditSetMasked
• guiEditSetMaxLength
• guiEditSetReadOnly

• guiEditSetCaretIndex

Gridlists

• guiCreateGridList
• guiGridListAddColumn
• guiGridListAddRow
• guiGridListAutoSizeColumn
• guiGridListClear
• guiGridListGetItemData
• guiGridListGetItemText
• guiGridListGetRowCount
• guiGridListGetSelectedItem
• guiGridListInsertRowAfter
• guiGridListRemoveColumn
• guiGridListRemoveRow
• guiGridListSetItemData
• guiGridListSetItemText
• guiGridListSetScrollBars
• guiGridListSetSelectedItem
• guiGridListSetSelectionMode
• guiGridListSetSortingEnabled

• guiGridListGetSelectedCount
• guiGridListGetSelectedItems
• guiGridListSetColumnWidth

• guiGridListGetColumnCount

• guiGridListGetItemColor
• guiGridListSetItemColor

Memos

• guiCreateMemo
• guiMemoSetReadOnly

• guiMemoSetCaretIndex

Progress bars

• guiCreateProgressBar
• guiProgressBarGetProgress
• guiProgressBarSetProgress

Radio buttons

• guiCreateRadioButton
• guiRadioButtonGetSelected
• guiRadioButtonSetSelected

Scrollbars

• guiCreateScrollBar
• guiScrollBarGetScrollPosition
• guiScrollBarSetScrollPosition

Scroll panes

• guiCreateScrollPane
• guiScrollPaneGetHorizontalScrollPosition
• guiScrollPaneGetVerticalScrollPosition
• guiScrollPaneSetHorizontalScrollPosition
• guiScrollPaneSetScrollBars
• guiScrollPaneSetVerticalScrollPosition

Static images

• guiCreateStaticImage
• guiStaticImageLoadImage

Tab panels

• guiCreateTabPanel

• guiGetSelectedTab
• guiSetSelectedTab

Tabs

• guiCreateTab
• guiDeleteTab

Text labels

• guiCreateLabel
• guiLabelGetFontHeight
• guiLabelGetTextExtent
• guiLabelSetColor
• guiLabelSetHorizontalAlign
• guiLabelSetVerticalAlign

Windows

• guiCreateWindow
• guiWindowSetMovable
• guiWindowSetSizable

Input functions

• bindKey
• unbindKey
• getKeyState

• getCommandsBoundToKey
• getFunctionsBoundToKey
• getKeyBoundToCommand
• getKeyBoundToFunction
• getControlState
• isControlEnabled
• setControlState
• toggleControl
• toggleAllControls
• getCursorPosition
• addCommandHandler
• removeCommandHandler
• executeCommandHandler
• getBoundKeys
• getAnalogControlState
• setCursorPosition

Marker functions

• createMarker
• getMarkerColor
• getMarkerCount
• getMarkerIcon
• getMarkerSize
• getMarkerTarget
• getMarkerType
• isElementWithinMarker
• setMarkerColor
• setMarkerIcon
• setMarkerSize
• setMarkerTarget
• setMarkerType

Object functions

• createObject
• moveObject
• setObjectScale
• stopObject

• isObjectStatic
• setObjectStatic

Output functions

• outputChatBox
• outputConsole
• outputDebugString
• showChat

Ped functions

• canPedBeKnockedOffBike
• createPed
• doesPedHaveJetPack
• getPedAmmoInClip
• getPedAnimation
• getPedAnimationData
• getPedArmor
• getPedBonePosition
• getPedClothes
• getPedContactElement
• getPedControlState

• getPedMoveState
• getPedOccupiedVehicle
• getPedRotation
• getPedSimplestTask
• getPedSkin
• getPedStat
• getPedTarget
• getPedTargetCollision
• getPedTargetEnd
• getPedTargetStart
• getPedTask
• getPedTotalAmmo
• getPedVoice
• getPedWeapon
• getPedWeaponMuzzlePosition
• getPedWeaponSlot
• isPedChoking
• isPedDoingGangDriveby
• isPedDoingTask
• isPedDucked
• isPedFrozen
• isPedHeadless
• isPedInVehicle
• isPedInWater
• isPedOnFire
• isPedOnGround
• setPedAimTarget
• setPedAnimation
• setPedCameraRotation
• setPedCanBeKnockedOffBike
• setPedControlState
• setPedDoingGangDriveby
• setPedFrozen
• setPedHeadless
• setPedLookAt
• setPedOnFire
• setPedRotation
• setPedSkin
• setPedVoice
• setPedWeaponSlot
• setPedFootBloodEnabled

Pickup functions

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

Player functions

• getLocalPlayer
• getPlayerName
• getPlayerNametagColor
• getPlayerNametagText
• getPlayerPing
• getPlayerTeam
• getPlayerWantedLevel
• isPlayerDead
• isPlayerMapForced
• isPlayerMapVisible
• showPlayerHudComponent

• getPlayerMapBoundingBox
• getPlayerMoney
• givePlayerMoney
• setPlayerMoney
• setPlayerNametagColor
• setPlayerNametagShowing
• setPlayerNametagText
• takePlayerMoney

Projectile functions

• createProjectile

• getProjectileCreator
• getProjectileForce
• getProjectileTarget

• getProjectileType

• detonateSatchels

Radar-area functions

• createRadarArea

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

Resource functions

• call
• getResourceConfig
• getResourceDynamicElementRoot

• getResourceExportedFunctions
• getResourceFromName
• getResourceGUIElement
• getResourceName
• getResourceRootElement
• getThisResource

Serial functions

• getPlayerUserName

• getPlayerSerial

Team functions

• countPlayersInTeam
• getTeamColor
• getTeamFriendlyFire
• getTeamFromName
• getTeamName
• getPlayersInTeam

Utility functions

• getDistanceBetweenPoints2D
• getDistanceBetweenPoints3D
• getEasingValue
• interpolateBetween
• getRealTime
• getTickCount
• getTimerDetails
• getNetworkStats
• setClipboard
• getTimers
• gettok
• killTimer
• resetTimer
• setTimer
• split
• getVersion
• isTimer
• md5
• tocolor
• utfChar
• utfCode
• utfLen
• utfSeek
• utfSub

• toJSON
• fromJSON
• setDevelopmentMode
• getDevelopmentMode

Vehicle functions

• addVehicleUpgrade
• attachTrailerToVehicle
• blowVehicle
• createVehicle
• detachTrailerFromVehicle
• fixVehicle
• getVehicleAdjustableProperty
• getVehicleColor
• getVehicleCompatibleUpgrades
• getVehicleController
• getVehicleDoorState
• getVehicleEngineState
• getVehicleLandingGearDown
• getVehicleLightState
• getVehicleMaxPassengers
• getVehicleName
• getVehicleOccupant
• getVehicleOccupants
• getVehicleCurrentGear
• getVehicleOverrideLights
• getVehiclePaintjob
• getVehiclePanelState
• getVehiclePlateText
• getVehicleRotation
• getVehicleSirensOn
• getVehicleTowedByVehicle
• getVehicleTowingVehicle
• getVehicleTurnVelocity
• getVehicleTurretPosition
• getVehicleUpgradeOnSlot
• getVehicleUpgrades
• getVehicleUpgradeSlotName
• getVehicleWheelStates
• getVehicleDoorOpenRatio
• getVehicleHandling
• getOriginalHandling
• isVehicleDamageProof
• isVehicleFrozen
• isVehicleFuelTankExplodable
• isVehicleLocked
• isVehicleOnGround
• removeVehicleUpgrade
• setVehicleAdjustableProperty
• setVehicleColor
• setVehicleDamageProof
• setVehicleDirtLevel
• setVehicleDoorState
• setVehicleDoorsUndamageable
• setVehicleEngineState
• setVehicleFrozen
• setVehicleFuelTankExplodable
• setVehicleLandingGearDown
• setVehicleLightState
• setVehicleLocked
• setVehicleOverrideLights
• setVehiclePaintjob
• setVehiclePanelState
• setVehicleRotation
• setVehicleSirensOn
• setVehicleTurretPosition
• setVehicleDoorOpenRatio
• setVehicleTurnVelocity
• setVehicleWheelStates
• getHelicopterRotorSpeed
• getTrainDirection
• getTrainSpeed
• getVehicleGravity
• getVehicleHeadLightColor
• getVehicleModelFromName
• getVehicleNameFromModel
• getVehicleType
• isTrainDerailable
• isTrainDerailed
• isVehicleBlown
• isVehicleTaxiLightOn
• setHelicopterRotorSpeed
• setTrainDerailable
• setTrainDerailed
• setTrainDirection
• setTrainSpeed
• setVehicleGravity
• setVehicleHeadLightColor
• setVehicleTaxiLightOn

• getVehicleVariant

Water functions

• createWater

• getWaterColor
• getWaterVertexPosition
• getWaterLevel
• getWaveHeight
• resetWaterColor
• setWaterColor
• setWaterLevel
• setWaterVertexPosition
• setWaveHeight

• resetWaterLevel

Weapon functions

• getWeaponIDFromName
• getWeaponNameFromID

• getWeaponProperty
• getOriginalWeaponProperty

World functions

• areTrafficLightsLocked
• getAircraftMaxHeight
• getCloudsEnabled
• getGameSpeed
• getGravity
• getGroundPosition
• getHeatHaze
• getJetpackMaxHeight
• getScreenFromWorldPosition
• getTime
• getTrafficLightState
• getWeather
• getWindVelocity
• getWorldFromScreenPosition
• getZoneName
• isLineOfSightClear
• processLineOfSight
• resetHeatHaze
• resetSkyGradient
• resetWindVelocity
• setAircraftMaxHeight
• setCloudsEnabled
• setGameSpeed
• setGravity
• setHeatHaze
• setSkyGradient
• setTime
• setTrafficLightState
• setTrafficLightsLocked
• setWeather
• setWeatherBlended
• setWindVelocity
• testLineAgainstWater
• getGarageBoundingBox
• getGaragePosition
• getGarageSize
• getMinuteDuration
• getPlayerBlurLevel
• isGarageOpen
• isWorldSpecialPropertyEnabled
• setCloudsEnabled
• setGarageOpen
• setJetpackMaxHeight
• setMinuteDuration
• setPlayerBlurLevel
• setWorldSpecialPropertyEnabled
• setAmbientSoundEnabled
• isAmbientSoundEnabled
• resetAmbientSounds
• setInteriorSoundsEnabled
• getInteriorSoundsEnabled
• setRainLevel
• getRainLevel
• resetRainLevel
• setSunSize
• getSunSize
• resetSunSize
• setSunColor
• getSunColor
• resetSunColor
• setFarClipDistance
• getFarClipDistance
• resetFarClipDistance
• setFogDistance
• getFogDistance
• resetFogDistance
• createSWATRope
• removeWorldModel
• restoreWorldModel
• restoreAllWorldModels
• setOcclusionsEnabled
• getOcclusionsEnabled
• setBirdsEnabled
• getBirdsEnabled

XML functions

• xmlCopyFile
• xmlCreateFile
• xmlDestroyNode
• xmlLoadFile
• xmlNodeGetAttribute
• xmlNodeGetValue
• xmlNodeSetAttribute
• xmlNodeSetValue
• xmlSaveFile
• xmlUnloadFile

• xmlCreateChild
• xmlFindChild
• xmlNodeGetAttributes
• xmlNodeGetChildren
• xmlNodeGetName
• xmlNodeGetParent
• xmlNodeSetName