V5 DocsAthenaClient.screen.progressBar ​
Functions ​
clear ​
Usage
AthenaClient.screen.progressBar.clear(): void
Clear the progress bar if there are no more bars to show.
Returns ​
void
None
Defined in ​
client/screen/progressBar.ts:105
create ​
Usage
AthenaClient.screen.progressBar.create(progressBar): void
Create a new progress bar.
Parameters ​
| Name | Type | Description |
|---|---|---|
progressBar | ProgressBar | ProgressBar |
Returns ​
void
None
Defined in ​
client/screen/progressBar.ts:64
remove ​
Usage
AthenaClient.screen.progressBar.remove(uid): void
removeBar removes a bar from the bars array.
Parameters ​
| Name | Type | Description |
|---|---|---|
uid | string | A unique string - The unique identifier of the bar. |
Returns ​
void
The function that is being returned is the function that is being called.