import {StorageComponent} from 'shapez.io/js/game/components/storage.js'

public class | source

StorageComponent

Extends:

BasicSerializableObject → Component → StorageComponent

Static Method Summary

Static Public Methods
public static	getId(): string
public static	getSchema(): {"storedCount": , "storedItem": }

Constructor Summary

Public Constructor
public	constructor(param0: object)

Member Summary

Public Members
public	maximumStorage: *
public	overlayOpacity: number We compute an opacity to make sure it doesn't flicker
public	storedCount: number How many of this item we have stored
public	storedItem: BaseItem Currently stored item

Method Summary

Public Methods
public	canAcceptItem(item: BaseItem): boolean Returns whether this storage can accept the item
public	getIsFull(): boolean Returns whether the storage is full
public	takeItem(item: BaseItem)

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

From class Component
public static	getId(): string Returns the components unique id
public static	getSchema(): {} Should return the schema used for serialization
public	copyAdditionalStateTo(otherComponent: Component) Copy the current state to another component
public	getDebugString(): string Returns a string representing the components data, only in dev builds

Static Public Methods

public static getId(): string source

Returns the components unique id

Override:

Component#getId

Return:

string

public static getSchema(): {"storedCount": , "storedItem": } source

Should return the schema used for serialization

Override:

Component#getSchema

Return:

{"storedCount": *, "storedItem": *}

Public Constructors

public constructor(param0: object) source

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

Override:

Component#constructor

Params:

Name	Type	Attribute	Description
param0	object
param0.maximumStorage	number=		How much this storage can hold

Public Members

public maximumStorage: * source

public overlayOpacity: number source

We compute an opacity to make sure it doesn't flicker

public storedCount: number source

How many of this item we have stored

public storedItem: BaseItem source

Currently stored item

Public Methods

public canAcceptItem(item: BaseItem): boolean source

Returns whether this storage can accept the item

Params:

Name	Type	Attribute	Description
item	BaseItem

Return:

boolean

public getIsFull(): boolean source

Returns whether the storage is full

Return:

boolean

public takeItem(item: BaseItem) source

Params:

Name	Type	Attribute	Description
item	BaseItem

StorageComponent

Extends:

Static Method Summary

Constructor Summary

Member Summary

Method Summary

Inherited Summary

Static Public Methods

public static getId(): string source

Override:

Return:

public static getSchema(): {"storedCount": *, "storedItem": *} source

Override:

Return:

Public Constructors

public constructor(param0: object) source

Override:

Params:

Public Members

public maximumStorage: * source

public overlayOpacity: number source

public storedCount: number source

public storedItem: BaseItem source

Public Methods

public canAcceptItem(item: BaseItem): boolean source

Params:

Return:

public getIsFull(): boolean source

Return:

public takeItem(item: BaseItem) source

Params:

public static getSchema(): {"storedCount": , "storedItem": } source