@nanoforge-dev/common

Enumerations

DefaultLibrariesEnum

Defined in: packages/common/src/library/manager/managers/library.manager.ts:19

Enumeration Members

ASSET_MANAGER

ASSET_MANAGER: 0;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:20

COMPONENT_SYSTEM

COMPONENT_SYSTEM: 1;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:21

GRAPHICS

GRAPHICS: 2;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:22

INPUT

INPUT: 3;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:23

MUSIC

MUSIC: 6;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:26

NETWORK

NETWORK: 4;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:24

SOUND

SOUND: 5;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:25

---

LibraryStatusEnum

Defined in: packages/common/src/context/contexts/library.context.ts:1

Enumeration Members

CLEAR

CLEAR: "CLEAR";

Defined in: packages/common/src/context/contexts/library.context.ts:4

LOADED

LOADED: "LOADED";

Defined in: packages/common/src/context/contexts/library.context.ts:3

UNLOADED

UNLOADED: "UNLOADED";

Defined in: packages/common/src/context/contexts/library.context.ts:2

Classes

abstract ApplicationContext

Defined in: packages/common/src/context/contexts/application.context.ts:1

Constructors

Constructor

new ApplicationContext(): ApplicationContext;

Returns

ApplicationContext

Properties

_delta

protected _delta: number;

Defined in: packages/common/src/context/contexts/application.context.ts:3

Accessors

delta

Get Signature

get delta(): number;

Defined in: packages/common/src/context/contexts/application.context.ts:9

Returns

number

isRunning

Get Signature

get isRunning(): boolean;

Defined in: packages/common/src/context/contexts/application.context.ts:5

Returns

boolean

Methods

muteSoundLibraries()

abstract muteSoundLibraries(): void;

Defined in: packages/common/src/context/contexts/application.context.ts:17

Returns

void

setIsRunning()

setIsRunning(value): void;

Defined in: packages/common/src/context/contexts/application.context.ts:13

Parameters

value

boolean

Returns

void

---

abstract BaseAssetManagerLibrary

Defined in: packages/common/src/library/libraries/abstracts/asset-manager.library.abstract.ts:6

Extends

• Library

Implements

• IAssetManagerLibrary

Constructors

Constructor

new BaseAssetManagerLibrary(rawOptions?): BaseAssetManagerLibrary;

Defined in: packages/common/src/library/libraries/library.ts:10

Parameters

rawOptions?

Partial<ILibraryOptions>

Returns

BaseAssetManagerLibrary

Inherited from

Library.constructor

Properties

_relationship

protected _relationship: RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:8

Inherited from

Library._relationship

Accessors

__name

Get Signature

get abstract __name(): string;

Defined in: packages/common/src/library/libraries/library.ts:27

Returns

string

Implementation of

IAssetManagerLibrary.__name

Inherited from

Library.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:23

Returns

RelationshipHandler

Implementation of

IAssetManagerLibrary.__relationship

Inherited from

Library.__relationship

Methods

__clear()

__clear(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:33

Parameters

_context

ClearContext

Returns

Promise<void>

Implementation of

IAssetManagerLibrary.__clear

Inherited from

Library.__clear

__init()

abstract __init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/abstracts/asset-manager.library.abstract.ts:7

Parameters

context

InitContext

Returns

Promise<void>

Implementation of

IAssetManagerLibrary.__init

Overrides

Library.__init

getAsset()

abstract getAsset(path): NfFile;

Defined in: packages/common/src/library/libraries/abstracts/asset-manager.library.abstract.ts:9

Parameters

path

string

Returns

NfFile

Implementation of

IAssetManagerLibrary.getAsset

throwNotInitializedError()

protected throwNotInitializedError(): never;

Defined in: packages/common/src/library/libraries/library.ts:35

Returns

never

Inherited from

Library.throwNotInitializedError

---

abstract BaseComponentSystemLibrary

Defined in: packages/common/src/library/libraries/abstracts/component-system.library.abstract.ts:5

Extends

• Library

Implements

• IComponentSystemLibrary

Constructors

Constructor

new BaseComponentSystemLibrary(rawOptions?): BaseComponentSystemLibrary;

Defined in: packages/common/src/library/libraries/library.ts:10

Parameters

rawOptions?

Partial<ILibraryOptions>

Returns

BaseComponentSystemLibrary

Inherited from

Library.constructor

Properties

_relationship

protected _relationship: RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:8

Inherited from

Library._relationship

Accessors

__name

Get Signature

get abstract __name(): string;

Defined in: packages/common/src/library/libraries/library.ts:27

Returns

string

Implementation of

IComponentSystemLibrary.__name

Inherited from

Library.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:23

Returns

RelationshipHandler

Implementation of

IComponentSystemLibrary.__relationship

Inherited from

Library.__relationship

Methods

__clear()

__clear(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:33

Parameters

_context

ClearContext

Returns

Promise<void>

Implementation of

IComponentSystemLibrary.__clear

Inherited from

Library.__clear

__init()

__init(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:30

Parameters

_context

InitContext

Returns

Promise<void>

Implementation of

IComponentSystemLibrary.__init

Inherited from

Library.__init

__run()

abstract __run(context): Promise<void>;

Defined in: packages/common/src/library/libraries/abstracts/component-system.library.abstract.ts:9

Parameters

context

Context

Returns

Promise<void>

Implementation of

IComponentSystemLibrary.__run

throwNotInitializedError()

protected throwNotInitializedError(): never;

Defined in: packages/common/src/library/libraries/library.ts:35

Returns

never

Inherited from

Library.throwNotInitializedError

---

abstract BaseGraphicsLibrary

Defined in: packages/common/src/library/libraries/abstracts/graphics.library.abstract.ts:5

Extends

• Library

Implements

• IGraphicsLibrary

Constructors

Constructor

new BaseGraphicsLibrary(rawOptions?): BaseGraphicsLibrary;

Defined in: packages/common/src/library/libraries/library.ts:10

Parameters

rawOptions?

Partial<ILibraryOptions>

Returns

BaseGraphicsLibrary

Inherited from

Library.constructor

Properties

_relationship

protected _relationship: RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:8

Inherited from

Library._relationship

Accessors

__name

Get Signature

get abstract __name(): string;

Defined in: packages/common/src/library/libraries/library.ts:27

Returns

string

Implementation of

IGraphicsLibrary.__name

Inherited from

Library.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:23

Returns

RelationshipHandler

Implementation of

IGraphicsLibrary.__relationship

Inherited from

Library.__relationship

Methods

__clear()

__clear(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:33

Parameters

_context

ClearContext

Returns

Promise<void>

Implementation of

IGraphicsLibrary.__clear

Inherited from

Library.__clear

__init()

__init(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:30

Parameters

_context

InitContext

Returns

Promise<void>

Implementation of

IGraphicsLibrary.__init

Inherited from

Library.__init

__run()

abstract __run(context): Promise<void>;

Defined in: packages/common/src/library/libraries/abstracts/graphics.library.abstract.ts:6

Parameters

context

Context

Returns

Promise<void>

Implementation of

IGraphicsLibrary.__run

throwNotInitializedError()

protected throwNotInitializedError(): never;

Defined in: packages/common/src/library/libraries/library.ts:35

Returns

never

Inherited from

Library.throwNotInitializedError

---

abstract BaseInputLibrary

Defined in: packages/common/src/library/libraries/abstracts/input.library.abstract.ts:4

Extends

• Library

Implements

• IInputLibrary

Constructors

Constructor

new BaseInputLibrary(rawOptions?): BaseInputLibrary;

Defined in: packages/common/src/library/libraries/library.ts:10

Parameters

rawOptions?

Partial<ILibraryOptions>

Returns

BaseInputLibrary

Inherited from

Library.constructor

Properties

_relationship

protected _relationship: RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:8

Inherited from

Library._relationship

Accessors

__name

Get Signature

get abstract __name(): string;

Defined in: packages/common/src/library/libraries/library.ts:27

Returns

string

Implementation of

IInputLibrary.__name

Inherited from

Library.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:23

Returns

RelationshipHandler

Implementation of

IInputLibrary.__relationship

Inherited from

Library.__relationship

Methods

__clear()

__clear(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:33

Parameters

_context

ClearContext

Returns

Promise<void>

Implementation of

IInputLibrary.__clear

Inherited from

Library.__clear

__init()

__init(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:30

Parameters

_context

InitContext

Returns

Promise<void>

Implementation of

IInputLibrary.__init

Inherited from

Library.__init

throwNotInitializedError()

protected throwNotInitializedError(): never;

Defined in: packages/common/src/library/libraries/library.ts:35

Returns

never

Inherited from

Library.throwNotInitializedError

---

abstract BaseMusicLibrary

Defined in: packages/common/src/library/libraries/abstracts/music.library.abstract.ts:5

Extends

• Library

Implements

• IMusicLibrary

Constructors

Constructor

new BaseMusicLibrary(rawOptions?): BaseMusicLibrary;

Defined in: packages/common/src/library/libraries/library.ts:10

Parameters

rawOptions?

Partial<ILibraryOptions>

Returns

BaseMusicLibrary

Inherited from

Library.constructor

Properties

_relationship

protected _relationship: RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:8

Inherited from

Library._relationship

Accessors

__name

Get Signature

get abstract __name(): string;

Defined in: packages/common/src/library/libraries/library.ts:27

Returns

string

Implementation of

IMusicLibrary.__name

Inherited from

Library.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:23

Returns

RelationshipHandler

Implementation of

IMusicLibrary.__relationship

Inherited from

Library.__relationship

Methods

__clear()

__clear(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:33

Parameters

_context

ClearContext

Returns

Promise<void>

Implementation of

IMusicLibrary.__clear

Inherited from

Library.__clear

__init()

abstract __init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/abstracts/music.library.abstract.ts:6

Parameters

context

InitContext

Returns

Promise<void>

Implementation of

IMusicLibrary.__init

Overrides

Library.__init

mute()

abstract mute(): void;

Defined in: packages/common/src/library/libraries/abstracts/music.library.abstract.ts:13

mutes or unmutes the sound.

Returns

void

Implementation of

IMusicLibrary.mute

play()

abstract play(sound): void;

Defined in: packages/common/src/library/libraries/abstracts/music.library.abstract.ts:8

Parameters

sound

string

Returns

void

throwNotInitializedError()

protected throwNotInitializedError(): never;

Defined in: packages/common/src/library/libraries/library.ts:35

Returns

never

Inherited from

Library.throwNotInitializedError

---

abstract BaseNetworkLibrary

Defined in: packages/common/src/library/libraries/abstracts/network.library.abstract.ts:4

Extends

• Library

Implements

• INetworkLibrary

Constructors

Constructor

new BaseNetworkLibrary(rawOptions?): BaseNetworkLibrary;

Defined in: packages/common/src/library/libraries/library.ts:10

Parameters

rawOptions?

Partial<ILibraryOptions>

Returns

BaseNetworkLibrary

Inherited from

Library.constructor

Properties

_relationship

protected _relationship: RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:8

Inherited from

Library._relationship

Accessors

__name

Get Signature

get abstract __name(): string;

Defined in: packages/common/src/library/libraries/library.ts:27

Returns

string

Implementation of

INetworkLibrary.__name

Inherited from

Library.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:23

Returns

RelationshipHandler

Implementation of

INetworkLibrary.__relationship

Inherited from

Library.__relationship

Methods

__clear()

__clear(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:33

Parameters

_context

ClearContext

Returns

Promise<void>

Implementation of

INetworkLibrary.__clear

Inherited from

Library.__clear

__init()

__init(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:30

Parameters

_context

InitContext

Returns

Promise<void>

Implementation of

INetworkLibrary.__init

Inherited from

Library.__init

throwNotInitializedError()

protected throwNotInitializedError(): never;

Defined in: packages/common/src/library/libraries/library.ts:35

Returns

never

Inherited from

Library.throwNotInitializedError

---

abstract BaseSoundLibrary

Defined in: packages/common/src/library/libraries/abstracts/sound.library.abstract.ts:5

Extends

• Library

Implements

• ISoundLibrary

Constructors

Constructor

new BaseSoundLibrary(rawOptions?): BaseSoundLibrary;

Defined in: packages/common/src/library/libraries/library.ts:10

Parameters

rawOptions?

Partial<ILibraryOptions>

Returns

BaseSoundLibrary

Inherited from

Library.constructor

Properties

_relationship

protected _relationship: RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:8

Inherited from

Library._relationship

Accessors

__name

Get Signature

get abstract __name(): string;

Defined in: packages/common/src/library/libraries/library.ts:27

Returns

string

Implementation of

ISoundLibrary.__name

Inherited from

Library.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.ts:23

Returns

RelationshipHandler

Implementation of

ISoundLibrary.__relationship

Inherited from

Library.__relationship

Methods

__clear()

__clear(_context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.ts:33

Parameters

_context

ClearContext

Returns

Promise<void>

Implementation of

ISoundLibrary.__clear

Inherited from

Library.__clear

__init()

abstract __init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/abstracts/sound.library.abstract.ts:6

Parameters

context

InitContext

Returns

Promise<void>

Implementation of

ISoundLibrary.__init

Overrides

Library.__init

mute()

abstract mute(): void;

Defined in: packages/common/src/library/libraries/abstracts/sound.library.abstract.ts:13

mutes or unmutes the sound.

Returns

void

Implementation of

ISoundLibrary.mute

play()

abstract play(sound): void;

Defined in: packages/common/src/library/libraries/abstracts/sound.library.abstract.ts:8

Parameters

sound

string

Returns

void

throwNotInitializedError()

protected throwNotInitializedError(): never;

Defined in: packages/common/src/library/libraries/library.ts:35

Returns

never

Inherited from

Library.throwNotInitializedError

---

ClearContext

Defined in: packages/common/src/context/contexts/executions/clear.context.ts:3

Extends

• BaseContext

Constructors

Constructor

new ClearContext(applicationContext, libraryManager): ClearContext;

Defined in: packages/common/src/context/contexts/executions/base.context.ts:8

Parameters

applicationContext

ApplicationContext

libraryManager

LibraryManager

Returns

ClearContext

Inherited from

BaseContext.constructor

Accessors

application

Get Signature

get application(): ApplicationContext;

Defined in: packages/common/src/context/contexts/executions/base.context.ts:13

Returns

ApplicationContext

Inherited from

BaseContext.application

libraries

Get Signature

get libraries(): LibraryManager;

Defined in: packages/common/src/context/contexts/executions/base.context.ts:17

Returns

LibraryManager

Inherited from

BaseContext.libraries

---

ClientLibraryManager

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:13

Constructors

Constructor

new ClientLibraryManager(libraryManager): ClientLibraryManager;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:16

Parameters

libraryManager

LibraryManager

Returns

ClientLibraryManager

Methods

get()

get<T>(sym): T;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:20

Type Parameters

T

T extends ILibrary = ILibrary

Parameters

sym

symbol

Returns

T

getAssetManager()

getAssetManager<T>(): T;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:40

Type Parameters

T

T extends IAssetManagerLibrary = IAssetManagerLibrary

Returns

T

getComponentSystem()

getComponentSystem<T>(): T;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:24

Type Parameters

T

T extends IComponentSystemLibrary = IComponentSystemLibrary

Returns

T

getGraphics()

getGraphics<T>(): T;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:28

Type Parameters

T

T extends IGraphicsLibrary = IGraphicsLibrary

Returns

T

getInput()

getInput<T>(): T;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:36

Type Parameters

T

T extends IInputLibrary = IInputLibrary

Returns

T

getMusic()

getMusic<T>(): T;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:48

Type Parameters

T

T extends IMusicLibrary = IMusicLibrary

Returns

T

getNetwork()

getNetwork<T>(): T;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:32

Type Parameters

T

T extends INetworkLibrary = INetworkLibrary

Returns

T

getSound()

getSound<T>(): T;

Defined in: packages/common/src/library/manager/managers/client-library.manager.ts:44

Type Parameters

T

T extends ISoundLibrary = ISoundLibrary

Returns

T

---

Context

Defined in: packages/common/src/context/contexts/client.context.ts:4

Constructors

Constructor

new Context(applicationContext, libraryManager): Context;

Defined in: packages/common/src/context/contexts/client.context.ts:8

Parameters

applicationContext

ApplicationContext

libraryManager

ClientLibraryManager

Returns

Context

Accessors

app

Get Signature

get app(): ApplicationContext;

Defined in: packages/common/src/context/contexts/client.context.ts:13

Returns

ApplicationContext

libs

Get Signature

get libs(): ClientLibraryManager;

Defined in: packages/common/src/context/contexts/client.context.ts:17

Returns

ClientLibraryManager

---

ExecutionContext

Defined in: packages/common/src/context/contexts/executions/execution.context.ts:3

Extends

• BaseContext

Constructors

Constructor

new ExecutionContext(applicationContext, libraryManager): ExecutionContext;

Defined in: packages/common/src/context/contexts/executions/base.context.ts:8

Parameters

applicationContext

ApplicationContext

libraryManager

LibraryManager

Returns

ExecutionContext

Inherited from

BaseContext.constructor

Accessors

application

Get Signature

get application(): ApplicationContext;

Defined in: packages/common/src/context/contexts/executions/base.context.ts:13

Returns

ApplicationContext

Inherited from

BaseContext.application

libraries

Get Signature

get libraries(): LibraryManager;

Defined in: packages/common/src/context/contexts/executions/base.context.ts:17

Returns

LibraryManager

Inherited from

BaseContext.libraries

---

InitContext

Defined in: packages/common/src/context/contexts/executions/init.context.ts:6

Extends

• BaseContext

Constructors

Constructor

new InitContext(
   context, 
   libraryManager, 
   configRegistry, 
   options): InitContext;

Defined in: packages/common/src/context/contexts/executions/init.context.ts:11

Parameters

context

ApplicationContext

libraryManager

LibraryManager

configRegistry

IConfigRegistry

options

IRunOptions

Returns

InitContext

Overrides

BaseContext.constructor

Accessors

application

Get Signature

get application(): ApplicationContext;

Defined in: packages/common/src/context/contexts/executions/base.context.ts:13

Returns

ApplicationContext

Inherited from

BaseContext.application

canvas

Get Signature

get canvas(): HTMLCanvasElement | undefined;

Defined in: packages/common/src/context/contexts/executions/init.context.ts:24

Returns

HTMLCanvasElement | undefined

config

Get Signature

get config(): IConfigRegistry;

Defined in: packages/common/src/context/contexts/executions/init.context.ts:32

Returns

IConfigRegistry

files

Get Signature

get files(): Map<string, string>;

Defined in: packages/common/src/context/contexts/executions/init.context.ts:28

Returns

Map<string, string>

libraries

Get Signature

get libraries(): LibraryManager;

Defined in: packages/common/src/context/contexts/executions/base.context.ts:17

Returns

LibraryManager

Inherited from

BaseContext.libraries

---

LibraryContext

Defined in: packages/common/src/context/contexts/library.context.ts:7

Constructors

Constructor

new LibraryContext(): LibraryContext;

Returns

LibraryContext

Properties

_status

protected _status: LibraryStatusEnum = LibraryStatusEnum.UNLOADED;

Defined in: packages/common/src/context/contexts/library.context.ts:8

Accessors

status

Get Signature

get status(): LibraryStatusEnum;

Defined in: packages/common/src/context/contexts/library.context.ts:10

Returns

LibraryStatusEnum

---

LibraryHandle

Defined in: packages/common/src/library/manager/handle/library.handle.ts:4

Type Parameters

T

T extends ILibrary = ILibrary

Constructors

Constructor

new LibraryHandle<T>(
   sym, 
   library, 
defaultContext): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/handle/library.handle.ts:9

Parameters

sym

symbol

library

T

defaultContext

LibraryContext

Returns

LibraryHandle<T>

Accessors

context

Get Signature

get context(): LibraryContext;

Defined in: packages/common/src/library/manager/handle/library.handle.ts:23

Returns

LibraryContext

library

Get Signature

get library(): T;

Defined in: packages/common/src/library/manager/handle/library.handle.ts:19

Returns

T

symbol

Get Signature

get symbol(): symbol;

Defined in: packages/common/src/library/manager/handle/library.handle.ts:15

Returns

symbol

---

LibraryManager

Defined in: packages/common/src/library/manager/managers/library.manager.ts:38

Extends

• BaseLibraryManager

Constructors

Constructor

new LibraryManager(): LibraryManager;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:39

Returns

LibraryManager

Overrides

BaseLibraryManager.constructor

Properties

_libraries

protected _libraries: LibraryHandle<ILibrary>[] = [];

Defined in: packages/common/src/library/manager/managers/base-library.manager.ts:6

Inherited from

BaseLibraryManager._libraries

Methods

_get()

protected _get<T>(index, sym?): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/base-library.manager.ts:24

Type Parameters

T

T extends ILibrary = ILibrary

Parameters

index

number

sym?

symbol

Returns

LibraryHandle<T>

Inherited from

BaseLibraryManager._get

_set()

protected _set(
   index, 
   sym, 
   library, 
   context): void;

Defined in: packages/common/src/library/manager/managers/base-library.manager.ts:30

Parameters

index

number

sym

symbol

library

ILibrary

context

LibraryContext

Returns

void

Inherited from

BaseLibraryManager._set

_setIndex()

protected _setIndex(sym, index): void;

Defined in: packages/common/src/library/manager/managers/base-library.manager.ts:34

Parameters

sym

symbol

index

number

Returns

void

Inherited from

BaseLibraryManager._setIndex

get()

get<T>(sym): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/base-library.manager.ts:12

Type Parameters

T

T extends ILibrary = ILibrary

Parameters

sym

symbol

Returns

LibraryHandle<T>

Todo

Add error management

Inherited from

BaseLibraryManager.get

getAssetManager()

getAssetManager<T>(): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:65

Type Parameters

T

T extends IAssetManagerLibrary = IAssetManagerLibrary

Returns

LibraryHandle<T>

getComponentSystem()

getComponentSystem<T>(): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:47

Type Parameters

T

T extends IComponentSystemLibrary = IComponentSystemLibrary

Returns

LibraryHandle<T>

getGraphics()

getGraphics<T>(): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:53

Type Parameters

T

T extends IGraphicsLibrary = IGraphicsLibrary

Returns

LibraryHandle<T>

getInput()

getInput<T>(): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:61

Type Parameters

T

T extends IInputLibrary = IInputLibrary

Returns

LibraryHandle<T>

getMusic()

getMusic<T>(): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:75

Type Parameters

T

T extends IMusicLibrary = IMusicLibrary

Returns

LibraryHandle<T>

getNetwork()

getNetwork<T>(): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:57

Type Parameters

T

T extends INetworkLibrary = INetworkLibrary

Returns

LibraryHandle<T>

getSound()

getSound<T>(): LibraryHandle<T>;

Defined in: packages/common/src/library/manager/managers/library.manager.ts:71

Type Parameters

T

T extends ISoundLibrary = ISoundLibrary

Returns

LibraryHandle<T>

setNewLibrary()

protected setNewLibrary(
   sym, 
   library, 
   context): void;

Defined in: packages/common/src/library/manager/managers/base-library.manager.ts:18

Parameters

sym

symbol

library

ILibrary

context

LibraryContext

Returns

void

Inherited from

BaseLibraryManager.setNewLibrary

---

NfConfigException

Defined in: packages/common/src/exception/exceptions/config.exception.ts:3

Extends

• NfException

Constructors

Constructor

new NfConfigException(message, library?): NfConfigException;

Defined in: packages/common/src/exception/exceptions/config.exception.ts:8

Parameters

message

string

library?

string

Returns

NfConfigException

Overrides

NfException.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

NfException.cause

message

message: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

NfException.message

name

name: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

NfException.name

stack?

optional stack: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

NfException.stack

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

NfException.stackTraceLimit

Accessors

code

Get Signature

get code(): number;

Defined in: packages/common/src/exception/exceptions/config.exception.ts:4

Returns

number

Overrides

NfException.code

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

NfException.captureStackTrace

isError()

static isError(error): error is Error;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

NfException.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

NfException.prepareStackTrace

---

NfFetchException

Defined in: packages/common/src/exception/exceptions/fetch.exception.ts:3

Extends

• NfException

Constructors

Constructor

new NfFetchException(code, text): NfFetchException;

Defined in: packages/common/src/exception/exceptions/fetch.exception.ts:10

Parameters

code

number

text

string

Returns

NfFetchException

Overrides

NfException.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

NfException.cause

message

message: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

NfException.message

name

name: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

NfException.name

stack?

optional stack: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

NfException.stack

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

NfException.stackTraceLimit

Accessors

code

Get Signature

get code(): number;

Defined in: packages/common/src/exception/exceptions/fetch.exception.ts:6

Returns

number

Overrides

NfException.code

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

NfException.captureStackTrace

isError()

static isError(error): error is Error;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

NfException.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

NfException.prepareStackTrace

---

NfFile

Defined in: packages/common/src/common/file.ts:3

Constructors

Constructor

new NfFile(path): NfFile;

Defined in: packages/common/src/common/file.ts:6

Parameters

path

string

Returns

NfFile

Accessors

path

Get Signature

get path(): string;

Defined in: packages/common/src/common/file.ts:10

Returns

string

Methods

arrayBuffer()

arrayBuffer(): Promise<ArrayBuffer>;

Defined in: packages/common/src/common/file.ts:14

Returns

Promise<ArrayBuffer>

blob()

blob(): Promise<Blob>;

Defined in: packages/common/src/common/file.ts:19

Returns

Promise<Blob>

bytes()

bytes(): Promise<Uint8Array<ArrayBuffer>>;

Defined in: packages/common/src/common/file.ts:24

Returns

Promise<Uint8Array<ArrayBuffer>>

formData()

formData(): Promise<FormData>;

Defined in: packages/common/src/common/file.ts:29

Returns

Promise<FormData>

json()

json(): Promise<any>;

Defined in: packages/common/src/common/file.ts:34

Returns

Promise<any>

text()

text(): Promise<string>;

Defined in: packages/common/src/common/file.ts:39

Returns

Promise<string>

---

NfNotFound

Defined in: packages/common/src/exception/exceptions/not-found.exception.ts:3

Extends

• NfException

Constructors

Constructor

new NfNotFound(item, type?): NfNotFound;

Defined in: packages/common/src/exception/exceptions/not-found.exception.ts:8

Parameters

item

string

type?

string

Returns

NfNotFound

Overrides

NfException.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

NfException.cause

message

message: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

NfException.message

name

name: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

NfException.name

stack?

optional stack: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

NfException.stack

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

NfException.stackTraceLimit

Accessors

code

Get Signature

get code(): number;

Defined in: packages/common/src/exception/exceptions/not-found.exception.ts:4

Returns

number

Overrides

NfException.code

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

NfException.captureStackTrace

isError()

static isError(error): error is Error;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

NfException.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

NfException.prepareStackTrace

---

NfNotInitializedException

Defined in: packages/common/src/exception/exceptions/not-initialized.exception.ts:3

Extends

• NfException

Constructors

Constructor

new NfNotInitializedException(item, type?): NfNotInitializedException;

Defined in: packages/common/src/exception/exceptions/not-initialized.exception.ts:8

Parameters

item

string

type?

string

Returns

NfNotInitializedException

Overrides

NfException.constructor

Properties

cause?

optional cause: unknown;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.error.d.ts:26

Inherited from

NfException.cause

message

message: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1077

Inherited from

NfException.message

name

name: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1076

Inherited from

NfException.name

stack?

optional stack: string;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1078

Inherited from

NfException.stack

stackTraceLimit

static stackTraceLimit: number;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:68

The Error.stackTraceLimit property specifies the number of stack frames collected by a stack trace (whether generated by new Error().stack or Error.captureStackTrace(obj)).

The default value is 10 but may be set to any valid JavaScript number. Changes will affect any stack trace captured after the value has been changed.

If set to a non-number value, or set to a negative number, stack traces will not capture any frames.

Inherited from

NfException.stackTraceLimit

Accessors

code

Get Signature

get code(): number;

Defined in: packages/common/src/exception/exceptions/not-initialized.exception.ts:4

Returns

number

Overrides

NfException.code

Methods

captureStackTrace()

static captureStackTrace(targetObject, constructorOpt?): void;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:52

Creates a .stack property on targetObject, which when accessed returns a string representing the location in the code at which Error.captureStackTrace() was called.

const myObject = {};
Error.captureStackTrace(myObject);
myObject.stack;  // Similar to `new Error().stack`

The first line of the trace will be prefixed with ${myObject.name}: ${myObject.message}.

The optional constructorOpt argument accepts a function. If given, all frames above constructorOpt, including constructorOpt, will be omitted from the generated stack trace.

The constructorOpt argument is useful for hiding implementation details of error generation from the user. For instance:

function a() {
  b();
}

function b() {
  c();
}

function c() {
  // Create an error without stack trace to avoid calculating the stack trace twice.
  const { stackTraceLimit } = Error;
  Error.stackTraceLimit = 0;
  const error = new Error();
  Error.stackTraceLimit = stackTraceLimit;

  // Capture the stack trace above function b
  Error.captureStackTrace(error, b); // Neither function c, nor b is included in the stack trace
  throw error;
}

a();

Parameters

targetObject

object

constructorOpt?

Function

Returns

void

Inherited from

NfException.captureStackTrace

isError()

static isError(error): error is Error;

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.esnext.error.d.ts:23

Indicates whether the argument provided is a built-in Error instance or not.

Parameters

error

unknown

Returns

error is Error

Inherited from

NfException.isError

prepareStackTrace()

static prepareStackTrace(err, stackTraces): any;

Defined in: node_modules/.pnpm/@types+node@24.10.2/node_modules/@types/node/globals.d.ts:56

Parameters

err

Error

stackTraces

CallSite[]

Returns

any

See

https://v8.dev/docs/stack-trace-api#customizing-stack-traces

Inherited from

NfException.prepareStackTrace

Interfaces

IAssetManagerLibrary

Defined in: packages/common/src/library/libraries/interfaces/finals/asset-manager.library.type.ts:4

Extends

• IExposedLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

IExposedLibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

IExposedLibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__init

getAsset()

getAsset(path): NfFile;

Defined in: packages/common/src/library/libraries/interfaces/finals/asset-manager.library.type.ts:5

Parameters

path

string

Returns

NfFile

---

IComponentSystemLibrary

Defined in: packages/common/src/library/libraries/interfaces/finals/component-system.library.type.ts:4

Extends

• IExposedLibrary.IRunnerLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

IExposedLibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

IExposedLibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__init

__run()

__run(context): Promise<void>;

Defined in: packages/common/src/library/libraries/interfaces/bases/runner.library.type.ts:5

Parameters

context

Context

Returns

Promise<void>

Inherited from

IRunnerLibrary.__run

---

IConfigRegistry

Defined in: packages/common/src/library/config/interfaces/config-registry.type.ts:1

Methods

registerConfig()

registerConfig<T>(config): Promise<T>;

Defined in: packages/common/src/library/config/interfaces/config-registry.type.ts:2

Type Parameters

T

T extends object

Parameters

config

() => T

Returns

Promise<T>

---

IExposedLibrary

Defined in: packages/common/src/library/libraries/interfaces/bases/exposed.library.type.ts:3

Extends

• ILibrary

Extended by

• IAssetManagerLibrary

• IComponentSystemLibrary

• IGraphicsLibrary

• IInputLibrary

• ISoundLibrary

• INetworkLibrary

• IMusicLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

ILibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

ILibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

ILibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

ILibrary.__init

---

IGraphicsLibrary

Defined in: packages/common/src/library/libraries/interfaces/finals/graphics.library.type.ts:4

Extends

• IExposedLibrary.IRunnerLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

IExposedLibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

IExposedLibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__init

__run()

__run(context): Promise<void>;

Defined in: packages/common/src/library/libraries/interfaces/bases/runner.library.type.ts:5

Parameters

context

Context

Returns

Promise<void>

Inherited from

IRunnerLibrary.__run

---

IInputLibrary

Defined in: packages/common/src/library/libraries/interfaces/finals/input.library.type.ts:3

Extends

• IExposedLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

IExposedLibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

IExposedLibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__init

---

ILibrary

Defined in: packages/common/src/library/libraries/library.type.ts:4

Extended by

• IExposedLibrary

• IRunnerLibrary

• IMutableLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

---

IMusicLibrary

Defined in: packages/common/src/library/libraries/interfaces/finals/music.library.type.ts:4

Extends

• IExposedLibrary.IMutableLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

IExposedLibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

IExposedLibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__init

mute()

mute(): void;

Defined in: packages/common/src/library/libraries/interfaces/bases/mutable.library.type.ts:7

mutes or unmutes the sound.

Returns

void

Inherited from

IMutableLibrary.mute

---

IMutableLibrary

Defined in: packages/common/src/library/libraries/interfaces/bases/mutable.library.type.ts:3

Extends

• ILibrary

Extended by

• ISoundLibrary

• IMusicLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

ILibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

ILibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

ILibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

ILibrary.__init

mute()

mute(): void;

Defined in: packages/common/src/library/libraries/interfaces/bases/mutable.library.type.ts:7

mutes or unmutes the sound.

Returns

void

---

INetworkLibrary

Defined in: packages/common/src/library/libraries/interfaces/finals/network.library.type.ts:3

Extends

• IExposedLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

IExposedLibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

IExposedLibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__init

---

IRunClientOptions

Defined in: packages/common/src/options/types/options.type.ts:3

Properties

canvas

canvas: HTMLCanvasElement;

Defined in: packages/common/src/options/types/options.type.ts:4

files

files: Map<string, string>;

Defined in: packages/common/src/options/types/options.type.ts:5

---

IRunnerLibrary

Defined in: packages/common/src/library/libraries/interfaces/bases/runner.library.type.ts:4

Extends

• ILibrary

Extended by

• IComponentSystemLibrary

• IGraphicsLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

ILibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

ILibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

ILibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

ILibrary.__init

__run()

__run(context): Promise<void>;

Defined in: packages/common/src/library/libraries/interfaces/bases/runner.library.type.ts:5

Parameters

context

Context

Returns

Promise<void>

---

IRunServerOptions

Defined in: packages/common/src/options/types/options.type.ts:8

Properties

files

files: Map<string, string>;

Defined in: packages/common/src/options/types/options.type.ts:9

---

ISoundLibrary

Defined in: packages/common/src/library/libraries/interfaces/finals/sound.library.type.ts:4

Extends

• IExposedLibrary.IMutableLibrary

Accessors

__name

Get Signature

get __name(): string;

Defined in: packages/common/src/library/libraries/library.type.ts:5

Returns

string

Inherited from

IExposedLibrary.__name

__relationship

Get Signature

get __relationship(): RelationshipHandler;

Defined in: packages/common/src/library/libraries/library.type.ts:7

Returns

RelationshipHandler

Inherited from

IExposedLibrary.__relationship

Methods

__clear()

__clear(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:11

Parameters

context

ClearContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__clear

__init()

__init(context): Promise<void>;

Defined in: packages/common/src/library/libraries/library.type.ts:9

Parameters

context

InitContext

Returns

Promise<void>

Inherited from

IExposedLibrary.__init

mute()

mute(): void;

Defined in: packages/common/src/library/libraries/interfaces/bases/mutable.library.type.ts:7

mutes or unmutes the sound.

Returns

void

Inherited from

IMutableLibrary.mute

Type Aliases

IRunOptions

type IRunOptions = 
  | IRunClientOptions
  | IRunServerOptions;

Defined in: packages/common/src/options/types/options.type.ts:1

Variables

ASSET_MANAGER_LIBRARY

const ASSET_MANAGER_LIBRARY: typeof ASSET_MANAGER_LIBRARY;

Defined in: packages/common/src/library/libraries/consts/library-label.const.ts:6

---

COMPONENT_SYSTEM_LIBRARY

const COMPONENT_SYSTEM_LIBRARY: typeof COMPONENT_SYSTEM_LIBRARY;

Defined in: packages/common/src/library/libraries/consts/library-label.const.ts:1

---

GRAPHICS_LIBRARY

const GRAPHICS_LIBRARY: typeof GRAPHICS_LIBRARY;

Defined in: packages/common/src/library/libraries/consts/library-label.const.ts:2

---

INPUT_LIBRARY

const INPUT_LIBRARY: typeof INPUT_LIBRARY;

Defined in: packages/common/src/library/libraries/consts/library-label.const.ts:7

---

MUSIC_LIBRARY

const MUSIC_LIBRARY: typeof MUSIC_LIBRARY;

Defined in: packages/common/src/library/libraries/consts/library-label.const.ts:5

---

NETWORK_LIBRARY

const NETWORK_LIBRARY: typeof NETWORK_LIBRARY;

Defined in: packages/common/src/library/libraries/consts/library-label.const.ts:3

---

SOUND_LIBRARY

const SOUND_LIBRARY: typeof SOUND_LIBRARY;

Defined in: packages/common/src/library/libraries/consts/library-label.const.ts:4