Class TeeSkin6

Class used to render TW 0.6 skins (ddnet).

Index

Constructors

Properties

opts clearCache setTTL

Methods

getSkinFileBuf render

Constructors

constructor

new TeeSkin6(options?: TeeSkin6Options): TeeSkin6
Construct a new TeeSkin6 instance.
Parameters
- options: TeeSkin6Options = {}
Returns TeeSkin6
- Defined in src/classes/skins/TeeSkin6.ts:79

Properties

`Readonly`opts

opts: Required<
{ skinDbUrl?: string; skinResource?: string
| Buffer<ArrayBufferLike> },
>

Options for this instance.

`Static`clearCache

clearCache: () => Promise<void> = ...

Clears the TeeSkin6.cache.

Type declaration

- (): Promise<void>
- Clears the CacheManager.store.
  
  Returns Promise<void>

`Static`setTTL

setTTL: (ttlMS?: number) => void = ...

Sets the TTL (Time-To-Live) for objects in cache.

Type declaration

- (ttlMS?: number): void
- Sets the CacheManager.ttl.
  Parameters
  - OptionalttlMS: number
    If provided, sets the CacheManager.ttl to this value, otherwise uses the default value.
  Returns void

Methods

getSkinFileBuf

getSkinFileBuf(force?: boolean): Promise<Buffer<ArrayBufferLike>>
Get the skin file buffer.
Parameters
- force: boolean = false
  Wether to bypass the cache when fetching.
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/classes/skins/TeeSkin6.ts:93

render

render(options?: TeeSkinRenderOptions): Promise<Buffer<ArrayBufferLike>>
Renders a tee image.
Parameters
- options: TeeSkinRenderOptions = {}
  Render options to use.
Returns Promise<Buffer<ArrayBufferLike>>
- Defined in src/classes/skins/TeeSkin6.ts:153