Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Timerbar

Create a Timerbar. It's automatically added to the internal Timerbar array and drawn in a FIFO (first in, first out) way.

// Create simple Timerbar
const myTimerbar = new Cfx.Timerbar("Hello");
myTimerbar.Text = "World";

// Disable Timerbar later on
myTimerbar.Visible = false;

Hierarchy

  • Timerbar

Index

Constructors

Properties

Accessors

Constructors

constructor

  • new Timerbar(title: string, useProgressBar?: boolean): Timerbar

Properties

Private isVisible

isVisible: boolean = false

Private pbarBgColor

pbarBgColor: number[] = ...

Private pbarFgColor

pbarFgColor: number[] = ...

Private pbarValue

pbarValue: number = 0.0

Private sprite

sprite: null | Sprite

Private text

text: string = ''

Private textColor

textColor: number[] = ...

Private title

title: string = ''

Private usePlayerStyle

usePlayerStyle: boolean = false

Private useProgressBar

useProgressBar: boolean = false

Accessors

PlayerStyle

  • get PlayerStyle(): boolean
  • set PlayerStyle(value: boolean): void

Progress

  • get Progress(): number
  • set Progress(value: number): void

ProgressbarBgColor

  • get ProgressbarBgColor(): number | number[]
  • set ProgressbarBgColor(value: number | number[]): void

ProgressbarFgColor

  • get ProgressbarFgColor(): number | number[]
  • set ProgressbarFgColor(value: number | number[]): void

Sprite

Text

  • get Text(): string
  • set Text(value: string): void

TextColor

  • get TextColor(): number | number[]
  • set TextColor(value: number | number[]): void

Title

  • get Title(): string
  • set Title(value: string): void

UseProgressBar

  • get UseProgressBar(): boolean

Visible

  • get Visible(): boolean
  • set Visible(value: boolean): void

Generated using TypeDoc