Maintenance script: UI Lua API import (WAR 1.4.8)

2026-10-16T19:41:55Z

UI Lua API import (WAR 1.4.8)

New page

{{LuaApi|group=LiveEvent}}
Returns the two jump-cooldown timers of the Current Events window.

<pre>
playerCooldown, cooldownLength = CurrentEventsGetTimers()
</pre>

== Arguments ==
None.

== Returns ==
;playerCooldown : <code>number</code> – The stock UI treats this as the player's remaining jump cooldown in seconds; <code>0</code> means the player can jump.
;cooldownLength : <code>number</code> – The stock UI treats this as the length of the jump cooldown in seconds, and shows it in minutes.

== Details ==
* Both values are stored as single-precision floats and returned as numbers.
* If the current-events data is not available, the function returns nothing.
* The stock UI uses the same function, <code>EA_Window_CurrentEvents.OnJumpTimerUpdated</code>, to handle this function's result and the <code>SystemData.Events.CURRENT_EVENTS_JUMP_TIMER_UPDATED</code> event.

== Errors ==
None.

== Example ==
From <code>default/ea_currenteventswindow/source/currenteventswindow.lua</code>:
<pre>
EA_Window_CurrentEvents.OnJumpTimerUpdated( CurrentEventsGetTimers() )
...
function EA_Window_CurrentEvents.OnJumpTimerUpdated( playerCurrentTimerSeconds, jumpCooldownTimerSeconds )
m_playerCurJumpCooldownTimerSeconds = playerCurrentTimerSeconds
m_jumpCooldownTimerHours = jumpCooldownTimerSeconds / TimeUtils.SECONDS_PER_HOUR
m_jumpCooldownTimerMinutes = jumpCooldownTimerSeconds / TimeUtils.SECONDS_PER_MINUTE

local jumpDisabled = m_playerCurJumpCooldownTimerSeconds ~= 0
...
</pre>

== See also ==
* [[API:CurrentEventsJumpToEvent|CurrentEventsJumpToEvent]]
* [[API:CurrentEventsGetList|CurrentEventsGetList]]

API:CurrentEventsGetTimers - Revision history

Maintenance script: UI Lua API import (WAR 1.4.8)