Skip to main content

Widgets

Widgets shown on the lobby view - news, community goals, limited-time deals, bonus rares and mystery boxes.

C→S 105 - OpenedLobby​

Nitro: DESKTOP_VIEW

Source: HotelViewEvent, DesktopViewComposer

Notifies the server that the client has navigated to the lobby view.

Body: (empty)

C→S 2912 - RequestWidgets​

Nitro: GET_CURRENT_TIMING_CODE

Source: HotelViewDataEvent, GetCurrentTimingCodeMessageComposer

Requests widget data for the lobby view. Server replies with WidgetData (1745).

Body:
data: string Semicolon-delimited string of widget state data, e.g. "widget_name;param1;param2"

C→S 410 - RequestWidgetNextLimitedOffer​

Nitro: GET_LIMITED_OFFER_APPEARING_NEXT

Source: HotelViewRequestLTDAvailabilityEvent, GetLimitedOfferAppearingNextComposer

Requests information about the next limited-time deal appearing for the lobby view. Server replies with WidgetNextLimitedOffer (44).

Body: (empty)

C→S 957 - RequestWidgetBonusRare​

Nitro: GET_BONUS_RARE_INFO

Source: HotelViewRequestBonusRareEvent, GetBonusRareInfoMessageComposer

Requests the current bonus rare item info for the lobby view.

Body: (empty)

C→S 271 - RequestWidgetSynchronization​

Nitro: GET_SECONDS_UNTIL

Source: HotelViewRequestSecondsUntilEvent, GetSecondsUntilMessageComposer

Requests the number of seconds until a given date, used to synchronize the widget countdown timers.

Body: (empty)

C→S 2318 - RequestWidgetBadgeReward​

Source: HotelViewRequestBadgeRewardEvent

Requests a badge reward to display in the lobby view, sending the badge identifier to claim.

Body: (empty)

C→S 1827 - RequestWidgetNews​

Nitro: DESKTOP_NEWS, GET_PROMO_ARTICLES

Source: RequestNewsListEvent, GetPromoArticlesComposer

Requests the news articles to display in the lobby view.

Body:
(empty)

S→C 122 - OpenLobby​

Nitro: DESKTOP_VIEW Source: HotelViewComposer, DesktopViewEvent

(no Arcturus composer)

Instructs the client to display the lobby view.

Body: (empty)

S→C 286 - WidgetNews​

Nitro: DESKTOP_NEWS, PROMO_ARTICLES Source: PromoArticlesMessageEvent

(no Arcturus composer)

Delivers news article data for the news widget in the lobby view.

FieldTypeNotes
countintNumber of articles
[count × entry]-Article entry
entry.idintArticle ID
entry.titlestringArticle title
entry.bodyTextstringArticle body text
entry.buttonTextstringCall-to-action button label
entry.linkTypeint0=URL, 1=internal link, 2=no link
entry.linkContentstringURL or internal link content
entry.imageUrlstringURL to article image

S→C 1745 - WidgetData​

Nitro: DESKTOP_CAMPAIGN, COMPETITION_TIMING_CODE Source: HotelViewDataComposer, CurrentTimingCodeMessageEvent

Delivers widget data for the lobby view (e.g. bonus rare, community goal widgets).

FieldTypeNotes
datastring
keystring

S→C 44 - WidgetNextLimitedOffer​

Nitro: LIMITED_OFFER_APPEARING_NEXT Source: HotelViewNextLTDAvailableComposer, LimitedOfferAppearingNextMessageEvent

(no Arcturus composer)

Notifies the client of the next limited-time deal so it can display a countdown.

Body:
time: int
pageId: int
itemId: int
itemName: string

S→C 2833 - WidgetMysteryBoxKeys​

Nitro: MYSTERY_BOX_KEYS Source: MysteryBoxKeysComposer, MysteryBoxKeysEvent

FieldTypeNotes
boxColorstringMystery box color string
keyColorstringMystery key color string

Delivers the list of mystery box keys available to the user for opening mystery boxes.

S→C 3201 - MysteryBoxOpen​

Nitro: SHOWMYSTERYBOXWAITMESSAGE Source: MysticBoxStartOpenComposer, ShowMysteryBoxWaitMessageEvent

(no Arcturus composer)

Triggers the mystery box open animation on the client.

Body: (empty)

S→C 596 - MysteryBoxClose​

Nitro: CANCELMYSTERYBOXWAITMESSAGE Source: MysticBoxCloseComposer, CancelMysteryBoxWaitMessageEvent

(no Arcturus composer)

Stops an in-progress mystery box open animation.

Body: (empty)

S→C 1050 - CloseAnnouncement​

Nitro: HOTEL_WILL_CLOSE_MINUTES Source: HotelWillCloseInMinutesComposer, HotelWillCloseInMinutesEvent

FieldTypeNotes
minutesintMinutes until the server closes

Notifies all users that the server will shutdown in a specified number of minutes.

S→C 1350 - MaintenanceAnnouncement​

Nitro: HOTEL_MAINTENANCE Source: HotelWillCloseInMinutesAndBackInComposer, MaintenanceStatusMessageEvent

Notifies the client that the server is entering maintenance mode.

FieldTypeNotes
isInMaintenancebooleanWhether the server is currently in maintenance
minutesUntilMaintenanceintMinutes until maintenance starts (0 if already in maintenance)
durationintExpected maintenance duration in minutes (optional, defaults to 15)

S→C 2771 - CloseAnnouncementReopenDate​

Nitro: HOTEL_CLOSES_AND_OPENS_AT Source: HotelClosesAndWillOpenAtComposer, HotelClosesAndWillOpenAtEvent

Notifies the client of the scheduled close and reopen times for the server.

FieldTypeNotes
openHourintHour the server will reopen (0-23)
openMinuteintMinute the server will reopen (0-59)
userThrownOutAtClosebooleanWhether the user will be kicked when the server closes

S→C 3728 - ClosedAnnouncement​

Nitro: HOTEL_CLOSED_AND_OPENS Source: HotelClosedAndOpensComposer, HotelClosedAndOpensEvent

(no Arcturus composer)

Notifies the client that the server has closed and delivers the scheduled reopening time.

FieldTypeNotes
openHourintHour the server will reopen (0-23)
openMinuteintMinute the server will reopen (0-59)

S→C 1663 - MergerAnnouncement​

Nitro: HOTEL_MERGE_NAME_CHANGE Source: HotelMergeNameChangeEvent

(no Arcturus composer)

Signals that a username change is required following a server merge.

Body: (empty)