Class CacheEntry

Hierarchy

CacheEntry

Index

Constructors

constructor

Methods

Constructors

constructor

new CacheEntry(cache: CacheMap, key: string, item: string): CacheEntry

- Defined in js/rmmv-ts/src/rpg_core.d.ts:4366
The resource class. Allows to be collected as a garbage if not use for some time or ticks

class

CacheEntry

constructor

Parameters
- cache: CacheMap
- key: string
- item: string
  
  Bitmap, HTML5Audio, WebAudio - whatever you want to store in the cache
Returns CacheEntry

Methods

allocate

allocate(): CacheEntry

- Defined in js/rmmv-ts/src/rpg_core.d.ts:4387
Allocates the resource

Returns CacheEntry

free

free(byTTL?: boolean): void

- Defined in js/rmmv-ts/src/rpg_core.d.ts:4381
frees the resource

Parameters
- Optional byTTL: boolean
Returns void

isStillAlive

isStillAlive(): boolean

- Defined in js/rmmv-ts/src/rpg_core.d.ts:4397
Returns boolean

setTimeToLive

setTimeToLive(ticks?: number, seconds?: number): CacheEntry

- Defined in js/rmmv-ts/src/rpg_core.d.ts:4395
Sets the time to live

Parameters
- Optional ticks: number
  
  TTL in ticks, 0 if not set
- Optional seconds: number
Returns CacheEntry

touch

touch(): void

- Defined in js/rmmv-ts/src/rpg_core.d.ts:4403
makes sure that resource wont freed by Time To Live if resource was already freed by TTL, put it in cache again

Returns void

Generated using TypeDoc