API:CurrentEventsJumpToEvent
From RoR Wiki
UI Lua API · LiveEvent functions
Version: WAR 1.4.8
Asks the server to take the player to a current world event (the "Go" button of the Current Events window).
CurrentEventsJumpToEvent(eventId)
Arguments
- eventId
number– Id of an event in the list from CurrentEventsGetList.
Returns
Nothing.
Details
- The id is looked up in the client's stored event list. If no event has that id, nothing is sent and no error is raised.
- The request sends the event's id and tier. Nothing is sent if the connection is not ready.
- If the current-events data is not available, the call does nothing, and the argument is not checked.
- Whether the jump happens is decided by the server. The stock UI uses CurrentEventsGetTimers to disable the button while the jump is on cooldown, and asks for confirmation first.
- Exactly one argument must be passed.
Errors
None besides the generic Invalid Parameters message when the argument is missing or not a number.
Example
From default/ea_currenteventswindow/source/currenteventswindow.lua:
function EA_Window_CurrentEvents.OnConfirmationDialogYes()
CurrentEventsJumpToEvent( m_selectedEventId )
m_confirmationDialogOpen = false
end