Class ResourceManager

This is mostly an internal class. TypeSprite normaly takes care of all calles you find here.

ResourceManager takes care of all resources. It's tightly coupled with World and WorldManager class and ensures that assets are loaded and available if needed.

It's possible to have multiple resource of the same file.

// Usage:

const res = new ResourceManager();
res.addLoader(new MyLoader1());
res.addLoader(new MyLoader2());

res.request('myOwner', ['loader1:path/to/file', 'loader2:path/to/file']).then(numFailed => {...});

See

ResourceLoader
SubResourceLoader

Hierarchy

ResourceManager

Constructors

constructor

new ResourceManager(maxParallel?: number): ResourceManager
Parameters
- maxParallel: number = 8
Returns ResourceManager
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:37

Properties

`Private` loaders

loaders: Map<string, ResourceLoader> = ...

`Private` `Readonly` maxParallel

maxParallel: number = 8

`Private` pendingHeartbeat

pendingHeartbeat: any = null

`Private` pendingRequests

pendingRequests: RequestSet[] = []

`Private` requireChain

requireChain: RequireChain = ...

`Private` rootPath

rootPath: string = ""

Methods

addLoader

addLoader(resourceLoader: ResourceLoader): void
Parameters
- resourceLoader: ResourceLoader
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:73

`Private` checkPendingRequests

checkPendingRequests(): void
A request is fulfilled if all resources are either: error or ready.

Here we perform the callbacks when this condition changed.

Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:312

`Private` checkWaitingResources

checkWaitingResources(): void
Checks if a waiting resources can start to load

Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:216

collectResourceInfo

collectResourceInfo(): Record<string, ResourceInfo>
Use this to understand the state of all resources.

Pretty GC heavy. Mostly meant for debugging/optimization.

Returns Record<string, ResourceInfo>
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:346

copyOwnership

copyOwnership(ownerId: string, additionalOwner: string): void
All resources that are owned by ownerId also become owned by additionalOwner.

It's meant for retaining resources during world-restarts.
Parameters
- ownerId: string
- additionalOwner: string
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:128

getActualUrl

getActualUrl(path: string): string
Parameters
- path: string
Returns string
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:378

getLoaderByUrl

getLoaderByUrl(resUrl: string): ResourceLoader[]
Parameters
- resUrl: string
Returns ResourceLoader[]
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:56

getResource

getResource<T>(resUrl: string): T
Type Parameters
- T
Parameters
- resUrl: string
Returns T
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:42

getResourceError

getResourceError(resUrl: string): string
Parameters
- resUrl: string
Returns string
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:49

`Private` internSetResourceState

internSetResourceState(resUrl: string, resState: ResourceState, err?: string): void
Parameters
- resUrl: string
- resState: ResourceState
- err: string = null
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:98

parseResUrl

parseResUrl(resUrl: string): [] | [string, string]
A TypeSprite resUrl looks like this:
```
texture:assets/spirtes1.png` => loaderId: "texture", path: "assets/sprites1.png"
image:assets/spirtes1.png`   => loaderId: "image",   path: "assets/sprites1.png"
```
Parameters
- resUrl: string
Returns [] | [string, string]
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:296

release

release(ownerId: string): void
All resources attached to that ownerId will be released.
Parameters
- ownerId: string
  
  resUrl
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:118

releaseAll

releaseAll(): void
Frees all resources.

Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:135

request

request(ownerId: string, resUrls: string[]): Promise<number>
Same as requireDirect but as a Promise (ease usage of await/async)
Parameters
- ownerId: string
- resUrls: string[]
Returns Promise<number>
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:144

requestDirect

requestDirect(ownerId: string, resUrls: string[], cb: ((number: any) => void)): void
Requires all resources. If they are not yet loaded they'll be put into the loading queue.

The callback return is called in sync if all resources are were loaded (or failed).

The ownerId is the world, resource, etc. that holds the resource.
Parameters
- ownerId: string
- resUrls: string[]
- cb: ((number: any) => void)
  - - (number: any): void
    - Parameters
      
      number: any
      
      Returns void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:159

`Private` scheduleHeartbeat

scheduleHeartbeat(): void
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:204

setRootPath

setRootPath(rootPath: string): void
If set, will be prefixed for every actual-path access. This is useful when running the game on a subfolder path.

See
SubResourceLoader
Parameters
- rootPath: string
Returns void
- Defined in docs/dev/projekte/2023/typespritejs/repos/typesprite-engine/src/entity/ResourceManager.ts:374

Class ResourceManager

See

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

maxParallel: number = 8

Returns ResourceManager

Properties

Private loaders

Private Readonly maxParallel

Private pendingHeartbeat

Private pendingRequests

Private requireChain

Private rootPath

Methods

addLoader

Parameters

resourceLoader: ResourceLoader

Returns void

Private checkPendingRequests

Returns void

Private checkWaitingResources

Returns void

collectResourceInfo

Returns Record<string, ResourceInfo>

copyOwnership

Parameters

ownerId: string

additionalOwner: string

Returns void

getActualUrl

Parameters

path: string

Returns string

getLoaderByUrl

Parameters

resUrl: string

Returns ResourceLoader[]

getResource

Type Parameters

T

Parameters

resUrl: string

Returns T

getResourceError

Parameters

resUrl: string

Returns string

getResourceState

Parameters

resUrl: string

Returns ResourceState

Private heartbeat

Returns void

Private internRelease

Parameters

res: Resource

Returns void

Private internSetResourceState

Parameters

resUrl: string

resState: ResourceState

err: string = null

Returns void

parseResUrl

Parameters

resUrl: string

Returns [] | [string, string]

release

Parameters

ownerId: string

Returns void

releaseAll

Returns void

request

`Private` loaders

`Private` `Readonly` maxParallel

`Private` pendingHeartbeat

`Private` pendingRequests

`Private` requireChain

`Private` rootPath

`Private` checkPendingRequests

`Private` checkWaitingResources

`Private` heartbeat

`Private` internRelease

`Private` internSetResourceState

`Private` scheduleHeartbeat