import {ShapeDefinition} from 'shapez.io/js/game/shape_definition.js'

public class | source

ShapeDefinition

Extends:

BasicSerializableObject → ShapeDefinition

Static Method Summary

Static Public Methods
public static	fromShortKey(key: string): ShapeDefinition Generates the definition from the given short key
public static	getId(): string
public static	getSchema(): {}
public static	isValidShortKey(key: string): boolean Checks if a given string is a valid short key
public static	isValidShortKeyInternal(key: string): boolean INTERNAL Checks if a given string is a valid short key

Constructor Summary

Public Constructor
public	constructor(param0: object)

Member Summary

Public Members
public	bufferGenerator: *
public	cachedHash: string
public	layers: *

Method Summary

Public Methods
public	cloneAndPaintWith(color: enumColors): * Clones the shape and colors everything in the given color
public	cloneAndPaintWith4Colors(colors: [enumColors, enumColors, enumColors, enumColors]): * Clones the shape and colors everything in the given colors
public	cloneAndStackWith(definition: ShapeDefinition): * Stacks the given shape definition on top.
public	cloneFilteredByQuadrants(includeQuadrants: Array<number>): ShapeDefinition Returns a definition with only the given quadrants
public	cloneRotate180(): ShapeDefinition Returns a definition which was rotated 180 degrees
public	cloneRotateCCW(): ShapeDefinition Returns a definition which was rotated counter clockwise
public	cloneRotateCW(): ShapeDefinition Returns a definition which was rotated clockwise
public	deserialize(data: ):
public	drawCentered(x: number, y: number, parameters: DrawParameters, diameter: number=) Draws the shape definition
public	drawFullSizeOnCanvas(context: CanvasRenderingContext2D, size: number) Draws the item to a canvas
public	generateAsCanvas(size: number): * Generates this shape as a canvas
public	getHash(): string Returns a unique id for this shape
public	internalCloneLayers(): Array<ShapeLayer> Internal method to clone the shape definition
public	internalGenerateShapeBuffer(canvas: HTMLCanvasElement, context: CanvasRenderingContext2D, w: number, h: number, dpi: number)
public	isEntirelyEmpty(): boolean Returns if the definition is entirely empty^
public	serialize(): *

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 fromShortKey(key: string): ShapeDefinition source

Generates the definition from the given short key

Params:

Name	Type	Attribute	Description
key	string

Return:

ShapeDefinition

public static getId(): string source

Override:

BasicSerializableObject#getId

Return:

string

public static getSchema(): {} source

Should return the serialization schema

Override:

BasicSerializableObject#getSchema

Return:

{}

public static isValidShortKey(key: string): boolean source

Checks if a given string is a valid short key

Params:

Name	Type	Attribute	Description
key	string

Return:

boolean

public static isValidShortKeyInternal(key: string): boolean source

INTERNAL Checks if a given string is a valid short key

Params:

Name	Type	Attribute	Description
key	string

Return:

boolean

Public Constructors

public constructor(param0: object) source

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

Override:

BasicSerializableObject#constructor

Params:

Name	Type	Attribute	Description
param0	object
param0.layers	Array<ShapeLayer>=

Public Members

public bufferGenerator: * source

public cachedHash: string source

public layers: * source

Public Methods

public cloneAndPaintWith(color: enumColors): * source

Clones the shape and colors everything in the given color

Params:

Name	Type	Attribute	Description
color	enumColors

Return:

public cloneAndPaintWith4Colors(colors: [enumColors, enumColors, enumColors, enumColors]): * source

Clones the shape and colors everything in the given colors

Params:

Name	Type	Attribute	Description
colors	[enumColors, enumColors, enumColors, enumColors]

Return:

public cloneAndStackWith(definition: ShapeDefinition): * source

Stacks the given shape definition on top.

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

public cloneFilteredByQuadrants(includeQuadrants: Array<number>): ShapeDefinition source

Returns a definition with only the given quadrants

Params:

Name	Type	Attribute	Description
includeQuadrants	Array<number>

Return:

ShapeDefinition

public cloneRotate180(): ShapeDefinition source

Returns a definition which was rotated 180 degrees

Return:

ShapeDefinition

public cloneRotateCCW(): ShapeDefinition source

Returns a definition which was rotated counter clockwise

Return:

ShapeDefinition

public cloneRotateCW(): ShapeDefinition source

Returns a definition which was rotated clockwise

Return:

ShapeDefinition

public deserialize(data: ): source

Override:

BasicSerializableObject#deserialize

Params:

Name	Type	Attribute	Description
data	*

Return:

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

Draws the shape definition

Params:

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

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

Draws the item to a canvas

Params:

Name	Type	Attribute	Description
context	CanvasRenderingContext2D
size	number

public generateAsCanvas(size: number): * source

Generates this shape as a canvas

Params:

Name	Type	Attribute	Description
size	number

Return:

public getHash(): string source

Returns a unique id for this shape

Return:

string

public internalCloneLayers(): Array<ShapeLayer> source

Internal method to clone the shape definition

Return:

Array<ShapeLayer>

public internalGenerateShapeBuffer(canvas: HTMLCanvasElement, context: CanvasRenderingContext2D, w: number, h: number, dpi: number) source

Params:

Name	Type	Attribute	Description
canvas	HTMLCanvasElement
context	CanvasRenderingContext2D
w	number
h	number
dpi	number

ShapeDefinition

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static fromShortKey(key: string): ShapeDefinition source

Params:

Return:

public static getId(): string source

Override:

Return:

public static getSchema(): {} source

Override:

Return:

public static isValidShortKey(key: string): boolean source

Params:

Return:

public static isValidShortKeyInternal(key: string): boolean source

Params:

Return:

Public Constructors

public constructor(param0: object) source

Override:

Params:

Public Members

public bufferGenerator: * source

public cachedHash: string source

public layers: * source

Public Methods

public cloneAndPaintWith(color: enumColors): * source

Params:

Return:

public cloneAndPaintWith4Colors(colors: [enumColors, enumColors, enumColors, enumColors]): * source

Params:

Return:

public cloneAndStackWith(definition: ShapeDefinition): * source

Params:

Return:

public cloneFilteredByQuadrants(includeQuadrants: Array<number>): ShapeDefinition source

Params:

Return:

public cloneRotate180(): ShapeDefinition source

Return:

public cloneRotateCCW(): ShapeDefinition source

Return:

public cloneRotateCW(): ShapeDefinition source

Return:

public deserialize(data: *): * source

Override:

Params:

Return:

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

Params:

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

Params:

public generateAsCanvas(size: number): * source

Params:

Return:

public getHash(): string source

Return:

public internalCloneLayers(): Array<ShapeLayer> source

Return:

public internalGenerateShapeBuffer(canvas: HTMLCanvasElement, context: CanvasRenderingContext2D, w: number, h: number, dpi: number) source

Params:

public isEntirelyEmpty(): boolean source

Return:

public serialize(): * source

Override:

Return:

public deserialize(data: ): source