Home Reference Source
import {AtlasSprite} from 'shapez.io/js/core/sprites.js'
public class | source

AtlasSprite

Extends:

BaseSprite → AtlasSprite

Constructor Summary

Public Constructor
public

constructor(spriteName: string)

Member Summary

Public Members
public
public

Method Summary

Public Methods
public

draw(context: *, x: *, y: *, w: *, h: *)

Draws the sprite onto a regular context using no contexts

public

drawCached(parameters: DrawParameters, x: number, y: number, w: number, h: number, clipping: boolean=)

Draws the sprite

public

drawCachedCentered(parameters: DrawParameters, x: number, y: number, size: number, clipping: boolean=)

public

drawCachedWithClipRect(parameters: DrawParameters, x: number, y: number, w: number, h: number, clipRect: Rectangle=)

Draws a subset of the sprite.

public

drawCentered(context: CanvasRenderingContext2D, x: number, y: number, size: number)

public

Returns the html to render as icon

public
public

renderToHTMLElement(element: HTMLElement, w: number, h: number)

Renders into an html element

Inherited Summary

From class BaseSprite
public

draw(context: CanvasRenderingContext2D, x: number, y: number, w: number, h: number)

Draws the sprite

public

getRawTexture(): HTMLImageElement | HTMLCanvasElement

Returns the raw handle

Public Constructors

public constructor(spriteName: string) source

Params:

NameTypeAttributeDescription
spriteName string

Public Members

public linksByResolution: Object<string, SpriteAtlasLink> source

public spriteName: * source

Public Methods

public draw(context: *, x: *, y: *, w: *, h: *) source

Draws the sprite onto a regular context using no contexts

Override:

BaseSprite#draw

Params:

NameTypeAttributeDescription
context *
x *
y *
w *
h *

See:

public drawCached(parameters: DrawParameters, x: number, y: number, w: number, h: number, clipping: boolean=) source

Draws the sprite

Params:

NameTypeAttributeDescription
parameters DrawParameters
x number
y number
w number
h number
clipping boolean=

Whether to perform culling

public drawCachedCentered(parameters: DrawParameters, x: number, y: number, size: number, clipping: boolean=) source

Params:

NameTypeAttributeDescription
parameters DrawParameters
x number
y number
size number
clipping boolean=

public drawCachedWithClipRect(parameters: DrawParameters, x: number, y: number, w: number, h: number, clipRect: Rectangle=) source

Draws a subset of the sprite. Does NO culling

Params:

NameTypeAttributeDescription
parameters DrawParameters
x number
y number
w number
h number
clipRect Rectangle=

The rectangle in local space (0 ... 1) to draw of the image

public drawCentered(context: CanvasRenderingContext2D, x: number, y: number, size: number) source

Params:

NameTypeAttributeDescription
context CanvasRenderingContext2D
x number
y number
size number

public getAsHTML(w: number, h: number): string source

Returns the html to render as icon

Params:

NameTypeAttributeDescription
w number
h number

Return:

string

public getRawTexture(): * source

Returns the raw handle

Override:

BaseSprite#getRawTexture

Return:

*

public renderToHTMLElement(element: HTMLElement, w: number, h: number) source

Renders into an html element

Params:

NameTypeAttributeDescription
element HTMLElement
w number
h number