LogoLogo
What's New?API StatusOur Website
  • Morpheus Platform Documentation
  • What is Morpheus Platform?
    • Glossary
    • Interoperability
    • Support
    • EULA
  • Firewall Problems
  • CREATION
    • Unreal Development
      • Get Started
        • Download the Editor
        • Upload Content
        • Creating your Own Map
        • Morpheus Base Project
        • Differences from Unreal
          • Character Configuration
        • Morpheus Networking
          • Introduction to Morpheus Networking
          • Network Levels
          • Replicated Properties
          • RPCs
          • Morpheus Render Targets
          • Morpheus Array
          • Networking FAQ
          • Replicating Sublevels
      • Editor Versions
      • Performance Guarantees
      • Features & Guides
        • Example Plugin
          • Nameplates
          • In-Game Roles
          • Resizing
        • Actor Pooling
        • Audio
        • Avatars
          • Creating an Avatar
          • Attachments
            • MML Attachments
          • Custom Animation Variables
          • Importing an NFT Collection
          • Capsules and Mesh Transforms
        • Bots
        • Chat
          • Unreal Text Chat
        • Control Panels
          • Control Panel Configuration
          • DJ Booth Mission Control
          • Observer Controls
        • Crowd Audio
          • CrowdAudioComponent advanced configuration
        • Crowd Rendering
          • Legacy Animated Crowd
            • Animated Crowd Console Commands
            • Attaching static meshes to crowd members
          • Crowd Materials
          • Performance Parameters
          • Live Config Settings
          • Crowd Animation
            • Crowd Anim Blueprint
              • User Guide - Crowd Anim Blueprint
              • Reference Guide - ABP Nodes
                • Animation Playback
                • States and State Machines
                • Variables
                • Transitions
                • Special
                • Blends
                • Additional Notes
        • Helpers & Extras
          • "Instanced Objects" in Blueprints
          • Objects with "world context"
          • Making DataAsset classes
          • Duplicate Objects
          • The Bootflow Subsystem
          • The "Wait For Condition" System
          • Advanced Graphics Settings
          • Listening to Inputs on UObjects
          • Morpheus UserID
          • World Services
          • M2Extras: Skins System
        • Loading Screen
        • Live Config
          • Editing for a World
          • Editing Locally
          • Default Settings
          • Accessing via Blueprint
          • Adding New Settings
          • Overriding Defaults
          • Using Arrays
        • MML
        • Motion Capture
        • Networking
        • Notifications
        • Raycastable Crowd
        • Singletons
        • Streaming & Multiplatform
          • GFN on Mobile
        • UI
          • "UI Mode"
        • Video Players
          • Embedded Video Player
          • Millicast video streaming
            • How to Setup an In-Game Video Stream
            • Picture-in-Picture mode
          • Streaming Video Player
            • How to Setup a URL Video Player
            • Picture-in-Picture mode
        • Visual Debugging
          • Inspector
        • Online Services
          • KV Store Service
        • Web Browser
          • Setup the browser widget
          • Viewport browser
          • In-world browser
          • Loading embedded pages
          • Game <--> Browser Communication
          • Debugging issues
        • Web Requests
          • Http Requests
            • Legacy HTTP Nodes
          • JSON Handling
          • WebSockets
          • Identity Validation
          • Allowed External URLs
          • Walkthrough Example
            • Example Counter Service
        • World Travel
          • World Travel in the Editor
        • Avatar Physics Assets
        • Action Gameplay Helper Components
      • Workflows
        • Upgrade the Editor
        • Editing Project Settings
        • Profiling
        • Marketplace Importing
        • Extra Workflows
          • Setup Play-in-Editor
          • Setup Local Asset Validation
          • Adding Gameplay Tags
          • Validating Game Assets
          • Custom Connection Modes
          • Connect Editor to a World
          • Common Issues
      • Best Practices
    • Worlds
      • Invite Players
        • Setting Role Groups
      • Persistent Worlds
      • Always on Worlds
    • Running Events
      • Large Scale Events - Checklist
      • Anti-Cheat (EAC)
      • Player Entry
        • React Native
        • Steam
        • Hardware Requirements
      • Broadcast
        • OBS Integration
      • Failover
      • Capacity and Queue Management
  • ADMINS
    • Access Control
      • Add Metaverse Contributors
      • Create a New Project
    • Pricing
      • Development Support
      • Included Usage & Overages
      • Cloud Streaming
      • Access Modes
      • War Room Support
      • Platform SLA
    • Settings
      • Projects
  • APIs and Tooling
    • API Reference
      • Accounts
      • Events
      • Key/Value Store
      • Organizations
      • Realtime
      • User Profile
      • World Builder
      • Worlds
    • Template Web App
      • Moderation
    • Pixel Streaming
    • Launcher
  • Dashboard
    • Assets
      • Assets Versions
      • Engine Plugins
      • Project Plugins
      • Templates
    • Releases
  • Integrations
    • Analytics
      • Send Events from Web
      • Send Events from Unreal
    • Chat
      • Integrate Pubnub with your Unreal Project
      • Add Moderation to Chat
Powered by GitBook
On this page
  • Configuring your World's Admission Policy
  • Closed: Manually Admitting Users in the Queue
  • Additional Configurations
  • (DEPRECATED) Capacity System

Was this helpful?

  1. CREATION
  2. Running Events

Capacity and Queue Management

PreviousFailoverNextAccess Control

Last updated 6 months ago

Was this helpful?

Configuring your World's Admission Policy

If you want to control capacity and admission, you can set this when launching from the Launch World modal on the dashboard. This will control entry to your world both via Streaming and also via downloaded clients.

There are 3 possible options you can choose from:

  • Open: no capacity limits are set (regardless of the value you enter for Session Capacity)

  • Automatic: the capacity limit applies, and people are admitted automatically as soon as space is freed, otherwise they are placed in a queue until people exit your world.

  • Closed: admissions are controlled via a (manually handled) queue, at which point you can control the flow of entry to the world.

Closed: Manually Admitting Users in the Queue

When choosing "Closed" as the admission policy, you will be presented with the ability to view and manage the number of users in your queue. This can be found under the "Operations" tab of your world.

When ready, you add admit a custom number of users from the queue into the world. Alternatively, you can bulk add every person from the queue to the world (up to the maximum capacity initially set):

Additional Configurations

If you want to disable queuing specifically for downloaded clients:

  • You can modify your world's live config to disable native client queuing. This can be found under Deployment -> Client -> Deployment Queue -> Respect Queue :

If you want to set a failsafe maximum capacity alongside your admissions policy setting:

  • You can modify your worlds live config to set a maximum number of clients per server. this can be found under Morpheus -> ConnectionParams -> Server -> Max Number of Clients :

(DEPRECATED) Capacity System

The old capacity system is being deprecated. While it can still be used, we will no longer be providing support/fixes should you encounter issues.

Capacity management & Queuing can be used to cap the number of users able to inhabit a world and manage the rate in which users are able to join. The settings can be found under the Operations tab on a World page. Capacity is defined as the maximum number of available seats in a World.

When you enable Capacity you shall be asked to set an initial limit. Any further users that attempt to join the world will need to wait until a seat becomes available by an active user leaving the world for over 5 minutes.

To manually control the flow of users into a world you must enable the queue. This is done by using the toggle next to the queue control. Once the queue is enabled you can manually add users to the world by clicking the Add Users button. It is possible to add a specific number of users or to add as many queueing users as possible (up to the capacity limit).

Capacity can only be used to manage players entering through streaming - not downloaded clients.

Capacity is only tracked from the point you enable - for example if there are 500 players in a world and then capacity is enabled and initially set to 1000 then a further 1000 players could join bringing the total to 1,500. Therefore if you plan to use capacity for a world you should enable it immediately.