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 Fire functions 14 GUI functions 14.1 Buttons 14.2 Checkboxes 14.3 Comboboxes 14.4 Edit fields 14.5 Gridlists 14.6 Memos 14.7 Progress bars 14.8 Radio buttons 14.9 Scrollbars 14.10 Scroll panes 14.11 Static images 14.12 Tab panels 14.13 Tabs 14.14 Text labels 14.15 Windows 15 Input functions 16 Marker functions 17 Object functions 18 Output functions 19 Ped functions 20 Pickup functions 21 Player functions 22 Projectile functions 23 Radar-area functions 24 Resource functions 25 Serial functions 26 Team functions 27 Utility functions 28 Vehicle functions 29 Water functions 30 Weapon functions 31 World functions 32 XML functions

Audio functions

• playSoundFrontEnd
• getRadioChannel
• getRadioChannelName

• getSoundLength
• getSoundMaxDistance

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

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

Blip functions

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

• getBlipOrdering
• setBlipOrdering

Camera functions

• fadeCamera
• getCameraTarget
• setCameraTarget

• getCameraInterior
• getCameraMatrix
• setCameraInterior
• setCameraMatrix

• setCameraClip

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

Effects functions

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

Element functions

• createElement
• destroyElement
• getAttachedElements

• 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
• setElementInterior
• setElementParent
• setElementPosition
• setElementStreamable
• setElementVelocity

• attachElements
• detachElements
• getElementColShape
• getElementMatrix
• getElementModel
• getElementRotation
• isElementInWater
• isElementSyncer
• setElementModel
• setElementRotation

• isElementCollidableWith
• setElementCollidableWith

• isElementDoubleSided

Engine functions

• engineImportTXD
• engineLoadCOL
• engineLoadDFF
• engineLoadTXD
• engineReplaceCOL
• engineReplaceModel
• engineRestoreCOL
• engineRestoreModel

• engineSetAsynchronousLoading

• engineSetModelLODDistance

Event functions

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

Explosion functions

• createExplosion

Fire functions

• createFire

GUI functions

• getChatboxLayout
• guiBringToFront
• guiGetAlpha
• guiGetEnabled
• guiGetFont
• guiGetInputEnabled
• guiGetPosition
• guiGetProperties
• guiGetProperty
• guiGetScreenSize
• guiGetSize
• guiGetText
• guiGetVisible
• guiMoveToBack
• guiSetAlpha
• guiSetEnabled
• guiSetFont
• guiSetInputEnabled
• guiSetPosition
• guiSetProperty
• guiSetSize
• guiSetText
• guiSetVisible
• isChatBoxInputActive
• isConsoleActive
• isDebugViewActive
• isMainMenuActive
• isMTAWindowActive
• isTransferBoxActive

Buttons

• guiCreateButton

Checkboxes

• guiCheckBoxGetSelected
• guiCheckBoxSetSelected
• guiCreateCheckBox

Comboboxes

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

• 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
• getObjectRotation
• setObjectRotation
• setObjectScale
• stopObject

• isObjectStatic
• setObjectStatic

Output functions

• outputChatBox
• outputConsole
• outputDebugString
• showChat

Ped functions

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

• getPedOccupiedVehicle
• getPedRotation
• getPedSimplestTask
• getPedSkin
• getPedStat
• getPedTarget
• getPedTargetCollision
• getPedTargetEnd
• getPedTargetRange
• 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

Pickup functions

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

Player functions

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

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

Projectile functions

• createProjectile

• getProjectileCreator
• getProjectileForce
• getProjectileTarget

• getProjectileType

Radar-area functions

• createRadarArea

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

Resource functions

• call
• getResourceConfig
• getResourceDynamicElementRoot
• getResourceFromName
• getResourceGUIElement
• getResourceName
• getResourceRootElement
• getThisResource

Serial functions

• getPlayerUserName

Team functions

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

Utility functions

• getDistanceBetweenPoints2D
• getDistanceBetweenPoints3D
• getRealTime
• getTickCount

• getTimerDetails
• getTimers
• gettok
• killTimer

• resetTimer
• setTimer
• split
• getVersion
• isTimer
• md5
• tocolor

Vehicle functions

• addVehicleUpgrade
• attachTrailerToVehicle
• blowVehicle
• createVehicle
• detachTrailerFromVehicle
• fixVehicle
• getVehicleAdjustableProperty
• getVehicleColor
• getVehicleCompatibleUpgrades
• getVehicleController
• getVehicleDoorState
• getVehicleLandingGearDown
• getVehicleLightState
• getVehicleMaxPassengers
• getVehicleName
• getVehicleOccupant

• getVehicleOccupants
• getVehicleCurrentGear
• getVehicleOverrideLights
• getVehiclePaintjob
• getVehiclePanelState
• getVehiclePlateText
• getVehicleRotation
• getVehicleSirensOn
• getVehicleTowedByVehicle
• getVehicleTowingVehicle
• getVehicleTurnVelocity
• getVehicleTurretPosition
• getVehicleUpgradeOnSlot
• getVehicleUpgrades
• getVehicleUpgradeSlotName
• getVehicleWheelStates

• isVehicleDamageProof
• isVehicleFrozen
• isVehicleFuelTankExplodable
• isVehicleLocked
• isVehicleOnGround
• removeVehicleUpgrade
• setVehicleAdjustableProperty
• setVehicleColor
• setVehicleDamageProof
• setVehicleDirtLevel
• setVehicleDoorState
• setVehicleDoorsUndamageable
• setVehicleEngineState
• setVehicleFrozen
• setVehicleFuelTankExplodable
• setVehicleLandingGearDown
• setVehicleLightState
• setVehicleLocked
• setVehicleOverrideLights
• setVehiclePaintjob
• setVehiclePanelState
• setVehicleRotation
• setVehicleSirensOn
• setVehicleTurnVelocity
• setVehicleWheelStates

• getHelicopterRotorSpeed
• getTrainDirection
• getTrainSpeed
• getVehicleGravity
• getVehicleHeadLightColor
• getVehicleModelFromName
• getVehicleNameFromModel
• getVehicleType
• isTrainDerailable
• isTrainDerailed
• isVehicleBlown
• isVehicleTaxiLightOn
• setHelicopterRotorSpeed
• setTrainDerailable
• setTrainDerailed
• setTrainDirection
• setTrainSpeed
• setVehicleGravity
• setVehicleHeadLightColor
• setVehicleTaxiLightOn

Water functions

• getWaveHeight
• setWaveHeight

• createWater
• getWaterLevel
• getWaterVertexPosition
• resetWaterColor
• setWaterColor
• setWaterLevel
• setWaterVertexPosition

Weapon functions

• getWeaponIDFromName
• getWeaponNameFromID

World functions

• getGameSpeed
• getGravity
• getGroundPosition
• getScreenFromWorldPosition
• getTime

• getWeather
• getWorldFromScreenPosition
• getZoneName
• isLineOfSightClear
• processLineOfSight
• resetSkyGradient
• setGameSpeed
• setGravity
• setSkyGradient
• setTime

• setWeather
• setWeatherBlended
• testLineAgainstWater

• getCloudsEnabled
• getGarageBoundingBox
• getGaragePosition
• getGarageSize
• getMinuteDuration
• getBlurLevel
• isGarageOpen
• isWorldSpecialPropertyEnabled
• setCloudsEnabled
• setGarageOpen
• setJetpackMaxHeight
• setMinuteDuration
• setBlurLevel
• setWorldSpecialPropertyEnabled

XML functions

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

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