CityBuilderCore.IStorageComponent Interface Reference

Detailed Description

building component that stores items, how it does that can be configured in orders

Inheritance diagram for CityBuilderCore.IStorageComponent:

Properties
ItemStorage	Storage [get]
	the storage that holds the components items
StorageOrder[]	Orders [get]
	orders determine how much of which item is stored and how they are treated
Properties inherited from CityBuilderCore.IBuildingTrait< IStorageComponent >
BuildingComponentReference< T >	Reference [get, set]
	reference to the building trait, use when the building might be replaced and when the reference has to be saved
Properties inherited from CityBuilderCore.IItemReceiver
int	Priority [get]
	can be used so certain receivers are preferred over others for example construction sites or production may be more important that putting items into storage
Properties inherited from CityBuilderCore.IBuildingTrait< IItemReceiver >
BuildingComponentReference< T >	Reference [get, set]
	reference to the building trait, use when the building might be replaced and when the reference has to be saved
Properties inherited from CityBuilderCore.IItemOwner
IItemContainer	ItemContainer [get]
	holds and manages the items for the owner
Properties inherited from CityBuilderCore.IBuildingTrait< IItemGiver >
BuildingComponentReference< T >	Reference [get, set]
	reference to the building trait, use when the building might be replaced and when the reference has to be saved

Additional Inherited Members
Public Member Functions inherited from CityBuilderCore.IItemReceiver
IEnumerable< Item >	GetReceiveItems ()
	returns the kinds of items the receiver needs
int	GetReceiveCapacityRemaining (Item item)
	how much of the item the receiver can still fit
void	ReserveCapacity (Item item, int quantity)
	reserves a capacity in the receiver so it is not filled up by someone else
void	UnreserveCapacity (Item item, int quantity)
	releases capacity that was earlier reserved by ReserveCapacity(Item, int) call before actually moving items into the receiver or if the delivery was somehow interrupted
int	Receive (ItemStorage storage, Item item, int quantity)
	requests that a quantity of items is moved from the storage to the receiver if the full amount does not fit the remaining quantity is returned
Public Member Functions inherited from CityBuilderCore.IItemGiver
int	GetGiveQuantity (Item item)
	checks how much of an item is available to be given
void	ReserveQuantity (Item item, int quantity)
	reserves a quantity of items that may later be given dont reverse more than is available(GetGiveQuantity(Item))
void	UnreserveQuantity (Item item, int quantity)
	releases a quantity that was reserved by ReserveQuantity(Item, int) before should be called before acutally moving items with Give(ItemStorage, Item, int) or if the process was interrupted
int	Give (ItemStorage storage, Item item, int quantity)
	requests that a quantity of items is put into the specified storage if the full amount is not available the remaining quantity is returned