Index

Search Results for

    Module alt-client

    Package: @altmp/altv-types

    Utils

    BaseObject

    VirtualEntityGroup

    VirtualEntity

    Audio

    AudioOutput

    AudioOutputFrontend

    AudioOutputWorld

    AudioOutputAttached

    WorldObject

    Checkpoint

    Entity

    Player

    LocalPlayer

    Vehicle

    WebView

    Worker

    Blip

    AreaBlip

    RadiusBlip

    PointBlip

    HandlingData

    MapZoomData

    LocalStorage

    MemoryBuffer

    Discord

    Voice

    WebSocketClient

    HttpClient

    Profiler

    RmlDocument

    RmlElement

    Utils

    FocusData

    WeaponData

    LocalObject

    WeaponObject

    Object

    Ped

    AudioFilter

    AudioCategory

    Marker

    Colshape

    ColshapeCylinder

    ColshapeSphere

    ColshapeCircle

    ColshapeCuboid

    ColshapeRectangle

    ColshapePolygon

    TextLabel

    LocalVehicle

    LocalPed

    Font

    Vector3

    Vector2

    Quaternion

    RGBA

    File

    Resource

    IClientEvent

    IDiscordUser

    IVehicleHandling

    IHttpResponse

    IHeapStats

    IProfile

    IProfileCallFrame

    IProfileNode

    IProfileTickInfo

    ICustomBaseObjectMeta

    ICustomBlipMeta

    ICustomCheckpointMeta

    ICustomColshapeMeta

    ICustomWebViewMeta

    ICustomAudioMeta

    ICustomEntityMeta

    ICustomPlayerMeta

    ICustomLocalPlayerMeta

    ICustomVehicleMeta

    ICustomPedMeta

    ICustomEmitEvent

    IMarkerOptions

    IInputDevice

    ISyncInfo

    IResourceConfig

    IVector2

    IVector3

    IQuaternion

    IResource

    IWeapon

    ICustomGlobalMeta

    ICustomGlobalSyncedMeta

    ICustomBaseObjectSyncedMeta

    ICustomEntitySyncedMeta

    ICustomEntityStreamSyncedMeta

    ICustomPlayerSyncedMeta

    ICustomPlayerStreamSyncedMeta

    ICustomPlayerLocalMeta

    ICustomVehicleSyncedMeta

    ICustomVehicleStreamSyncedMeta

    ICustomVirtualEntityStreamSyncedMeta

    ICustomPedSyncedMeta

    ICustomPedStreamSyncedMeta

    ICustomCheckpointStreamSyncedMeta

    ICustomServerClientEvent

    ICustomClientServerEvent

    ICustomServerClientRpc

    ICustomClientServerRpc

    IInspectOptions

    Locale

    StatName

    VehicleIndicatorLights

    WebSocketReadyState

    ConfigFlag

    WatermarkPosition

    GameFont

    TextAlign

    TextLabelAlignment

    BaseObjectType

    BlipSprite

    BlipColor

    BlipType

    MarkerType

    ColShapeType

    AudioCategories

    FileEncoding

    Permission

    CheckpointType

    ModelType

    KeyCode

    BodyPart

    PedConfigFlag

    VoiceConnectionState

    VehicleLockState

    Functions

    | Improve this Doc View Source

    addGxtText(string | number, string)

    Declaration
    addGxtText(key: string | number, value: string): void
    Parameters
    Type Name Description
    string | number key
    string value
    | Improve this Doc View Source

    beginScaleformMovieMethodMinimap(string)

    Declaration
    beginScaleformMovieMethodMinimap(methodName: string): boolean
    Parameters
    Type Name Description
    string methodName
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    emit<K extends never>(K, Parameters<ICustomEmitEvent[K]>)

    Declaration
    emit<K extends never>(eventName: K, ...args: Parameters<ICustomEmitEvent[K]>): void
    Parameters
    Type Name Description
    K eventName
    Parameters<ICustomEmitEvent[K]> args
    | Improve this Doc View Source

    emit<K extends string>(Exclude<K, keyof IClientEvent>, any[])

    Declaration
    emit<K extends string>(eventName: Exclude<K, keyof IClientEvent>, ...args: any[]): void
    Parameters
    Type Name Description
    Exclude<K, keyof IClientEvent> eventName
    any[] args
    | Improve this Doc View Source

    emitRaw<K extends never>(K, Parameters<ICustomEmitEvent[K]>)

    Declaration
    emitRaw<K extends never>(eventName: K, ...args: Parameters<ICustomEmitEvent[K]>): void
    Parameters
    Type Name Description
    K eventName
    Parameters<ICustomEmitEvent[K]> args
    | Improve this Doc View Source

    emitRaw<K extends string>(Exclude<K, keyof IClientEvent>, any[])

    Declaration
    emitRaw<K extends string>(eventName: Exclude<K, keyof IClientEvent>, ...args: any[]): void
    Parameters
    Type Name Description
    Exclude<K, keyof IClientEvent> eventName
    any[] args
    | Improve this Doc View Source

    emitServer<K extends never>(K, Parameters<ICustomClientServerEvent[K]>)

    Declaration
    emitServer<K extends never>(eventName: K, ...args: Parameters<ICustomClientServerEvent[K]>): void
    Parameters
    Type Name Description
    K eventName
    Parameters<ICustomClientServerEvent[K]> args
    | Improve this Doc View Source

    emitServer<K extends string>(Exclude<K, never>, any[])

    Declaration
    emitServer<K extends string>(eventName: Exclude<K, never>, ...args: any[]): void
    Parameters
    Type Name Description
    Exclude<K, never> eventName
    any[] args
    | Improve this Doc View Source

    emitServerRaw<K extends never>(K, Parameters<ICustomClientServerEvent[K]>)

    Declaration
    emitServerRaw<K extends never>(eventName: K, ...args: Parameters<ICustomClientServerEvent[K]>): void
    Parameters
    Type Name Description
    K eventName
    Parameters<ICustomClientServerEvent[K]> args
    | Improve this Doc View Source

    emitServerRaw<K extends string>(Exclude<K, never>, any[])

    Declaration
    emitServerRaw<K extends string>(eventName: Exclude<K, never>, ...args: any[]): void
    Parameters
    Type Name Description
    Exclude<K, never> eventName
    any[] args
    | Improve this Doc View Source

    emitServerUnreliable<K extends never>(K, Parameters<ICustomClientServerEvent[K]>)

    Declaration
    emitServerUnreliable<K extends never>(eventName: K, ...args: Parameters<ICustomClientServerEvent[K]>): void
    Parameters
    Type Name Description
    K eventName
    Parameters<ICustomClientServerEvent[K]> args
    | Improve this Doc View Source

    emitServerUnreliable<K extends string>(Exclude<K, never>, any[])

    Declaration
    emitServerUnreliable<K extends string>(eventName: Exclude<K, never>, ...args: any[]): void
    Parameters
    Type Name Description
    Exclude<K, never> eventName
    any[] args
    | Improve this Doc View Source

    emitRpc<K extends never>(K, Parameters<ICustomClientServerRpc[K]>)

    Declaration
    emitRpc<K extends never>(rpcName: K, ...args: Parameters<ICustomClientServerRpc[K]>): Promise<ReturnType<shared.ICustomClientServerRpc[K]>>
    Parameters
    Type Name Description
    K rpcName
    Parameters<ICustomClientServerRpc[K]> args
    Returns
    Type Description
    Promise<ReturnType<ICustomClientServerRpc[K]>>
    | Improve this Doc View Source

    emitRpc<K extends string>(Exclude<K, never>, any[])

    Declaration
    emitRpc<K extends string>(rpcName: Exclude<K, never>, ...args: any[]): Promise<any>
    Parameters
    Type Name Description
    Exclude<K, never> rpcName
    any[] args
    Returns
    Type Description
    Promise<any>
    | Improve this Doc View Source

    onRpc<K extends never>(K, (...args: Parameters<ICustomServerClientRpc[K]>) => ReturnType<ICustomServerClientRpc[K]> | Promise<ReturnType<ICustomServerClientRpc[K]>>)

    Declaration
    onRpc<K extends never>(rpcName: K, listener: (...args: Parameters<ICustomServerClientRpc[K]>) => ReturnType<ICustomServerClientRpc[K]> | Promise<ReturnType<ICustomServerClientRpc[K]>>): void
    Parameters
    Type Name Description
    K rpcName
    (...args: Parameters<ICustomServerClientRpc[K]>) => ReturnType<ICustomServerClientRpc[K]> | Promise<ReturnType<ICustomServerClientRpc[K]>> listener
    | Improve this Doc View Source

    onRpc<K extends string>(Exclude<K, never>, (...args: any[]) => any)

    Declaration
    onRpc<K extends string>(rpcName: Exclude<K, never>, listener: (...args: any[]) => any): void
    Parameters
    Type Name Description
    Exclude<K, never> rpcName
    (...args: any[]) => any listener
    | Improve this Doc View Source

    offRpc<K extends never>(K, (...args: Parameters<ICustomServerClientRpc[K]>) => ReturnType<ICustomServerClientRpc[K]> | Promise<ReturnType<ICustomServerClientRpc[K]>>)

    Declaration
    offRpc<K extends never>(rpcName: K, listener?: (...args: Parameters<ICustomServerClientRpc[K]>) => ReturnType<ICustomServerClientRpc[K]> | Promise<ReturnType<ICustomServerClientRpc[K]>>): void
    Parameters
    Type Name Description
    K rpcName
    (...args: Parameters<ICustomServerClientRpc[K]>) => ReturnType<ICustomServerClientRpc[K]> | Promise<ReturnType<ICustomServerClientRpc[K]>> listener
    | Improve this Doc View Source

    offRpc<K extends string>(Exclude<K, never>, (...args: any[]) => any)

    Declaration
    offRpc<K extends string>(rpcName: Exclude<K, never>, listener?: (...args: any[]) => any): void
    Parameters
    Type Name Description
    Exclude<K, never> rpcName
    (...args: any[]) => any listener
    | Improve this Doc View Source

    gameControlsEnabled()

    Declaration
    gameControlsEnabled(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getCursorPos(boolean)

    Declaration
    getCursorPos(normalized?: boolean): shared.Vector2
    Parameters
    Type Name Description
    boolean normalized
    Returns
    Type Description
    Vector2
    | Improve this Doc View Source

    getGxtText(string | number)

    Declaration
    getGxtText(key: string | number): string | null
    Parameters
    Type Name Description
    string | number key
    Returns
    Type Description
    string | null
    | Improve this Doc View Source

    getLicenseHash()

    Declaration
    getLicenseHash(): string
    Returns
    Type Description
    string
    | Improve this Doc View Source

    getLocale()

    Declaration
    getLocale(): Locale
    Returns
    Type Description
    Locale
    | Improve this Doc View Source

    getLocale()

    Declaration
    getLocale(): Object
    Returns
    Type Description
    Object
    | Improve this Doc View Source

    getMsPerGameMinute()

    Declaration
    getMsPerGameMinute(): number
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getServerTime()

    Declaration
    getServerTime(): number
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getPermissionState(Permission)

    Declaration
    getPermissionState(permId: Permission): boolean
    Parameters
    Type Name Description
    Permission permId
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getPermissionState<T extends number>(T)

    Declaration
    getPermissionState<T extends number>(permId: T): boolean
    Parameters
    Type Name Description
    T permId
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getStat(StatName)

    Declaration
    getStat(statName: StatName): number
    Parameters
    Type Name Description
    StatName statName
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getStat("stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability")

    Declaration
    getStat(statName: "stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability"): number
    Parameters
    Type Name Description
    "stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability" statName
    Returns
    Type Description
    number
    | Improve this Doc View Source

    isConsoleOpen()

    Declaration
    isConsoleOpen(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isGameFocused()

    Declaration
    isGameFocused(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isInStreamerMode()

    Declaration
    isInStreamerMode(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isKeyToggled(KeyCode)

    Declaration
    isKeyToggled(key: KeyCode): boolean
    Parameters
    Type Name Description
    KeyCode key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isKeyDown(KeyCode)

    Declaration
    isKeyDown(key: KeyCode): boolean
    Parameters
    Type Name Description
    KeyCode key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isMenuOpen()

    Declaration
    isMenuOpen(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isTextureExistInArchetype(number, string)

    Declaration
    isTextureExistInArchetype(modelHash: number, targetTextureName: string): boolean
    Parameters
    Type Name Description
    number modelHash
    string targetTextureName
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    loadModel(number)

    Declaration
    loadModel(modelHash: number): void
    Parameters
    Type Name Description
    number modelHash
    | Improve this Doc View Source

    loadModelAsync(number)

    Declaration
    loadModelAsync(modelHash: number): void
    Parameters
    Type Name Description
    number modelHash
    | Improve this Doc View Source

    offServer<K extends never>(K, (...args: Parameters<ICustomServerClientEvent[K]>) => void)

    Declaration
    offServer<K extends never>(eventName: K, listener: (...args: Parameters<ICustomServerClientEvent[K]>) => void): void
    Parameters
    Type Name Description
    K eventName
    (...args: Parameters<ICustomServerClientEvent[K]>) => void listener
    | Improve this Doc View Source

    offServer<K extends string>(Exclude<K, never>, (...args: any[]) => void)

    Declaration
    offServer<K extends string>(eventName: Exclude<K, never>, listener: (...args: any[]) => void): void
    Parameters
    Type Name Description
    Exclude<K, never> eventName
    (...args: any[]) => void listener
    | Improve this Doc View Source

    offServer(string, (...args: any[]) => void)

    Declaration
    offServer(eventName: string, listener: (...args: any[]) => void): void
    Parameters
    Type Name Description
    string eventName
    (...args: any[]) => void listener
    | Improve this Doc View Source

    offServer((eventName: string, ...args: any[]) => void)

    Declaration
    offServer(listener: (eventName: string, ...args: any[]) => void): void
    Parameters
    Type Name Description
    (eventName: string, ...args: any[]) => void listener
    | Improve this Doc View Source

    on<K extends keyof IClientEvent>(K, (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void)

    Declaration
    on<K extends keyof IClientEvent>(eventName: K, listener: (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void): void
    Parameters
    Type Name Description
    K eventName
    (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void listener
    | Improve this Doc View Source

    on<K extends string>(Exclude<K, keyof IClientEvent>, (...args: any[]) => void)

    Declaration
    on<K extends string>(eventName: Exclude<K, keyof IClientEvent>, listener: (...args: any[]) => void): void
    Parameters
    Type Name Description
    Exclude<K, keyof IClientEvent> eventName
    (...args: any[]) => void listener
    | Improve this Doc View Source

    once<K extends keyof IClientEvent>(K, (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void)

    Declaration
    once<K extends keyof IClientEvent>(eventName: K, listener: (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void): void
    Parameters
    Type Name Description
    K eventName
    (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void listener
    | Improve this Doc View Source

    once<K extends string>(Exclude<K, keyof IClientEvent>, (...args: any[]) => void)

    Declaration
    once<K extends string>(eventName: Exclude<K, keyof IClientEvent>, listener: (...args: any[]) => void): void
    Parameters
    Type Name Description
    Exclude<K, keyof IClientEvent> eventName
    (...args: any[]) => void listener
    | Improve this Doc View Source

    off<K extends keyof IClientEvent>(K, (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void)

    Declaration
    off<K extends keyof IClientEvent>(eventName: K, listener: (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void): void
    Parameters
    Type Name Description
    K eventName
    (...args: Parameters<K extends keyof IClientEvent ? IClientEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void listener
    | Improve this Doc View Source

    off<K extends string>(Exclude<K, keyof IClientEvent>, (...args: any[]) => void)

    Declaration
    off<K extends string>(eventName: Exclude<K, keyof IClientEvent>, listener: (...args: any[]) => void): void
    Parameters
    Type Name Description
    Exclude<K, keyof IClientEvent> eventName
    (...args: any[]) => void listener
    | Improve this Doc View Source

    onServer<K extends never>(K, (...args: Parameters<ICustomServerClientEvent[K]>) => void)

    Declaration
    onServer<K extends never>(eventName: K, listener: (...args: Parameters<ICustomServerClientEvent[K]>) => void): void
    Parameters
    Type Name Description
    K eventName
    (...args: Parameters<ICustomServerClientEvent[K]>) => void listener
    | Improve this Doc View Source

    onServer<K extends string>(Exclude<K, never>, (...args: any[]) => void)

    Declaration
    onServer<K extends string>(eventName: Exclude<K, never>, listener: (...args: any[]) => void): void
    Parameters
    Type Name Description
    Exclude<K, never> eventName
    (...args: any[]) => void listener
    | Improve this Doc View Source

    onServer((eventName: string, ...args: any[]) => void)

    Declaration
    onServer(listener: (eventName: string, ...args: any[]) => void): void
    Parameters
    Type Name Description
    (eventName: string, ...args: any[]) => void listener
    | Improve this Doc View Source

    onceServer<K extends never>(K, (...args: Parameters<ICustomServerClientEvent[K]>) => void)

    Declaration
    onceServer<K extends never>(eventName: K, listener: (...args: Parameters<ICustomServerClientEvent[K]>) => void): void
    Parameters
    Type Name Description
    K eventName
    (...args: Parameters<ICustomServerClientEvent[K]>) => void listener
    | Improve this Doc View Source

    onceServer<K extends string>(Exclude<K, never>, (...args: any[]) => void)

    Declaration
    onceServer<K extends string>(eventName: Exclude<K, never>, listener: (...args: any[]) => void): void
    Parameters
    Type Name Description
    Exclude<K, never> eventName
    (...args: any[]) => void listener
    | Improve this Doc View Source

    onceServer((eventName: string, ...args: any[]) => void)

    Declaration
    onceServer(listener: (eventName: string, ...args: any[]) => void): void
    Parameters
    Type Name Description
    (eventName: string, ...args: any[]) => void listener
    | Improve this Doc View Source

    removeGxtText(string)

    Declaration
    removeGxtText(key: string): void
    Parameters
    Type Name Description
    string key
    | Improve this Doc View Source

    removeIpl(string)

    Declaration
    removeIpl(iplName: string): void
    Parameters
    Type Name Description
    string iplName
    | Improve this Doc View Source

    requestIpl(string)

    Declaration
    requestIpl(iplName: string): void
    Parameters
    Type Name Description
    string iplName
    | Improve this Doc View Source

    takeScreenshot()

    Declaration
    takeScreenshot(): Promise<string>
    Returns
    Type Description
    Promise<string>
    | Improve this Doc View Source

    takeScreenshotGameOnly()

    Declaration
    takeScreenshotGameOnly(): Promise<string>
    Returns
    Type Description
    Promise<string>
    | Improve this Doc View Source

    resetStat(StatName)

    Declaration
    resetStat(statName: StatName): void
    Parameters
    Type Name Description
    StatName statName
    | Improve this Doc View Source

    resetStat("stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability")

    Declaration
    resetStat(statName: "stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability"): void
    Parameters
    Type Name Description
    "stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability" statName
    | Improve this Doc View Source

    setCamFrozen(boolean)

    Declaration
    setCamFrozen(state: boolean): void
    Parameters
    Type Name Description
    boolean state
    | Improve this Doc View Source

    isCamFrozen()

    Declaration
    isCamFrozen(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    setConfigFlag(ConfigFlag, boolean)

    Declaration
    setConfigFlag(flag: ConfigFlag, state: boolean): void
    Parameters
    Type Name Description
    ConfigFlag flag
    boolean state
    | Improve this Doc View Source

    setConfigFlag("DISABLE_AUTO_WEAPON_SWAP" | "DISABLE_PED_PROP_KNOCK_OFF" | "DISABLE_IDLE_CAMERA" | "DISABLE_VEHICLE_ENGINE_SHUTDOWN_ON_LEAVE" | "DISABLE_SP_ENTER_VEHICLE_CLIPSET" | "FORCE_RENDER_SNOW" | "FORCE_HIDE_NIGHT_PROPS" | "FORCE_SHOW_NIGHT_PROPS" | "DISABLE_EMISSIVE_LIGHTS_RENDERING" | "FORCE_VEHICLE_TYRE_BURST", boolean)

    Declaration
    setConfigFlag(flag: "DISABLE_AUTO_WEAPON_SWAP" | "DISABLE_PED_PROP_KNOCK_OFF" | "DISABLE_IDLE_CAMERA" | "DISABLE_VEHICLE_ENGINE_SHUTDOWN_ON_LEAVE" | "DISABLE_SP_ENTER_VEHICLE_CLIPSET" | "FORCE_RENDER_SNOW" | "FORCE_HIDE_NIGHT_PROPS" | "FORCE_SHOW_NIGHT_PROPS" | "DISABLE_EMISSIVE_LIGHTS_RENDERING" | "FORCE_VEHICLE_TYRE_BURST", state: boolean): void
    Parameters
    Type Name Description
    "DISABLE_AUTO_WEAPON_SWAP" | "DISABLE_PED_PROP_KNOCK_OFF" | "DISABLE_IDLE_CAMERA" | "DISABLE_VEHICLE_ENGINE_SHUTDOWN_ON_LEAVE" | "DISABLE_SP_ENTER_VEHICLE_CLIPSET" | "FORCE_RENDER_SNOW" | "FORCE_HIDE_NIGHT_PROPS" | "FORCE_SHOW_NIGHT_PROPS" | "DISABLE_EMISSIVE_LIGHTS_RENDERING" | "FORCE_VEHICLE_TYRE_BURST" flag
    boolean state
    | Improve this Doc View Source

    getConfigFlag(ConfigFlag)

    Declaration
    getConfigFlag(flag: ConfigFlag): boolean
    Parameters
    Type Name Description
    ConfigFlag flag
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getConfigFlag("DISABLE_AUTO_WEAPON_SWAP" | "DISABLE_PED_PROP_KNOCK_OFF" | "DISABLE_IDLE_CAMERA" | "DISABLE_VEHICLE_ENGINE_SHUTDOWN_ON_LEAVE" | "DISABLE_SP_ENTER_VEHICLE_CLIPSET" | "FORCE_RENDER_SNOW" | "FORCE_HIDE_NIGHT_PROPS" | "FORCE_SHOW_NIGHT_PROPS" | "DISABLE_EMISSIVE_LIGHTS_RENDERING" | "FORCE_VEHICLE_TYRE_BURST")

    Declaration
    getConfigFlag(flag: "DISABLE_AUTO_WEAPON_SWAP" | "DISABLE_PED_PROP_KNOCK_OFF" | "DISABLE_IDLE_CAMERA" | "DISABLE_VEHICLE_ENGINE_SHUTDOWN_ON_LEAVE" | "DISABLE_SP_ENTER_VEHICLE_CLIPSET" | "FORCE_RENDER_SNOW" | "FORCE_HIDE_NIGHT_PROPS" | "FORCE_SHOW_NIGHT_PROPS" | "DISABLE_EMISSIVE_LIGHTS_RENDERING" | "FORCE_VEHICLE_TYRE_BURST"): boolean
    Parameters
    Type Name Description
    "DISABLE_AUTO_WEAPON_SWAP" | "DISABLE_PED_PROP_KNOCK_OFF" | "DISABLE_IDLE_CAMERA" | "DISABLE_VEHICLE_ENGINE_SHUTDOWN_ON_LEAVE" | "DISABLE_SP_ENTER_VEHICLE_CLIPSET" | "FORCE_RENDER_SNOW" | "FORCE_HIDE_NIGHT_PROPS" | "FORCE_SHOW_NIGHT_PROPS" | "DISABLE_EMISSIVE_LIGHTS_RENDERING" | "FORCE_VEHICLE_TYRE_BURST" flag
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    doesConfigFlagExist(string)

    Declaration
    doesConfigFlagExist(flag: string): boolean
    Parameters
    Type Name Description
    string flag
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    setCursorPos(IVector2, boolean)

    Declaration
    setCursorPos(pos: IVector2, normalized?: boolean): void
    Parameters
    Type Name Description
    IVector2 pos
    boolean normalized
    | Improve this Doc View Source

    setMsPerGameMinute(number)

    Declaration
    setMsPerGameMinute(milliseconds: number): void
    Parameters
    Type Name Description
    number milliseconds
    | Improve this Doc View Source

    setRotationVelocity(number, number, number, number)

    Declaration
    setRotationVelocity(scriptID: number, x: number, y: number, z: number): void
    Parameters
    Type Name Description
    number scriptID
    number x
    number y
    number z
    | Improve this Doc View Source

    setStat(StatName, number)

    Declaration
    setStat(statName: StatName, value: number): void
    Parameters
    Type Name Description
    StatName statName
    number value
    | Improve this Doc View Source

    setStat("stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability", number)

    Declaration
    setStat(statName: "stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability", value: number): void
    Parameters
    Type Name Description
    "stamina" | "strength" | "lung_capacity" | "wheelie_ability" | "flying_ability" | "shooting_ability" | "stealth_ability" statName
    number value
    | Improve this Doc View Source

    setWeatherCycle(number[], number[])

    Declaration
    setWeatherCycle(weathers: number[], multipliers: number[]): void
    Parameters
    Type Name Description
    number[] weathers
    number[] multipliers
    | Improve this Doc View Source

    setWeatherSyncActive(boolean)

    Declaration
    setWeatherSyncActive(isActive: boolean): void
    Parameters
    Type Name Description
    boolean isActive
    | Improve this Doc View Source

    showCursor(boolean)

    Declaration
    showCursor(state: boolean): void
    Parameters
    Type Name Description
    boolean state
    | Improve this Doc View Source

    isCursorVisible()

    Declaration
    isCursorVisible(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    toggleGameControls(boolean)

    Declaration
    toggleGameControls(state: boolean): void
    Parameters
    Type Name Description
    boolean state
    | Improve this Doc View Source

    toggleVoiceControls(boolean)

    Declaration
    toggleVoiceControls(state: boolean): void
    Parameters
    Type Name Description
    boolean state
    | Improve this Doc View Source

    isFullScreen()

    Declaration
    isFullScreen(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getPoolSize(string)

    Declaration
    getPoolSize(poolName: string): number
    Parameters
    Type Name Description
    string poolName
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getPoolCount(string)

    Declaration
    getPoolCount(poolName: string): number
    Parameters
    Type Name Description
    string poolName
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getPoolEntities(string)

    Declaration
    getPoolEntities(poolName: string): number[]
    Parameters
    Type Name Description
    string poolName
    Returns
    Type Description
    number[]
    | Improve this Doc View Source

    getVoicePlayers()

    Declaration
    getVoicePlayers(): number[]
    Returns
    Type Description
    number[]
    | Improve this Doc View Source

    removeVoicePlayer(number)

    Declaration
    removeVoicePlayer(player: number): void
    Parameters
    Type Name Description
    number player
    | Improve this Doc View Source

    getVoiceSpatialVolume(number)

    Declaration
    getVoiceSpatialVolume(player: number): number
    Parameters
    Type Name Description
    number player
    Returns
    Type Description
    number
    | Improve this Doc View Source

    setVoiceSpatialVolume(number, number)

    Declaration
    setVoiceSpatialVolume(player: number, volume: number): void
    Parameters
    Type Name Description
    number player
    number volume
    | Improve this Doc View Source

    getVoiceNonSpatialVolume(number)

    Declaration
    getVoiceNonSpatialVolume(player: number): number
    Parameters
    Type Name Description
    number player
    Returns
    Type Description
    number
    | Improve this Doc View Source

    setVoiceNonSpatialVolume(number, number)

    Declaration
    setVoiceNonSpatialVolume(player: number, volume: number): void
    Parameters
    Type Name Description
    number player
    number volume
    | Improve this Doc View Source

    addVoiceFilter(number, AudioFilter)

    Declaration
    addVoiceFilter(player: number, filter: AudioFilter): void
    Parameters
    Type Name Description
    number player
    AudioFilter filter
    | Improve this Doc View Source

    removeVoiceFilter(number)

    Declaration
    removeVoiceFilter(player: number): void
    Parameters
    Type Name Description
    number player
    | Improve this Doc View Source

    getVoiceFilter(number)

    Declaration
    getVoiceFilter(player: number): AudioFilter
    Parameters
    Type Name Description
    number player
    Returns
    Type Description
    AudioFilter
    | Improve this Doc View Source

    updateClipContext(Record<string, string>)

    Declaration
    updateClipContext(context: Record<string, string>): void
    Parameters
    Type Name Description
    Record<string, string> context
    | Improve this Doc View Source

    loadYtyp(string)

    Declaration
    loadYtyp(path: string): boolean
    Parameters
    Type Name Description
    string path
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    unloadYtyp(string)

    Declaration
    unloadYtyp(path: string): boolean
    Parameters
    Type Name Description
    string path
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    evalModule(string)

    Declaration
    evalModule(code: string): Record<string, any>
    Parameters
    Type Name Description
    string code
    Returns
    Type Description
    Record<string, any>
    | Improve this Doc View Source

    getRemoteEventListeners(null | string)

    Declaration
    getRemoteEventListeners(eventName: null | string): readonly (...args: any[]) => void[]
    Parameters
    Type Name Description
    null | string eventName
    Returns
    Type Description
    readonly (...args: any[]) => void[]
    | Improve this Doc View Source

    getHeadshotBase64(number)

    Declaration
    getHeadshotBase64(id: number): string
    Parameters
    Type Name Description
    number id
    Returns
    Type Description
    string
    | Improve this Doc View Source

    setPedDlcClothes(number, number, number, number, number, number)

    Declaration
    setPedDlcClothes(scriptID: number, dlc: number, component: number, drawable: number, texture: number, palette?: number): void
    Parameters
    Type Name Description
    number scriptID
    number dlc
    number component
    number drawable
    number texture
    number palette
    | Improve this Doc View Source

    setPedDlcProp(number, number, number, number, number)

    Declaration
    setPedDlcProp(scriptID: number, dlc: number, component: number, drawable: number, texture: number): void
    Parameters
    Type Name Description
    number scriptID
    number dlc
    number component
    number drawable
    number texture
    | Improve this Doc View Source

    clearPedProp(number, number)

    Declaration
    clearPedProp(scriptID: number, component: number): void
    Parameters
    Type Name Description
    number scriptID
    number component
    | Improve this Doc View Source

    setWatermarkPosition(WatermarkPosition)

    Declaration
    setWatermarkPosition(position: WatermarkPosition): void
    Parameters
    Type Name Description
    WatermarkPosition position
    | Improve this Doc View Source

    setWatermarkPosition<T extends number>(T)

    Declaration
    setWatermarkPosition<T extends number>(position: T): void
    Parameters
    Type Name Description
    T position
    | Improve this Doc View Source

    getPing()

    Declaration
    getPing(): number
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getFps()

    Declaration
    getFps(): number
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getTotalPacketsSent()

    Declaration
    getTotalPacketsSent(): bigint
    Returns
    Type Description
    bigint
    | Improve this Doc View Source

    getTotalPacketsLost()

    Declaration
    getTotalPacketsLost(): bigint
    Returns
    Type Description
    bigint
    | Improve this Doc View Source

    getServerIp()

    Declaration
    getServerIp(): string
    Returns
    Type Description
    string
    | Improve this Doc View Source

    getServerPort()

    Declaration
    getServerPort(): number
    Returns
    Type Description
    number
    | Improve this Doc View Source

    copyToClipboard(string)

    Declaration
    copyToClipboard(val: string): void
    Parameters
    Type Name Description
    string val
    | Improve this Doc View Source

    toggleRmlControls(boolean)

    Declaration
    toggleRmlControls(state: boolean): void
    Parameters
    Type Name Description
    boolean state
    | Improve this Doc View Source

    rmlControlsEnabled()

    Declaration
    rmlControlsEnabled(): boolean
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    loadRmlFont(string, string, boolean, boolean)

    Declaration
    loadRmlFont(path: string, name: string, italic?: boolean, bold?: boolean): void
    Parameters
    Type Name Description
    string path
    string name
    boolean italic
    boolean bold
    | Improve this Doc View Source

    worldToScreen(number, number, number)

    Declaration
    worldToScreen(x: number, y: number, z: number): shared.Vector3
    Parameters
    Type Name Description
    number x
    number y
    number z
    Returns
    Type Description
    Vector3
    | Improve this Doc View Source

    worldToScreen(IVector3)

    Declaration
    worldToScreen(value: IVector3): shared.Vector3
    Parameters
    Type Name Description
    IVector3 value
    Returns
    Type Description
    Vector3
    | Improve this Doc View Source

    screenToWorld(number, number)

    Declaration
    screenToWorld(x: number, y: number): shared.Vector3
    Parameters
    Type Name Description
    number x
    number y
    Returns
    Type Description
    Vector3
    | Improve this Doc View Source

    screenToWorld(IVector2)

    Declaration
    screenToWorld(value: IVector2): shared.Vector3
    Parameters
    Type Name Description
    IVector2 value
    Returns
    Type Description
    Vector3
    | Improve this Doc View Source

    getCamPos()

    Declaration
    getCamPos(): shared.Vector3
    Returns
    Type Description
    Vector3
    | Improve this Doc View Source

    getScreenResolution()

    Declaration
    getScreenResolution(): shared.Vector2
    Returns
    Type Description
    Vector2
    | Improve this Doc View Source

    getLocalMeta<K extends string>(Exclude<K, never>)

    Declaration
    getLocalMeta<K extends string>(key: Exclude<K, never>): unknown
    Parameters
    Type Name Description
    Exclude<K, never> key
    Returns
    Type Description
    unknown
    | Improve this Doc View Source

    getLocalMeta<K extends never>(K)

    Declaration
    getLocalMeta<K extends never>(key: K): shared.ICustomPlayerLocalMeta[K] | undefined
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    ICustomPlayerLocalMeta[K] | undefined
    | Improve this Doc View Source

    getLocalMeta<V extends unknown>(string)

    Declaration
    getLocalMeta<V extends unknown>(key: string): V | undefined
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    V | undefined
    | Improve this Doc View Source

    hasLocalMeta(string)

    Declaration
    hasLocalMeta(key: string): boolean
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    hasLocalMeta<K extends never>(K)

    Declaration
    hasLocalMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    setMinimapComponentPosition(string, string, string, IVector2, IVector2)

    Declaration
    setMinimapComponentPosition(name: string, alignX: string, alignY: string, pos: IVector2, size: IVector2): void
    Parameters
    Type Name Description
    string name
    string alignX
    string alignY
    IVector2 pos
    IVector2 size
    | Improve this Doc View Source

    setMinimapComponentPosition(string, string, string, number, number, number, number)

    Declaration
    setMinimapComponentPosition(name: string, alignX: string, alignY: string, posX: number, posY: number, sizeX: number, sizeY: number): void
    Parameters
    Type Name Description
    string name
    string alignX
    string alignY
    number posX
    number posY
    number sizeX
    number sizeY
    | Improve this Doc View Source

    resetMinimapComponentPosition(string)

    Declaration
    resetMinimapComponentPosition(name: string): void
    Parameters
    Type Name Description
    string name
    | Improve this Doc View Source

    setMinimapIsRectangle(boolean)

    Declaration
    setMinimapIsRectangle(state: boolean): void
    Parameters
    Type Name Description
    boolean state
    | Improve this Doc View Source

    loadDefaultIpls()

    Declaration
    loadDefaultIpls(): void
    | Improve this Doc View Source

    isPointOnScreen(number, number, number)

    Declaration
    isPointOnScreen(x: number, y: number, z: number): boolean
    Parameters
    Type Name Description
    number x
    number y
    number z
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    isPointOnScreen(IVector3)

    Declaration
    isPointOnScreen(value: IVector3): boolean
    Parameters
    Type Name Description
    IVector3 value
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    getPedBonePos(number, number)

    Declaration
    getPedBonePos(ped: number, boneId: number): shared.Vector3
    Parameters
    Type Name Description
    number ped
    number boneId
    Returns
    Type Description
    Vector3
    | Improve this Doc View Source

    deleteMeta(string)

    Declaration
    deleteMeta(key: string): void
    Parameters
    Type Name Description
    string key
    | Improve this Doc View Source

    deleteMeta<K extends never>(K)

    Declaration
    deleteMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | Improve this Doc View Source

    getMeta<K extends string>(Exclude<K, never>)

    Declaration
    getMeta<K extends string>(key: Exclude<K, never>): unknown
    Parameters
    Type Name Description
    Exclude<K, never> key
    Returns
    Type Description
    unknown
    | Improve this Doc View Source

    getMeta<K extends never>(K)

    Declaration
    getMeta<K extends never>(key: K): ICustomGlobalMeta[K] | undefined
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    ICustomGlobalMeta[K] | undefined
    | Improve this Doc View Source

    getMeta<V extends unknown>(string)

    Declaration
    getMeta<V extends unknown>(key: string): V | undefined
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    V | undefined
    | Improve this Doc View Source

    getMetaKeys()

    Declaration
    getMetaKeys(): readonly string[]
    Returns
    Type Description
    readonly string[]
    | Improve this Doc View Source

    hasMeta(string)

    Declaration
    hasMeta(key: string): boolean
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    hasMeta<K extends never>(K)

    Declaration
    hasMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    setMeta<K extends string>(K, InterfaceValueByKey<ICustomGlobalMeta, K, unknown, void>)

    Declaration
    setMeta<K extends string>(key: K, value: InterfaceValueByKey<ICustomGlobalMeta, K, unknown, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomGlobalMeta, K, unknown, void> value
    | Improve this Doc View Source

    setMeta<K extends never>(K, ICustomGlobalMeta[K])

    Declaration
    setMeta<K extends never>(key: K, value: ICustomGlobalMeta[K]): void
    Parameters
    Type Name Description
    K key
    ICustomGlobalMeta[K] value
    | Improve this Doc View Source

    setMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomGlobalMeta, K, V, void>)

    Declaration
    setMeta<V extends unknown, K extends string>(key: K, value: InterfaceValueByKey<ICustomGlobalMeta, K, V, void>): void
    Parameters
    Type Name Description
    K key
    InterfaceValueByKey<ICustomGlobalMeta, K, V, void> value
    | Improve this Doc View Source

    getSyncedMeta<K extends string>(Exclude<K, never>)

    Declaration
    getSyncedMeta<K extends string>(key: Exclude<K, never>): unknown
    Parameters
    Type Name Description
    Exclude<K, never> key
    Returns
    Type Description
    unknown
    | Improve this Doc View Source

    getSyncedMeta<K extends never>(K)

    Declaration
    getSyncedMeta<K extends never>(key: K): ICustomGlobalSyncedMeta[K] | undefined
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    ICustomGlobalSyncedMeta[K] | undefined
    | Improve this Doc View Source

    getSyncedMeta<V extends unknown>(string)

    Declaration
    getSyncedMeta<V extends unknown>(key: string): V | undefined
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    V | undefined
    | Improve this Doc View Source

    getSyncedMetaKeys()

    Declaration
    getSyncedMetaKeys(): readonly string[]
    Returns
    Type Description
    readonly string[]
    | Improve this Doc View Source

    hasSyncedMeta(string)

    Declaration
    hasSyncedMeta(key: string): boolean
    Parameters
    Type Name Description
    string key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    hasSyncedMeta<K extends never>(K)

    Declaration
    hasSyncedMeta<K extends never>(key: K): boolean
    Parameters
    Type Name Description
    K key
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    clearEveryTick(number)

    Declaration
    clearEveryTick(id: number): void
    Parameters
    Type Name Description
    number id
    | Improve this Doc View Source

    clearInterval(number)

    Declaration
    clearInterval(id: number): void
    Parameters
    Type Name Description
    number id
    | Improve this Doc View Source

    clearNextTick(number)

    Declaration
    clearNextTick(id: number): void
    Parameters
    Type Name Description
    number id
    | Improve this Doc View Source

    clearTimeout(number)

    Declaration
    clearTimeout(id: number): void
    Parameters
    Type Name Description
    number id
    | Improve this Doc View Source

    everyTick((...args: any[]) => void)

    Declaration
    everyTick(handler: (...args: any[]) => void): number
    Parameters
    Type Name Description
    (...args: any[]) => void handler
    Returns
    Type Description
    number
    | Improve this Doc View Source

    hash(string)

    Declaration
    hash(str: string): number
    Parameters
    Type Name Description
    string str
    Returns
    Type Description
    number
    | Improve this Doc View Source

    hasResource(string)

    Declaration
    hasResource(name: string): boolean
    Parameters
    Type Name Description
    string name
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    log(any, any[])

    Declaration
    log(arg: any, ...args: any[]): void
    Parameters
    Type Name Description
    any arg
    any[] args
    | Improve this Doc View Source

    logError(any, any[])

    Declaration
    logError(arg: any, ...args: any[]): void
    Parameters
    Type Name Description
    any arg
    any[] args
    | Improve this Doc View Source

    logWarning(any, any[])

    Declaration
    logWarning(arg: any, ...args: any[]): void
    Parameters
    Type Name Description
    any arg
    any[] args
    | Improve this Doc View Source

    logDebug(any, any[])

    Declaration
    logDebug(arg: any, ...args: any[]): void
    Parameters
    Type Name Description
    any arg
    any[] args
    | Improve this Doc View Source

    nextTick((...args: any[]) => void)

    Declaration
    nextTick(handler: (...args: any[]) => void): number
    Parameters
    Type Name Description
    (...args: any[]) => void handler
    Returns
    Type Description
    number
    | Improve this Doc View Source

    setInterval((...args: any[]) => void, number)

    Declaration
    setInterval(handler: (...args: any[]) => void, miliseconds: number): number
    Parameters
    Type Name Description
    (...args: any[]) => void handler
    number miliseconds
    Returns
    Type Description
    number
    | Improve this Doc View Source

    setTimeout((...args: any[]) => void, number)

    Declaration
    setTimeout(handler: (...args: any[]) => void, miliseconds: number): number
    Parameters
    Type Name Description
    (...args: any[]) => void handler
    number miliseconds
    Returns
    Type Description
    number
    | Improve this Doc View Source

    getAllResources()

    Declaration
    getAllResources(): readonly IResource[]
    Returns
    Type Description
    readonly IResource[]
    | Improve this Doc View Source

    time(string)

    Declaration
    time(timerName: string): void
    Parameters
    Type Name Description
    string timerName
    | Improve this Doc View Source

    time()

    Declaration
    time(): void
    | Improve this Doc View Source

    timeEnd(string)

    Declaration
    timeEnd(timerName: string): void
    Parameters
    Type Name Description
    string timerName
    | Improve this Doc View Source

    timeEnd()

    Declaration
    timeEnd(): void
    | Improve this Doc View Source

    getEventListeners(null | string)

    Declaration
    getEventListeners(eventName: null | string): readonly (...args: any[]) => void[]
    Parameters
    Type Name Description
    null | string eventName
    Returns
    Type Description
    readonly (...args: any[]) => void[]
    | Improve this Doc View Source

    stringToSHA256(string)

    Declaration
    stringToSHA256(string: string): string
    Parameters
    Type Name Description
    string string
    Returns
    Type Description
    string
    | Improve this Doc View Source

    getVoiceConnectionState()

    Declaration
    getVoiceConnectionState(): VoiceConnectionState
    Returns
    Type Description
    VoiceConnectionState
    | Improve this Doc View Source

    getNetTime()

    Declaration
    getNetTime(): number
    Returns
    Type Description
    number

    Variables

    | Improve this Doc View Source

    resourceName

    Declaration
    const resourceName: string
    | Improve this Doc View Source

    version

    Declaration
    const version: string
    | Improve this Doc View Source

    sdkVersion

    Declaration
    const sdkVersion: string
    | Improve this Doc View Source

    branch

    Declaration
    const branch: string
    | Improve this Doc View Source

    debug

    Declaration
    const debug: boolean
    | Improve this Doc View Source

    defaultDimension

    Declaration
    const defaultDimension: number
    | Improve this Doc View Source

    globalDimension

    Declaration
    const globalDimension: number
    | Improve this Doc View Source

    isClient

    Declaration
    const isClient: boolean
    | Improve this Doc View Source

    isServer

    Declaration
    const isServer: boolean