Skip to main content
Branch: Development

@altv/types-shared

Index

Classes

Enumerations

Functions

Interfaces

Namespaces

Variables

Variables

constbranch

branch: string

Represents the current branch.

constdebug

debug: boolean

Returns if the resource is in debug mode.

Returns

True when the resource is launched with debug mode enabled.

constdefaultDimension

defaultDimension: number

Default dimension (0). Read more: https://docs.altv.mp/articles/dimensions.html

constglobalDimension

globalDimension: number

Global dimension (-2147483648). Read more: https://docs.altv.mp/articles/dimensions.html

constisClient

isClient: boolean

A boolean indicating whether the current script is executed on the clientside.

constisServer

isServer: boolean

A boolean indicating whether the current script is executed on the serverside.

constresourceName

resourceName: string

Resource name of the executing resource.

constsdkVersion

sdkVersion: string

Represents the current SDK version.

Remarks

It’s the version of the SDK the current runtime was compiled with.

constversion

version: string

Represents the current version.

Remarks

It’s a slighty modified semantic versioning specification, which can be matched using this regular expression pattern ^(0|[1-9]\d*)\.(0|[1-9]\d*)(?:-((?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*)(?:\.(?:0|[1-9]\d*|\d*[a-zA-Z-][0-9a-zA-Z-]*))*))$.