Skip to content
Version 2.32.0
↓ Get the launcher

IFrameworkDeveloperMode interface

The user’s framework developer mode, read-only for plugins (2.30.0). Split out of IFramework, which is at the framework’s interface-size budget; consumers reach it through services.Framework exactly as if it were declared there.

Developer mode is the switch a player turns on from Settings (7 clicks on the version on the About tab, or "developer": { "developerMode": true } in stellar.framework.config.json). Use it to show your plugin’s debug tools, extra diagnostics and verbose logs only while the user has it on — normal players never see them. Plugins can only read it; turning it on or off is the user’s choice.

public interface IFrameworkDeveloperMode
name description
DeveloperMode { get; } Whether developer mode is on right now. Read live: a cached field read, cheap enough to check every tick or from an element Func. False until the framework has loaded its settings.
event DeveloperModeChanged Raised on the Unity main thread with the new value whenever developer mode is switched on or off — from Settings or by a hand edit of the framework config file. Not raised for your plugin’s current value at subscribe time: read DeveloperMode once, then follow this. Your subscription is dropped automatically when your plugin is disabled or unloaded. A throwing handler is logged and never blocks other plugins’ handlers.