UI <BadgeClient/>

A module to manage UI elements from the game.

JO Functions > jo.ui.finishTimer()

<!-- @include: ./slots/headers.md#client|jo.ui.finishTimer -->

Terminates the Timer's UI and destroys associated resources <br>

<!-- @include: ./slots/descriptions.md#client|jo.ui.finishTimer -->

JO Functions > jo.ui.finishTimer() > Syntax

jo.ui.finishTimer()

<!-- @include: ./slots/examples.md#client|jo.ui.finishTimer -->

<!-- @include: ./slots/footers.md#client|jo.ui.finishTimer -->

JO Functions > jo.ui.initTimer()

<!-- @include: ./slots/headers.md#client|jo.ui.initTimer -->

Initializes the timer's UI <br>

<!-- @include: ./slots/descriptions.md#client|jo.ui.initTimer -->

JO Functions > jo.ui.initTimer() > Syntax

jo.ui.initTimer()

JO Functions > jo.ui.initTimer() > Return Value

Type : number

The state machine identifier

<!-- @include: ./slots/examples.md#client|jo.ui.initTimer -->

<!-- @include: ./slots/footers.md#client|jo.ui.initTimer -->

JO Functions > jo.ui.startTimer()

<!-- @include: ./slots/headers.md#client|jo.ui.startTimer -->

Starts the timer's UI <br>

<!-- @include: ./slots/descriptions.md#client|jo.ui.startTimer -->

JO Functions > jo.ui.startTimer() > Syntax

jo.ui.startTimer(time, low)

JO Functions > jo.ui.startTimer() > Parameters

time : integer

The time in seconds for the timer

low : integer <BadgeOptional />

The threshold in seconds at which the timer color will turn red

<!-- @include: ./slots/examples.md#client|jo.ui.startTimer -->

<!-- @include: ./slots/footers.md#client|jo.ui.startTimer -->

JO Functions > jo.ui.stopTimer()

<!-- @include: ./slots/headers.md#client|jo.ui.stopTimer -->

Stops the Timer's UI before it finishes naturally <br>

<!-- @include: ./slots/descriptions.md#client|jo.ui.stopTimer -->

JO Functions > jo.ui.stopTimer() > Syntax

jo.ui.stopTimer()

<!-- @include: ./slots/examples.md#client|jo.ui.stopTimer -->

<!-- @include: ./slots/footers.md#client|jo.ui.stopTimer -->

JO Functions > jo.ui.updateRank()

<!-- @include: ./slots/headers.md#client|jo.ui.updateRank -->

Updates the rank element on the top left of weapon wheel <br>

<!-- @include: ./slots/descriptions.md#client|jo.ui.updateRank -->

JO Functions > jo.ui.updateRank() > Syntax

jo.ui.updateRank(level, xp, xpRequired)

JO Functions > jo.ui.updateRank() > Parameters

level : integer

The level printed in the left of the element

xp : integer

The current xp amount

xpRequired : integer

The amount of XP required to level up

<!-- @include: ./slots/examples.md#client|jo.ui.updateRank -->

<!-- @include: ./slots/footers.md#client|jo.ui.updateRank -->

Internal Variables and Structures

The Timer UI system uses the following internal variables and structures, which should not be modified directly:

• jo.ui.TimerUI.data.uiFlowblock - Reference to the UI flowblock component
• jo.ui.TimerUI.data.container - Reference to the databinding container
• jo.ui.TimerUI.data.timer - Reference to the timer's databinding entry
• jo.ui.TimerUI.data.show - Reference to the visibility databinding entry
• jo.ui.TimerUI.data.stateMachine - Identifier for the UI state machine
• jo.ui.TimerUI.data.time - Current timer value in seconds

These variables are essential for the proper functioning and state management of the Timer UI system. Modifying them directly may cause unexpected behavior.