Struct ScyllaModuleID

Provides compile-time string constants for every built-in Scylla module ID. Use these constants instead of verbatim string literals when declaring ScyllaModuleDependency instances or when calling GetModule<T>(string) and related query methods, so that typos are caught at compile time rather than at runtime.

Inherited Members
Namespace: Scylla.Core.Modules
Assembly: ScyllaCore.dll
Syntax
public struct ScyllaModuleID
Remarks

Each constant value is the canonical, framework-internal ID string for the corresponding module. These IDs must exactly match the ID returned by each module's Info property.

When creating a custom module, define its ID in an equivalent constants struct within your own assembly rather than adding it here, to keep the core framework free of third-party dependencies.

Declaring a hard dependency on the Input module:

var dependencies = new List<ScyllaModuleDependency>
{
    new ScyllaModuleDependency(ScyllaModuleID.INPUT, ScyllaModuleDependencyType.Hard, "1.0.0")
};

Obtaining a typed reference to the Camera module:

var camera = moduleManager.GetModule<ScyllaCameraModule>(ScyllaModuleID.CAMERA);

Fields

CAMERA

The ID of the ScyllaCamera module, which is the Tier 2 feature module that manages all camera behavior through a seven-mode pipeline (FirstPerson, Follow, Orbit, Fixed, Strategy, Rail, Free) with transitions, collision handling, and post-process effects. Initialization priority: 100. Depends on INPUT and requires the Unity Splines package for Rail mode.

Declaration
public const string CAMERA = "ScyllaCamera"
Field Value
Type Description
string

CONSOLE

The ID of the ScyllaConsole module, which is the Tier 2 feature module that provides the in-game developer console, CLI command dispatcher, and real-time performance monitor. Initialization priority: 60. Depends on UI and INPUT.

Declaration
public const string CONSOLE = "ScyllaConsole"
Field Value
Type Description
string

CORE

The ID of the ScyllaCore singleton, which is the root framework manager rather than a pluggable module. This constant is used in log messages and exception reports that originate from core infrastructure rather than from a specific module. It is not a valid argument to GetModule(string) because ScyllaCore is not registered as a module.

Declaration
public const string CORE = "ScyllaCore"
Field Value
Type Description
string

DATA

The ID of the ScyllaData module, which is the Tier 1 foundational module that provides the framework's first-class data management layer: authored DataRecord ScriptableObjects, plain-C# DataInstance runtime state, a central DataRegistry, the field-type handler registry, and the IStatsHost integration contract consumed by the future Stats refactor. Initialization priority: 50 (between TEXT_MODE at 40 and CONSOLE at 60). Depends only on CORE.

Declaration
public const string DATA = "ScyllaData"
Field Value
Type Description
string

GRAPHICS

The ID of the ScyllaGraphics module, which is the Tier 1 foundational module for SDF-based 2D vector shape rendering under URP. Initialization priority: 30.

Declaration
public const string GRAPHICS = "ScyllaGraphics"
Field Value
Type Description
string

INPUT

The ID of the ScyllaInput module, which is the Tier 1 foundational module responsible for all input handling via the Unity Input System. Initialization priority: 20. All modules that require player input should declare a hard dependency on this ID.

Declaration
public const string INPUT = "ScyllaInput"
Field Value
Type Description
string

STATS

The ID of the ScyllaStats module, which is the Tier 2 feature module that provides a genre-agnostic stats system construction kit with a seven-stage resolution pipeline, ScriptableObject-driven authoring, formula system, modifier architecture, resource pools, and progression systems. Initialization priority: 70. Depends only on CORE.

Declaration
public const string STATS = "ScyllaStats"
Field Value
Type Description
string

TEXT_MODE

The ID of the ScyllaTextMode module, which is the Tier 1 foundational module for grid-based SDF text rendering and terminal emulation. Uses the ScyllaTextMode.ConsoleDisplay bridge assembly to connect to ScyllaConsole output. Initialization priority: 40.

Declaration
public const string TEXT_MODE = "ScyllaTextMode"
Field Value
Type Description
string

UI

The ID of the ScyllaUI module, which provides the Tier 1 foundational user interface infrastructure: TextMeshPro integration, Unity EventSystem management, and the shared debug canvas. Initialization priority: 50. The ScyllaConsole module declares a hard dependency on this ID.

Declaration
public const string UI = "ScyllaUI"
Field Value
Type Description
string

See Also