Setup
This asset comes with the License Manager. You can add it to your world and try it right away, but you must validate your product license with the License Manager before you can publish your world.
Roles
Roles are the core building block of the Security System. Each role has a name, a color, and a set of behaviors you configure once in the Editor — they can't be created or redefined while the world is running, only assigned to players at runtime.
Assignment Methods
There are several ways a role can reach a player. Which one applies depends entirely on how you configure the role — most of these can be mixed and matched on the same role.
The Security Keypad
The SecurityKeypad prefab is a physical, interactable in-world keypad. A player walks up, presses numbered buttons to enter a role's password, and the system automatically checks it once enough digits are entered — there's no separate submit button.
Actions
Roles can be wired to automatically do things in the world the moment they're granted or revoked from a player — teleporting them, playing an animation, or showing/hiding objects. This binding happens on SS_RolesManagement, in its Role Actions list, separate from the Roles list itself: any number of actions can be attached to a single role's grant or revoke, with no per-role limit.
Notifications
This page describes an optional integration. The Security System works fine, with no errors, if the Notification System isn't installed and left unconfigured.
Player Tags
This page describes an optional integration. If the Player Tags field described below is left empty, or you haven't installed the Player Tags asset at all, every role's Player Tag dropdown simply shows "No Player Tags" and nothing else needs configuring — the Security System works exactly the same either way, with no errors.
Player Management Panel & Theme
The management panel is the main interface security staff use to view and control every player's roles. It's built once at edit time by SSSecuritySystemUI's custom Inspector, and its colors are driven by a separate, shared SSConfigUI script.
API Reference
The Security System exposes a set of public methods on SS_SecuritySystem for other Udon scripts to interact with it — whether that's checking a player's roles for a custom door or sign, or granting/revoking roles from your own UI.