Namespace

SaffronLibrary.Prime.Systems.Contracts

CoreKeyNames

Public static class of string constants for core parameter keys.

public static class CoreKeyNames
{
    public const string StringValue;
    public const string ObjectValue;
    public const string StringKey;
    public const string StringTag;
    public const string DomainContext;
    public const string RegistrationKey;
    public const string ObjectTransform;
    public const string IDCollection;
    public const string ID;
    public const string GameObjectCollection;
    public const string Duration;
}

• StringValue: Key for generic string values.
• ObjectValue: Key for loosely typed object values.
• StringKey: Key for the unique identifier of a definition.
• StringTag: Key for string tags used in event identification and filtering.
• DomainContext: Key for the targeted domain of a message.
• RegistrationKey: Key for registration key values in payloads.
• ObjectTransform: Key for Unity Transform components.
• IDCollection: Key for collections of integer identifiers.
• ID: Key for a single integer identifier.
• GameObjectCollection: Key for a list of GameObject values.
• Duration: Key for a duration value in seconds.

The private members Base and the nested Schema class are not part of the public API.

CoreParamKeys

Public static class of typed parameter keys.

public static class CoreParamKeys
{
    public static readonly ParamKey<string> Tag;
    public static readonly ParamKey<Domain> DomainContext;
    public static readonly ParamKey<string> RegistrationKey;
    public static readonly ParamKey<Transform> Transform;
    public static readonly ParamKey<IList<int>> IDs;
    public static readonly ParamKey<string> StringValue;
    public static readonly ParamKey<int> ID;
    public static readonly ParamKey<string> Key;
    public static readonly ParamKey<object> ObjectValue;
    public static readonly ParamKey<List<GameObject>> GameObjects;
    public static readonly ParamKey<float> Duration;
}

• Tag: String tags for event identification and filtering.
• DomainContext: The targeted Domain for a message.
• RegistrationKey: Registration key values in payloads.
• Transform: A Unity Transform for spatial operations.
• IDs: A list of integer identifiers for batch operations.
• StringValue: Generic string values passed between systems.
• ID: A single integer identifier for entity operations.
• Key: The unique identifier for a definition.
• ObjectValue: A loosely typed value, boxed as object.
• GameObjects: A list of GameObject values.
• Duration: A duration in seconds.

Domain

Public enum that identifies the system that owns a domain. Underlying type is int.

public enum Domain
{
    UI = 0,
    Audio = 1,
    VFX = 2,
    Tutorial = 3,
    Level = 4,
    InApp = 5,
    Debug = 6,
    Application = 7,
    Puzzle = 8,
    Analytic = 9,
    Ad = 10,
    Animation = 11,
    Release = 12,
    Factory = 13,
    Accessibility = 14,
    Save = 15,
    Scheduler = 16,
    Cinematic = 17,
    Evaluator = 18,
    Data = 19,
    Game = 20,
    Update = 21,
    Scene = 22,
    Companion = 23,
}

• UI (0): User interface, menus, HUD, and Canvas elements.
• Audio (1): Sound effects, music, and audio mixing.
• VFX (2): Particle systems, shaders, and post-processing.
• Tutorial (3): Onboarding, hints, and step-by-step guidance.
• Level (4): Scene loading, level progression, and checkpoints.
• InApp (5): In-app purchases and store transactions.
• Debug (6): Debug overlays, console logging, and diagnostics.
• Application (7): Focus changes, quitting, and application state.
• Puzzle (8): Puzzle state and progress, such as a puzzle being solved.
• Analytic (9): Event tracking, metrics, and analytics integration.
• Ad (10): Ad display and ad campaigns.
• Animation (11): Tweens, character animation, and motion control.
• Release (12): Build versioning, feature flags, and A/B configuration.
• Factory (13): Object creation, pooling, and instantiation.
• Accessibility (14): Screen reader, colorblind, and input alternatives.
• Save (15): Persistent data and save state.
• Scheduler (16): Coroutines, delayed calls, and recurring events.
• Cinematic (17): Cutscenes, camera sequences, and Timeline playables.
• Evaluator (18): Condition checks, validation, and rule processing.
• Data (19): ScriptableObject data, configuration, and remote content.
• Game (20): Game speed, pause and resume, and session flow.
• Update (21): Registration of updateable objects for per-frame ticks.
• Scene (22): Scene loading and transition commands.
• Companion (23): Companion features and support modules.