Inspector
How to use the Morpheus Admin Inspector
Overview
The Morpheus Inspector is a tool that can be used in editor and live deployments to:
View network and rendering lod levels of entities
Hide and delete entities at runtime
Kick players
Filter players by connection type (streaming client or native client)
Provide additional information about entities when provided a custom implementation by a project
As well as debugging, the Inspector can also be used as a form of manual moderation in games, and the kick functionality can be extended from within projects to also ban users.
Usage
By default, the Inspector can be only opened with the command Morpheus.Inspector.Admin
.
Note that as the Inspector is only accessible via a console command, you'll only be able to access it from a non-Shipping client. This doesn't mean that hacked Shipping clients won't be able to run this command though!
To expose the ability to access the Inspector without a console command, in your project you can call RequestEnterAdmin
and ExitAdmin
from the client MorpheusInspectorAdminSingleton
singleton.
The server determines which players have permissions to open the Inspector. The default Inspector only allows permissions for users with the Director
role to open the Inspector.
Extending
To change the permissions for who can access the Inspector, or to extend its functionality, you will need to create an Inspector singleton class that extends from Morpheus Inspector Admin Singleton
and set it as the Inspector Admin Singleton Class
in your project's world settings.
This singleton class implements CanEnterAdmin
, which determines which players can access the Inspector panel, and has the Admin Class
field which determines which admin panel actor is spawned. The admin panel actor is the actor that determines the behaviour of the Inspector.
Last updated