AC.Recipe Class Reference

Inheritance diagram for AC.Recipe:

Public Member Functions
	Recipe (int[] idArray)
	The default Constructor.
bool	CanBeCrafted (InvCollection invCollection, int[] limitToCategoryIDs=null)
	Checks if a collection of inventory item instances has all the items necessary to craft this recipe's item.
int	GetNumItemReferences (int itemID)
int	UpdateItemReferences (int oldItemID, int newItemID)

Public Attributes
string	label
int	id
List< Ingredient >	ingredients = new List<Ingredient> ()
int	resultID
bool	useSpecificSlots
OnCreateRecipe	onCreateRecipe = OnCreateRecipe.JustMoveToInventory
ActionListAsset	invActionList
ActionListAsset	actionListOnCreate

Properties
string	EditorLabel [get]

Detailed Description

A data container for a recipe. A recipe requires multiple inventory items, optionally arranged in a specific pattern, and replaces them with a new inventory item.

Constructor & Destructor Documentation

Recipe()

AC.Recipe.Recipe

(

int[]

idArray

)

The default Constructor.

Parameters

idArray

An array of already-used ID numbers, so that a unique one can be generated

Member Function Documentation

CanBeCrafted()

bool AC.Recipe.CanBeCrafted	(	InvCollection	invCollection,
		int[]	limitToCategoryIDs = null )

Checks if a collection of inventory item instances has all the items necessary to craft this recipe's item.

Parameters

invCollection	The collection of inventory item instances to check
limitToCategoryIDs	If set, an array of item categories that the resulting item must be within for the recipe to be valid

Returns

True if the collection has all the items necessary to craft the recipe's item

GetNumItemReferences()

int AC.Recipe.GetNumItemReferences

(

int

itemID

)

Implements AC.IItemReferencer.

UpdateItemReferences()

int AC.Recipe.UpdateItemReferences	(	int	oldItemID,
		int	newItemID )

Implements AC.IItemReferencer.

Member Data Documentation

actionListOnCreate

ActionListAsset AC.Recipe.actionListOnCreate

The ActionListAsset to run when the recipe is created

id

int AC.Recipe.id

A unique identifier

ingredients

List<Ingredient> AC.Recipe.ingredients = new List<Ingredient> ()

The required ingredients

invActionList

ActionListAsset AC.Recipe.invActionList

The ActionListAsset to run, if onCreateRecipe = OnCreateRecipe.RunActionList

label

string AC.Recipe.label

The recipe's editor name

onCreateRecipe

OnCreateRecipe AC.Recipe.onCreateRecipe = OnCreateRecipe.JustMoveToInventory

What happens when the recipe is created (JustMoveToInventory, SelectItem, RunActionList)

resultID

int AC.Recipe.resultID

The ID number of the associated inventory item (InvItem) created when the recipe is complete

useSpecificSlots

bool AC.Recipe.useSpecificSlots

If True, then the ingredients must be placed in specific slots within a MenuCrafting element