Skip to main content

Room Settings

Room configuration, rights management, bans, mutes, word filter, floor plan editor, and room rollers.

C→S 3129 - RequestRoomSettings

Nitro: ROOM_SETTINGS

Source: RequestRoomSettingsEvent, RoomSettingsComposer

Requests the full settings data for a room, sent when the owner opens the room settings panel.

Body: (empty)

C→S 1969 - RoomSettingsSave

Nitro: ROOM_SETTINGS_SAVE

Source: RoomSettingsSaveEvent, SaveRoomSettingsComposer

Submits updated room settings (name, description, access mode, capacity, chat rules, etc.) to the server.

Body:
roomId: int
name: string
description: string
readInt: int
password: string
usersMax: int
categoryId: int
readInt: int
tag: string
readInt: int
readBoolean: boolean
readBoolean: boolean
readBoolean: boolean
readBoolean: boolean
readInt: int
readInt: int
readInt: int
readInt: int
readInt: int
readInt: int
readInt: int
readInt: int
readInt: int

C→S 2300 - RequestRoomHeightmap

Nitro: ROOM_MODEL

Source: RequestRoomHeightmapEvent, GetRoomEntryDataMessageComposer

Requests the room heightmap and entry data when entering a room.

Body: (empty)

C→S 1687 - FloorPlanEditorRequestBlockedTiles

Nitro: GET_OCCUPIED_TILES

Source: FloorPlanEditorRequestBlockedTilesEvent, GetOccupiedTilesMessageComposer

Requests the list of permanently blocked (non-walkable) tiles for the floor plan editor.

Body: (empty)

C→S 3559 - FloorPlanEditorRequestDoorSettings

Nitro: GET_ROOM_ENTRY_TILE

Source: FloorPlanEditorRequestDoorSettingsEvent, GetRoomEntryTileMessageComposer

Requests the current door tile position and direction for the floor plan editor.

Body: (empty)

C→S 875 - FloorPlanEditorSave

Nitro: ROOM_MODEL_SAVE

Source: FloorPlanEditorSaveEvent, UpdateFloorPropertiesMessageComposer

Submits a new floor plan layout (tile map, door position, wall and floor thickness) to the server.

Body:
map: string
doorX: int
doorY: int
doorRotation: int
wallSize: int
floorSize: int

C→S 3385 - RequestRoomRights

Nitro: ROOM_RIGHTS_LIST

Source: RequestRoomRightsEvent, RoomUsersWithRightsComposer

Requests the list of users who have been granted rights in the current room.

Body: (empty)

C→S 2683 - RoomRemoveAllRights

Nitro: ROOM_RIGHTS_REMOVE_ALL

Source: RoomRemoveAllRightsEvent, RemoveAllRightsMessageComposer

Removes room rights from all users at once, sent by the room owner.

Body: (empty)

C→S 3182 - RoomRemoveRights

Nitro: ROOM_RIGHTS_REMOVE_OWN

Source: RoomRemoveRightsEvent, RemoveOwnRoomRightsRoomMessageComposer

Removes the current user's own rights from a room they no longer want to manage.

Body: (empty)

C→S 2267 - RoomRequestBannedUsers

Nitro: ROOM_BAN_LIST

Source: RoomRequestBannedUsersEvent, RoomBannedUsersComposer

Requests the list of users currently banned from a room, sent when the owner opens the ban list.

Body: (empty)

C→S 1477 - RoomUserBan

Nitro: ROOM_BAN_GIVE

Source: RoomUserBanEvent, RoomBanUserComposer

Bans a user from the room for a specified duration, sent by the room owner or a rights holder.

Body:
userId: int
roomId: int

C→S 992 - UnbanRoomUser

Nitro: ROOM_BAN_REMOVE

Source: UnbanRoomUserEvent, RoomUnbanUserComposer

Removes a ban for a specific user from the room's ban list.

Body:
userId: int

C→S 3485 - RoomUserMute

Nitro: ROOM_MUTE_USER

Source: RoomUserMuteEvent, RoomMuteUserComposer

Mutes a user in the room for a specified number of minutes, sent by the room owner or a rights holder.

Body:
userId: int
roomId: int

C→S 3637 - RoomMute

Nitro: ROOM_MUTE

Source: RoomMuteEvent, RoomMuteComposer

Toggles the room-wide mute state, silencing all non-moderator chat in the room.

Body: (empty)

C→S 1911 - RequestRoomWordFilter

Nitro: ROOM_FILTER_WORDS

Source: RequestRoomWordFilterEvent, GetCustomRoomFilterMessageComposer

Requests the room's custom word filter list, sent when the owner opens the word filter settings.

Body: (empty)

C→S 3001 - RoomWordFilterModify

Nitro: ROOM_FILTER_WORDS_MODIFY

Source: RoomWordFilterModifyEvent, UpdateRoomFilterMessageComposer

Adds or removes a word from the room's custom word filter.

Body:
roomId: int
add: boolean

C→S 143 - VoteForRoom

Nitro: VOTE_FOR_ROOM Note: No Arcturus handler - Nitro only. Source: VoteForRoomMessageComposer

FieldTypeNotes
kstringUnknown vote/competition identifier

Casts a like/vote for the current room.

C→S 314 - ConvertGlobalRoomId

Nitro: CONVERT_GLOBAL_ROOM_ID Note: No Arcturus handler - Nitro only. Source: ConvertGlobalRoomIdMessageComposer

FieldTypeNotes
flatIdstringGlobal/legacy room ID string to convert to a local room ID

Requests conversion of a global (cross-server) room ID to a local room ID.

C→S 1265 - RoomSettingsUpdateRoomCategoryAndTrade

Nitro: ROOM_SETTINGS_UPDATE_ROOM_CATEGORY_AND_TRADE Note: No Arcturus handler - Nitro only. Source: UpdateRoomCategoryAndTradeSettingsComposer

FieldTypeNotes
kintNew room category ID
_arg_2intTrade settings value
_arg_3intUnknown int

Updates the room's navigator category and trade mode setting.

C→S 2468 - UpdateRoomThumbnail

Nitro: UPDATE_ROOM_THUMBNAIL Note: No Arcturus handler - Nitro only. Source: UpdateRoomThumbnailMessageComposer

FieldTypeNotes
flatIdintRoom ID to update thumbnail for
bgImgIdintBackground image ID
frontImgIdintForeground / overlay image ID
objCountintNumber of object layers

Submits an updated room thumbnail image.

C→S 3305 - SetRoomSessionTags

Nitro: SET_ROOM_SESSION_TAGS Note: No Arcturus handler - Nitro only. Source: SetRoomSessionTagsMessageComposer

FieldTypeNotes
kstringFirst session tag string
_arg_2stringSecond session tag string

Sets the current session tags for the room (used for navigator discovery).

C→S 3736 - RoomDirectoryRoomNetworkOpenConnection

Nitro: ROOM_DIRECTORY_ROOM_NETWORK_OPEN_CONNECTION Note: No Arcturus handler - Nitro only. Source: RoomNetworkOpenConnectionMessageComposer

FieldTypeNotes
kintRoom network / room directory ID
_arg_2intConnection parameter / slot index

Opens a network connection for the room directory feature.

Opens a network connection for a room in the room directory. Nitro-only.

S→C 558 - RoomHeightMapUpdate

Nitro: ROOM_HEIGHT_MAP_UPDATE Source: UpdateStackHeightComposer, RoomHeightMapUpdateEvent

FieldTypeNotes
countbyteNumber of tile updates in this batch
[count × x]byteTile X coordinate
[count × y]byteTile Y coordinate
[count × value]shortEncoded tile height + flags (use RoomHeightMapParser to decode)

Delivers an incremental update to the room heightmap (e.g. after a furniture placement changes walkability).

S→C 3990 - RoomModelBlockedTiles

Nitro: ROOM_MODEL_BLOCKED_TILES Source: FloorPlanEditorBlockedTilesComposer, RoomOccupiedTilesMessageEvent

Delivers blocked (non-walkable) tile positions for the floor plan editor.

FieldTypeNotes
countintNumber of blocked tile entries
[count × x]intTile X coordinate
[count × y]intTile Y coordinate

Delivers the set of permanently blocked (non-walkable) tiles for the room model.

S→C 1664 - RoomModelDoor

Nitro: ROOM_MODEL_DOOR Source: FloorPlanEditorDoorSettingsComposer, RoomEntryTileMessageEvent

Delivers the entry tile coordinates for the room the client is entering.

FieldTypeNotes
xintEntry tile X coordinate
yintEntry tile Y coordinate
directionintInitial facing direction (0–7, multiplied by 45° = degrees)

Delivers the door tile position and direction for the room model.

S→C 3547 - RoomThickness

Nitro: ROOM_THICKNESS Source: RoomThicknessComposer, RoomVisualizationSettingsEvent

FieldTypeNotes
hideWallsbooleanWhether walls are hidden
thicknessWallintRaw wall thickness value (-2 to 1; decoded as 2^value)
thicknessFloorintRaw floor thickness value (-2 to 1; decoded as 2^value)

Delivers the wall and floor thickness settings for the current room.

S→C 3207 - RoomRolling

Nitro: ROOM_ROLLING Source: ObjectsRollingEvent

Furniture rolling/sliding physics. One roller event can carry multiple item rolls plus an optional unit roll.

FieldTypeNotes
fromXintSource tile X
fromYintSource tile Y
toXintDestination tile X
toYintDestination tile Y
itemCountintNumber of rolling items
[itemCount × itemId]intItem ID
[itemCount × fromHeight]stringSource height string
[itemCount × toHeight]stringDestination height string
rollerIdintRoller item ID
movementTypeint0=no unit, 1=move, 2=slide
[if movementType>0] unitIdintRoom unit ID
[if movementType>0] unitFromHeightstringUnit source height
[if movementType>0] unitToHeightstringUnit destination height

Notifies clients of a rolling/sliding event for a furniture item or user on a roller.

S→C 1498 - RoomSettings

Nitro: ROOM_SETTINGS Source: RoomSettingsComposer, RoomSettingsDataEvent

Full room settings data. See also S→C 1191 (ROOM_SETTINGS_CHAT) for the chat subset.

FieldTypeNotes
roomIdintRoom ID
namestringRoom name
descriptionstringRoom description
doorModeint0=open, 1=doorbell, 2=password, 3=invisible
passwordstringRoom password (empty if not password-locked)
userLimitintMax users allowed
categoryIdintNavigator category ID
tagCountintNumber of tags
[tagCount × tag]stringRoom tag
isPublicbooleanWhether the room is publicly listed
allowPetsbooleanWhether pets are allowed
allowPetsEatbooleanWhether pets can eat
blockRoomWalkbooleanWhether room entry walking is blocked
hideWallsbooleanWhether walls are hidden
wallThicknessintWall thickness (-2 to 1)
floorThicknessintFloor thickness (-2 to 1)
whoMutesintWho can mute: 0=owner, 1=rights, 2=all
whoKicksintWho can kick: 0=owner, 1=rights, 2=all
whoBansintWho can ban: 0=owner, 1=rights, 2=all
chatModeint0=free flow, 1=line by line
chatBubbleWidthint0=wide, 1=normal, 2=thin
chatScrollSpeedint0=fast, 1=normal, 2=slow
chatDistanceintChat hearing distance
chatFloodProtectionint0=strict, 1=normal, 2=loose
tradeModeint0=no trade, 1=rights, 2=all
moveDiagonallybooleanWhether diagonal movement is allowed

Delivers the full room settings for the settings editor panel (name, description, access, capacity, trade, etc.).

S→C 948 - RoomSettingsSave

Nitro: ROOM_SETTINGS_SAVE Source: RoomSettingsSavedComposer, RoomSettingsSavedEvent

FieldTypeNotes
roomIdintID of the room whose settings were saved

Confirms that room settings were saved successfully.

S→C 1555 - RoomSettingsSaveError

Nitro: ROOM_SETTINGS_SAVE_ERROR Source: RoomEditSettingsErrorComposer, RoomSettingsSaveErrorEvent

FieldTypeNotes
roomIdintRoom ID
errorCodeintError code (see RoomSettingsSaveErrorParser constants)
messagestringAdditional error message text

Reports that saving room settings failed, with an error code.

S→C 1191 - RoomSettingsChat

Nitro: ROOM_SETTINGS_CHAT Source: RoomChatSettingsComposer, RoomChatSettingsEvent

FieldTypeNotes
modeint0=free flow, 1=line by line
weightintBubble width: 0=wide, 1=normal, 2=thin
speedintScroll speed: 0=fast, 1=normal, 2=slow
distanceintChat hearing distance in tiles
protectionintFlood filter: 0=strict, 1=normal, 2=loose

Delivers the room's chat moderation settings (chat mode, flood filter, chat distance).

S→C 3297 - RoomInfoUpdated

Nitro: ROOM_INFO_UPDATED Source: RoomSettingsUpdatedComposer, RoomSettingsUpdatedEvent

FieldTypeNotes
roomIdintRoom ID whose info (name/description) was updated

Notifies clients in the room that the room info (name, description) has been updated.

S→C 1284 - RoomRightsList

Nitro: ROOM_RIGHTS_LIST Source: RoomRightsListComposer, FlatControllersEvent

FieldTypeNotes
roomIdintRoom ID
countintNumber of rights holders
[count × userId]intAccount ID
[count × username]stringUsername

Delivers the full list of users who have been granted room rights by the owner.

S→C 2088 - RoomRightsListAdd

Nitro: ROOM_RIGHTS_LIST_ADD Source: RoomAddRightsListComposer, FlatControllerAddedEvent

FieldTypeNotes
roomIdintRoom ID
userIdintAccount ID of the user added
usernamestringUsername of the user added

Notifies that a user has been added to the room rights list.

S→C 1327 - RoomRightsListRemove

Nitro: ROOM_RIGHTS_LIST_REMOVE Source: RoomRemoveRightsListComposer, FlatControllerRemovedEvent

FieldTypeNotes
roomIdintRoom ID
userIdintAccount ID of the user whose rights were removed

Notifies that a user has been removed from the room rights list.

S→C 2392 - RoomRightsClear

Nitro: ROOM_RIGHTS_CLEAR Source: RoomNoRightsComposer, RoomRightsClearEvent

(no Arcturus composer)

Sent when the user's room rights are cleared (all rights removed).

Notifies the client that all of its room rights have been cleared.

Body: (empty)

S→C 1869 - RoomBanList

Nitro: ROOM_BAN_LIST Source: RoomBannedUsersComposer, BannedUsersFromRoomEvent

FieldTypeNotes
roomIdintRoom ID
countintNumber of banned users
[count × userId]intBanned user account ID
[count × username]stringBanned username

Delivers the list of users currently banned from the room.

S→C 3429 - RoomBanRemove

Nitro: ROOM_BAN_REMOVE Source: RoomUserUnbannedComposer, UserUnbannedFromRoomEvent

FieldTypeNotes
roomIdintRoom ID
userIdintAccount ID of the un-banned user

Notifies that a user has been unbanned (removed from the room ban list).

S→C 826 - RoomMuted

Nitro: ROOM_MUTE_USER / REMAINING_MUTE

Source: MutedWhisperComposer, RemainingMuteEvent

FieldTypeNotes
isMutedbooleanWhether the room is currently muted

Notifies the client that the user has been muted in the room (remaining mute time), used for whisper-block feedback.

S→C 2533 - RoomMuted

Nitro: ROOM_MUTED Source: RoomMutedComposer, MuteAllInRoomEvent

Sent when the room muted state changes.

FieldTypeNotes
isMutedbooleanWhether the room is now muted (true) or unmuted (false)

Notifies clients that the room has been muted (only moderators can chat).

S→C 2937 - RoomGetFilterWords

Nitro: ROOM_GET_FILTER_WORDS Source: RoomFilterWordsComposer, RoomFilterSettingsMessageEvent

FieldTypeNotes
countintNumber of filtered words
[count × word]stringFiltered word

Delivers the room's custom word filter list.

S→C 482 - RoomScore

Nitro: ROOM_SCORE Source: RoomScoreComposer, RoomScoreEvent

FieldTypeNotes
totalLikesintTotal number of likes the room has received
canLikebooleanWhether the current user can still like the room

Delivers the current room score (like count) and whether the user can still vote.

S→C 1033 - RoomSpectator

Nitro: ROOM_SPECTATOR Source: RoomUnknown3Composer, YouAreSpectatorMessageEvent

(no Arcturus composer)

Sent to notify the client it is now in spectator mode in the current room.

Notifies the client that it is in spectator mode for the current room (view-only, no interaction).

Body: (empty)

S→C 52 - GuestRoomSearchResult

Nitro: GUEST_ROOM_SEARCH_RESULT Note: No Arcturus composer - Nitro only. Source: PrivateRoomsComposer, GuestRoomSearchResultEvent

(no Arcturus composer)

Search results for a navigator room query.

FieldTypeNotes
searchTypeintType of search performed
searchParamstringSearch parameter string
countintNumber of room results
[count × room]RoomDataRoom data entry (same structure as in NAVIGATOR_SEARCH_RESULT)
hasAdditionalbooleanWhether an additional official/promoted room follows
[if hasAdditional] adOfficialRoomEntryPromoted room entry

Delivers the result of a legacy guest room lookup (room data for a specific room ID).

S→C 1634 - RoomMessageNotification

Nitro: ROOM_MESSAGE_NOTIFICATION Note: No Arcturus composer - Nitro only. Source: RoomMessagesPostedCountComposer, RoomMessageNotificationMessageEvent

(no Arcturus composer)

FieldTypeNotes
roomIdintRoom ID where the notification originated
roomNamestringRoom name
messageCountintNumber of unread messages in this room

Delivers a room-level notification message (e.g. from a wired action or admin broadcast).

S→C 1759 - RoomAdError

Nitro: ROOM_AD_ERROR Note: No Arcturus composer - Nitro only. Source: RoomAdErrorComposer, RoomAdErrorEvent

(no Arcturus composer)

FieldTypeNotes
errorCodeintAd error code
filteredTextstringFiltered/censored text that caused the error

Reports that a room advertisement purchase or submission failed.

S→C 2274 - RoomPromotionMessage

Nitro: ROOM_PROMOTION

Source: RoomPromotionMessage

FieldTypeNotes
(no promotion)-promotionId:int(-1), ownerId:int(-1), name:string(""), unknown×4:int(0,0,0,0), name2:string(""), desc:string(""), unknown2×3:int(0,0,0)
(with promotion)-promotionId:int(roomId), ownerId:int, ownerName:string, roomId:int, type:int(1), + additional fields

Notes: When the room has no active promotion, Arcturus sends a sequence of −1/0/"" placeholder values. Full promotion data includes title, description, category, and timestamps.

Delivers room promotion/event data for display in the room info panel.

S→C 2897 - RoomEditSettingsError

Nitro: ROOM_SETTINGS_ERROR

Source: RoomEditSettingsError, RoomSettingsErrorEvent

FieldTypeNotes
roomIdintID of the room with the settings error
errorCodeintError code
infostringError description

Reports that saving room settings failed, with a room ID and error description.

S→C 3896 - ShowEnforceRoomCategory

Nitro: SHOW_ENFORCE_ROOM_CATEGORY Note: No Arcturus composer - Nitro only. Source: RoomCategoryUpdateMessageComposer, ShowEnforceRoomCategoryDialogEvent

(no Arcturus composer)

Prompts the user to update their room category to comply with hotel rules.

Prompts the user to update their room category to comply with hotel content rules. Nitro-only.

Body: (empty)