CommunityItemInterface.cs

namespace FortressCraft.Community
{
	using System;

	/// <summary>
	///		A community interface to allow cross-mod communication for item storage
	/// </summary>
	[Obsolete("Official Item Interfaces are released, use those. http://steamcommunity.com/app/254200/discussions/1/364040166673615738/", true)]
	public interface CommunityItemInterface
	{
		/// <summary>
		///		Checks to see if a Storage Medium has any items
		/// </summary>
		/// <returns>True if the storage medium has any item, false otherwise</returns>
		Boolean HasItems();

		///  <summary>
		/// 		Checks to see if a Storage Medium has the specified item
		///  
		/// 		Checks for Ore/Item/Cube
		///  </summary>
		///  <param name="item">The Item to Check For</param>
		///  <returns>True if the storage medium has the specified item, false otherwise</returns>
		Boolean HasItem(ItemBase item);

		///  <summary>
		/// 		Checks to see if a Storage Medium has the specified item
		///  
		/// 		Checks for Ore/Item/Cube
		///  </summary>
		///  <param name="item">The Item to Check For</param>
		///  <param name="amount">Stores the amount of the items available</param>
		///  <returns>True if the storage medium has the specified item, false otherwise</returns>
		Boolean HasItems(ItemBase item, out Int32 amount);

		/// <summary>
		///		Checks to see if a Storage Medium has <c>amount</c> capcity free
		/// </summary>
		/// <param name="amount">The amount of capcity to check for</param>
		/// <returns>True if the storage medium has <c>amount</c> capacity free, otherwise false</returns>
		Boolean HasFreeSpace(UInt32 amount);

		/// <summary>
		///		Get the free capcity of the entity
		/// </summary>
		/// <returns>The free capcity of the entity</returns>
		Int32 GetFreeSpace();

		/// <summary>
		///		Attempts to give the Item to a Storage Medium
		/// </summary>
		/// <param name="item">The Item to give to a Storage Medium</param>
		/// <returns>True if the Storage Medium accepted the item, otherwise false</returns>
		Boolean GiveItem(ItemBase item);

		/// <summary>
		///		Attempts to take an Item from a Storage Medium
		/// </summary>
		/// <param name="item">The Item to Retrieve</param>
		/// <returns>An ItemBase if the requested Item was found, otherwise null</returns>
		ItemBase TakeItem(ItemBase item);

        /// <summary>
        ///     Attempts to take any item from a Storage Medium
        /// </summary>
        /// <returns>An ItemBase if there's something to return, or null if empty</returns>
        ItemBase TakeAnyItem();
	}
}