Server/Functions

This is a list of all server functions. For more information on using functions, visit the how to use functions page.

Blip Functions

getBlipCount
getBlips
gta.createBlip
gta.createBlipAttachedTo

blip.children
blip.clearExistsFor
blip.dimension
blip.existsFor
blip.getData
blip.getRotation
blip.id
blip.isCreatedFor
blip.isLocal
blip.isOwner
blip.isSyncer
blip.isType
blip.name
blip.netFlags
blip.parent
blip.position
blip.removeAllData
blip.removeData
blip.resource
blip.rotation
blip.setData
blip.setExistsFor
blip.setRotation
blip.setSyncer
blip.streamInDistance
blip.streamOutDistance
blip.syncer
blip.syncerId
blip.type

Building Functions

getBuildingCount
getBuildings
gta.createBuilding

building.children
building.clearExistsFor
building.dimension
building.existsFor
building.getData
building.getRotation
building.heading
building.id
building.interior
building.isCreatedFor
building.isLocal
building.isOwner
building.isSyncer
building.isType
building.matrix
building.modelIndex
building.name
building.netFlags
building.parent
building.position
building.removeAllData
building.removeData
building.resource
building.rotation
building.setData
building.setExistsFor
building.setRotation
building.setSyncer
building.streamInDistance
building.streamOutDistance
building.syncer
building.syncerId
building.type

Camera Functions

gta.fadeCamera

CancellableEvent Functions

cancellableEvent.isDefaultPrevented
cancellableEvent.preventDefault

Chat Functions

message
messageAllExcept
messageClient

Client Functions

getClient
getClientFromPlayerElement
getClients
localClient

client.administrator
client.cameraInterior
client.console
client.despawnPlayer
client.disconnect
client.game
client.gameVersion
client.getData
client.index
client.ip
client.name
client.ping
client.player
client.removeAllData
client.removeData
client.setData

Command Functions

addCommandHandler
consoleCommand
hasCommandHandler
removeCommandHandler

Element Functions

destroyElement
getElementCount
getElementFromId
getElementFromName
getElements
getElementsByType

element.children
element.clearExistsFor
element.dimension
element.existsFor
element.getData
element.getRotation
element.id
element.isCreatedFor
element.isLocal
element.isOwner
element.isSyncer
element.isType
element.name
element.netFlags
element.parent
element.position
element.removeAllData
element.removeData
element.resource
element.rotation
element.setData
element.setExistsFor
element.setRotation
element.setSyncer
element.streamInDistance
element.streamOutDistance
element.syncer
element.syncerId
element.type

Entity Functions

entity.children
entity.clearExistsFor
entity.dimension
entity.existsFor
entity.getData
entity.getRotation
entity.heading
entity.id
entity.interior
entity.isCreatedFor
entity.isLocal
entity.isOwner
entity.isSyncer
entity.isType
entity.matrix
entity.modelIndex
entity.name
entity.netFlags
entity.parent
entity.position
entity.removeAllData
entity.removeData
entity.resource
entity.rotation
entity.setData
entity.setExistsFor
entity.setRotation
entity.setSyncer
entity.streamInDistance
entity.streamOutDistance
entity.syncer
entity.syncerId
entity.type

Event Functions

addEvent
addEventHandler
bindEventHandler
removeEventHandler
triggerEvent
triggerNetworkEvent
unbindEventHandler

File Functions

createFile
fileExists
loadTextFile
openFile
saveTextFile

GTA Time Functions

gta.time.day
gta.time.hour
gta.time.minute
gta.time.minuteDuration
gta.time.second

HTTP Functions

httpGet

Key Functions

bindKey
unbindAllKeys
unbindKey

KeyEvent Functions

keyEvent.down
keyEvent.isDefaultPrevented
keyEvent.keyCode
keyEvent.mod
keyEvent.preventDefault
keyEvent.repeat
keyEvent.scanCode

Marker Functions

getMarkerCount
getMarkers
gta.createSphere

marker.children
marker.clearExistsFor
marker.dimension
marker.existsFor
marker.getData
marker.getRotation
marker.id
marker.isCreatedFor
marker.isLocal
marker.isOwner
marker.isSyncer
marker.isType
marker.name
marker.netFlags
marker.parent
marker.position
marker.removeAllData
marker.removeData
marker.resource
marker.rotation
marker.setData
marker.setExistsFor
marker.setRotation
marker.setSyncer
marker.streamInDistance
marker.streamOutDistance
marker.syncer
marker.syncerId
marker.type

Matrix4x4 Functions

matrix4x4.getElement
matrix4x4.getVector3
matrix4x4.m11
matrix4x4.m12
matrix4x4.m13
matrix4x4.m14
matrix4x4.m21
matrix4x4.m22
matrix4x4.m23
matrix4x4.m24
matrix4x4.m31
matrix4x4.m32
matrix4x4.m33
matrix4x4.m34
matrix4x4.m41
matrix4x4.m42
matrix4x4.m43
matrix4x4.m44
matrix4x4.multiply
matrix4x4.setElement
matrix4x4.setIdentity
matrix4x4.setInverse
matrix4x4.setMultiply
matrix4x4.setRotate
matrix4x4.setRotateX
matrix4x4.setRotateY
matrix4x4.setRotateZ
matrix4x4.setScale
matrix4x4.setTranslate
matrix4x4.transformCoordinate

Miscellaneous Functions

collectAllGarbage
getConsole
gta.ssvBridgeEnabled
inPoly
platform
toColour

NetFlags Functions

netFlags.alwaysExistForSyncer
netFlags.defaultExistance
netFlags.deleting
netFlags.distanceStreaming
netFlags.forcedSyncer
netFlags.findSyncer
netFlags.onAllDimensions
netFlags.onlySyncIfDetached
netFlags.registered
netFlags.sendSync
netFlags.transient

Network Functions

addNetworkHandler
removeNetworkHandler

Object Functions

getObjectCount
getObjects
gta.createObject
registerNetObject

object.children
object.clearExistsFor
object.dimension
object.existsFor
object.getData
object.getRotation
object.heading
object.id
object.interior
object.isCreatedFor
object.isLocal
object.isOwner
object.isSyncer
object.isType
object.matrix
object.modelIndex
object.name
object.netFlags
object.parent
object.position
object.removeAllData
object.removeData
object.resource
object.rotation
object.setData
object.setExistsFor
object.setRotation
object.setSyncer
object.streamInDistance
object.streamOutDistance
object.syncer
object.syncerId
object.turnVelocity
object.type
object.velocity

Ped Functions

getPedCount
getPeds
gta.createPed

ped.armour
ped.children
ped.clearExistsFor
ped.dimension
ped.existsFor
ped.getData
ped.getRotation
ped.giveWeapon
ped.heading
ped.health
ped.id
ped.interior
ped.isCreatedFor
ped.isEnteringVehicle
ped.isExitingVehicle
ped.isLocal
ped.isOwner
ped.isSyncer
ped.isType
ped.matrix
ped.modelIndex
ped.name
ped.netFlags
ped.parent
ped.position
ped.removeAllData
ped.removeData
ped.resource
ped.rotation
ped.seat
ped.setData
ped.setExistsFor
ped.setRotation
ped.setSyncer
ped.skin
ped.streamInDistance
ped.streamOutDistance
ped.syncer
ped.syncerId
ped.turnVelocity
ped.type
ped.vehicle
ped.velocity
ped.warpIntoVehicle
ped.weapon
ped.weaponAmmunition
ped.weaponClipAmmunition
ped.weaponState

Physical Functions

getPhysicalCount
getPhysicals

physical.children
physical.clearExistsFor
physical.dimension
physical.existsFor
physical.getData
physical.getRotation
physical.heading
physical.id
physical.interior
physical.isCreatedFor
physical.isLocal
physical.isOwner
physical.isSyncer
physical.isType
physical.matrix
physical.modelIndex
physical.name
physical.netFlags
physical.parent
physical.position
physical.removeAllData
physical.removeData
physical.resource
physical.rotation
physical.setData
physical.setExistsFor
physical.setRotation
physical.setSyncer
physical.streamInDistance
physical.streamOutDistance
physical.syncer
physical.syncerId
physical.turnVelocity
physical.type
physical.velocity

Pickup Functions

getPickupCount
getPickups
gta.createPickup

Platform Functions

platform.modState
platform.name
platform.ticks

Player Functions

getPlayerCount
getPlayers
gta.createPlayer
localPlayer
spawnPlayer

player.armour
player.children
player.clearExistsFor
player.dimension
player.existsFor
player.getData
player.getRotation
player.giveWeapon
player.heading
player.health
player.id
player.interior
player.isCreatedFor
player.isEnteringVehicle
player.isExitingVehicle
player.isLocal
player.isOwner
player.isSyncer
player.isType
player.matrix
player.modelIndex
player.name
player.netFlags
player.parent
player.position
player.removeAllData
player.removeData
player.resource
player.rotation
player.seat
player.setData
player.setExistsFor
player.setRotation
player.setSyncer
player.skin
player.streamInDistance
player.streamOutDistance
player.syncer
player.syncerId
player.turnVelocity
player.type
player.vehicle
player.velocity
player.warpIntoVehicle
player.weapon
player.weaponAmmunition
player.weaponClipAmmunition
player.weaponState

Reflection Functions

exportFunction

reflection.call
reflection.clone
reflection.createFunction
reflection.move
reflection.tostring

Resource Functions

findResourceByName
getResources
thisResource

resource.exports
resource.getExport
resource.isStarted
resource.isStarting
resource.name
resource.restart
resource.start
resource.stop

Sdl Functions

sdl.getModState
sdl.platform
sdl.ticks

Server Functions

server.banIP
server.bindIP
server.duplicateNames
server.game
server.gameMode
server.getCVar
server.getRule
server.httpPort
server.httpServer
server.httpURL
server.isIPBanned
server.listed
server.logPath
server.maxClients
server.minClientVersion
server.name
server.pickupStreamInDistance
server.pickupStreamOutDistance
server.port
server.rcon
server.rconPort
server.setPassword
server.setRule
server.shutdown
server.streamInDistance
server.streamOutDistance
server.syncInterval
server.syncLocalEntities
server.syncMethod
server.unbanAllIPs
server.unbanIP

Session Functions

gta.hostSession
gta.joinSession
gta.quickMatch

Stream Functions

stream.close
stream.length
stream.position
stream.readBytes
stream.readDouble
stream.readFloat
stream.readInt16
stream.readInt32
stream.readInt64
stream.readInt8
stream.readLine
stream.readString
stream.readUInt16
stream.readUInt32
stream.readUInt64
stream.readUInt8
stream.writeBytes
stream.writeDouble
stream.writeFloat
stream.writeInt16
stream.writeInt32
stream.writeInt64
stream.writeInt8
stream.writeString
stream.writeUInt16
stream.writeUInt32
stream.writeUInt64
stream.writeUInt8

TextReader Functions

textReader.close
textReader.loadText
textReader.readCharacter
textReader.readLine

Timer Functions

clearImmediate
clearInterval
clearTimeout
setImmediate
setInterval
setTimeout

Train Functions

getTrainCount
getTrains

train.children
train.clearExistsFor
train.colour1
train.colour2
train.colour3
train.colour4
train.derailed
train.dimension
train.engine
train.existsFor
train.fix
train.getData
train.getOccupant
train.getOccupants
train.getRotation
train.heading
train.headlights
train.id
train.interior
train.isCreatedFor
train.isLocal
train.isOwner
train.isSyncer
train.isType
train.locked
train.lockedStatus
train.matrix
train.modelIndex
train.name
train.netFlags
train.parent
train.position
train.randomiseColours
train.removeAllData
train.removeData
train.resource
train.rotation
train.setColours
train.setData
train.setExistsFor
train.setRGBColours
train.setRotation
train.setSyncer
train.speed
train.streamInDistance
train.streamOutDistance
train.strongGrip
train.syncer
train.syncerId
train.taillights
train.track
train.trackPosition
train.turnVelocity
train.type
train.velocity

Vec2 Functions

vec2.addPolar
vec2.cartesianToPolar
vec2.extrapolate
vec2.interpolate
vec2.sphericalExtrapolate
vec2.sphericalInterpolate
vec2.x
vec2.y

Vec3 Functions

vec3.absDotProduct
vec3.addPolar
vec3.addSpherical
vec3.cartesianToPolar
vec3.cartesianToSpherical
vec3.crossProduct
vec3.distance
vec3.dotProduct
vec3.extrapolate
vec3.interpolate
vec3.length
vec3.midPoint
vec3.normalise
vec3.sphericalExtrapolate
vec3.sphericalInterpolate
vec3.squaredDistance
vec3.squaredLength
vec3.x
vec3.y
vec3.z

Vehicle Functions

getVehicleCount
getVehicles
gta.createVehicle

vehicle.children
vehicle.clearExistsFor
vehicle.colour1
vehicle.colour2
vehicle.colour3
vehicle.colour4
vehicle.dimension
vehicle.engine
vehicle.existsFor
vehicle.fix
vehicle.getData
vehicle.getOccupant
vehicle.getOccupants
vehicle.getRotation
vehicle.heading
vehicle.id
vehicle.interior
vehicle.isCreatedFor
vehicle.isLocal
vehicle.isOwner
vehicle.isSyncer
vehicle.isType
vehicle.locked
vehicle.lockedStatus
vehicle.matrix
vehicle.modelIndex
vehicle.name
vehicle.netFlags
vehicle.parent
vehicle.position
vehicle.randomiseColours
vehicle.removeAllData
vehicle.removeData
vehicle.resource
vehicle.rotation
vehicle.setColours
vehicle.setData
vehicle.setExistsFor
vehicle.setRGBColours
vehicle.setRotation
vehicle.setSyncer
vehicle.streamInDistance
vehicle.streamOutDistance
vehicle.strongGrip
vehicle.syncer
vehicle.syncerId
vehicle.turnVelocity
vehicle.type
vehicle.velocity

Weather Functions

gta.forceWeather
gta.weather

World Functions

addToWorld

XmlDocument Functions

xmlDocument.load
xmlDocument.rootElement

XmlElement Functions

xmlElement.attributes
xmlElement.children
xmlElement.childrenCount
xmlElement.clear
xmlElement.getBoolAttribute
xmlElement.getFloatAttribute
xmlElement.getIntegerAttribute
xmlElement.getStringAttribute
xmlElement.name
xmlElement.parent
xmlElement.text