Skip to main content

Settings

RoomSystem​

The main RoomSystem script is in charge of handling room updates, invites, transitions etc.

warning

For most setups, there should only be 1 RoomSystem in the instance at all times and it should never be turned off for best results.

Settings​

  • DebugMode : bool - Enables extra console messages for help debugging.
  • RingCooldown : float - Time in seconds between being able to ring the room again.

Audio​

  • Volume : float - Master volume for room system sounds.
  • LockedSound : audioClip - Played when trying to enter a locked room.
  • RingSound : audioClip - Played when ringing the room.
  • DoorOpenSound : audioClip - Played when the room door opens.
  • ButtonSound : audioClip - Played on every room control button press.

References​

These are used internally and you should never have to change these.

  • NotificationCanvas : GameObject - Canvas used to display room notifications.
  • NotificationText : TextMeshProUGUI - Text component used to display room notifications.
  • Screen : RoomScreen : Room screen component used to display room controls.
  • TransitionAnimator : Animator - Animator used for room transition effects.
  • PostProcessVolume : GameObject - Post process volume used for room transition effects.

Room​

This script represents each private room on your map, each one must be tied to 1 RoomSystem.

Room Settings​

  • EntryPoint: Transform - Where players will spawn when entering the room.
  • ExitPoint: Transform - Where players will be moved when exiting the room.
  • ScreenPoint: Transform - Point where the room controls screen will be placed.

Room References​

  • RoomSystem : RoomSystem - Reference to the main RoomSystem in the instance.

Room Screen​

Colors​

  • DefaultColor : Color - Color of disabled buttons.
  • LockedColor : Color - Color of locked room button.
  • ActiveColor : Color - Color of active buttons.

Localization​

  • TextLocked : string - Text displayed when the room is locked.
  • TextUnlocked : string - Text displayed when the room is unlocked.
  • TextRingBell : string - Text displayed when the bell was rung.

Screen References​

  • CaptionTextInside : TextMeshProUGUI - The text panel to show the caption of the room.
  • RingerTextInside : TextMeshProUGUI - The text panel Where to display the name of the ringer player.
  • InvitesContent : GameObject - The content of the scroll view used to show people to invite.
  • LockButton : Button - Button used to lock/unlock the room.
  • DNDButton : Button - Button used to toggle Do Not Disturb mode.
  • LFCButton : Button - Button used to toggle Looking For Company mode.
  • AnonymousButton : Button - Button used to toggle Anonymous mode.
  • NightModeSlider : Slider - Slider used to adjust night mode intensity.
  • InputFieldText : TextMeshProUGUI - Text component of the input field for the room caption.
  • RoomSystem : RoomSystem - Reference to the main RoomSystem in the instance.