lib

table

lib.DiscordField

inline

boolean

name

string

value

string

lib.DiscordSlashCommandChoice

name

string

value

string

lib.async

async

lib.cache

table

lib.class

Class

lib.classes

table

lib.classes.color

Color

lib.classes.events

EventEmitter

lib.classes.list

List

lib.classes.locale

Locale

lib.classes.map

Map

lib.color

table

lib.color.get_current

function

lib.config

lib.config

lib.config

class

table

default

table<string, Config>

get

function

get_sub

function

get_valid

function

get_valid_sub

function

register

function

register_sub

function

lib.config.class

table

lib.config.class.config

Config

lib.config.default

{ [string]: Config }

lib.config.get

function

lib.config.get_sub

function

lib.config.get_valid

function

lib.config.get_valid_sub

function

lib.config.register

function

lib.config.register_sub

function

lib.console

console

lib.convar

table

lib.convar.get_type

function

lib.convar.get_value

function

lib.current_resource

unknown

lib.database

table

lib.database.count

fun(collection: string, query: table, callback: fun(success: boolean, count: number)|fun(success: boolean, error: string))

lib.database.delete

fun(collection: string, query: table, callback: fun(success: boolean, deletedCount: number)|fun(success: boolean, error: string))

lib.database.delete_one

fun(collection: string, query: table, callback: fun(success: boolean, deletedCount: number)|fun(success: boolean, error: string))

lib.database.find

fun(collection: string, query: table, limit: number, callback: fun(success: boolean, documents: table)|fun(success: boolean, error: string))

lib.database.find_one

fun(collection: string, query: table, callback: fun(success: boolean, document: table)|fun(success: boolean, error: string))

lib.database.insert

fun(collection: string, documents: table, callback: fun(success: boolean, error: string)|fun(success: boolean, insertedCount: number, insertedIds: table))

lib.database.insert_one

fun(collection: string, document: table, callback: fun(success: boolean, error: string)|fun(success: boolean, insertedCount: number, insertedIds: table))

lib.database.is_ready

function

lib.database.ready

function

lib.database.schema

lib.database.schema

lib.database.schema

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.database.schema:Constructor(name: string, fields: table<string, any>)

Default

(method) lib.database.schema:Default()
  -> table<string, any>

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetResult

(method) lib.database.schema:GetResult(result: table<string, any>)
  -> table

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

Serialize

(method) lib.database.schema:Serialize(object: BaseObject)
  -> table<string, any>

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

fields

table<string, lib.database.schema.field>

name

string

new

(method) BaseObject:new(...any)
  -> BaseObject

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.database.schema.field

default

any

name

string

schema

(lib.database.schema)?

type

string

lib.database.update

fun(collection: string, query: table, update: table, callback: fun(success: boolean, error: string)|fun(success: boolean, updatedCount: number))

lib.database.update_one

fun(collection: string, query: table, update: table, callback: fun(success: boolean, error: string)|fun(success: boolean, updatedCount: number))

lib.database.validate_object

function

lib.debug

boolean

lib.discord

BaseObject

lib.discord

AddGuild

(method) lib.discord:AddGuild(guildId: string)
  -> lib.discord.guild

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.discord:Constructor()

DoesGuildExist

(method) lib.discord:DoesGuildExist(guildId: string)
  -> boolean

GetGuild

(method) lib.discord:GetGuild(id: string)
  -> lib.discord.guild|nil

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

IsReady

(method) lib.discord:IsReady()
  -> boolean

Ready

(method) lib.discord:Ready(callback: function)

RemoveGuild

(method) lib.discord:RemoveGuild(guildId: string)
  -> boolean

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

channel

lib.discord.channel

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

guild

lib.discord.guild

guilds

table<string, lib.discord.guild>

message

lib.discord.message

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

slash_command

lib.discord.slash_command

slash_command_option

lib.discord.slash_command_option

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.discord.channel

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.discord.channel:Constructor(id: string)

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

Send

(method) lib.discord.channel:Send(message: lib.discord.message)
  -> lib.discord.channel

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

guild

string

id

string

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.discord.guild

AddChannel

(method) lib.discord.guild:AddChannel(channelId: string)
  -> lib.discord.channel

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.discord.guild:Constructor(id: string)

DoesChannelExist

(method) lib.discord.guild:DoesChannelExist(channelId: string)
  -> boolean

GetChannel

(method) lib.discord.guild:GetChannel(id: string)
  -> lib.discord.channel|nil

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

channels

table<string, lib.discord.channel>

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

id

string

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.discord.message

AddField

(method) lib.discord.message:AddField(field: lib.DiscordField)
  -> lib.discord.message

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.discord.message:Constructor()

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

SetAuthor

(method) lib.discord.message:SetAuthor(author: string, image: string)
  -> lib.discord.message

SetAuthorImage

(method) lib.discord.message:SetAuthorImage(image: string)
  -> lib.discord.message

SetColor

(method) lib.discord.message:SetColor(color: eDiscordColor)
  -> lib.discord.message

SetFields

(method) lib.discord.message:SetFields(fields: lib.DiscordField[])
  -> lib.discord.message

SetFooterImage

(method) lib.discord.message:SetFooterImage(image: string)
  -> lib.discord.message

SetFooterText

(method) lib.discord.message:SetFooterText(text: string)
  -> lib.discord.message

SetText

(method) lib.discord.message:SetText(text: string)
  -> lib.discord.message

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

author

string

author_image

string

color

eDiscordColor

fields

lib.DiscordField[]

footer_image

string

footer_text

string

new

(method) BaseObject:new(...any)
  -> BaseObject

super

(method) BaseObject:super(...any)
  -> unknown|nil

text

string

lib.discord.slash_command

AddBooleanOption

(method) lib.discord.slash_command:AddBooleanOption(name: string, description: string, required: boolean)
  -> lib.discord.slash_command

AddNumberOption

(method) lib.discord.slash_command:AddNumberOption(name: string, description: string, required: boolean, choices: lib.DiscordSlashCommandChoice[])
  -> lib.discord.slash_command

AddStringOption

(method) lib.discord.slash_command:AddStringOption(name: string, description: string, required: boolean, choices: lib.DiscordSlashCommandChoice[])
  -> lib.discord.slash_command

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.discord.slash_command:Constructor(name: string, description: string, callback: fun(notify: fun(message: string), userId: string, arguments: table<string, any>), roleId?: string)

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetOption

(method) lib.discord.slash_command:GetOption(name: string)
  -> lib.discord.slash_command_option

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

HandleArgs

(method) lib.discord.slash_command:HandleArgs(args: table)
  -> table<string, any>

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

description

string

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

name

string

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

options

lib.discord.slash_command_option[]

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

role

string

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.discord.slash_command_option

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.discord.slash_command_option:Constructor(command: string, name: string, description: string, required: boolean, choices: lib.DiscordSlashCommandChoice[], type: string)

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

choices

lib.DiscordSlashCommandChoice[]

description

string

name

string

new

(method) BaseObject:new(...any)
  -> BaseObject

required

boolean

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.entity

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.entity:Constructor(handle: number)

FreezePosition

(method) lib.entity:FreezePosition(toggle: boolean)

GetCoords

(method) lib.entity:GetCoords()
  -> vector4

GetHandle

(method) lib.entity:GetHandle()
  -> number

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetState

(method) lib.entity:GetState()
  -> Entity

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

IsValid

function lib.entity.IsValid(entity?: Entity)
  -> boolean

SetCoords

(method) lib.entity:SetCoords(coords: vector3|vector4, no_offset: boolean)

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

handle

number

model

nil

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

super

(method) BaseObject:super(...any)
  -> unknown|nil

type

unknown

lib.entity

table

lib.entity.classes

table

lib.entity.classes.entity

lib.entity

lib.entity.classes.local_player

lib.entity.player.local

lib.entity.classes.net_player

lib.entity.player.net

lib.entity.classes.ped

lib.entity.ped

lib.entity.classes.player_ped

lib.entity.player_ped

lib.entity.does_exist

function

lib.entity.freeze_position

function

lib.entity.get_coords

function

lib.entity.is_model_loaded

function

lib.entity.ped

AddWeapon

(method) lib.entity.ped:AddWeapon(name: string, ammo: number, forceInHand: boolean)

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

ClearBloodDamage

(method) lib.entity.ped:ClearBloodDamage()

Constructor

(method) lib.entity.ped:Constructor(handle: number)

FreezePosition

(method) lib.entity:FreezePosition(toggle: boolean)

GetCoords

(method) lib.entity:GetCoords()
  -> vector4

GetCurrentWeapon

(method) lib.entity.ped:GetCurrentWeapon()
  -> number

Get the current equiped weapon hash

GetHandle

(method) lib.entity:GetHandle()
  -> number

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetState

(method) lib.entity:GetState()
  -> Entity

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

IsValid

function lib.entity.IsValid(entity?: Entity)
  -> boolean

RemoveWeapon

(method) lib.entity.ped:RemoveWeapon(name: string)

SetCoords

(method) lib.entity:SetCoords(coords: vector3|vector4, no_offset: boolean)

SetDefaultComponent

(method) lib.entity.ped:SetDefaultComponent()

SetRandomComponent

(method) lib.entity.ped:SetRandomComponent()

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

coords

vector4

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

handle

number

model

string

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

super

(method) BaseObject:super(...any)
  -> unknown|nil

type

unknown

lib.entity.player.local

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.entity.player.local:Constructor()

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetPed

(method) lib.entity.player.local:GetPed()
  -> lib.entity.player_ped

GetState

(method) lib.entity.player.local:GetState()
  -> LocalPlayer

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

SetMaxWantedLevel

(method) lib.entity.player.local:SetMaxWantedLevel(level: number)

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

SetWantedLevel

(method) lib.entity.player.local:SetWantedLevel(level: number)

SetWantedLevelNow

(method) lib.entity.player.local:SetWantedLevelNow(level: number)

ShowNotification

(method) lib.entity.player.local:ShowNotification(message: string, hudColorIndex: eHUDColorIndex, isTranslation: boolean, ...any)

ToString

(method) BaseObject:ToString()
  -> string

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

id

unknown

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

ped

lib.entity.player_ped

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.entity.player.net

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.entity.player.net:Constructor(id: number)

Get

function lib.entity.player.net.Get(id: number|lib.entity.player.net)
  -> lib.entity.player.net

GetAll

function lib.entity.player.net.GetAll()
  -> lib.entity.player.net[]

GetAllFromID

function lib.entity.player.net.GetAllFromID()
  -> string[]

GetByIdentifier

function lib.entity.player.net.GetByIdentifier(identifier: string)
  -> lib.entity.player.net|nil

GetIdentifier

function lib.entity.player.net.GetIdentifier(playerId: number, identifierType: eIdentifierType, truncate: boolean)
  -> string

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetName

(method) lib.entity.player.net:GetName()
  -> string

GetPed

(method) lib.entity.player.net:GetPed()
  -> lib.entity.player_ped

GetPing

(method) lib.entity.player.net:GetPing()
  -> number

GetState

(method) lib.entity.player.net:GetState()
  -> Player

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

IsValid

function lib.entity.player.net.IsValid(player?: lib.entity.player.net)
  -> boolean

Kick

(method) lib.entity.player.net:Kick(reason: string)

Remove

function lib.entity.player.net.Remove(id: number|lib.entity.player.net)

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ShowNotification

(method) lib.entity.player.net:ShowNotification(message: string, hudColorIndex: eHUDColorIndex, isTranslation: boolean, ...any)

ToString

(method) BaseObject:ToString()
  -> string

TriggerCallback

(method) lib.entity.player.net:TriggerCallback(eventName: string, callback: fun(...any):void, ...any)

TriggerEvent

(method) lib.entity.player.net:TriggerEvent(eventName: string, ...any)

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

id

number

identifier

string

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

ped

lib.entity.player_ped

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.entity.player_ped

AddWeapon

(method) lib.entity.ped:AddWeapon(name: string, ammo: number, forceInHand: boolean)

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

ClearBloodDamage

(method) lib.entity.ped:ClearBloodDamage()

Constructor

(method) lib.entity.player_ped:Constructor(id: number)

FreezePosition

(method) lib.entity:FreezePosition(toggle: boolean)

GetCoords

(method) lib.entity:GetCoords()
  -> vector4

GetCurrentWeapon

(method) lib.entity.ped:GetCurrentWeapon()
  -> number

Get the current equiped weapon hash

GetHandle

(method) lib.entity.player_ped:GetHandle()
  -> unknown

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetState

(method) lib.entity:GetState()
  -> Entity

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

IsValid

function lib.entity.IsValid(entity?: Entity)
  -> boolean

RemoveWeapon

(method) lib.entity.ped:RemoveWeapon(name: string)

Resurrect

(method) lib.entity.player_ped:Resurrect(coords?: vector4)

SetCoords

(method) lib.entity:SetCoords(coords: vector3|vector4, no_offset: boolean)

SetDefaultComponent

(method) lib.entity.ped:SetDefaultComponent()

SetModel

(async) (method) lib.entity.player_ped:SetModel(model: string|number)

SetRandomComponent

(method) lib.entity.ped:SetRandomComponent()

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

coords

vector4

emit

(method) EventEmitter:emit(eventName: string, ...any)
  -> nil

events

table<string, table<number, fun(...vararg)>>

handle

number

id

number

model

string|number

new

(method) BaseObject:new(...any)
  -> BaseObject

on

(method) EventEmitter:on(eventName: string, callback: fun(...vararg))
  -> table

remove

(method) EventEmitter:remove(eventData: table)
  -> nil

super

(method) BaseObject:super(...any)
  -> unknown|nil

type

unknown

lib.entity.players

table

lib.entity.release_model

function

lib.entity.request_model

function

lib.entity.set_coords

function

lib.enums

table

lib.error_handler

table|fun(callback: function, catch: fun(error: string)):any

lib.events

table

lib.events.base_event

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.events.base_event:Constructor()

Get

function lib.events.base_event.Get(id: string)
  -> lib.events.base_event

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetName

(method) lib.events.base_event:GetName()
  -> string

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

Remove

function lib.events.base_event.Remove(event: lib.events.base_event)
  -> boolean

SetCallback

(method) lib.events.base_event:SetCallback(callback: fun(event: lib.events.base_event|lib.events.net_event, source: number, ...any))
  -> lib.events.base_event

SetHandler

(method) lib.events.base_event:SetHandler()
  -> lib.events.base_event

SetName

(method) lib.events.base_event:SetName(name: string)
  -> lib.events.base_event

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

callback

fun(...any)

handler

eventData

id

string

name

string

new

(method) BaseObject:new(...any)
  -> BaseObject

super

(method) BaseObject:super(...any)
  -> unknown|nil

times_triggered

number

type

string

lib.events.emit

lib.events.emit

lib.events.emit

broadcast

fun(eventName: string, ...any):void

callback

fun(eventName: string, src: number, callback: fun(...any), ...any):fun(eventName: string, callback: fun(...any), ...any):void|void

net

fun(eventName: string, ...any)|fun(eventName: string, src: boolean|number, ...any)

lib.events.net_event

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.events.net_event:Constructor()

Get

function lib.events.base_event.Get(id: string)
  -> lib.events.base_event

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetName

(method) lib.events.base_event:GetName()
  -> string

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

Remove

function lib.events.base_event.Remove(event: lib.events.base_event)
  -> boolean

SetCallback

(method) lib.events.base_event:SetCallback(callback: fun(event: lib.events.base_event|lib.events.net_event, source: number, ...any))
  -> lib.events.base_event

SetHandler

(method) lib.events.net_event:SetHandler()
  -> lib.events.net_event

SetName

(method) lib.events.base_event:SetName(name: string)
  -> lib.events.base_event

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

callback

fun(...any)

handler

unknown

id

string

name

string

new

(method) BaseObject:new(...any)
  -> BaseObject

super

(method) BaseObject:super(...any)
  -> unknown|nil

times_triggered

number

type

string

lib.events.on

lib.events.on

lib.events.on

callback

fun(eventName: string, callback: fun(response: fun(...any), ...any)|fun(src: number, response: fun(...any), ...any), ...any):void

game

fun(eventName: string, callback: fun(event: lib.events.base_event, ...any)):lib.events.base_event

internal

fun(eventName: string, callback: fun(...any)|fun(event: lib.events.base_event, src: boolean|number, ...any)):lib.events.base_event

net

fun(eventName: string, callback: fun(...any)|fun(event: lib.events.net_event, src: boolean|number, ...any)):lib.events.net_event

secure

fun(eventName: string, callback: fun(...any)|fun(event: lib.events.net_event, src: boolean|number, ...any)):lib.events.net_event

lib.events.remove

function

lib.events.safe_callback

fun(eventName: string, callback: fun(...any), ...any)

lib.game

table

lib.game.classes

table

lib.game.classes.marker

Marker

lib.game.classes.marker_circle

MarkerCircle

lib.game.classes.zone

Zone

lib.game.crash

function

lib.game.hash

function

lib.game.input

function

lib.game.loaded

function

lib.game.notification

lib.notification

lib.get_required_resource

function lib.get_required_resource()
  -> string

lib.is_server

unknown

lib.math

View documents

mathlib

lib.name

string

lib.notification

CallParentMethod

(method) BaseObject:CallParentMethod(methodName: string, ...any)
  -> any

Constructor

(method) lib.notification:Constructor()

GetMetatable

(method) BaseObject:GetMetatable()
  -> table

GetType

(method) BaseObject:GetType()
  -> string

GetValue

(method) BaseObject:GetValue(key: string)
  -> any

IsInstanceOf

(method) BaseObject:IsInstanceOf(class_name: string|BaseObject)
  -> boolean

Send

(method) lib.notification:Send(message: string, hudColorIndex: eHudColorIndex, isTranslation: boolean, ...any)
  -> string

SendTo

(method) lib.notification:SendTo(source: number, message: string, hudColorIndex: eHudColorIndex, isTranslation: boolean, ...any)

SetToString

(method) BaseObject:SetToString(name: string)
  -> BaseObject

SetValue

(method) BaseObject:SetValue(key: string, value: any)

ToString

(method) BaseObject:ToString()
  -> string

event

string

new

(method) BaseObject:new(...any)
  -> BaseObject

super

(method) BaseObject:super(...any)
  -> unknown|nil

lib.resource

table

lib.resource.does_exist

function

lib.resource.get_metadata

function

lib.set_required_resource

function lib.set_required_resource(resource?: string)

lib.string

View documents

stringlib

lib.table

View documents

tablelib

lib.ui

Background

function lib.ui.Background()

BadgeStyle

table

Banner

function lib.ui.Banner()

CheckboxStyle

table

CloseAll

function lib.ui.CloseAll()

Colour

table

Controls

function lib.ui.Controls()
  -> nil

Controls

CurrentIsEqualTo

function lib.ui.CurrentIsEqualTo(Current: any, To: any, Style: any, DefaultStyle: any)
  -> unknown

CurrentMenu

nil

Data

UISize

Description

function lib.ui.Description()

DisableControlsOnMenu

function lib.ui.DisableControlsOnMenu()

Disable control action

Enum

unknown

EnumHeritage

unknown

GenerateList

function lib.ui.GenerateList(min: number, max: number)
  -> table

GetCurrentMenu

function lib.ui.GetCurrentMenu()
  -> UIMenu

GetSafeZoneBounds

function lib.ui.GetSafeZoneBounds()
  -> table

GetStyleAudio

function lib.ui.GetStyleAudio()
  -> string

GoActionControl

function lib.ui.GoActionControl(Controls: any, Action: any)

GoActionControlSlider

function lib.ui.GoActionControlSlider(Controls: any, Action: any)

GoBack

function lib.ui.GoBack()
  -> nil

GoBack

GoBackTo

function lib.ui.GoBackTo(menu: UIMenu, callback: function)

GoBackTo

GoDown

function lib.ui.GoDown(Options: number)
  -> nil

GoDown

GoUp

function lib.ui.GoUp(Options: number)
  -> nil

GoUp

IsMouseInBounds

function lib.ui.IsMouseInBounds(X: any, Y: any, Width: any, Height: any)
  -> boolean

IsVisible

function lib.ui.IsVisible(Menu: any)

ItemOffset

number

LastControl

boolean

MouseBounds

function lib.ui.MouseBounds(CurrentMenu: any, Selected: any, Option: any, SettingsButton: any)
  -> boolean

Navigation

function lib.ui.Navigation()
  -> nil

Navigation

NextMenu

UIMenu

Options

integer

Panel

Panel

PanelColour

table

PlaySound

unknown

Render

function lib.ui.Render()

RenderRectangle

function

RenderSprite

function

RenderText

function

ResetDescription

function lib.ui.ResetDescription()

Reset Current Menu description

SafeZone

function lib.ui.SafeZone(CurrentMenu: any)

SetDescription

function lib.ui.SetDescription(CurrentMenu: any, Description: any, Selected: any)

SetScaleformParams

function lib.ui.SetScaleformParams(scaleform: any, data: any)

SetStyleAudio

function lib.ui.SetStyleAudio(StyleAudio: string)
  -> void

SetStyleAudio

SetTextEnabled

function lib.ui.SetTextEnabled(bool: boolean)

Settings

Settings

StatisticPanelCount

integer

Subtitle

function lib.ui.Subtitle()

TextEnabled

boolean

Visible

function lib.ui.Visible(Menu: any, Value: any)
  -> unknown

Window

Window

starts

function lib.ui.starts(String: any, Start: any)
  -> boolean

visual

Visual

lib.ui

lib.ui

lib.ui.Background

function lib.ui.Background()

lib.ui.BadgeStyle

table

lib.ui.Banner

function lib.ui.Banner()

lib.ui.CheckboxStyle

table

lib.ui.CloseAll

function lib.ui.CloseAll()

lib.ui.Colour

table

lib.ui.Controls

Controls

function lib.ui.Controls()
  -> nil

lib.ui.CurrentIsEqualTo

function lib.ui.CurrentIsEqualTo(Current: any, To: any, Style: any, DefaultStyle: any)
  -> unknown

lib.ui.CurrentMenu

nil

nil

any

nil

nil

lib.ui.CurrentMenu.Index

integer

lib.ui.CurrentMenu.Pagination.Maximum

integer

lib.ui.CurrentMenu.Pagination.Minimum

integer

lib.ui.CurrentMenu.open

boolean

boolean

lib.ui.Data

UISize

lib.ui.Description

function lib.ui.Description()

lib.ui.DisableControlsOnMenu

Disable control action

function lib.ui.DisableControlsOnMenu()

lib.ui.Enum

unknown

lib.ui.EnumHeritage

unknown

lib.ui.GenerateList

function lib.ui.GenerateList(min: number, max: number)
  -> table

lib.ui.GetCurrentMenu

function lib.ui.GetCurrentMenu()
  -> UIMenu

lib.ui.GetSafeZoneBounds

function lib.ui.GetSafeZoneBounds()
  -> table

lib.ui.GetStyleAudio

function lib.ui.GetStyleAudio()
  -> string

lib.ui.GoActionControl

function lib.ui.GoActionControl(Controls: any, Action: any)

lib.ui.GoActionControlSlider

function lib.ui.GoActionControlSlider(Controls: any, Action: any)

lib.ui.GoBack

GoBack

function lib.ui.GoBack()
  -> nil

lib.ui.GoBackTo

GoBackTo

function lib.ui.GoBackTo(menu: UIMenu, callback: function)

lib.ui.GoDown

GoDown

function lib.ui.GoDown(Options: number)
  -> nil

lib.ui.GoUp

GoUp

function lib.ui.GoUp(Options: number)
  -> nil

lib.ui.IsMouseInBounds

function lib.ui.IsMouseInBounds(X: any, Y: any, Width: any, Height: any)
  -> boolean

lib.ui.IsVisible

function lib.ui.IsVisible(Menu: any)

lib.ui.ItemOffset

number

integer

integer

integer

number

number

number

integer

number

number

number

number

number

number

number

number

number

number

number

number

lib.ui.LastControl

boolean

boolean

boolean

boolean

boolean

lib.ui.MouseBounds

function lib.ui.MouseBounds(CurrentMenu: any, Selected: any, Option: any, SettingsButton: any)
  -> boolean

lib.ui.Navigation

Navigation

function lib.ui.Navigation()
  -> nil

lib.ui.NextMenu

UIMenu

nil

nil

UIMenu

nil

nil

UIMenu

nil

nil

UIMenu

any

lib.ui.Options

integer

integer

integer

integer

integer

number

number

number

number

number

number

number

number

lib.ui.Panel

Panel

lib.ui.PanelColour

table

lib.ui.PlaySound

unknown

lib.ui.Render

function lib.ui.Render()

lib.ui.RenderRectangle

function

lib.ui.RenderSprite

function

lib.ui.RenderText

function

lib.ui.ResetDescription

Reset Current Menu description

function lib.ui.ResetDescription()

lib.ui.SafeZone

function lib.ui.SafeZone(CurrentMenu: any)

lib.ui.SetDescription

function lib.ui.SetDescription(CurrentMenu: any, Description: any, Selected: any)

lib.ui.SetScaleformParams

function lib.ui.SetScaleformParams(scaleform: any, data: any)

lib.ui.SetStyleAudio

SetStyleAudio

function lib.ui.SetStyleAudio(StyleAudio: string)
  -> void

lib.ui.SetTextEnabled

function lib.ui.SetTextEnabled(bool: boolean)

lib.ui.Settings

Settings

lib.ui.Settings.Audio.Use

string

lib.ui.StatisticPanelCount

integer

integer

number

integer

number

number

lib.ui.Subtitle

function lib.ui.Subtitle()

lib.ui.TextEnabled

boolean

boolean

boolean

boolean

boolean

boolean

boolean

boolean

lib.ui.Visible

function lib.ui.Visible(Menu: any, Value: any)
  -> unknown

lib.ui.Window

Window

lib.ui.Window.Heritage

table

lib.ui.Window.Heritage.RegisterBackground

function Window.Heritage.RegisterBackground()

lib.ui.Window.Heritage.RegisterFirstParent

function Window.Heritage.RegisterFirstParent(currentIndex: number)

lib.ui.Window.Heritage.RegisterSecondParent

function Window.Heritage.RegisterSecondParent(currentIndex: number)

lib.ui.Window.Heritage.Render

function Window.Heritage.Render()

lib.ui.starts

function lib.ui.starts(String: any, Start: any)
  -> boolean

lib.ui.visual

Visual

lib.uuid

function