📄️ All DSL Global Functions
A list of all global functions that DSL provides, including their DSL version and a brief description.
📄️ -- progress
51 of 327 functions have been documented.
📄️ AddScriptLoaderCallback
...
📄️ AllConfigStrings
...
📄️ AllConfigValues
Iterates over all values in a configuration object for a given key.
📄️ AllObjects
...
📄️ AllPeds
Returns an iterator function that will return each valid ped one at a time.
📄️ AllPlayers
...
📄️ AllSyncEntities
...
📄️ AllSyncEntityValues
...
📄️ AllSyncPeds
...
📄️ AllSyncPlayers
...
📄️ AllSyncVehicles
...
📄️ AllVehicles
...
📄️ AllowOnServer
...
📄️ CallFunctionFromScript
...
📄️ CameraGetRotation
Returns the current rotation angles of the camera in the game world.
📄️ CameraGetXYZ
Returns the current camera position and its look-at coordinates.
📄️ CameraIsWidescreen
...
📄️ CanWriteFiles
...
📄️ ClearCommand
Unregister a `command` from the current script. Nothing will happen if the command is not registered with the script, and no error will be raised.
📄️ ClearDisplay
...
📄️ CloseFile
...
📄️ ConnectToServer
...
📄️ CopyTimecycle
...
📄️ CreateAdvancedThread
...
📄️ CreateDrawingThread
Creates a new thread specifically for drawing operations in the game.
📄️ CreateFolder
...
📄️ CreateFont
Creates a font object from a file.
📄️ CreateRenderTarget
...
📄️ CreateSyncDimension
...
📄️ CreateSyncEntity
...
📄️ CreateSyncPed
...
📄️ CreateSyncVehicle
...
📄️ CreateSystemThread
Creates a new system thread that runs concurrently with the main game thread.
📄️ CreateTexture
Create a `texture` for later drawing given a relative path of a `.png` file.
📄️ CreateThread
Create a new thread in DSL.
📄️ CreateTimecycle
...
📄️ DeleteSyncDimension
...
📄️ DeleteSyncEntity
...
📄️ DidPlayerUseLauncher
...
📄️ DiscardText
...
📄️ DisconnectFromServer
...
📄️ DoesCommandExist
Check if a `command` exists.
📄️ DontAutoStartScript
...
📄️ DrawBackBufferOntoTarget
...
📄️ DrawRectangle
Draws a rectangle on the screen.
📄️ DrawText
Draws text on the screen.
📄️ DrawTextInline
Draws text on the screen in a specified style for a given duration.
📄️ DrawTexture
Draws a texture on the screen.
📄️ DrawTexture2
...
📄️ FindFile
...
📄️ FindFiles
...
📄️ FlushFile
...
📄️ ForceActionNode
...
📄️ ForceFacialNode
...
📄️ ForceTaskNode
...
📄️ ForceWindowUpdate
...
📄️ GetAllPoolInfo
...
📄️ GetAnyKeyBeingPressed
...
📄️ GetAnyKeyBeingReleased
...
📄️ GetAnyKeyPressed
...
📄️ GetBaseGameFunction
...
📄️ GetConfigBoolean
Get a boolean value from a configuration object.
📄️ GetConfigNumber
Get the number associated with a key in a config.
📄️ GetConfigString
Return the value associated with `key` as a string.
📄️ GetConfigStrings
...
📄️ GetConfigValue
Return the raw value associated with `key` as a string.
📄️ GetControllerPed
...
📄️ GetCurrentScript
...
📄️ GetDisplayAspectRatio
Return the current display aspect ratio.
📄️ GetDisplayResolution
Get the current display resolution used by DSL's renderer.
📄️ GetExtraTimecycle
...
📄️ GetFrameCount
...
📄️ GetFrameTime
Returns the amount of time that has passed since the last frame in seconds.
📄️ GetHash
...
📄️ GetHudTexture
...
📄️ GetInputHardware
...
📄️ GetInternalResolution
Get the game's current internal resolution.
📄️ GetKeyCode
...
📄️ GetLocalizedText
Return the localized `text` associated with a certain `label`.
📄️ GetMouseInput
Returns direct mouse input.
📄️ GetMouseScroll
Returns the scroll wheel value for the mouse.
📄️ GetNodeFromData
...
📄️ GetPackageFilePath
...
📄️ GetPersistentDataTable
...
📄️ GetPhysicsMult
...
📄️ GetPlayerIp
...
📄️ GetPlayerName
...
📄️ GetPoolSize
...
📄️ GetPoolSpace
...
📄️ GetPoolUsage
...
📄️ GetRawPersistentDataTable
...
📄️ GetRawSaveDataTable
...
📄️ GetSaveDataTable
...
📄️ GetScreenCoords
...
📄️ GetScreenResolution
Get the size of the primary monitor.
📄️ GetScriptCollection
...
📄️ GetScriptConfig
Returns the `config` object belonging to the current collection.
📄️ GetScriptEnvironment
...
📄️ GetScriptFilePath
Get a full path given a relative path.
📄️ GetScriptName
...
📄️ GetScriptNetworkTable
...
📄️ GetScriptSharedTable
...
📄️ GetServerHz
...
📄️ GetServerList
...
📄️ GetSimulationSpeed
Return the game's simulation speed.
📄️ GetString
...
📄️ GetSyncActiveDimension
...
📄️ GetSyncDimensionName
...
📄️ GetSyncDimensionSpace
...
📄️ GetSyncEntityArea
...
📄️ GetSyncEntityDimension
...
📄️ GetSyncEntityFromId
...
📄️ GetSyncEntityId
...
📄️ GetSyncEntityModel
...
📄️ GetSyncEntityOwner
...
📄️ GetSyncEntityPed
...
📄️ GetSyncEntityPos
...
📄️ GetSyncEntitySpace
...
📄️ GetSyncEntityVehicle
...
📄️ GetSyncMainDimension
...
📄️ GetSyncPedVehicle
...
📄️ GetSyncPlayerFromPed
...
📄️ GetSyncPlayerPed
...
📄️ GetSyncVehiclePassenger
...
📄️ GetSystemTimer
...
📄️ GetTextFormatting
Get current text formatting table.
📄️ GetTextureAspectRatio
Get the aspect ratio of a texture.
📄️ GetTextureDisplayAspectRatio
Get the ratio that should be used to draw a texture without affecting its aspect ratio.
📄️ GetTextureResolution
Get the resolution of a texture.
📄️ GetThreadName
...
📄️ GetThreadWait
...
📄️ GetTimecycle
...
📄️ GetTimer
...
📄️ GetTypingString
...
📄️ GetVolumeSetting
...
📄️ HookFunction
Register a new function hook.
📄️ ImportScript
...
📄️ IsActionNodeValid
...
📄️ IsConfigMissing
Check if a config file is missing.
📄️ IsConsoleActive
Checks if the console is currently opened.
📄️ IsDslScriptRunning
...
📄️ IsGamePaused
Checks if the game is... *paused*.
📄️ IsHash
...
📄️ IsKeyBeingPressed
Check if a keyboard key was just pressed.
📄️ IsKeyBeingReleased
Check if a keyboard key was just released.
📄️ IsKeyPressed
Check if a keyboard key is currently pressed.
📄️ IsKeyValid
Check if a keyboard key is valid.
📄️ IsMouseBeingPressed
Check if a mouse button was just pressed.
📄️ IsMouseBeingReleased
Check if a mouse button was just released.
📄️ IsMousePressed
Check if a mouse button is currently pressed.
📄️ IsNetworkingAllowed
Check if networking is allowed in the user's DSL config.
📄️ IsPlayerValid
...
📄️ IsSaveDataReady
...
📄️ IsScriptRunning
...
📄️ IsScriptZipped
...
📄️ IsSyncActive
...
📄️ IsSyncDimensionValid
...
📄️ IsSyncEntityOwned
...
📄️ IsSyncEntityReady
...
📄️ IsSyncEntityValid
...
📄️ IsSyncPedValid
...
📄️ IsSyncVehicleValid
...
📄️ IsSystemAccessAllowed
Check if system access is unrestricted.
📄️ IsThreadRunning
...
📄️ IsTypingActive
...
📄️ IsUsingJoystick
...
📄️ KickPlayer
...
📄️ LoadConfigFile
Load a config file.
📄️ LoadScript
Load a *DSL* script into the current script's environment.
📄️ LoadTable
...
📄️ LockSyncEntityOwner
...
📄️ MeasureText
...
📄️ MeasureTextInline
...
📄️ ObjectFaceHeading
...
📄️ ObjectGetEntityFlag
...
📄️ ObjectGetHeading
...
📄️ ObjectGetModelId
...
📄️ ObjectGetPosXYZ
...
📄️ ObjectGetRotation
...
📄️ ObjectIsValid
...
📄️ ObjectNameToHashID
...
📄️ ObjectSetEntityFlag
...
📄️ ObjectSetPosXYZ
...
📄️ ObjectSetRotation
...
📄️ OpenFile
...
📄️ PackData
...
📄️ PackTable
...
📄️ PedCanEnterVehicle
...
📄️ PedCreateScriptless
...
📄️ PedGetActionNode
...
📄️ PedGetActionNodeData
...
📄️ PedGetActionTree
...
📄️ PedGetControllerID
...
📄️ PedGetFacialNode
...
📄️ PedGetFacialNodeData
...
📄️ PedGetModelId
Gets the model ID of a given ped.
📄️ PedGetPointer
...
📄️ PedGetPunishmentPoints
...
📄️ PedGetSyncEntity
...
📄️ PedGetTaskNode
...
📄️ PedGetTaskNodeData
...
📄️ PedGetThrottle
...
📄️ PedIsDoingFacial
...
📄️ PedMeDoingFacial
...
📄️ PedMeDoingTask
...
📄️ PedSetActionNodeSimple
...
📄️ PedSetFacialNodeSimple
...
📄️ PedSetPosSimple
Moves a ped without moving the player.
📄️ PedSetTaskNodeSimple
...
📄️ PedSetThrottle
...
📄️ PedSpoofModel
...
📄️ PlayerHasControl
...
📄️ PopTextFormatting
...
📄️ PrintError
...
📄️ PrintOutput
...
📄️ PrintSpecial
...
📄️ PrintWarning
...
📄️ QuitGame
...
📄️ QuitServer
...
📄️ ReadFile
...
📄️ RegisterFunction
...
📄️ RegisterGameFile
...
📄️ RegisterLocalEventHandler
...
📄️ RegisterLocalizedText
...
📄️ RegisterNetworkEventHandler
...
📄️ RemoveEventHandler
...
📄️ RemoveFunctionHook
...
📄️ ReplaceCode
...
📄️ ReplaceFunction
...
📄️ ReplaceLocalizedText
...
📄️ RequestServerListing
...
📄️ RequireDependency
...
📄️ RequireLoaderVersion
...
📄️ RequirePoolSize
...
📄️ RequireSync
...
📄️ RequireSystemAccess
...
📄️ RestoreTimecycles
...
📄️ RunCommand
...
📄️ RunLocalEvent
...
📄️ SavePersistentDataTables
...
📄️ SaveTable
...
📄️ SeasonGet
...
📄️ SeekFile
...
📄️ SendNetworkEvent
...
📄️ SetAllTimecycles
...
📄️ SetButtonPressed
...
📄️ SetCommand
...
📄️ SetDrawLayer
...
📄️ SetExtraTimecycle
...
📄️ SetHelpText
...
📄️ SetMinigameActive
...
📄️ SetMissionActive
...
📄️ SetRendererAlphaBlending
...
📄️ SetSimulationSpeed
...
📄️ SetStickValue
...
📄️ SetStoryDisabled
...
📄️ SetString
...
📄️ SetSyncActiveDimension
...
📄️ SetSyncEntityDimension
...
📄️ SetSyncEntityModel
...
📄️ SetSyncEntityPos
...
📄️ SetSyncPedVehicle
...
📄️ SetSyncPlayerPed
...
📄️ SetTextAlign
...
📄️ SetTextBlack
...
📄️ SetTextBold
...
📄️ SetTextClipping
...
📄️ SetTextColor
...
📄️ SetTextColour
...
📄️ SetTextFont
...
📄️ SetTextFormatting
...
📄️ SetTextHeight
...
📄️ SetTextItalic
...
📄️ SetTextOutline
...
📄️ SetTextPosition
...
📄️ SetTextRedrawing
...
📄️ SetTextScale
...
📄️ SetTextShadow
...
📄️ SetTextWrapping
...
📄️ SetTextureBounds
...
📄️ SetTimecycle
...
📄️ SetVolumeSetting
...
📄️ SoundPlayAmbientSpeechEventSpecific
...
📄️ StartScript
...
📄️ StartTyping
...
📄️ StartVirtualScript
...
📄️ StopCurrentScriptCollection
...
📄️ StopTyping
...
📄️ TerminateCurrentScript
...
📄️ TerminateCurrentThread
...
📄️ TerminateScript
...
📄️ TerminateThread
...
📄️ UnlockSyncEntityOwner
...
📄️ UnpackData
...
📄️ UnpackTable
...
📄️ UseBaseGameScriptFunctions
...
📄️ UseProxyScriptForFunction
...
📄️ VehicleGetColor
...
📄️ VehicleGetColours
...
📄️ VehicleGetPassenger
...
📄️ VehicleGetPointer
...
📄️ VehicleGetRotation
...
📄️ VehicleGetStatus
...
📄️ VehicleGetSyncEntity
...
📄️ VehicleSetPosSimple
...
📄️ VehicleSetRotation
...
📄️ VehicleUseHorn
...
📄️ Wait
...
📄️ WasSyncEntityUpdated
...
📄️ WasTypingAborted
...
📄️ WeatherGetNext
...
📄️ WeatherGetNow
...
📄️ WeatherGetTransition
...
📄️ WeatherTransition
...
📄️ WriteFile
...
📄️ ZeroController
...
📄️ double
...
📄️ float
...
📄️ int16
...
📄️ int32
...
📄️ int8
...
📄️ print
...
📄️ ptr
...
📄️ type2
...
📄️ uint16
...
📄️ uint32
...
📄️ uint8
...