ecspresso
    Preparing search index...

    Interface Plugin<Cfg, Requires, Labels, Groups, AssetGroupNames, ReactiveQueryNames>

    Plugin interface for ECSpresso. A plugin is a plain object with an install function that configures a world directly, plus phantom properties for compile-time type extraction.

    interface Plugin<
        Cfg extends WorldConfig = EmptyConfig,
        Requires extends WorldConfig = EmptyConfig,
        Labels extends string = never,
        Groups extends string = never,
        AssetGroupNames extends string = never,
        ReactiveQueryNames extends string = never,
    > {
        _assetGroupNames?: AssetGroupNames;
        _cfg?: Cfg;
        _groups?: Groups;
        _labels?: Labels;
        _reactiveQueryNames?: ReactiveQueryNames;
        _requires?: Requires;
        id: string;
        install: (
            world: default<MergeConfigs<Cfg, Requires>>,
            onCleanup: PluginCleanupRegistrar,
        ) => void;
        systemDefaults?: SystemDefaults<MergeConfigs<Cfg, Requires>>;
    }

    Type Parameters

    • Cfg extends WorldConfig = EmptyConfig

      The WorldConfig this plugin provides (components, events, resources, etc.)

    • Requires extends WorldConfig = EmptyConfig

      The WorldConfig this plugin requires from other plugins

    • Labels extends string = never
    • Groups extends string = never
    • AssetGroupNames extends string = never
    • ReactiveQueryNames extends string = never
    Index

    Properties

    _assetGroupNames? _cfg? _groups? _labels? _reactiveQueryNames? _requires? id install systemDefaults?

    Properties

    Optional Readonly_assetGroupNames

    _assetGroupNames?: AssetGroupNames

    Optional Readonly_cfg

    _cfg?: Cfg

    Optional Readonly_groups

    _groups?: Groups

    Optional Readonly_labels

    _labels?: Labels

    Optional Readonly_reactiveQueryNames

    _reactiveQueryNames?: ReactiveQueryNames

    Optional Readonly_requires

    _requires?: Requires
    id: string
    install: (
        world: default<MergeConfigs<Cfg, Requires>>,
        onCleanup: PluginCleanupRegistrar,
    ) => void
    systemDefaults?: SystemDefaults<MergeConfigs<Cfg, Requires>>

    Default system configuration applied to every world.addSystem(...) call made inside the plugin's install function. Explicit per-system calls override. Set via PluginBuilder.setSystemDefaults(...).

    Settings

    Member Visibility

    On This Page

    Properties