Bully Scripting: Global Functions

DSLAddScriptLoaderCallback(callback)

CLIENT

Does the same thing as RegisterLocalEventHandler("NativeScriptLoaded", callback) would. Mainly meant for legacy support.

DSLAllConfigStrings(config)

SHARED

Like AllConfigValues, but surrounding quotation marks may be removed if present.

DSLAllConfigValues(config, key)

SHARED

Returns an iterator function for all values for a certain config key. Multiple values can be specified in a config file by having multiple lines with the same key.

DSLAllNativeScripts()

CLIENT

Returns an iterator function for all running scripts in the game’s list of native scripts.

DSLAllObjects()

CLIENT

Returns an iterator function for all objects. All objects are guaranteed to be valid when returned.

DSLalloc(bytes)

CLIENT

Allocates memory and returns a pointer object to the start of it.

DSLAllowOnServer()

SHARED

A script header function that designates this script as being allowed to keep running when connecting to a server.

Mainly meant for things that don't affect gameplay, like an FPS counter for example.

DSLAllPeds()

CLIENT

Returns an iterator function for all peds. All peds are guaranteed to be valid when returned.

DSLAllPickups()

CLIENT

Returns an iterator function for all pickups.

DSLAllPlayers([all])

SERVER

Returns an iterator function for all connected players. If all is given and is true, even players that aren't in the "connected" state will be returned.

DSLAllSyncDimensions()

SERVER

Returns an iterator for all sync dimensions.

DSLAllSyncEntities([dimension])

SHARED

Returns an iterator for every sync entity. Includes peds and vehicles, as they are still entities. If a dimension is specified, only entities in that dimension are returned.

DSLAllSyncEntityValues(entity)

SHARED

Returns an iterator for every value in the entity's scripted data table. Works similar to pairs, where a key and value is returned for each call.

DSLAllSyncPeds([dimension])

SHARED

Returns an iterator for every sync ped. If a dimension is specified, only entities in that dimension are returned.

DSLAllSyncPlayers([dimension])

SERVER

Returns an iterator for all players with a sync ped. Keep in mind, all connected players are given a sync ped and will always have one until they're dropped. If a dimension is specified, only players in that dimension are returned.

DSLAllSyncVehicles([dimension])

SHARED

Returns an iterator for every sync vehicle. If a dimension is specified, only entities in that dimension are returned.

DSLAllVehicles()

CLIENT

Returns an iterator for all vehicles. All vehicles are guaranteed to be valid when returned.

DSLargerror(index, string)

SHARED

Raises an error in a way similar to luaL_argerror in Lua's C API. Useful for validating arguments in custom functions.

DSLCallFunctionFromScript([script], func [, ...])

CLIENT

Calls a function from the context of another script. The script can be a DSL script object, the name of a running script (like "main.lua"), or nil for no script.

Returns all results from the function.

DSLCameraGetMatrix()

CLIENT

Returns a 3x3 matrix object from the camera.

DSLCameraGetRotation([order])

CLIENT

Returns the rotation of the camera in radians. May take an optional rotation order.

DSLCameraGetXYZ([distance])

CLIENT

Returns the position of the camera, and a position in front of the camera. The distance argument defines how far in front the second position is, and it will default to 1.

DSLCameraIsWidescreen()

CLIENT

Returns true if the game is in widescreen / cinematic mode. Useful when wanting to check if CameraSetWidescreen was used.

DSLCameraSetMatrix(matrix)

CLIENT

Sets the camera's matrix.

DSLCameraSetPosition(x, y, z)

CLIENT

Sets the position of the camera. This will usually appear to do nothing unless used in a CameraUpdated event.

Usually you should use CameraSetXYZ instead (or as well, if needed).

DSLCameraSetRotation(pitch, roll, yaw [, order])

CLIENT

Sets the rotation of the camera in radians. May take an optional rotation order. This will usually appear to do nothing unless used in a CameraUpdated event.

Usually you should also use CameraSetXYZ in a game thread to help ensure proper rendering. Otherwise, the game may not render things it thinks are out of view.

DSLCanWriteFiles()

SHARED

Returns true if file writing is allowed. It is not allowed after connecting to a server, or if the current script is zipped.

DSLClearCommand()

SHARED

Unregisters a scripted command that may have been registered using SetCommand.

DSLClearDisplay()

CLIENT

Instantly clears the display, making it black. Should only be used in drawing threads.

DSLClearTarget(target)

CLIENT

Clears the render target texture.

DSLCloseFile(file)

SHARED

Close the file.

DSLCopyTexture(texture [, format])

CLIENT

Returns a texture object that is a copy of the texture passed. The format is optional, and only a few are supported. By default, the texture will be compatible with DumpTexture.

DSLCopyTimecycle(tc)

CLIENT

Returns a copy of the timecycle object.

DSLCreateAdvancedThread(type, func)

SHARED

Creates and returns a new thread using the function. Some thread types can only be created using this function.

DSLCreateBitfield([copy])

SHARED

Creates and returns a bitfield object. If copy is given, it is another bitfield to copy from. Otherwise each bit is zero (off) by default.

This bitfield can be indexed like a table using a zero-based index in the range [0, 32).

Can be used to save space in functions like SaveTable, PackTable, PackData, or SendNetworkEvent.

DSLCreateDrawingThread(func)

CLIENT

Creates and returns a new thread using the function. Drawing threads are run right before the game presents the frame.

DSLCreateFolder(name)

SHARED

Creates a folder and all intermediate paths.

DSLCreateFont(name)

CLIENT

Returns a font object by taking a name of a system font. Usually not useful, and only exists because there used to be plans to add custom font support.

DSLCreateMatrix

SHARED

Returns a matrix object. Takes 2 values for the dimensions (row and column count), or a table of rows where each row is another table of numbers (for each column).

DSLCreateRenderTarget(width, height)

CLIENT

Returns a texture object that can be drawn onto using DrawBackBufferOntoTarget.

DSLCreateSyncDimension([name])

SERVER

Creates and returns a new sync dimension. The name is optional, and is primarily only meant for debug purposes. Use SetSyncActiveDimension to activate the dimension.

DSLCreateSyncEntity()

SERVER

Creates and returns a new generic sync entity. This type of entity will not "do" anything on the client by default, so it can be used to script custom sync.

The entity is created in the active dimension, which can be set using SetSyncActiveDimension.

DSLCreateSyncPed()

SERVER

Creates and returns a new sync ped. Sync peds are still considered sync entities.

The entity is created in the active dimension, which can be set using SetSyncActiveDimension.

DSLCreateSyncVehicle()

SERVER

Creates and returns a new sync vehicle. Sync vehicles are still considered sync entities.

The entity is created in the active dimension, which can be set using SetSyncActiveDimension.

DSLCreateSystemThread(func)

CLIENT

Creates and returns a new thread using the function. System threads are run before nearly everything else in the frame.

DSLCreateTexture(name)

CLIENT

Returns a texture object by loading a PNG file given a name. No other formats are supported. The file path is relative to the currently running mod (so the file should be in your mod’s folder).

DSLCreateTextureFromString(data)

CLIENT

Like CreateTexture, but instead of a file name the data is given from a string. The string is still limited to PNG, and is treated just like the data came from a file.

DSLCreateThread(func)

SHARED

Creates and returns a new thread using the function. This thread is considered a game thread, running right after native game scripts.

DSLCreateTimecycle()

CLIENT

Returns a new timecycle object.

DSLCreateVector(...)

SHARED

Returns a matrix object with 1 column and as many rows as there are arguments (up to 4).

DSLDeleteSyncDimension(dimension)

SERVER

Deletes a sync dimension. If it was active, the main dimension is activated.

DSLDeleteSyncEntity(entity)

SERVER

Deletes a sync entity.

DSLDidPlayerUseLauncher(player)

SERVER

Returns true if the player joined through a launcher.

DSLDiscardText()

CLIENT

Discards the active text formatting. See DrawText for details on text formatting functions.

DSLDoesAccountExist(name)

SERVER

Returns true if an account exists with the given case-insensitive name.

DSLDoesCommandExist(command)

SHARED

Returns true if a command exists.

DSLDoesPlayerHaveRole(player, role)

SERVER

Returns true if the player has the role. Always returns true if the role is "admin" and the player's ip is "127.0.0.1".

DSLdofile(name)

SHARED

A custom version of Lua 5.0.2's dofile function that provides enhanced security.

DSLDontAutoStartScript()

SHARED

A script header function that will instantly quit the script if it was started using the initial script auto start.

DSLdouble(value)

CLIENT

Returns an 8 byte double object.

DSLDrawBackBufferOntoTarget(target)

CLIENT

Draws the back buffer onto the render target texture. Should only be used in drawing threads.

DSLDrawRectangle(x, y, width, height [, r [, g [, b [, a]]]])

CLIENT

Draws a rectangle onto the screen. Any un-specified color defaults to 255. If this function is not called from a drawing thread it will be cached and drawn later, see SetDrawLayer for details.

DSLDrawText(text [, ...])

CLIENT

Draws the text using the active text formatting options. Text formatting can be set up using functions that start with SetText. After drawing, the text formatting is reset.

If multiple arguments are given, the string.format function is used to format the string. Returns the width and height of the draw, just like MeasureText would have returned. If this function is not called from a drawing thread it will be cached and drawn later, see SetDrawLayer.

DSLDrawTextInline([width, ] text [..., ] [, duration [, style]])

CLIENT

Draws text in a single call rather than using text formatting options. Returns the width and height of the draw. If this function is not called from a drawing thread it will be cached and drawn later, see SetDrawLayer for details.

The optional width argument should be a number if used, and specifies how wide the text can be before it wraps around. If not specified, the text will not wrap.

The required text argument must be a string. The text may contain any combination of inline format specifiers. Any specifiers that require additional arguments go after the text argument in the order they're specified.

The optional duration argument is how long the text should be drawn in milliseconds. Use 0 to only draw for one frame, or use -1 to only draw for one frame but also not use the reservation system (and instead draw it directly). By default, 0 is assumed.

The optional style argument specifies how to style the text and which reservation slot to use. It can be a number in the range [1, 6] or a text formatting table. By default, 1 is assumed.

Only one text can be drawn for any given style argument. Calling the function again with the same style but different text will override the previously reserved text. However this system is not used if duration is -1, the ~xy~ specifier is used, or if called directly from a drawing thread.

The following inline format specifiers can be put in the text argument. Multiple specifiers can be combined using + to be more compact (like ~font+color~ instead of ~font~~color~).

DSLDrawTexture(texture, x, y, width, height [, r [, g [, b [, a]]]])

CLIENT

Draws a texture onto the screen. If any color channel is not specified, it will default to 255.

If this function is not called from a drawing thread it will be cached and drawn later, see SetDrawLayer for details.

DSLDrawTexture2(texture, x, y, width, height, degrees [, r [, g [, b [, a]]]])

CLIENT

Like DrawTexture, but the position is treated as the center of the draw rather than the top level corner. The texture can also be rotated.

If this function is not called from a drawing thread it will be cached and drawn later, see SetDrawLayer for details.

DSLDrawTextureOntoTarget(target, texture, x, y, width, height, [, r [, g [, b [, a]]]])

CLIENT

Like DrawTexture, but onto a render target texture rather than onto the main back buffer.

If this function is not called from a drawing thread it will be cached and drawn later, see SetDrawLayer for details.

DSLDumpTexture(texture, name [, compression [, alpha]])

CLIENT

Dumps a texture to a PNG file. An optional compression level may be passed in the range [0, 9]. Will fail if CanWriteFiles wouldn't have returned true. The optional alpha argument can be set to true to set every pixel to have a full alpha channel before dumping. If you want the default compression level but also want to use the alpha argument, use -1 for compression. Returns a status (boolean) and an error message if the status is false.

DSLDumpTextureToString(texture [, compression [, alpha]])

CLIENT

Dumps a texture to a string. An optional compression level may be passed in the range [0, 9]. Will fail if CanWriteFiles wouldn't have returned true. The optional alpha argument can be set to true to set every pixel to have a full alpha channel before dumping. If you want the default compression level but also want to use the alpha argument, use -1 for compression. Returns the string if successful, otherwise nil and an error message is returned.

DSLFindFile(name)

SHARED

Returns nothing if no file was found, or the file count if there's at least one.

On Windows, you may use magic characters like * or ? to search for files.

On Unix, this function is not supported.

DSLFindFiles(name)

SHARED

Returns an iterator function for each found file. Each returned value of the iterator is a table containing a "name" string and a "directory" boolean.

On Windows, you may use magic characters like * or ? to search for files.

On Unix, this function is not supported.

DSLfloat(value)

CLIENT

Returns a 4 byte float object.

DSLFlushFile(file)

SHARED

Flushes the file.

DSLForceActionNode(ped, node)

CLIENT

Similar to PedSetActionNode, but forces the node to play by ignoring any conditions for the node.

Note that there is no argument for loading an action tree. If needed, use LoadActionTree first.

DSLForceFacialNode(ped, node)

CLIENT

Like ForceActionNode, but for facial nodes. Can have unexpected but interesting effects when playing a node.

DSLForceTaskNode(ped, node)

CLIENT

Like ForceActionNode, but for task nodes. Can have unexpected but interesting effects when playing a node.