Documentation / @debuffjp/assets / Assets
Class: Assets
Defined in: ../debuff/packages/assets/src/index.ts:49
Constructors
Constructor
new Assets(
manifest,base?):Assets
Defined in: ../debuff/packages/assets/src/index.ts:55
Parameters
manifest
base?
string = ""
Returns
Assets
Properties
manifest
readonlymanifest:AssetManifest
Defined in: ../debuff/packages/assets/src/index.ts:56
Methods
audio()
audio(
id):ArrayBuffer
Defined in: ../debuff/packages/assets/src/index.ts:123
Raw encoded audio; decode with @debuffjp/audio.
Parameters
id
string
Returns
ArrayBuffer
entry()
entry(
id):AssetEntry
Defined in: ../debuff/packages/assets/src/index.ts:139
Parameters
id
string
Returns
fetch()
fetch(
id):Promise<unknown>
Defined in: ../debuff/packages/assets/src/index.ts:146
Fetch a single asset (lazy loading). Concurrent calls share one request.
Parameters
id
string
Returns
Promise<unknown>
frame()
frame(
id):ImageFrame
Defined in: ../debuff/packages/assets/src/index.ts:95
The image region for an asset: { image, x, y, w, h }, ready for draw.sprite. Works whether or not it was atlased.
Parameters
id
string
Returns
frames()
frames(
id):ImageFrame[]
Defined in: ../debuff/packages/assets/src/index.ts:105
Frames of a sprite sheet declared with the name@WxH.png convention, row-major, ready for new Sprite({ frames }). Works whether or not the sheet was atlased.
Parameters
id
string
Returns
has()
has(
id):boolean
Defined in: ../debuff/packages/assets/src/index.ts:76
Parameters
id
string
Returns
boolean
image()
image(
id):HTMLImageElement
Defined in: ../debuff/packages/assets/src/index.ts:84
The whole image element. For images packed into an atlas this would be the atlas, so it throws; use frame(id) (works for both) with draw.sprite.
Parameters
id
string
Returns
HTMLImageElement
json()
json<
T>(id):T
Defined in: ../debuff/packages/assets/src/index.ts:118
Type Parameters
T
T = unknown
Parameters
id
string
Returns
T
load()
load(
groups?,onProgress?):Promise<void>
Defined in: ../debuff/packages/assets/src/index.ts:61
Load every asset in the given groups (default: "default").
Parameters
groups?
string | readonly string[] = "default"
onProgress?
(p) => void
Returns
Promise<void>
text()
text(
id):string
Defined in: ../debuff/packages/assets/src/index.ts:127
Parameters
id
string
Returns
string
url()
url(
id):string
Defined in: ../debuff/packages/assets/src/index.ts:135
The asset's URL without downloading it, for streaming: audio.stream(assets.url("music/theme")). Keep long tracks in a group you never load() (e.g. assets/music/) so they aren't fetched twice.
Parameters
id
string
Returns
string