CityBuilderCore.SplitItemContainer Class Reference

Detailed Description

item container that combines different ItemStorages that are each meant for one specific item
used in the ProductionComponent where storage is split between different producers and consumers

Inheritance diagram for CityBuilderCore.SplitItemContainer:

Public Member Functions
	SplitItemContainer (IEnumerable< ItemStorage > storages, Func< Item, ItemStorage > itemStorageGetter)
void	ReserveCapacity (Item item, int amount)
void	UnreserveCapacity (Item item, int amount)
void	ReserveQuantity (Item item, int amount)
void	UnreserveQuantity (Item item, int amount)
IEnumerable< Item >	GetItems ()
IEnumerable< ItemQuantity >	GetItemQuantities ()
int	GetItemQuantity ()
int	GetItemQuantity (Item item)
int	GetItemQuantity (ItemCategory itemCategory)
int	GetItemCapacity ()
int	GetItemCapacity (Item item)
int	GetItemCapacity (ItemCategory itemCategory)
int	GetItemCapacityRemaining ()
int	GetItemCapacityRemaining (Item item)
int	GetItemCapacityRemaining (ItemCategory itemCategory)
int	AddItems (Item item, int quantity)
	adds items to that storage up to its capacity, remaining quantity is returned (adding 10 items to a storage that can only fit 4 more will return 6)
int	RemoveItems (Item item, int quantity)
	removes items from storage and returns the remaining quantity if not enough items were present (removing 4 items from a store that contains only 3 will return 1)

Member Function Documentation

AddItems()

int CityBuilderCore.SplitItemContainer.AddItems	(	Item	item,
		int	quantity )

adds items to that storage up to its capacity, remaining quantity is returned
(adding 10 items to a storage that can only fit 4 more will return 6)

Parameters

item	the item to add
quantity	maximum quantity to add

Returns

remaining quantity that did not fit

Implements CityBuilderCore.IItemContainer.

GetItemCapacity() [1/3]

int CityBuilderCore.SplitItemContainer.GetItemCapacity

(

)

Implements CityBuilderCore.IItemContainer.

GetItemCapacity() [2/3]

int CityBuilderCore.SplitItemContainer.GetItemCapacity

(

Item

item

)

Implements CityBuilderCore.IItemContainer.

GetItemCapacity() [3/3]

int CityBuilderCore.SplitItemContainer.GetItemCapacity

(

ItemCategory

itemCategory

)

Implements CityBuilderCore.IItemContainer.

GetItemCapacityRemaining() [1/3]

int CityBuilderCore.SplitItemContainer.GetItemCapacityRemaining

(

)

Implements CityBuilderCore.IItemContainer.

GetItemCapacityRemaining() [2/3]

int CityBuilderCore.SplitItemContainer.GetItemCapacityRemaining

(

Item

item

)

Implements CityBuilderCore.IItemContainer.

GetItemCapacityRemaining() [3/3]

int CityBuilderCore.SplitItemContainer.GetItemCapacityRemaining

(

ItemCategory

itemCategory

)

Implements CityBuilderCore.IItemContainer.

GetItemQuantities()

IEnumerable< ItemQuantity > CityBuilderCore.SplitItemContainer.GetItemQuantities

(

)

Implements CityBuilderCore.IItemContainer.

GetItemQuantity() [1/3]

int CityBuilderCore.SplitItemContainer.GetItemQuantity

(

)

Implements CityBuilderCore.IItemContainer.

GetItemQuantity() [2/3]

int CityBuilderCore.SplitItemContainer.GetItemQuantity

(

Item

item

)

Implements CityBuilderCore.IItemContainer.

GetItemQuantity() [3/3]

int CityBuilderCore.SplitItemContainer.GetItemQuantity

(

ItemCategory

itemCategory

)

Implements CityBuilderCore.IItemContainer.

GetItems()

IEnumerable< Item > CityBuilderCore.SplitItemContainer.GetItems

(

)

Implements CityBuilderCore.IItemContainer.

RemoveItems()

int CityBuilderCore.SplitItemContainer.RemoveItems	(	Item	item,
		int	quantity )

removes items from storage and returns the remaining quantity if not enough items were present
(removing 4 items from a store that contains only 3 will return 1)

Parameters

item	the item to remove
quantity	the maximum quantity to remove

Returns

remaining quantity not removed

Implements CityBuilderCore.IItemContainer.

ReserveCapacity()

void CityBuilderCore.SplitItemContainer.ReserveCapacity	(	Item	item,
		int	amount )

Implements CityBuilderCore.IItemContainer.

ReserveQuantity()

void CityBuilderCore.SplitItemContainer.ReserveQuantity	(	Item	item,
		int	amount )

Implements CityBuilderCore.IItemContainer.

UnreserveCapacity()

void CityBuilderCore.SplitItemContainer.UnreserveCapacity	(	Item	item,
		int	amount )

Implements CityBuilderCore.IItemContainer.

UnreserveQuantity()

void CityBuilderCore.SplitItemContainer.UnreserveQuantity	(	Item	item,
		int	amount )

Implements CityBuilderCore.IItemContainer.