Home Reference Source
import System from 'oxygen-core/systems/System.js'
public class | source

System

System base class. Every Oxygen Core system extends this class.

Static Member Summary

Static Public Members
public static get
public static get

systems: *

Static Method Summary

Static Public Methods
public static

Dispose and remove all registered systems.

public static

get(typename: string): System | null

Returns system instance of given type name.

public static

register(typename: string, system: System): System

Register new system instance under given name.

public static

unregister(typename: string): System

Unregister given system.

Method Summary

Public Methods
public

Destructor (disposes all internal resources).

public

Event called after system gets registered.

public

Event called before system gets unregistered.

Static Public Members

public static get events: Events source

public static get systems: * source

Static Public Methods

public static dispose() source

Dispose and remove all registered systems.

Example:

System.dispose();

public static get(typename: string): System | null source

Returns system instance of given type name.

Params:

NameTypeAttributeDescription
typename string

System type name.

Return:

System | null

System instance if registered or null if not.

Example:

const system = System.get('MySystem');

public static register(typename: string, system: System): System source

Register new system instance under given name.

Params:

NameTypeAttributeDescription
typename string

System type name.

system System

System instance.

Return:

System

Registered system instance.

Example:

class MySystem extends System {}
System.register('MySystem', new MySystem());
const { MySystem } = System.systems;

public static unregister(typename: string): System source

Unregister given system.

Params:

NameTypeAttributeDescription
typename string

System type name

Return:

System

Unregistered system instance.

Example:

System.unregister('MySystem');

Public Methods

public dispose() source

Destructor (disposes all internal resources).

public onRegister() source

Event called after system gets registered.

public onUnregister() source

Event called before system gets unregistered.