Index

Search Results for

    Module alt-server

    Package: @altmp/altv-types

    Utils

    ConnectionInfo

    BaseObject

    WorldObject

    VirtualEntityGroup

    VirtualEntity

    Entity

    Player

    Vehicle

    Blip

    AreaBlip

    RadiusBlip

    PointBlip

    Colshape

    ColshapeCylinder

    ColshapeSphere

    ColshapeCircle

    ColshapeCuboid

    ColshapeRectangle

    ColshapePolygon

    Checkpoint

    VoiceChannel

    Resource

    Utils

    Ped

    Object

    Marker

    Vector3

    Vector2

    Quaternion

    RGBA

    File

    VehicleBadgePosition

    IConnectionInfo

    IServerEvent

    IFireInfo

    IVehicleNeon

    ICloth

    IDlcCloth

    IProp

    IDlcProp

    IHeadOverlay

    IHeadBlendData

    IBoneInfo

    IVehicleModel

    IPedModel

    IWeaponModel

    IAmmoFlags

    IDecoration

    ICustomBaseObjectMeta

    ICustomBlipMeta

    ICustomColshapeMeta

    ICustomCheckpointMeta

    ICustomVoiceChannelMeta

    ICustomEntityMeta

    ICustomPlayerMeta

    ICustomVehicleMeta

    ICustomEmitEvent

    IServerConfig

    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

    ExplosionType

    RadioStation

    NumberPlateStyle

    VehicleBumper

    VehicleBumperDamage

    VehicleDoor

    VehicleDoorState

    VehicleModType

    VehiclePart

    VehiclePartDamage

    WeatherType

    WindowTint

    BaseObjectFilterType

    Benefit

    CloudAuthResult

    ConnectDeniedReason

    AmmoSpecialType

    BaseObjectType

    BlipSprite

    BlipColor

    BlipType

    MarkerType

    ColShapeType

    AudioCategories

    FileEncoding

    Permission

    CheckpointType

    ModelType

    KeyCode

    BodyPart

    PedConfigFlag

    VoiceConnectionState

    VehicleLockState

    Functions

    | Improve this Doc View Source

    setSyncedMeta<K extends string>(K, InterfaceValueByKey<ICustomGlobalSyncedMeta, K, unknown, void>)

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

    setSyncedMeta<K extends never>(K, ICustomGlobalSyncedMeta[K])

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

    setSyncedMeta<V extends unknown, K extends string>(K, InterfaceValueByKey<ICustomGlobalSyncedMeta, K, V, void>)

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

    deleteSyncedMeta(string)

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

    deleteSyncedMeta<K extends never>(K)

    Declaration
    deleteSyncedMeta<K extends never>(key: K): void
    Parameters
    Type Name Description
    K key
    | 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 IServerEvent>, any[])

    Declaration
    emit<K extends string>(eventName: Exclude<K, keyof IServerEvent>, ...args: any[]): void
    Parameters
    Type Name Description
    Exclude<K, keyof IServerEvent> 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 IServerEvent>, any[])

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

    emitClient<K extends never>(Player | Player[], K, Parameters<ICustomServerClientEvent[K]>)

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

    emitClient<K extends string>(Player | Player[], Exclude<K, never>, any[])

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

    emitClientRaw<K extends never>(Player | Player[], K, Parameters<ICustomServerClientEvent[K]>)

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

    emitClientRaw<K extends string>(Player | Player[], Exclude<K, never>, any[])

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

    emitClientUnreliable<K extends never>(Player | Player[], K, Parameters<ICustomServerClientEvent[K]>)

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

    emitClientUnreliable<K extends string>(Player | Player[], Exclude<K, never>, any[])

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

    emitAllClients<K extends never>(K, Parameters<ICustomServerClientEvent[K]>)

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

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

    Declaration
    emitAllClients<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

    emitAllClientsRaw<K extends never>(K, Parameters<ICustomServerClientEvent[K]>)

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

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

    Declaration
    emitAllClientsRaw<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

    emitAllClientsUnreliable<K extends never>(K, Parameters<ICustomServerClientEvent[K]>)

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

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

    Declaration
    emitAllClientsUnreliable<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

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

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

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

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

    offRpc<K extends never>(string, (player: Player, ...args: Parameters<ICustomClientServerRpc[K]>) => ReturnType<ICustomClientServerRpc[K]> | Promise<ReturnType<ICustomClientServerRpc[K]>>)

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

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

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

    setPassword(string)

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

    hashServerPassword(string)

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

    stopServer()

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

    offClient<K extends never>(K, (player: Player, ...args: Parameters<ICustomClientServerEvent[K]>) => void)

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

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

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

    offClient(string, (player: Player, ...args: any[]) => void)

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

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

    Declaration
    offClient(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 IServerEvent>(K, (...args: Parameters<K extends keyof IServerEvent ? IServerEvent[K] : K extends never ? ICustomEmitEvent[K] : never>) => void)

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

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

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

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

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

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

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

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

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

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

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

    onClient<K extends never>(K, (player: Player, ...args: Parameters<ICustomClientServerEvent[K]>) => void)

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

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

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

    onClient((eventName: string, player: Player, ...args: any[]) => void)

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

    onceClient<K extends never>(K, (player: Player, ...args: Parameters<ICustomClientServerEvent[K]>) => void)

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

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

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

    onceClient((eventName: string, player: Player, ...args: any[]) => void)

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

    startResource(string)

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

    restartResource(string)

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

    addClientConfigKey(string)

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

    hasBenefit(Benefit)

    Declaration
    hasBenefit(benefit: Benefit): boolean
    Parameters
    Type Name Description
    Benefit benefit
    Returns
    Type Description
    boolean
    | Improve this Doc View Source

    stopResource(string)

    Declaration
    stopResource(name: string): void
    Parameters
    Type Name Description
    string name
    | 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

    getVehicleModelInfoByHash(number)

    Declaration
    getVehicleModelInfoByHash(vehicleHash: number): IVehicleModel
    Parameters
    Type Name Description
    number vehicleHash
    Returns
    Type Description
    IVehicleModel
    | Improve this Doc View Source

    getLoadedVehicleModels()

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

    getPedModelInfoByHash(number)

    Declaration
    getPedModelInfoByHash(pedModelHash: number): IPedModel
    Parameters
    Type Name Description
    number pedModelHash
    Returns
    Type Description
    IPedModel
    | Improve this Doc View Source

    getWeaponModelInfoByHash(number)

    Declaration
    getWeaponModelInfoByHash(weaponModelHash: number): IWeaponModel
    Parameters
    Type Name Description
    number weaponModelHash
    Returns
    Type Description
    IWeaponModel
    | Improve this Doc View Source

    getAmmoHashForWeaponHash(number)

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

    getServerConfig()

    Declaration
    getServerConfig(): IServerConfig
    Returns
    Type Description
    IServerConfig
    | Improve this Doc View Source

    toggleWorldProfiler(boolean)

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

    getEntitiesInDimension(number, BaseObjectFilterType)

    Declaration
    getEntitiesInDimension(dimension: number, allowedTypes: BaseObjectFilterType): readonly Entity[]
    Parameters
    Type Name Description
    number dimension
    BaseObjectFilterType allowedTypes
    Returns
    Type Description
    readonly Entity[]
    | Improve this Doc View Source

    getEntitiesInRange(IVector3, number, number, BaseObjectFilterType)

    Declaration
    getEntitiesInRange(position: IVector3, range: number, dimension: number, allowedTypes: BaseObjectFilterType): readonly Entity[]
    Parameters
    Type Name Description
    IVector3 position
    number range
    number dimension
    BaseObjectFilterType allowedTypes
    Returns
    Type Description
    readonly Entity[]
    | Improve this Doc View Source

    getClosestEntities(IVector3, number, number, number, BaseObjectFilterType)

    Declaration
    getClosestEntities(position: IVector3, range: number, dimension: number, limit: number, allowedTypes: BaseObjectFilterType): readonly Entity[]
    Parameters
    Type Name Description
    IVector3 position
    number range
    number dimension
    number limit
    BaseObjectFilterType allowedTypes
    Returns
    Type Description
    readonly Entity[]
    | Improve this Doc View Source

    setVoiceExternalPublic(string, number)

    Declaration
    setVoiceExternalPublic(host: string, port: number): void
    Parameters
    Type Name Description
    string host
    number port
    | Improve this Doc View Source

    setVoiceExternal(string, number)

    Declaration
    setVoiceExternal(phost: string, port: number): void
    Parameters
    Type Name Description
    string phost
    number port
    | Improve this Doc View Source

    getMaxStreamingPeds()

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

    setMaxStreamingPeds(number)

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

    getMaxStreamingObjects()

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

    setMaxStreamingObjects(number)

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

    getMaxStreamingVehicles()

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

    setMaxStreamingVehicles(number)

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

    getStreamerThreadCount()

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

    setStreamerThreadCount(number)

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

    getStreamingTickRate()

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

    setStreamingTickRate(number)

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

    getStreamingDistance()

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

    setStreamingDistance(number)

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

    getMigrationThreadCount()

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

    setMigrationThreadCount(number)

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

    getSyncSendThreadCount()

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

    setSyncSendThreadCount(number)

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

    getSyncReceiveThreadCount()

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

    setSyncReceiveThreadCount(number)

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

    getMigrationTickRate()

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

    setMigrationTickRate(number)

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

    getColShapeTickRate()

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

    setColShapeTickRate(number)

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

    getMigrationDistance()

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

    setMigrationDistance(number)

    Declaration
    setMigrationDistance(count: number): void
    Parameters
    Type Name Description
    number count
    | 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

    rootDir

    Declaration
    const rootDir: string
    | 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

    Type Aliases

    | Improve this Doc View Source

    DateTimeHour

    Declaration
    type DateTimeHour = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23
    | Improve this Doc View Source

    DateTimeMinute

    Declaration
    type DateTimeMinute = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59
    | Improve this Doc View Source

    DateTimeSecond

    Declaration
    type DateTimeSecond = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 32 | 33 | 34 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 51 | 52 | 53 | 54 | 55 | 56 | 57 | 58 | 59
    | Improve this Doc View Source

    DateTimeDay

    Declaration
    type DateTimeDay = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30
    | Improve this Doc View Source

    DateTimeMonth

    Declaration
    type DateTimeMonth = 0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 | 11