Dimensional Depot

Parent

Actor

The dimensional depot, remote storage or also known as central storage.

Properties

centralStorageItemStackLimit : Int

The stack limit of the central storage.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Central Storage Item Stack Limit

centralStorageTimeToUpload : Float

The amount of time it takes to upload an item to the central storage.

Details
Flags ReadOnly RuntimeSync RuntimeParallel

Display Name

Central Storage Time to Upload

Functions

canUploadItemsToCentralStorage (itemType : Class<ItemType>) → canUpload : Bool

Returns true if any items of the given type can be uploaded to the central storage.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Can upload Items to Central Storage
Parameters
Name Type Description

Item Type itemType

Class<ItemType>

The type of the item you want to check if it can be uploaded.
Return Values
Name Type Description

Can Upload canUpload

Bool

True if the given item type can be uploaded to the central storage.

getCentralStorageItemLimit (itemType : Class<ItemType>) → number : Int

Returns the maxiumum number of items of a given type you can upload to the central storage.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Central Storage Item Limit
Parameters
Name Type Description

Item Type itemType

Class<ItemType>

The type of the item you want to check if it can be uploaded.
Return Values
Name Type Description

Number number

Int

The maximum number of items you can upload.

getItemCountFromCentralStorage (itemType : Class<ItemType>) → number : Int

Returns the number of items of a given type that is stored within the central storage.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get Item Count from Central Storage
Parameters
Name Type Description

Item Type itemType

Class<ItemType>

The type of the item you want to get the number of items in the central storage from.
Return Values
Name Type Description

Number number

Int

The number of items in the central storage.

getAllItemsFromCentralStorage () → items : Array<Struct<ItemAmount>>

Return a list of all items the central storage currently contains.

Details

Flags

RuntimeSync RuntimeParallel MemberFunc

Display Name

Get all Items from Cental Stroage
Return Values
Name Type Description

Items items

Array<Struct<ItemAmount>>

The list of items that the central storage currently contains.

Signals

ItemAmountUpdated (Class<ItemType> Item Type itemType, Int Item Amount itemAmount)

Gets triggered when the amount of item in the central storage changes.

Details
Parameters
Name Type Description

Item Type itemType

Class<ItemType>

The type of the item that got uploaded.

Item Amount itemAmount

Int

The new amount of items of the given type.

ItemLimitReachedUpdated (Class<ItemType> Item Type itemType, Bool Reached reached)

Gets triggered when an item type reached maximum capacity, or when it now has again available space for new items.

Details
Parameters
Name Type Description

Item Type itemType

Class<ItemType>

The type of the item which changed if it has reached the limit or not.

Reached reached

Bool

True if the given item type has reached the limit or not.

NewItemAdded (Class<ItemType> Item Type itemType)

Gets triggered when a new item gets uploaded to the central storage.

Details
Parameters
Name Type Description

Item Type itemType

Class<ItemType>

The type of the item that got uploaded.