Package com.planet_ink.coffee_mud.Abilities.interfaces

Interface ItemCraftor

All Superinterfaces:

Ability, java.lang.Cloneable, CMObject, java.lang.Comparable<CMObject>, Contingent, CraftorAbility, Environmental, Expireable, Modifiable, MsgListener, RecipeDriven, StatsAffecting, Tickable

All Known Implementing Classes:

Alchemy, Apothecary, Armorsmithing, Baking, Blacksmithing, Boatwright, CageBuilding, CaravanBuilding, Carpentry, ClanCrafting, ClanShipwrighting, Cobbling, Cooking, Costuming, Distilling, DrugCutting, EnhancedCraftingSkill, Fletching, FoodPrep, GaolFood, GenCraftSkill, GenWrightSkill, GlassBlowing, Gunsmithing, Herbalism, ImprovedAlchemy, InstrumentMaking, JewelMaking, LeatherWorking, LegendaryWeaponsmithing, MasterArmorsmithing, MasterBaking, MasterCooking, MasterCostuming, MasterDistilling, MasterFoodPrep, MasterLeatherWorking, MasterTailoring, MasterWeaponsmithing, Paladin_CraftHolyAvenger, Paladin_CraftUnholyReaver, PaperMaking, Pottery, Rodsmithing, ScrimShaw, ScrollScribing, Sculpting, Shipwright, Siegecraft, Smelting, StaffMaking, Tailoring, Textiling, Torturesmithing, Wainwrighting, WandMaking, Weaponsmithing, Weaving

public interface ItemCraftor
extends CraftorAbility

This interface denotes an ability that also incidentally is capable of generating objects, usually items. This is probably a common skill, but one could imagine an itemcraftor also being a spell that generates its own items. Also the item generation is an incidental and internal aspect of the ability, these methods allow that functionality to be exposed for archon use.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	ItemCraftor.CraftedItem	For auto-crafting, this object represents an item, and (optionally) a key to go with it.
static class	ItemCraftor.CraftorType

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.CraftorAbility

CraftorAbility.CraftorFilter

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CRAFTING_BRAND_STR_ANON	The base unlocalized brand added to anonymously crafted items
static java.lang.String	CRAFTING_BRAND_STR_NAME	The base unlocalized brand added to named crafted items
static java.lang.String	CRAFTING_BRAND_STR_PREFIX	The base unlocalized brand added to crafted items

Fields inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

ACODE_CHANT, ACODE_COMMON_SKILL, ACODE_DESCS, ACODE_DESCS_, ACODE_DISEASE, ACODE_LANGUAGE, ACODE_POISON, ACODE_PRAYER, ACODE_PROPERTY, ACODE_SKILL, ACODE_SONG, ACODE_SPELL, ACODE_SUPERPOWER, ACODE_TECH, ACODE_THIEF_SKILL, ACODE_TRAP, ALL_ACODES, ALL_DOMAINS, CACHEINDEX_CLASSLESS, CACHEINDEX_EXPERTISE, CACHEINDEX_LASTTIME, CACHEINDEX_NORMAL, CACHEINDEX_TOTAL, CAN_AREAS, CAN_DESCS, CAN_EXITS, CAN_ITEMS, CAN_MOBS, CAN_ROOMS, COST_ALL, COST_NORMAL, COST_PCT, DOMAIN_ABJURATION, DOMAIN_ACROBATIC, DOMAIN_ALERT, DOMAIN_ALTERATION, DOMAIN_ANATOMY, DOMAIN_ANIMALAFFINITY, DOMAIN_ARCANELORE, DOMAIN_ARCHON, DOMAIN_ARMORUSE, DOMAIN_ARTISTIC, DOMAIN_BINDING, DOMAIN_BLESSING, DOMAIN_BREEDING, DOMAIN_BUILDINGSKILL, DOMAIN_CALLIGRAPHY, DOMAIN_COMBATFLUIDITY, DOMAIN_COMBATLORE, DOMAIN_COMMUNING, DOMAIN_CONJURATION, DOMAIN_CORRUPTION, DOMAIN_COSMOLOGY, DOMAIN_CRAFTINGSKILL, DOMAIN_CREATION, DOMAIN_CRIMINAL, DOMAIN_CURSING, DOMAIN_DANCING, DOMAIN_DEATHLORE, DOMAIN_DECEPTIVE, DOMAIN_DEEPMAGIC, DOMAIN_DESCS, DOMAIN_DETRAP, DOMAIN_DIRTYFIGHTING, DOMAIN_DIVINATION, DOMAIN_EDUCATIONLORE, DOMAIN_ENCHANTMENT, DOMAIN_ENDURING, DOMAIN_EPICUREAN, DOMAIN_EVANGELISM, DOMAIN_EVASIVE, DOMAIN_EVOCATION, DOMAIN_FITNESS, DOMAIN_FOOLISHNESS, DOMAIN_GATHERINGSKILL, DOMAIN_GRAPPLING, DOMAIN_HEALING, DOMAIN_HOLYPROTECTION, DOMAIN_ILLUSION, DOMAIN_INFLUENTIAL, DOMAIN_KICKING, DOMAIN_LEGAL, DOMAIN_MARTIALLORE, DOMAIN_MOONALTERING, DOMAIN_MOONSUMMONING, DOMAIN_NATURELORE, DOMAIN_NEUTRALIZATION, DOMAIN_PLANTCONTROL, DOMAIN_PLANTGROWTH, DOMAIN_PLAYING, DOMAIN_POISONING, DOMAIN_PRESERVING, DOMAIN_PUNCHING, DOMAIN_RACIALABILITY, DOMAIN_RESTORATION, DOMAIN_ROCKCONTROL, DOMAIN_ROPEUSE, DOMAIN_SEATRAVEL, DOMAIN_SHAPE_SHIFTING, DOMAIN_SHIELDUSE, DOMAIN_SINGING, DOMAIN_STEALING, DOMAIN_STEALTHY, DOMAIN_STREETSMARTS, DOMAIN_THEATRE, DOMAIN_TRANSMUTATION, DOMAIN_TRAPPING, DOMAIN_TRAVEL, DOMAIN_VERBS, DOMAIN_VEXING, DOMAIN_WARDING, DOMAIN_WATERCONTROL, DOMAIN_WATERLORE, DOMAIN_WEAPON_USE, DOMAIN_WEATHER_MASTERY, FLAG_ADJUSTER, FLAG_AGGROFYING, FLAG_AIRBASED, FLAG_BINDING, FLAG_CASTER, FLAG_CHAOS, FLAG_CHARMING, FLAG_CLANMAGIC, FLAG_DESCS, FLAG_EARTHBASED, FLAG_ELECTRICBASED, FLAG_ENABLER, FLAG_FEARING, FLAG_FIREBASED, FLAG_HEALINGMAGIC, FLAG_HEATING, FLAG_HOLY, FLAG_IMMUNER, FLAG_INTOXICATING, FLAG_LAW, FLAG_MINDALTERING, FLAG_MODERATE, FLAG_MOVING, FLAG_NEUTRAL, FLAG_NODISENCHANT, FLAG_NONENCHANTMENT, FLAG_NOORDERING, FLAG_NOUNINVOKING, FLAG_PARALYZING, FLAG_POTENTIALLY_DEADLY, FLAG_RESISTER, FLAG_STEALING, FLAG_SUMMONING, FLAG_SUNSUMMONING, FLAG_TIDEALTERING, FLAG_TORTURING, FLAG_TRACKING, FLAG_TRANSPORTING, FLAG_UNCRAFTABLE, FLAG_UNHOLY, FLAG_WATERBASED, FLAG_WEATHERAFFECTING, FLAG_ZAPPER, POWER_COST_THRESHOLD, POWER_LEVEL_THRESHOLD, POWER_OVERRIDE_THRESHOLD, QUALITY_BENEFICIAL_OTHERS, QUALITY_BENEFICIAL_SELF, QUALITY_DESCS, QUALITY_INDIFFERENT, QUALITY_MALICIOUS, QUALITY_OK_OTHERS, QUALITY_OK_SELF, RANGE_CHOICES, TICKS_ALMOST_FOREVER, TICKS_FOREVER, USAGE_DESCS, USAGE_HITPOINTS, USAGE_MANA, USAGE_MOVEMENT, USAGE_NADA, USAGEINDEX_COUNT, USAGEINDEX_HITPOINTS, USAGEINDEX_MANA, USAGEINDEX_MOVEMENT, USAGEINDEX_TIMELSW, USAGEINDEX_TOTAL

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

idConverter

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

RCP_FINALNAME, RCP_LEVEL

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

STATUS_AFFECT, STATUS_ALIVE, STATUS_BEHAVIOR, STATUS_CLASS, STATUS_DEAD, STATUS_END, STATUS_FIGHT, STATUS_MISC, STATUS_MISC2, STATUS_MISC3, STATUS_MISC4, STATUS_MISC5, STATUS_MISC6, STATUS_MISC7, STATUS_NOT, STATUS_OTHER, STATUS_RACE, STATUS_REBIRTH, STATUS_SCRIPT, STATUS_START, STATUS_WEATHER, TICKID_AREA, TICKID_BALLISTICK, TICKID_CLAN, TICKID_CLANITEM, TICKID_DEADBODY_DECAY, TICKID_ELECTRONICS, TICKID_EMAIL, TICKID_EVENT, TICKID_EXIT_BEHAVIOR, TICKID_EXIT_REOPEN, TICKID_ITEM_BEHAVIOR, TICKID_ITEM_BOUNCEBACK, TICKID_LIGHT_FLICKERS, TICKID_LIVEAUCTION, TICKID_LONGERMASK, TICKID_MISCELLANEOUS, TICKID_MOB, TICKID_PROPERTY_SPECIAL, TICKID_QUEST, TICKID_READYTOSTOP, TICKID_ROOM_BEHAVIOR, TICKID_ROOM_ITEM_REJUV, TICKID_SHORTERMASK, TICKID_SOLITARYMASK, TICKID_SPECIALCOMBAT, TICKID_SPECIALMANEUVER, TICKID_SPELL_AFFECT, TICKID_SUPPORT, TICKID_TIMEAUCTION, TICKID_TRAP_DESTRUCTION, TICKID_TRAP_RESET

Method Summary

Modifier and Type	Method	Description
java.util.List<ItemCraftor.CraftedItem>	craftAllItemSets(boolean forceLevels)	Crafts every item of a type supported by this class of every supported material.
java.util.List<ItemCraftor.CraftedItem>	craftAllItemSets(int material, boolean forceLevels)	Crafts every item of a type supported by this class of the given resource code.
ItemCraftor.CraftedItem	craftAnyItem(int material)	Crafts a random item of a type supported by this class of the given resource code.
ItemCraftor.CraftedItem	craftAnyItemNearLevel(int minlevel, int maxlevel)	Crafts a random item of a type supported by this class of a random resource code but within the given level range.
ItemCraftor.CraftedItem	craftItem(java.lang.String recipeName)	Crafts the item specified by the recipe name, of a supported material type which this class can produce.
ItemCraftor.CraftedItem	craftItem(java.lang.String recipeName, int material, boolean forceLevels, boolean noSafety)	Crafts the item specified by the recipe name, of the specified material type which this class can produce or -1 for any material.
int[]	getCraftableLevelRange()	Returns the level range of the items craftable by this skill.
ItemCraftor.CraftorType	getCraftorType()	Returns the general craftor type of this skill, to let outside subsystems know what they might expect.
double	getItemWeightMultiplier(boolean bundling)	Returns the ratio of the weight of material used to make an item with this skill versus the item weight when finished
boolean	mayICraft(Item I)	Returns whether the given item could have been crafted by this skill.
boolean	supportsDeconstruction()	Returns true if mundane items can be demonstructed into recipes with this skill.

Methods inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.Ability

abilityCode, abstractQuality, accountForYourself, adjustedLevel, affecting, appropriateToMyFactions, autoInvocation, bubbleAffect, canAffect, canAffect, canBeLearnedBy, canBePracticedBy, canBeTaughtBy, canBeUninvoked, canTarget, canTarget, castingQuality, castingTime, checkedCastingCost, classificationCode, combatCastingTime, enchantQuality, externalFiles, flags, getTrainingCost, helpProficiency, invoke, invoke, invoker, isAutoInvoked, isNowAnAutoEffect, makeLongLasting, makeNonUninvokable, mayBeEnchanted, practice, preInvoke, proficiency, proficiencyCheck, putInCommandlist, requirements, setAbilityCode, setAffectedOne, setInvoker, setProficiency, startTickDown, teach, triggerStrings, unInvoke, unlearn, usageCost, usageType

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

copyOf, ID, initializeClass, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

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

amDestroyed, destroy, isSavable, setSavable

Methods inherited from interface com.planet_ink.coffee_mud.Abilities.interfaces.CraftorAbility

fetchMyRecipes, getDecodedComponentsDescription, myResources

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

description, displayText, image, isGeneric, L, maxRange, minRange, miscTextFormat, Name, rawImage, sameAs, setDescription, setDisplayText, setImage, setMiscText, setName, text

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

expirationDate, setExpirationDate

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

getSaveStatIndex, getStat, getStatCodes, isStat, setStat

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

executeMsg, okMessage

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

fetchRecipes, getDecodedItemNameAndLevel, getRecipeFilename, getRecipeFormat, matchingRecipeNames

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

affectCharState, affectCharStats, affectPhyStats

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

getTickStatus, name, tick

Field Detail

CRAFTING_BRAND_STR_PREFIX

static final java.lang.String CRAFTING_BRAND_STR_PREFIX

The base unlocalized brand added to crafted items

See Also:

Constant Field Values

CRAFTING_BRAND_STR_ANON

static final java.lang.String CRAFTING_BRAND_STR_ANON

The base unlocalized brand added to anonymously crafted items

See Also:

Constant Field Values

CRAFTING_BRAND_STR_NAME

static final java.lang.String CRAFTING_BRAND_STR_NAME

The base unlocalized brand added to named crafted items

See Also:

Constant Field Values

Method Detail

getCraftorType

ItemCraftor.CraftorType getCraftorType()

Returns the general craftor type of this skill, to let outside subsystems know what they might expect.

Returns:

the craftor type

See Also:

ItemCraftor.CraftorType

craftAnyItem

ItemCraftor.CraftedItem craftAnyItem(int material)

Crafts a random item of a type supported by this class of the given resource code. Returns a pair containing the finished Item. A second element is rare, but will occur when a key is required and also generated.

Parameters:

material - the rawmaterial code to make the item out of

Returns:

an item pair

craftAnyItemNearLevel

ItemCraftor.CraftedItem craftAnyItemNearLevel(int minlevel,
                                              int maxlevel)

Crafts a random item of a type supported by this class of a random resource code but within the given level range. Returns a item pair containing the finished Item. A second element is rare, but will occur when a key is required and also generated.

Parameters:

minlevel - the min level to try to match

maxlevel - the max level to try to match

Returns:

an item pair

getCraftableLevelRange

int[] getCraftableLevelRange()

Returns the level range of the items craftable by this skill.

Returns:

the level range of the items craftable by this skill.

craftAllItemSets

java.util.List<ItemCraftor.CraftedItem> craftAllItemSets(int material,
                                                         boolean forceLevels)

Crafts every item of a type supported by this class of the given resource code. Each finished item is represented as a vector in the returned vector. The item vector usually only contains the finished item, but a second element will occur when a key is required and also generated.

Parameters:

material - the rawmaterial code to make the item out of

forceLevels - forces crafted item to have a level if it otherwise doesn't

Returns:

a vector of vectors of item(s)

craftAllItemSets

java.util.List<ItemCraftor.CraftedItem> craftAllItemSets(boolean forceLevels)

Crafts every item of a type supported by this class of every supported material. Each finished item is represented as a vector in the returned vector. The item vector usually only contains the finished item, but a second element will occur when a key is required and also generated.

Parameters:

forceLevels - forces crafted item to have a level if it otherwise doesn't

Returns:

a vector of vectors of item vector(s)

craftItem

ItemCraftor.CraftedItem craftItem(java.lang.String recipeName)

Crafts the item specified by the recipe name, of a supported material type which this class can produce. Returns a vector containing the finished Item. A second element is rare, but will occur when a key is required and also generated.

Parameters:

recipeName - the name of the item to make

Returns:

a vector of Item(s)

craftItem

ItemCraftor.CraftedItem craftItem(java.lang.String recipeName,
                                  int material,
                                  boolean forceLevels,
                                  boolean noSafety)

Crafts the item specified by the recipe name, of the specified material type which this class can produce or -1 for any material. Returns a vector containing the finished Item. A second element is rare, but will occur when a key is required and also generated.

Parameters:

recipeName - the name of the item to make

material - the rawmaterial code to make the item out of, or -1

forceLevels - forces crafted item to have a level if it otherwise doesn't

noSafety - whether normal safeguards against creating broken items are overridden

Returns:

a vector of Item(s)

mayICraft

boolean mayICraft(Item I)

Returns whether the given item could have been crafted by this skill.

Parameters:

I - the item to examine

Returns:

true if the item is consistent with this crafting, or false otherwise

supportsDeconstruction

boolean supportsDeconstruction()

Returns true if mundane items can be demonstructed into recipes with this skill.

Returns:

true if mundane items can be demonstructed into recipes with this skill.

getItemWeightMultiplier

double getItemWeightMultiplier(boolean bundling)

Returns the ratio of the weight of material used to make an item with this skill versus the item weight when finished

Parameters:

bundling - true if the item being created is just a raw resource bundle

Returns:

the ratio of the weight of material used to make an item with this