Home Reference Source
import {ShapeItem} from 'shapez.io/js/game/items/shape_item.js'
public class | source

ShapeItem

Extends:

BasicSerializableObjectBaseItem → ShapeItem

Static Method Summary

Static Public Methods
public static
public static

getSchema(): *

Constructor Summary

Public Constructor
public

Member Summary

Public Members
public

Method Summary

Public Methods
public

deserialize(data: *)

public

drawFullSizeOnCanvas(context: CanvasRenderingContext2D, size: number)

Draws the item to a canvas

public

drawItemCenteredImpl(x: number, y: number, parameters: DrawParameters, diameter: number=)

public

equalsImpl(other: BaseItem): *

public
public
public

getItemType(): "shape"

public

serialize(): *

Inherited Summary

From class BasicSerializableObject
public static
public static

getId()

public static

Should return the serialization schema

public static

verify(data: *): string | void

public

deserialize(data: any, root: import("./savegame_serializer").GameRoot): string | void

public
From class BaseItem
public static
public static
public

drawFullSizeOnCanvas(context: CanvasRenderingContext2D, size: number)

Draws the item to a canvas

public

drawItemCenteredClipped(x: number, y: number, parameters: DrawParameters, diameter: number=)

Draws the item at the given position

public

drawItemCenteredImpl(x: number, y: number, parameters: DrawParameters, diameter: number=)

INTERNAL

public

Returns if the item equals the other itme

public abstract

Override for custom comparison

public

Returns a string id of the item

public
public

getItemType(): ItemType

Static Public Methods

public static getId(): string source

Override:

BaseItem#getId

Return:

string

public static getSchema(): * source

Should return the serialization schema

Override:

BaseItem#getSchema

Return:

*

Public Constructors

public constructor(definition: ShapeDefinition) source

Fixes typeof DerivedComponent is not assignable to typeof Component, compiled out in non-dev builds

Override:

BaseItem#constructor

Params:

NameTypeAttributeDescription
definition ShapeDefinition

Public Members

public definition: * source

Public Methods

public deserialize(data: *) source

Override:

BasicSerializableObject#deserialize

Params:

NameTypeAttributeDescription
data *

public drawFullSizeOnCanvas(context: CanvasRenderingContext2D, size: number) source

Draws the item to a canvas

Override:

BaseItem#drawFullSizeOnCanvas

Params:

NameTypeAttributeDescription
context CanvasRenderingContext2D
size number

public drawItemCenteredImpl(x: number, y: number, parameters: DrawParameters, diameter: number=) source

INTERNAL

Override:

BaseItem#drawItemCenteredImpl

Params:

NameTypeAttributeDescription
x number
y number
parameters DrawParameters
diameter number=

public equalsImpl(other: BaseItem): * source

Override for custom comparison

Override:

BaseItem#equalsImpl

Params:

NameTypeAttributeDescription
other BaseItem

Return:

*

public getAsCopyableKey(): string source

Returns a string id of the item

Override:

BaseItem#getAsCopyableKey

Return:

string

public getBackgroundColorAsResource(): * source

Override:

BaseItem#getBackgroundColorAsResource

Return:

*

public getItemType(): "shape" source

Override:

BaseItem#getItemType

Return:

"shape"

*

public serialize(): * source

Override:

BasicSerializableObject#serialize

Return:

*