import {BaseItem} from 'shapez.io/js/game/base_item.js'

public class | source

BaseItem

Extends:

BasicSerializableObject → BaseItem

Direct Subclass:

BooleanItem, ColorItem, ShapeItem

Class for items on belts etc. Not an entity for performance reasons

Static Method Summary

Static Public Methods
public static	getId(): string
public static	getSchema(): object

Constructor Summary

Public Constructor
public	constructor()

Method Summary

Public Methods
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	equals(other: BaseItem): boolean Returns if the item equals the other itme
public abstract	equalsImpl(other: BaseItem): boolean Override for custom comparison
public	getAsCopyableKey(): string Returns a string id of the item
public	getBackgroundColorAsResource(): string
public	getItemType(): ItemType

Inherited Summary

From class BasicSerializableObject
public static	getCachedSchema(): Schema
public static	getId()
public static	getSchema(): Schema Should return the serialization schema
public static	verify(data: *): string \| void
public	deserialize(data: any, root: import("./savegame_serializer").GameRoot): string \| void
public	serialize(): object

Static Public Methods

public static getId(): string source

Override:

BasicSerializableObject#getId

Return:

string

public static getSchema(): object source

Should return the serialization schema

Override:

BasicSerializableObject#getSchema

Return:

object

Public Constructors

public constructor() source

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

Override:

BasicSerializableObject#constructor

Public Methods

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

Draws the item to a canvas

Params:

Name	Type	Attribute	Description
context	CanvasRenderingContext2D
size	number

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

Draws the item at the given position

Params:

Name	Type	Attribute	Description
x	number
y	number
parameters	DrawParameters
diameter	number=

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

INTERNAL

Params:

Name	Type	Attribute	Description
x	number
y	number
parameters	DrawParameters
diameter	number=

public equals(other: BaseItem): boolean source

Returns if the item equals the other itme

Params:

Name	Type	Attribute	Description
other	BaseItem

Return:

boolean

public abstract equalsImpl(other: BaseItem): boolean source

Override for custom comparison

Params:

Name	Type	Attribute	Description
other	BaseItem

Return:

boolean

public getAsCopyableKey(): string source

Returns a string id of the item

Return:

string

public getBackgroundColorAsResource(): string source

Return:

string

public getItemType(): ItemType source

Return:

ItemType