Client Lib
drawText2d
Draws text onto the screen in 2D space for a single frame.
qbx.drawText2d(params)- params:
table- text:
string - coords:
vector2- On-screen coordinates.
- scale?:
integer- Default:
0.35
- Default:
- font?:
integer- Default:
4
- Default:
- color?:
vector4- An RGBA value; white by default.
- width?:
number- Default:
1.0
- Default:
- height?:
number- Default:
1.0
- Default:
- enableDropShadow?:
boolean- Enables a black drop shadow for the text.
- enableOutline?:
boolean- Enables a black outline for the text.
- text:
drawText3d
Draws text onto the screen in 3D space for a single frame.
qbx.drawText3d(params)- params:
table- text:
string - coords:
vector3- In-world coordinates.
- scale?:
integer|vector2- Use a integer to scale uniformly or use a vec2 to scale x and y different amounts.
- Default:
vec2(0.35, 0.35)
- font?:
integer- Default:
4
- Default:
- color?:
vector4- An RGBA value; white by default.
- disableDrawRect?:
boolean- Disables drawing a rectangle background for the text.
- enableDropShadow?:
boolean- Enables a black drop shadow for the text.
- enableOutline?:
boolean- Enables a black outline for the text.
- text:
getEntityAndNetIdFromBagName
Gets and returns an entity handle and network id from a state bag name.
Will return 0 for both if an invalid entity was received.
qbx.getEntityAndNetIdFromBagName(bagName)- bagName:
string
Returns:
- entity:
integer - netId:
integer
entityStateHandler
Returns a state bag handler made for entities.
qbx.entityStateHandler(keyFilter, cb)- keyFilter:
string - cb:
fun(entity: number, netId: number, value: any, bagName: string)
Returns: number
deleteVehicle
Deletes the specified vehicle and returns whether it was successful.
qbx.deleteVehicle(vehicle)- vehicle:
integer
Returns: boolean
getVehicleDisplayName
Returns the model name of the given vehicle.
qbx.getVehicleDisplayName(vehicle)- vehicle:
integer
Returns: string
getVehicleMakeName
Returns the brand name of the given vehicle.
qbx.getVehicleMakeName(vehicle)- vehicle:
integer
Returns: string
getVehicleModName
Returns the mod type name of the given vehicle.
qbx.getVehicleModName(vehicle, modType, modIndex)- vehicle:
integer - modType:
integer - modIndex:
integer
Returns: string
getVehicleLiveryName
Returns the livery name of the given vehicle.
qbx.getVehicleLiveryName(vehicle, liveryIndex)- vehicle:
integer - liveryIndex:
integer
Returns: string
getStreetName
Returns the street name and cross section name at the given coords.
qbx.getStreetName(coords)- coords:
vector3
Returns:
- streetName:
table- main:
string - cross:
string
- main:
getZoneName
Returns the name of the zone at the given coords.
qbx.getZoneName(coords)- coords:
vector3
Returns: string
setVehicleExtra
Set an extra on the given vehicle.
qbx.setVehicleExtra(vehicle, extra, enable)- vehicle:
integer - extra:
integer - enable:
boolean- Whether to enable the extra.
resetVehicleExtras
Enables all the extras of the given vehicle.
qbx.resetVehicleExtras(vehicle)- vehicle:
integer
setVehicleExtras
Sets all the extras of the given vehicle.
qbx.setVehicleExtra(vehicle, extras)- vehicle:
integer - extras:
table<integer, boolean>
isWearingGloves
Returns if the local ped is wearing gloves.
qbx.isWearingGloves()Returns: boolean
loadAudioBank
Attempts to load an audio bank and returns whether it was successful.
Remember to use ReleaseScriptAudioBank since you can only load up to 10 banks.
qbx.loadAudioBank(audioBank, timeout)- audioBank:
string - timeout?:
number
Returns: boolean
playAudio
Plays a sound with the provided audio name and audio ref.
If returnSoundId is false or not specified the soundId is released,
otherwise the function returns the soundId without releasing it.
qbx.playAudio(params)- params:
table- audioName:
string - audioRef:
string - returnSoundId?:
boolean - audioSource?:
number | vector3- Entity handle or vector3 coords.
- range?:
number- Only used if
audioSourceis a vector3 coordinate.
- Only used if
- audioName:
Returns: number?