class MAGES::Hub¶

Overview¶

The primary Component of MAGES NXT. Manages all core MAGES interfaces. More…

class Hub: public MonoBehaviour
{
public:
    // fields

    static const string StubBundlePath = "Packages/com.oramavr.mages.nxt.core/Hub/Runtime/Bundles/StubBundle.asset";

    // properties

    Hub Instance;
    Bundle BaseBundle;
    Bundle RuntimeBundle;
    bool AutoStart;

    // methods

    static Bundle CreateStubBundle();
    static Bundle FindCurrentBundle();
    static LicenseLimits GetLicenseLimits();
    T Get< T >();
    void StartSystems();
};

Detailed Documentation¶

The primary Component of MAGES NXT. Manages all core MAGES interfaces.

Fields¶

static const string StubBundlePath = "Packages/com.oramavr.mages.nxt.core/Hub/Runtime/Bundles/StubBundle.asset"

The path to the stub bundle asset.

Properties¶

Hub Instance

Gets the instanced Hub (Runtime Only).

Bundle BaseBundle

Gets or sets the base bundle from which the runtime bundle is constructed.

Bundle RuntimeBundle

Gets the runtime bundle.

bool AutoStart

Gets or sets a value indicating whether the Hub should automatically start (useful when spawned manually).

Methods¶

static Bundle CreateStubBundle()

Create a stub bundle.

Returns:

Bundle.

static Bundle FindCurrentBundle()

Find the current bundle. Can be called both in edit-mode and play-mode.

Returns:

The current bundle, if available.

static LicenseLimits GetLicenseLimits()

Gets the license limits.

Use wisely (slow), performs file access.

Returns:

The license limits.

T Get< T >()

Get a module.

Parameters:

Returns:

The module instance.

void StartSystems()

Start all systems.