TextLabel | custom alt:V docs JS

Hierarchy

WorldObject
- TextLabel

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TextLabel(text: string, fontName: string, fontSize: number, scale: number, pos: IVector3, rot: IVector3, color: RGBA, outlineWidth: number, outlineColor: RGBA, useStreaming?: boolean, streamingDistance?: number): TextLabel
new TextLabel(text: string, fontName: string, fontSize: number, scale: number, pos: IVector3, rot: IVector3, color: RGBA, outlineWidth: number, outlineColor: RGBA, useStreaming?: boolean, streamingDistance?: number): TextLabel

Overrides BaseObject.constructor
- Defined in types-client/index.d.ts:4188
Creates static text label without streaming enabled.

Parameters
- text: string
- fontName: string
- fontSize: number
- scale: number
- pos: IVector3
- rot: IVector3
- color: RGBA
- outlineWidth: number
- outlineColor: RGBA
- Optional useStreaming: boolean
- Optional streamingDistance: number
Returns TextLabel
Overrides BaseObject.constructor
- Defined in types-client/index.d.ts:4203
Creates text label with streaming enabled.

Parameters
- text: string
- fontName: string
- fontSize: number
- scale: number
- pos: IVector3
- rot: IVector3
- color: RGBA
- outlineWidth: number
- outlineColor: RGBA
- Optional useStreaming: boolean
- Optional streamingDistance: number
Returns TextLabel

Properties

align

align: TextLabelAlignment

color

color: RGBA

dimension

dimension: number

Object dimension.

remarks: Check https://docs.altv.mp/articles/dimensions.html to understand how it works.

faceCamera

faceCamera: boolean

font

font: string

Readonly id

id: number

Readonly isGlobal

isGlobal: boolean

Readonly isRemote

isRemote: boolean

Whether this entity was created clientside or serverside. (Clientside = false, Serverside = true).

Readonly isStreamedIn

isStreamedIn: boolean

outlineColor

outlineColor: RGBA

outlineWidth

outlineWidth: number

pos

pos: Vector3

Object position

Readonly refCount

refCount: number

Returns the ref count of the entity.

remarks: It's only available in debug-mode.

Readonly remoteID

remoteID: number

The serverside id of this entity.

rot

rot: Vector3

scale

scale: number

Readonly streamingDistance

streamingDistance: number

Readonly target

target: Player

text

text: string

Readonly type

type: BaseObjectType

Type of the object.

Readonly valid

valid: boolean

Object usability.

returns: False if object is no longer usable.

visible

visible: boolean

Static Readonly all

all: readonly TextLabel[]

Methods

deleteMeta

deleteMeta(key: string): void
deleteMeta<K>(key: K): void

Inherited from BaseObject.deleteMeta

Overrides BaseObject.deleteMeta
- Defined in types-client/index.d.ts:581
Parameters
- key: string
Returns void
Inherited from BaseObject.deleteMeta

Overrides BaseObject.deleteMeta
- Defined in types-client/index.d.ts:582
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectMeta>
Parameters
- key: K
Returns void

destroy

destroy(): void

Inherited from BaseObject.destroy
- Defined in types-shared/index.d.ts:2563
Removes the object from the world.

Returns void

getMeta

getMeta<K>(key: Exclude<K, keyof ICustomBaseObjectMeta>): unknown
getMeta<K>(key: K): ICustomBaseObjectMeta[K] | undefined
getMeta<V>(key: string): V | undefined

Inherited from BaseObject.getMeta

Overrides BaseObject.getMeta
- Defined in types-client/index.d.ts:587
Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomBaseObjectMeta>
Returns unknown
Inherited from BaseObject.getMeta

Overrides BaseObject.getMeta
- Defined in types-client/index.d.ts:588
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectMeta>
Parameters
- key: K
Returns ICustomBaseObjectMeta[K] | undefined
Inherited from BaseObject.getMeta

Overrides BaseObject.getMeta
- Defined in types-client/index.d.ts:590
deprecated

See ICustomBaseObjectMeta

Type parameters
- V: any
Parameters
- key: string
Returns V | undefined

getMetaDataKeys

getMetaDataKeys(): readonly string[]

Inherited from BaseObject.getMetaDataKeys
- Defined in types-shared/index.d.ts:2593
Returns readonly string[]

getSyncedMeta

getSyncedMeta<K>(key: Exclude<K, keyof ICustomBaseObjectSyncedMeta>): unknown
getSyncedMeta<K>(key: K): ICustomBaseObjectSyncedMeta[K] | undefined
getSyncedMeta<V>(key: string): V | undefined

Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2614
Gets a value using the specified key.

Type parameters
- K: string
Parameters
- key: Exclude<K, keyof ICustomBaseObjectSyncedMeta>
  
  The key of the value to get.
Returns unknown

Dynamic value associated with the specified key or undefined if no data is present.
Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2615
Type parameters
- K: ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
Returns ICustomBaseObjectSyncedMeta[K] | undefined
Inherited from BaseObject.getSyncedMeta
- Defined in types-shared/index.d.ts:2617
deprecated

See "alt-shared".ICustomBaseObjectSyncedMeta

Type parameters
- V: any
Parameters
- key: string
Returns V | undefined

getSyncedMetaKeys

getSyncedMetaKeys(): readonly string[]

Inherited from BaseObject.getSyncedMetaKeys
- Defined in types-shared/index.d.ts:2628
Returns readonly string[]

hasMeta

hasMeta(key: string): boolean
hasMeta<K>(key: K): boolean

Inherited from BaseObject.hasMeta

Overrides BaseObject.hasMeta
- Defined in types-client/index.d.ts:584
Parameters
- key: string
Returns boolean
Inherited from BaseObject.hasMeta

Overrides BaseObject.hasMeta
- Defined in types-client/index.d.ts:585
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectMeta>
Parameters
- key: K
Returns boolean

hasSyncedMeta

hasSyncedMeta(key: string): boolean
hasSyncedMeta<K>(key: K): boolean

Inherited from BaseObject.hasSyncedMeta
- Defined in types-shared/index.d.ts:2625
Determines whether contains the specified key.

Parameters
- key: string
  
  The key of the value to locate.
Returns boolean

True if the meta table contains any data at the specified key or False if not
Inherited from BaseObject.hasSyncedMeta
- Defined in types-shared/index.d.ts:2626
Type parameters
- K: ExtractStringKeys<ICustomBaseObjectSyncedMeta>
Parameters
- key: K
Returns boolean

setMeta

setMeta<K>(key: K, value: shared.InterfaceValueByKey<ICustomBaseObjectMeta, K>): void
setMeta<K>(key: K, value: ICustomBaseObjectMeta[K]): void
setMeta<V, K>(key: K, value: shared.InterfaceValueByKey<ICustomBaseObjectMeta, K, V>): void

Inherited from BaseObject.setMeta

Overrides BaseObject.setMeta
- Defined in types-client/index.d.ts:592
Type parameters
- K: string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomBaseObjectMeta, K>
Returns void
Inherited from BaseObject.setMeta

Overrides BaseObject.setMeta
- Defined in types-client/index.d.ts:593
Type parameters
- K: shared.ExtractStringKeys<ICustomBaseObjectMeta>
Parameters
- key: K
- value: ICustomBaseObjectMeta[K]
Returns void
Inherited from BaseObject.setMeta

Overrides BaseObject.setMeta
- Defined in types-client/index.d.ts:595
deprecated

See ICustomBaseObjectMeta

Type parameters
- V: any
- K: string = string
Parameters
- key: K
- value: shared.InterfaceValueByKey<ICustomBaseObjectMeta, K, V>
Returns void

Static getByID

getByID(id: number): TextLabel | null

Overrides BaseObject.getByID
- Defined in types-client/index.d.ts:4228
Retrieves the marker from the pool.

Parameters
- id: number
  
  The id of the marker.
Returns TextLabel | null

Entity if it was found, otherwise null.

Static getByRemoteID

getByRemoteID(type: BaseObjectType, id: number): BaseObject | null

Inherited from BaseObject.getByRemoteID
- Defined in types-client/index.d.ts:579
Parameters
- type: BaseObjectType
- id: number
Returns BaseObject | null

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

text: string

fontName: string

fontSize: number

scale: number

pos: IVector3

rot: IVector3

color: RGBA

outlineWidth: number

outlineColor: RGBA

Optional useStreaming: boolean

Optional streamingDistance: number

Returns TextLabel

Parameters

text: string

fontName: string

fontSize: number

scale: number

pos: IVector3

rot: IVector3

color: RGBA

outlineWidth: number

outlineColor: RGBA

Optional useStreaming: boolean

Optional streamingDistance: number

Returns TextLabel

Properties

align

color

dimension

faceCamera

font

fontSize

Readonly id

Readonly isGlobal

Readonly isRemote

Readonly isStreamedIn

outlineColor

outlineWidth

pos

Readonly refCount

Readonly remoteID

rot

scale

Readonly streamingDistance

Readonly target

text

Readonly type

Readonly valid

visible

Static Readonly all

Methods

deleteMeta

Parameters

key: string

Returns void

Type parameters

K: shared.ExtractStringKeys<ICustomBaseObjectMeta>

Parameters

key: K

Returns void

destroy

Returns void

getMeta

Type parameters

K: string

Parameters

key: Exclude<K, keyof ICustomBaseObjectMeta>

Returns unknown

Type parameters

K: shared.ExtractStringKeys<ICustomBaseObjectMeta>

Parameters

key: K