CMD++ Core

Class: StorageContainer

StorageContainer

Class representing a container for all Storage instances, as well as a representation of the current Storage instance.

new StorageContainer()

Source:

Members

name :string

Name of current storage.
Type:
  • string
Source:

capacity :number

Capacity of current storage.
Type:
  • number
Source:

price :number

Price of current storage.
Type:
  • number
Source:

idx :number

ID of current storage.
Type:
  • number
Source:

current :Storage

Current storage.
Type:
Source:

upgrade :Storage

Next storage in upgrade list.
Type:
Source:

otherNames :Array.<string>

Names of all storages excluding the currently selected.
Type:
  • Array.<string>
Source:

others :Object

All storages excluding the currently selected.
Type:
  • Object
Source:

allNames :Array.<string>

Names of all storages.
Type:
  • Array.<string>
Source:

all :Object

All storages.
Type:
  • Object
Source:

name :string

Name of current storage.
Type:
  • string
Source:

capacity :number

Capacity of current storage.
Type:
  • number
Source:

price :number

Price of current storage.
Type:
  • number
Source:

idx :number

ID of current storage.
Type:
  • number
Source:

current :Storage

Current storage.
Type:
Source:

upgrade :Storage

Next storage in upgrade list.
Type:
Source:

otherNames :Array.<string>

Names of all storages excluding the currently selected.
Type:
  • Array.<string>
Source:

others :Object

All storages excluding the currently selected.
Type:
  • Object
Source:

allNames :Array.<string>

Names of all storages.
Type:
  • Array.<string>
Source:

all :Object

All storages.
Type:
  • Object
Source:

Methods

checkStorage(data, increment)

Check if storage is full.
Parameters:
Name Type Description
data number Data to check against.
increment number Increment to check against.
Source:
Returns:
If storage has enough space.
Type
boolean

<static> getStorage(storages)

Instantiate StorageContainer
Parameters:
Name Type Description
storages Array.<string> | undefined Names of storages. If undefined, use default storages.
Source:
Returns:
Type
StorageContainer

checkStorage(data, increment)

Check if storage is full.
Parameters:
Name Type Description
data number Data to check against.
increment number Increment to check against.
Source:
Returns:
If storage has enough space.
Type
boolean

<static> getStorage(storages)

Instantiate StorageContainer
Parameters:
Name Type Description
storages Array.<string> | undefined Names of storages. If undefined, use default storages.
Source:
Returns:
Type
StorageContainer

Class: StorageContainer

StorageContainer

Class representing a container for all Storage instances, as well as a representation of the current Storage instance.

new StorageContainer()

Source:

Members

name :string

Name of current storage.
Type:
  • string
Source:

capacity :number

Capacity of current storage.
Type:
  • number
Source:

price :number

Price of current storage.
Type:
  • number
Source:

idx :number

ID of current storage.
Type:
  • number
Source:

current :Storage

Current storage.
Type:
Source:

upgrade :Storage

Next storage in upgrade list.
Type:
Source:

otherNames :Array.<string>

Names of all storages excluding the currently selected.
Type:
  • Array.<string>
Source:

others :Object

All storages excluding the currently selected.
Type:
  • Object
Source:

allNames :Array.<string>

Names of all storages.
Type:
  • Array.<string>
Source:

all :Object

All storages.
Type:
  • Object
Source:

name :string

Name of current storage.
Type:
  • string
Source:

capacity :number

Capacity of current storage.
Type:
  • number
Source:

price :number

Price of current storage.
Type:
  • number
Source:

idx :number

ID of current storage.
Type:
  • number
Source:

current :Storage

Current storage.
Type:
Source:

upgrade :Storage

Next storage in upgrade list.
Type:
Source:

otherNames :Array.<string>

Names of all storages excluding the currently selected.
Type:
  • Array.<string>
Source:

others :Object

All storages excluding the currently selected.
Type:
  • Object
Source:

allNames :Array.<string>

Names of all storages.
Type:
  • Array.<string>
Source:

all :Object

All storages.
Type:
  • Object
Source:

Methods

checkStorage(data, increment)

Check if storage is full.
Parameters:
Name Type Description
data number Data to check against.
increment number Increment to check against.
Source:
Returns:
If storage has enough space.
Type
boolean

<static> getStorage(storages)

Instantiate StorageContainer
Parameters:
Name Type Description
storages Array.<string> | undefined Names of storages. If undefined, use default storages.
Source:
Returns:
Type
StorageContainer

checkStorage(data, increment)

Check if storage is full.
Parameters:
Name Type Description
data number Data to check against.
increment number Increment to check against.
Source:
Returns:
If storage has enough space.
Type
boolean

<static> getStorage(storages)

Instantiate StorageContainer
Parameters:
Name Type Description
storages Array.<string> | undefined Names of storages. If undefined, use default storages.
Source:
Returns:
Type
StorageContainer