Skip to main content

room.settings

Generated from spec/protocol.yaml. Do not edit by hand.

Overview

  • ID: 1498
  • Header: ROOM_SETTINGS
  • Direction: Server to Client (s2c)
  • Realm: Room
  • Phase: session
  • Since: nitro-1.6.6
  • Summary: Deliver the full room settings record

Payload fields

FieldTypeRequiredDescription
roomIdint32requiredID of the room.
roomNamestringrequiredCurrent room name.
roomDescriptionstringrequiredCurrent room description.
doorModeint32requiredCurrent door mode: 0=open, 1=doorbell, 2=password, 3=invisible.
userLimitint32requiredCurrent maximum user count.
categoryIdint32requiredCurrent navigator category.
tagsstring[]requiredCurrent room tags.
tradeModeint32requiredCurrent trade mode.
allowPetsbooleanrequiredWhether visitors may bring pets.
allowPetsEatbooleanrequiredWhether pets may eat room items.
allowWalkthroughbooleanrequiredWhether avatars can walk through each other.
hideWallsbooleanrequiredWhether walls are hidden.
wallThicknessint32requiredWall thickness level.
floorThicknessint32requiredFloor thickness level.
muteStateint32requiredWho can mute users.
kickStateint32requiredWho can kick users.
banStateint32requiredWho can ban users.
chatSettingsobjectrequiredChat configuration (mode, weight, speed, distance, flood protection).

Behavior

Sender

Sent in response to room.get_settings (c2s 3129). Contains all editable room configuration fields.

Receiver

The client populates the settings editor form with the received values. Confirmed in GLADIATOR.

Notes

  • No additional notes