Package com.planet_ink.coffee_mud.core.interfaces

Interface RecipeDriven

All Superinterfaces:

java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>

All Known Subinterfaces:

CraftorAbility, ItemCraftor

All Known Implementing Classes:

Alchemy, Apothecary, Armorsmithing, Baking, Blacksmithing, Boatwright, BuildingSkill, CageBuilding, CaravanBuilding, Carpentry, ClanCrafting, ClanShipwrighting, Cobbling, Construction, Cooking, Costuming, CraftingSkill, Decorating, Dissertating, Distilling, DrugCutting, Dyeing, EnhancedCraftingSkill, Excavation, Fletching, FoodPrep, GaolFood, GenCraftSkill, GenWrightSkill, GlassBlowing, Gunsmithing, Herbalism, Herbology, ImprovedAlchemy, InstrumentMaking, Irrigation, JewelMaking, Lacquerring, Landscaping, LeatherWorking, LegendaryWeaponsmithing, LockSmith, Masonry, MasterArmorsmithing, MasterBaking, MasterCooking, MasterCostuming, MasterDistilling, MasterDyeing, MasterFoodPrep, MasterHerbology, MasterLacquerring, MasterLeatherWorking, MasterMycology, MasterPaintingSkill, MasterTailoring, MasterWeaponsmithing, Mycology, Painting, PaintingSkill, Paladin_CraftHolyAvenger, Paladin_CraftUnholyReaver, PaperMaking, Pottery, Rodsmithing, ScrimShaw, ScrollScribing, Sculpting, Shipwright, Siegecraft, Smelting, SpellCraftingSkill, StaffMaking, Tailoring, Taxidermy, Textiling, Thief_MakeBomb, Thief_MinorTrap, Thief_Trap, Torturesmithing, Wainwrighting, WandMaking, Weaponsmithing, Weaving, Welding

public interface RecipeDriven
extends CMObject

A CMObject whose behavior is driven by 'recipes', or some data file formatted in a standard way.

See Also:

CMClass

Field Summary

Fields

Modifier and Type	Field	Description
static int	RCP_FINALNAME	Standard for all data drivens, where first field is the name
static int	RCP_LEVEL	Standard for all data drivens, where second field is the level, if applicable

Fields inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

idConverter

Method Summary

Modifier and Type	Method	Description
java.util.List<java.util.List<java.lang.String>>	fetchRecipes()	A list containing an entry for each recipe Each recipe is also a list of strings.
Pair<java.lang.String,java.lang.Integer>	getDecodedItemNameAndLevel(java.util.List<java.lang.String> recipe)	Given a raw recipe, returns the raw name and level of the ting built therefrom.
java.lang.String	getRecipeFilename()	A String naming the file where the recipes are found
java.lang.String	getRecipeFormat()	A String containing the format of each entry in the parameter file in a recipe.
java.util.List<java.lang.String>	matchingRecipeNames(java.lang.String recipeName, boolean beLoose)	Returns a vector containing an entry for each recipe whose name matches the given name.

Methods inherited from interface com.planet_ink.coffee_mud.core.interfaces.CMObject

copyOf, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Field Detail

RCP_FINALNAME

static final int RCP_FINALNAME

Standard for all data drivens, where first field is the name

See Also:

Constant Field Values

RCP_LEVEL

static final int RCP_LEVEL

Standard for all data drivens, where second field is the level, if applicable

See Also:

Constant Field Values

Method Detail

fetchRecipes

java.util.List<java.util.List<java.lang.String>> fetchRecipes()

A list containing an entry for each recipe Each recipe is also a list of strings.

Returns:

a vector of vectors

getRecipeFormat

java.lang.String getRecipeFormat()

A String containing the format of each entry in the parameter file in a recipe.

Returns:

a String showing the format of each entry in the parameter file

getRecipeFilename

java.lang.String getRecipeFilename()

A String naming the file where the recipes are found

Returns:

a String naming the file where the recipes are found

matchingRecipeNames

java.util.List<java.lang.String> matchingRecipeNames(java.lang.String recipeName,
                                                     boolean beLoose)

Returns a vector containing an entry for each recipe whose name matches the given name. Each entry is also a vector.

Parameters:

recipeName - the name of the recipe

beLoose - whether to be specific or "loose" with name matching

Returns:

a vector of vectors

getDecodedItemNameAndLevel

Pair<java.lang.String,java.lang.Integer> getDecodedItemNameAndLevel(java.util.List<java.lang.String> recipe)

Given a raw recipe, returns the raw name and level of the ting built therefrom.

Parameters:

recipe - the raw recipe description

Returns:

a descriptive pair