import {ShapeDefinitionManager} from 'shapez.io/js/game/shape_definition_manager.js'

public class | source

ShapeDefinitionManager

Extends:

BasicSerializableObject → ShapeDefinitionManager

Static Method Summary

Static Public Methods
public static	getId(): string

Constructor Summary

Public Constructor
public	constructor(root: GameRoot)

Member Summary

Public Members
public	operationCache: Object<string, Array<ShapeDefinition>\|ShapeDefinition>
public	root: *
public	shapeKeyToDefinition: Object<string, ShapeDefinition> Store a cache from key -> definition
public	shapeKeyToItem: {} Store a cache from key -> item

Method Summary

Public Methods
public	getDefinitionFromSimpleShapes(subShapes: [enumSubShape, enumSubShape, enumSubShape, enumSubShape]): ShapeDefinition
public	getShapeFromShortKey(hash: string): ShapeDefinition Returns a shape instance from a given short key
public	getShapeItemFromDefinition(definition: ShapeDefinition): ShapeItem Returns a shape item for a given definition
public	getShapeItemFromShortKey(hash: string): ShapeItem Returns a item instance from a given short key
public	registerOrReturnHandle(definition: ShapeDefinition): * Checks if we already have cached this definition, and if so throws it away and returns the already cached variant
public	registerShapeDefinition(definition: ShapeDefinition) Registers a new shape definition
public	shapeActionCutHalf(definition: ShapeDefinition): [ShapeDefinition, ShapeDefinition] Generates a definition for splitting a shape definition in two halfs
public	shapeActionCutQuad(definition: ShapeDefinition): [ShapeDefinition, ShapeDefinition, ShapeDefinition, ShapeDefinition] Generates a definition for splitting a shape definition in four quads
public	shapeActionPaintWith(definition: ShapeDefinition, color: enumColors): ShapeDefinition Generates a definition for painting it with the given color
public	shapeActionPaintWith4Colors(definition: ShapeDefinition, colors: [enumColors, enumColors, enumColors, enumColors]): ShapeDefinition Generates a definition for painting it with the 4 colors
public	shapeActionRotate180(definition: ShapeDefinition): ShapeDefinition Generates a definition for rotating a shape FL
public	shapeActionRotateCCW(definition: ShapeDefinition): ShapeDefinition Generates a definition for rotating a shape counter clockwise
public	shapeActionRotateCW(definition: ShapeDefinition): ShapeDefinition Generates a definition for rotating a shape clockwise
public	shapeActionStack(lowerDefinition: ShapeDefinition, upperDefinition: ShapeDefinition): ShapeDefinition Generates a definition for stacking the upper definition onto the lower one

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 Constructors

public constructor(root: GameRoot) source

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

Override:

BasicSerializableObject#constructor

Params:

Name	Type	Attribute	Description
root	GameRoot

Public Members

public operationCache: Object<string, Array<ShapeDefinition>|ShapeDefinition> source

public root: * source

public shapeKeyToDefinition: Object<string, ShapeDefinition> source

Store a cache from key -> definition

public shapeKeyToItem: {} source

Store a cache from key -> item

Public Methods

public getDefinitionFromSimpleShapes(subShapes: [enumSubShape, enumSubShape, enumSubShape, enumSubShape]): ShapeDefinition source

Params:

Name	Type	Attribute	Description
subShapes	[enumSubShape, enumSubShape, enumSubShape, enumSubShape]

Return:

ShapeDefinition

public getShapeFromShortKey(hash: string): ShapeDefinition source

Returns a shape instance from a given short key

Params:

Name	Type	Attribute	Description
hash	string

Return:

ShapeDefinition

public getShapeItemFromDefinition(definition: ShapeDefinition): ShapeItem source

Returns a shape item for a given definition

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

ShapeItem

public getShapeItemFromShortKey(hash: string): ShapeItem source

Returns a item instance from a given short key

Params:

Name	Type	Attribute	Description
hash	string

Return:

ShapeItem

public registerOrReturnHandle(definition: ShapeDefinition): * source

Checks if we already have cached this definition, and if so throws it away and returns the already cached variant

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

public registerShapeDefinition(definition: ShapeDefinition) source

Registers a new shape definition

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

public shapeActionCutHalf(definition: ShapeDefinition): [ShapeDefinition, ShapeDefinition] source

Generates a definition for splitting a shape definition in two halfs

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

[ShapeDefinition, ShapeDefinition]

public shapeActionCutQuad(definition: ShapeDefinition): [ShapeDefinition, ShapeDefinition, ShapeDefinition, ShapeDefinition] source

Generates a definition for splitting a shape definition in four quads

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

[ShapeDefinition, ShapeDefinition, ShapeDefinition, ShapeDefinition]

public shapeActionPaintWith(definition: ShapeDefinition, color: enumColors): ShapeDefinition source

Generates a definition for painting it with the given color

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition
color	enumColors

Return:

ShapeDefinition

public shapeActionPaintWith4Colors(definition: ShapeDefinition, colors: [enumColors, enumColors, enumColors, enumColors]): ShapeDefinition source

Generates a definition for painting it with the 4 colors

Params:

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

Return:

ShapeDefinition

public shapeActionRotate180(definition: ShapeDefinition): ShapeDefinition source

Generates a definition for rotating a shape FL

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

ShapeDefinition

public shapeActionRotateCCW(definition: ShapeDefinition): ShapeDefinition source

Generates a definition for rotating a shape counter clockwise

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

ShapeDefinition

public shapeActionRotateCW(definition: ShapeDefinition): ShapeDefinition source

Generates a definition for rotating a shape clockwise

Params:

Name	Type	Attribute	Description
definition	ShapeDefinition

Return:

ShapeDefinition

public shapeActionStack(lowerDefinition: ShapeDefinition, upperDefinition: ShapeDefinition): ShapeDefinition source

Generates a definition for stacking the upper definition onto the lower one

Params:

Name	Type	Attribute	Description
lowerDefinition	ShapeDefinition
upperDefinition	ShapeDefinition

Return:

ShapeDefinition