AthenaShared.interfaces.progressBar.ProgressBar ​

shared/interfaces/progressBar.ProgressBar

Used to create and show a progress bar. Used in server to client.

Interface

ProgressBar

Properties ​

color ​

• color: RGBA

The color of the progress bar.

Defined in ​

shared/interfaces/progressBar.ts:30

distance ​

• distance: number

The distance in which the progress bar can be seen.

Defined in ​

shared/interfaces/progressBar.ts:44

finalTime ​

• Optional finalTime: number

Do not set this. Leave it alone.

Defined in ​

shared/interfaces/progressBar.ts:67

milliseconds ​

• milliseconds: number

How long this progress bar should last.

Defined in ​

shared/interfaces/progressBar.ts:37

percentageEnabled ​

• Optional percentageEnabled: boolean

Defined in ​

shared/interfaces/progressBar.ts:53

position ​

• position: Object

The position in a 3D space to show the progress bar. Only a single client will see it.

Type declaration ​

Defined in ​

shared/interfaces/progressBar.ts:23

startTime ​

• Optional startTime: number

Do not set this. Leave it alone.

Defined in ​

shared/interfaces/progressBar.ts:60

text ​

• Optional text: string

The text to display on the progress bar.

Defined in ​

shared/interfaces/progressBar.ts:51

uid ​

• Optional uid: string

A unique identifier to remove the progress bar early.

Defined in ​

shared/interfaces/progressBar.ts:15