Package com.planet_ink.coffee_mud.Libraries

Class RawCMaterial

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.RawCMaterial

All Implemented Interfaces:

CMObject, Tickable, CMLibrary, MaterialLibrary, java.lang.Cloneable, java.lang.Comparable<CMObject>

public class RawCMaterial
extends StdLibrary
implements MaterialLibrary

Nested Class Summary

Nested classes/interfaces inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.MaterialLibrary

MaterialLibrary.DeadResourceRecord

Field Summary

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

idConverter

Fields inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

isDebugging, name, serviceClient, tickStatus

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

Constructor Summary

Constructors

Constructor	Description
RawCMaterial()

Method Summary

Modifier and Type	Method	Description
void	addEffectsToResource(Item I)	Given a raw material resource, this method will query for the natural effects/properties of that resource type, and add them to the given item.
void	adjustResourceName(Item I)	Given a raw material resource item with particular resource and subType and weight/amount, this method will set its name and display text as appropriate.
MaterialLibrary.DeadResourceRecord	destroyResources(Room R, int howMuch, int finalMaterial, int finalSubHash, int otherMaterial, int otherSubHash)	Searches the given room for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns all kinds of statistics about what was destroyed in the form of a DeadResourceRecord
protected MaterialLibrary.DeadResourceRecord	destroyResources(java.util.List<Item> V, int howMuch, int finalMaterial, int otherMaterial, Item never, Container C, RawMaterial firstMaterialI, RawMaterial otherMaterialI)
int	destroyResourcesAmt(Room E, int howMuch, int finalMaterial, java.lang.String subType, Container C)	Searches the given room for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns the amount destroyed.
int	destroyResourcesAmt(MOB E, int howMuch, int finalMaterial, java.lang.String subType, Container C)	Searches the given mob for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns the amount destroyed.
int	destroyResourcesAmt(java.util.List<Item> V, int howMuch, int resourceCode, java.lang.String subType, Container C)	Searches the given mob for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns the amount destroyed.
int	destroyResourcesValue(Room E, int howMuch, int finalMaterial, int finalSubHash, int otherMaterial, int otherSubHash)	Searches the given room for an amount of specified qualifying resource items in the given list and in NO container, destroys that many pounds of the resource, and then returns the value of what was destroyed.
int	destroyResourcesValue(MOB E, int howMuch, int finalMaterial, int finalSubHash, int otherMaterial, int otherSubHash)	Searches the given mob for an amount of specified qualifying resource items in the given list and in NO container, destroys that many pounds of the resource, and then returns the value of what was destroyed.
int	destroyResourcesValue(java.util.List<Item> V, int howMuch, int finalMaterial, int otherMaterial, Item never, Container C)	Searches the given list for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns the value of what was destroyed.
protected java.util.List<Item>	disBundle(Item I, int number, int bundleSize, Container C)
RawMaterial	fetchFoundOtherEncoded(Room E, java.lang.String otherRequired)	Searches the given room for specified qualifying resource items.
RawMaterial	fetchFoundOtherEncoded(MOB E, java.lang.String otherRequired)	Searches the given mob for specified qualifying resource items.
protected RawMaterial	fetchFoundOtherEncoded(java.util.List<Item> V, java.lang.String otherRequired)
RawMaterial	findFirstResource(Room E, int resource)	Searches the given Room for the first qualifying raw material resource item that matches the given resource code number.
RawMaterial	findFirstResource(Room E, java.lang.String other)	Searches the given Room for the first qualifying raw material resource item that matches the given resource name, with optional subtype in parenthesis.
RawMaterial	findFirstResource(MOB E, int resource)	Searches the given MOB for the first qualifying raw material resource item that matches the given resource code number.
RawMaterial	findFirstResource(MOB E, java.lang.String other)	Searches the given MOB for the first qualifying raw material resource item that matches the given resource name, with optional subtype in parenthesis.
protected RawMaterial	findFirstResource(java.util.List<Item> V, int resource, Container C, java.lang.String subType)
RawMaterial	findFirstResource(java.util.List<Item> V, java.lang.String other)
int	findMaterialCode(java.lang.String s, boolean exact)	Searches for the given material type, and, if found, returns the material code.
int	findMaterialRelativeInt(java.lang.String s)	Searches for the given material type, and, if found, returns the ordinal value of the material code.
RawMaterial	findMostOfMaterial(Room E, int material)	Searches the given Room for the largest pile of qualifying raw material resource item that matches the given material type code number.
RawMaterial	findMostOfMaterial(Room E, java.lang.String other)	Searches the given Room for the largest pile of qualifying raw material resource item that matches the given material type name, with optional subtype in parenthesis.
RawMaterial	findMostOfMaterial(MOB E, int material)	Searches the given MOB for the largest pile of qualifying raw material resource item that matches the given material type code number.
RawMaterial	findMostOfMaterial(MOB E, java.lang.String other)	Searches the given MOB for the largest pile of qualifying raw material resource item that matches the given material type name, with optional subtype in parenthesis.
protected RawMaterial	findMostOfMaterial(java.util.List<Item> V, int material, java.lang.String subType)
protected RawMaterial	findMostOfMaterial(java.util.List<Item> V, java.lang.String other)
protected RawMaterial	findMostResource(java.util.List<Item> V, int resource, Container C)
protected int	findNumberOfResource(java.util.List<Item> V, int startAt, RawMaterial resource)
int	findNumberOfResourceLike(Room E, RawMaterial resource)	Searches the given room for all raw material resource items that have the same material type and subtype as the given raw material resource item, and returns the total amount of similar resources.
int	findNumberOfResourceLike(MOB E, RawMaterial resource)	Searches the given mob for all raw material resource items that have the same material type and subtype as the given raw material resource item, and returns the total amount of similar resources.
int	findResourceCode(java.lang.String s, boolean exact)	Searches for the given resource code by name, and, if found, returns the resource code.
protected java.util.List<Item>	getAllItems(ItemPossessor P)
protected java.util.List<Item>	getAllRawMaterial(Room R, int material1, int material2)
protected java.util.List<Item>	getAllRawMaterial(MOB M, int material1, int material2)
int	getBurnDuration(Environmental E)	Returns the number of ticks that the given item, whatever will burn, or 0 if it won't burn.
java.lang.String	getGeneralItemType(Item I)	Returns a plural for the type of item given.
java.lang.String	getMaterialDesc(int materialCode)	Returns the name of the given material type code
int	getRandomResourceOfMaterial(int material)	Returns a random resource code of the given material type
java.lang.String	getResourceDesc(int resourceCode)	Returns the name of the given resource type code
protected java.util.List<Item>	getSomeRawMaterial(Room R, int material1, int subTypeHash1, int material2, int subTypeHash2)
protected java.util.List<Item>	getSomeRawMaterial(MOB M, int material1, int subTypeHash1, int material2, int subTypeHash2)
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	isResourceCodeRoomMapped(int resourceCode)	Searches through all the locale/room classes to discover whether the given resource code appears in any of them as a possible resource.
Item	makeItemResource(int type)	Creates a resource item of one pound.
Item	makeItemResource(int type, java.lang.String subType)	Creates a resource item of one pound.
protected Item	makeItemResource(int myResource, java.lang.String localeCode, boolean noAnimals, java.lang.String fullName, java.lang.String subType)
protected MOB	makeMOBResource(int myResource)
PhysicalAgent	makeResource(int myResource, java.lang.String localeCode, boolean noAnimals, java.lang.String fullName, java.lang.String subType)	Creates a resource item, or possibly a mob that represents the resource.
java.lang.String	makeResourceBetterName(int rscCode, java.lang.String subType, boolean plural)	Returns an appropriate name for an raw material item of the given resource and subtype.
java.lang.String	makeResourceSimpleName(int rscCode, java.lang.String subType)	Returns a simplistic name for a raw material item of the given resource and subtype.
boolean	quickDestroy(Item I)	Removes the given item from its possessor, and then calls destroy on the item.
boolean	rebundle(Item item)	This great workhorse takes a given raw resource item and finds any pairings in its new possessor, and, if found, re-bundles with the existing item, and renames it.
Item	splitBundle(Item I, int size, Container C)	Given a bundle (more than weight 1) raw resource item, this method will split the item into two parts, one part of the given size, which is returned, and the other being what remains of I.
Item	unbundle(Item I, int number, Container C)	Given a bundle (more than weight 1) raw resource item, this method will split the item into the given number of parts, each being 1 pound.

Methods inherited from interface com.planet_ink.coffee_mud.Libraries.interfaces.CMLibrary

activate, getServiceClient, L, propertiesLoaded, shutdown

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

copyOf, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from class com.planet_ink.coffee_mud.Libraries.StdLibrary

activate, checkDatabase, compareTo, copyOf, getServiceClient, getTickStatus, initializeClass, L, name, newInstance, propertiesLoaded, setThreadStatus, shutdown, tick

Constructor Detail

RawCMaterial

public RawCMaterial()

Method Detail

ID

public java.lang.String ID()

Description copied from interface: CMObject

The CoffeeMud Java Class ID shared by all instances of this object. Unlike the Java Class name, this method does not include package information. However, it must return a String value unique to its class category in the ClassLoader. Class categories include Libraries, Common, Areas, Abilities, Behaviors, CharClasses, Commands, Exits Locales, MOBS, Races, WebMacros, Basic Items, Armor, Weapons, ClanItems, Tech. The name is typically identical to the class name.

Specified by:

ID in interface CMObject

Overrides:

ID in class StdLibrary

Returns:

the name of this class

getRandomResourceOfMaterial

public int getRandomResourceOfMaterial(int material)

Description copied from interface: MaterialLibrary

Returns a random resource code of the given material type

Specified by:

getRandomResourceOfMaterial in interface MaterialLibrary

Parameters:

material - the material type code

Returns:

a random resource code of that material

quickDestroy

public boolean quickDestroy(Item I)

Description copied from interface: MaterialLibrary

Removes the given item from its possessor, and then calls destroy on the item. By removing it first, it shortcuts some of the more thorough processes that standard item destroy goes through, including recovery of stats.

Specified by:

quickDestroy in interface MaterialLibrary

Parameters:

I - null, or an item to destroy

Returns:

true if it was destroyed, or false if null

rebundle

public boolean rebundle(Item item)

Description copied from interface: MaterialLibrary

This great workhorse takes a given raw resource item and finds any pairings in its new possessor, and, if found, re-bundles with the existing item, and renames it. The passed item is then destroyed.

Specified by:

rebundle in interface MaterialLibrary

Parameters:

item - the raw material item to rebundle

Returns:

true if the rebundle happened, false otherwise

See Also:

MaterialLibrary.unbundle(Item, int, Container), MaterialLibrary.rebundle(Item), MaterialLibrary.splitBundle(Item, int, Container)

splitBundle

public Item splitBundle(Item I,
                        int size,
                        Container C)

Description copied from interface: MaterialLibrary

Given a bundle (more than weight 1) raw resource item, this method will split the item into two parts, one part of the given size, which is returned, and the other being what remains of I. The container of the item is also required, for some reason.

Specified by:

splitBundle in interface MaterialLibrary

Parameters:

I - the bundled item

size - the amount of the bundle to split out

C - the container I is in, and which the split goes into

Returns:

null, or the split out resource

See Also:

MaterialLibrary.unbundle(Item, int, Container)

unbundle

public Item unbundle(Item I,
                     int number,
                     Container C)

Description copied from interface: MaterialLibrary

Given a bundle (more than weight 1) raw resource item, this method will split the item into the given number of parts, each being 1 pound. One of those is then returned. The container of the item is also required, for some reason.

Specified by:

unbundle in interface MaterialLibrary

Parameters:

I - the resource bundle to split up

number - the number of 1 pounders to remove

C - the container of the bundle and the 1 pounders

Returns:

the first one pounder

See Also:

MaterialLibrary.splitBundle(Item, int, Container)

disBundle

protected java.util.List<Item> disBundle(Item I,
                                         int number,
                                         int bundleSize,
                                         Container C)

getMaterialDesc

public java.lang.String getMaterialDesc(int materialCode)

Description copied from interface: MaterialLibrary

Returns the name of the given material type code

Specified by:

getMaterialDesc in interface MaterialLibrary

Parameters:

materialCode - the material type code

Returns:

the name of the material type code

See Also:

MaterialLibrary.getResourceDesc(int)

getResourceDesc

public java.lang.String getResourceDesc(int resourceCode)

Description copied from interface: MaterialLibrary

Returns the name of the given resource type code

Specified by:

getResourceDesc in interface MaterialLibrary

Parameters:

resourceCode - the given resource type code

Returns:

the name of the given resource type code

See Also:

MaterialLibrary.getMaterialDesc(int)

findMaterialRelativeInt

public int findMaterialRelativeInt(java.lang.String s)

Description copied from interface: MaterialLibrary

Searches for the given material type, and, if found, returns the ordinal value of the material code.

Specified by:

findMaterialRelativeInt in interface MaterialLibrary

Parameters:

s - the possible material type

Returns:

the ordinal value of the material

See Also:

MaterialLibrary.findMaterialCode(String, boolean), MaterialLibrary.findResourceCode(String, boolean)

findMaterialCode

public int findMaterialCode(java.lang.String s,
                            boolean exact)

Description copied from interface: MaterialLibrary

Searches for the given material type, and, if found, returns the material code.

Specified by:

findMaterialCode in interface MaterialLibrary

Parameters:

s - the possible material type

exact - true for exact match only, false for startswith

Returns:

the material code

See Also:

MaterialLibrary.findResourceCode(String, boolean), MaterialLibrary.findMaterialRelativeInt(String)

findResourceCode

public int findResourceCode(java.lang.String s,
                            boolean exact)

Description copied from interface: MaterialLibrary

Searches for the given resource code by name, and, if found, returns the resource code.

Specified by:

findResourceCode in interface MaterialLibrary

Parameters:

s - the possible resource codes name

exact - true for exact match only, false for startswith

Returns:

the resource code

See Also:

MaterialLibrary.findMaterialCode(String, boolean), MaterialLibrary.findMaterialRelativeInt(String)

addEffectsToResource

public void addEffectsToResource(Item I)

Description copied from interface: MaterialLibrary

Given a raw material resource, this method will query for the natural effects/properties of that resource type, and add them to the given item.

Specified by:

addEffectsToResource in interface MaterialLibrary

Parameters:

I - the raw material item

makeMOBResource

protected MOB makeMOBResource(int myResource)

makeItemResource

protected Item makeItemResource(int myResource,
                                java.lang.String localeCode,
                                boolean noAnimals,
                                java.lang.String fullName,
                                java.lang.String subType)

makeResource

public PhysicalAgent makeResource(int myResource,
                                  java.lang.String localeCode,
                                  boolean noAnimals,
                                  java.lang.String fullName,
                                  java.lang.String subType)

Description copied from interface: MaterialLibrary

Creates a resource item, or possibly a mob that represents the resource.

Specified by:

makeResource in interface MaterialLibrary

Parameters:

myResource - the full resource code

localeCode - null, the string representation of the rooms domain type source

noAnimals - true to only return items, false to possibly return a mob

fullName - null, or the secret identity name

subType - null, "", or the resource subType

Returns:

the resource item or mob, created from scratch

See Also:

MaterialLibrary.makeItemResource(int), MaterialLibrary.makeItemResource(int, String)

getGeneralItemType

public java.lang.String getGeneralItemType(Item I)

Description copied from interface: MaterialLibrary

Returns a plural for the type of item given. For raw resources, it returns the material name.

Specified by:

getGeneralItemType in interface MaterialLibrary

Parameters:

I - the item to get the general type of

Returns:

the general type of the item

makeResourceBetterName

public java.lang.String makeResourceBetterName(int rscCode,
                                               java.lang.String subType,
                                               boolean plural)

Description copied from interface: MaterialLibrary

Returns an appropriate name for an raw material item of the given resource and subtype. Differentiates between ores and cloth bolts and liquid pools, which is why it is a "better" name.

Specified by:

makeResourceBetterName in interface MaterialLibrary

Parameters:

rscCode - the resource code

subType - null, "" or the subType

plural - true to make the name plural (more than 1), or false singular

Returns:

the better resource item name

See Also:

MaterialLibrary.makeResourceSimpleName(int, String), MaterialLibrary.adjustResourceName(Item)

makeResourceSimpleName

public java.lang.String makeResourceSimpleName(int rscCode,
                                               java.lang.String subType)

Description copied from interface: MaterialLibrary

Returns a simplistic name for a raw material item of the given resource and subtype. The name is always broad, like "iron ore".

Specified by:

makeResourceSimpleName in interface MaterialLibrary

Parameters:

rscCode - the resource code

subType - "", null, or a subType

Returns:

a broad name for the resource

See Also:

MaterialLibrary.makeResourceBetterName(int, String, boolean), MaterialLibrary.adjustResourceName(Item)

adjustResourceName

public void adjustResourceName(Item I)

Description copied from interface: MaterialLibrary

Given a raw material resource item with particular resource and subType and weight/amount, this method will set its name and display text as appropriate.

Specified by:

adjustResourceName in interface MaterialLibrary

Parameters:

I - the raw material item to name

See Also:

MaterialLibrary.makeResourceBetterName(int, String, boolean), MaterialLibrary.makeResourceSimpleName(int, String)

makeItemResource

public Item makeItemResource(int type)

Description copied from interface: MaterialLibrary

Creates a resource item of one pound.

Specified by:

makeItemResource in interface MaterialLibrary

Parameters:

type - the resource code

Returns:

the newly created resource item

See Also:

MaterialLibrary.makeItemResource(int, String), MaterialLibrary.makeResource(int, String, boolean, String, String)

makeItemResource

public Item makeItemResource(int type,
                             java.lang.String subType)

Description copied from interface: MaterialLibrary

Creates a resource item of one pound.

Specified by:

makeItemResource in interface MaterialLibrary

Parameters:

type - the resource code

subType - "" or the subType of the resource

Returns:

the newly created resource item

See Also:

MaterialLibrary.makeItemResource(int), MaterialLibrary.makeResource(int, String, boolean, String, String)

destroyResourcesAmt

public int destroyResourcesAmt(MOB E,
                               int howMuch,
                               int finalMaterial,
                               java.lang.String subType,
                               Container C)

Description copied from interface: MaterialLibrary

Searches the given mob for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns the amount destroyed.

Specified by:

destroyResourcesAmt in interface MaterialLibrary

Parameters:

E - the possessor of raw material resource items

howMuch - the amount to destroy, in weight

finalMaterial - the resource code of the material to destroy

subType - null, "", or the sub type of the resource

C - the container in which the items must be found

Returns:

the amount destroyed

See Also:

MaterialLibrary.destroyResourcesAmt(List, int, int, String, Container), MaterialLibrary.destroyResourcesAmt(Room, int, int, String, Container), MaterialLibrary.destroyResourcesValue(List, int, int, int, Item, Container), MaterialLibrary.destroyResources(Room, int, int, int, int, int)

destroyResourcesAmt

public int destroyResourcesAmt(Room E,
                               int howMuch,
                               int finalMaterial,
                               java.lang.String subType,
                               Container C)

Description copied from interface: MaterialLibrary

Searches the given room for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns the amount destroyed.

Specified by:

destroyResourcesAmt in interface MaterialLibrary

Parameters:

E - the possessor of raw material resource items

howMuch - the amount to destroy, in weight

finalMaterial - the resource code of the material to destroy

subType - null, "", or the sub type of the resource

C - the container in which the items must be found

Returns:

the amount destroyed

See Also:

MaterialLibrary.destroyResourcesAmt(List, int, int, String, Container), MaterialLibrary.destroyResourcesAmt(MOB, int, int, String, Container), MaterialLibrary.destroyResourcesValue(List, int, int, int, Item, Container), MaterialLibrary.destroyResources(Room, int, int, int, int, int)

destroyResourcesAmt

public int destroyResourcesAmt(java.util.List<Item> V,
                               int howMuch,
                               int resourceCode,
                               java.lang.String subType,
                               Container C)

Description copied from interface: MaterialLibrary

Searches the given mob for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns the amount destroyed.

Specified by:

destroyResourcesAmt in interface MaterialLibrary

Parameters:

V - the list of raw material resource items

howMuch - the amount to destroy, in weight

resourceCode - the resource code of the material to destroy

subType - null, "", or the sub type of the resource

C - the container in which the items must be found

Returns:

the amount destroyed

See Also:

MaterialLibrary.destroyResourcesAmt(MOB, int, int, String, Container), MaterialLibrary.destroyResourcesAmt(Room, int, int, String, Container), MaterialLibrary.destroyResourcesValue(List, int, int, int, Item, Container), MaterialLibrary.destroyResources(Room, int, int, int, int, int)

destroyResourcesValue

public int destroyResourcesValue(Room E,
                                 int howMuch,
                                 int finalMaterial,
                                 int finalSubHash,
                                 int otherMaterial,
                                 int otherSubHash)

Description copied from interface: MaterialLibrary

Searches the given room for an amount of specified qualifying resource items in the given list and in NO container, destroys that many pounds of the resource, and then returns the value of what was destroyed.

Specified by:

destroyResourcesValue in interface MaterialLibrary

Parameters:

E - the possessor of raw material resource items

howMuch - the amount to destroy, in weight

finalMaterial - the resource code of the material to destroy

finalSubHash - 0 or the hash of the subtype

otherMaterial - -1, 0, or the OTHER resource code of the material to destroy

otherSubHash - 0 or the hash of the subtype

Returns:

the value of what was destroyed

See Also:

MaterialLibrary.destroyResourcesValue(Room, int, int, int, int, int), MaterialLibrary.destroyResourcesValue(MOB, int, int, int, int, int), MaterialLibrary.destroyResourcesValue(List, int, int, int, Item, Container), MaterialLibrary.destroyResourcesAmt(List, int, int, String, Container), MaterialLibrary.destroyResources(Room, int, int, int, int, int)

destroyResourcesValue

public int destroyResourcesValue(MOB E,
                                 int howMuch,
                                 int finalMaterial,
                                 int finalSubHash,
                                 int otherMaterial,
                                 int otherSubHash)

Description copied from interface: MaterialLibrary

Searches the given mob for an amount of specified qualifying resource items in the given list and in NO container, destroys that many pounds of the resource, and then returns the value of what was destroyed.

Specified by:

destroyResourcesValue in interface MaterialLibrary

Parameters:

E - the possessor of raw material resource items

howMuch - the amount to destroy, in weight

finalMaterial - the resource code of the material to destroy

finalSubHash - 0 or the hash of the subtype

otherMaterial - -1, 0, or the OTHER resource code of the material to destroy

otherSubHash - 0 or the hash of the subtype

Returns:

the value of what was destroyed

See Also:

MaterialLibrary.destroyResourcesValue(Room, int, int, int, int, int), MaterialLibrary.destroyResourcesValue(MOB, int, int, int, int, int), MaterialLibrary.destroyResourcesValue(List, int, int, int, Item, Container), MaterialLibrary.destroyResourcesAmt(List, int, int, String, Container), MaterialLibrary.destroyResources(Room, int, int, int, int, int)

destroyResourcesValue

public int destroyResourcesValue(java.util.List<Item> V,
                                 int howMuch,
                                 int finalMaterial,
                                 int otherMaterial,
                                 Item never,
                                 Container C)

Description copied from interface: MaterialLibrary

Searches the given list for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns the value of what was destroyed.

Specified by:

destroyResourcesValue in interface MaterialLibrary

Parameters:

V - the list of raw material resource items

howMuch - the amount to destroy, in weight

finalMaterial - the resource code of the material to destroy

otherMaterial - -1, 0, or the OTHER resource code of the material to destroy

never - null, or a specific item to never destroy no matter what

C - the container in which the items must be found

Returns:

the value of what was destroyed

See Also:

MaterialLibrary.destroyResourcesValue(Room, int, int, int, int, int), MaterialLibrary.destroyResourcesValue(MOB, int, int, int, int, int), MaterialLibrary.destroyResourcesValue(List, int, int, int, Item, Container), MaterialLibrary.destroyResourcesAmt(List, int, int, String, Container), MaterialLibrary.destroyResources(Room, int, int, int, int, int)

destroyResources

public MaterialLibrary.DeadResourceRecord destroyResources(Room R,
                                                           int howMuch,
                                                           int finalMaterial,
                                                           int finalSubHash,
                                                           int otherMaterial,
                                                           int otherSubHash)

Description copied from interface: MaterialLibrary

Searches the given room for an amount of specified qualifying resource items in the given list and in the given container, destroys that many pounds of the resource, and then returns all kinds of statistics about what was destroyed in the form of a DeadResourceRecord

Specified by:

destroyResources in interface MaterialLibrary

Parameters:

R - the possessor of raw material resource items

howMuch - the amount to destroy, in weight

finalMaterial - the resource code of the material to destroy

finalSubHash - 0 or the hash of the subtype

otherMaterial - -1, 0, or the OTHER resource code of the material to destroy

otherSubHash - 0 or the hash of the subtype

Returns:

the dead resource record of statistics

See Also:

MaterialLibrary.DeadResourceRecord, MaterialLibrary.destroyResourcesValue(List, int, int, int, Item, Container), MaterialLibrary.destroyResourcesAmt(List, int, int, String, Container), MaterialLibrary.destroyResources(Room, int, int, int, int, int)

destroyResources

protected MaterialLibrary.DeadResourceRecord destroyResources(java.util.List<Item> V,
                                                              int howMuch,
                                                              int finalMaterial,
                                                              int otherMaterial,
                                                              Item never,
                                                              Container C,
                                                              RawMaterial firstMaterialI,
                                                              RawMaterial otherMaterialI)

findFirstResource

public RawMaterial findFirstResource(Room E,
                                     java.lang.String other)

Description copied from interface: MaterialLibrary

Searches the given Room for the first qualifying raw material resource item that matches the given resource name, with optional subtype in parenthesis.

Specified by:

findFirstResource in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

other - the resource name, with optional subtype in parenthesis

Returns:

null, or the first matching raw material item

See Also:

MaterialLibrary.findFirstResource(MOB, int), MaterialLibrary.findFirstResource(MOB, String), MaterialLibrary.findFirstResource(Room, int)

findFirstResource

public RawMaterial findFirstResource(MOB E,
                                     java.lang.String other)

Description copied from interface: MaterialLibrary

Searches the given MOB for the first qualifying raw material resource item that matches the given resource name, with optional subtype in parenthesis.

Specified by:

findFirstResource in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

other - the resource name, with optional subtype in parenthesis

Returns:

null, or the first matching raw material item

See Also:

MaterialLibrary.findFirstResource(MOB, int), MaterialLibrary.findFirstResource(Room, int), MaterialLibrary.findFirstResource(Room, String)

findFirstResource

public RawMaterial findFirstResource(java.util.List<Item> V,
                                     java.lang.String other)

findFirstResource

public RawMaterial findFirstResource(Room E,
                                     int resource)

Description copied from interface: MaterialLibrary

Searches the given Room for the first qualifying raw material resource item that matches the given resource code number.

Specified by:

findFirstResource in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

resource - the resource code number

Returns:

null, or the first matching raw material item

See Also:

MaterialLibrary.findFirstResource(MOB, int), MaterialLibrary.findFirstResource(MOB, String), MaterialLibrary.findFirstResource(Room, String)

findFirstResource

public RawMaterial findFirstResource(MOB E,
                                     int resource)

Description copied from interface: MaterialLibrary

Searches the given MOB for the first qualifying raw material resource item that matches the given resource code number.

Specified by:

findFirstResource in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

resource - the resource code number

Returns:

null, or the first matching raw material item

See Also:

MaterialLibrary.findFirstResource(MOB, String), MaterialLibrary.findFirstResource(Room, int), MaterialLibrary.findFirstResource(Room, String)

findFirstResource

protected RawMaterial findFirstResource(java.util.List<Item> V,
                                        int resource,
                                        Container C,
                                        java.lang.String subType)

findMostResource

protected RawMaterial findMostResource(java.util.List<Item> V,
                                       int resource,
                                       Container C)

findMostOfMaterial

public RawMaterial findMostOfMaterial(Room E,
                                      java.lang.String other)

Description copied from interface: MaterialLibrary

Searches the given Room for the largest pile of qualifying raw material resource item that matches the given material type name, with optional subtype in parenthesis. The items must not be in a container.

Specified by:

findMostOfMaterial in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

other - the material type name, with optional subtype in parenthesis

Returns:

null, or the largest matching raw material item

See Also:

MaterialLibrary.findMostOfMaterial(MOB, int), MaterialLibrary.findMostOfMaterial(MOB, String), MaterialLibrary.findMostOfMaterial(Room, int)

findMostOfMaterial

public RawMaterial findMostOfMaterial(MOB E,
                                      java.lang.String other)

Description copied from interface: MaterialLibrary

Searches the given MOB for the largest pile of qualifying raw material resource item that matches the given material type name, with optional subtype in parenthesis. The items must not be in a container.

Specified by:

findMostOfMaterial in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

other - the material type name, with optional subtype in parenthesis

Returns:

null, or the largest matching raw material item

See Also:

MaterialLibrary.findMostOfMaterial(MOB, int), MaterialLibrary.findMostOfMaterial(Room, int), MaterialLibrary.findMostOfMaterial(Room, String)

findMostOfMaterial

protected RawMaterial findMostOfMaterial(java.util.List<Item> V,
                                         java.lang.String other)

findNumberOfResourceLike

public int findNumberOfResourceLike(Room E,
                                    RawMaterial resource)

Description copied from interface: MaterialLibrary

Searches the given room for all raw material resource items that have the same material type and subtype as the given raw material resource item, and returns the total amount of similar resources. The items must not be in a container.

Specified by:

findNumberOfResourceLike in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

resource - the resource item to match others against

Returns:

the total amount of resources like the given one found

See Also:

MaterialLibrary.findNumberOfResourceLike(MOB, RawMaterial)

findNumberOfResourceLike

public int findNumberOfResourceLike(MOB E,
                                    RawMaterial resource)

Description copied from interface: MaterialLibrary

Searches the given mob for all raw material resource items that have the same material type and subtype as the given raw material resource item, and returns the total amount of similar resources. The items must not be in a container.

Specified by:

findNumberOfResourceLike in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

resource - the resource item to match others against

Returns:

the total amount of resources like the given one found

See Also:

MaterialLibrary.findNumberOfResourceLike(Room, RawMaterial)

findNumberOfResource

protected int findNumberOfResource(java.util.List<Item> V,
                                   int startAt,
                                   RawMaterial resource)

findMostOfMaterial

public RawMaterial findMostOfMaterial(Room E,
                                      int material)

Description copied from interface: MaterialLibrary

Searches the given Room for the largest pile of qualifying raw material resource item that matches the given material type code number. The items must not be in a container.

Specified by:

findMostOfMaterial in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

material - the material type code number

Returns:

null, or the largest matching raw material item

See Also:

MaterialLibrary.findMostOfMaterial(MOB, int), MaterialLibrary.findMostOfMaterial(MOB, String), MaterialLibrary.findMostOfMaterial(Room, String)

findMostOfMaterial

public RawMaterial findMostOfMaterial(MOB E,
                                      int material)

Description copied from interface: MaterialLibrary

Searches the given MOB for the largest pile of qualifying raw material resource item that matches the given material type code number. The items must not be in a container.

Specified by:

findMostOfMaterial in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

material - the material type code number

Returns:

null, or the largest matching raw material item

See Also:

MaterialLibrary.findMostOfMaterial(MOB, String), MaterialLibrary.findMostOfMaterial(Room, int), MaterialLibrary.findMostOfMaterial(Room, String)

findMostOfMaterial

protected RawMaterial findMostOfMaterial(java.util.List<Item> V,
                                         int material,
                                         java.lang.String subType)

isResourceCodeRoomMapped

public boolean isResourceCodeRoomMapped(int resourceCode)

Description copied from interface: MaterialLibrary

Searches through all the locale/room classes to discover whether the given resource code appears in any of them as a possible resource.

Specified by:

isResourceCodeRoomMapped in interface MaterialLibrary

Parameters:

resourceCode - the resource code

Returns:

true if its used somewhere.

getSomeRawMaterial

protected java.util.List<Item> getSomeRawMaterial(Room R,
                                                  int material1,
                                                  int subTypeHash1,
                                                  int material2,
                                                  int subTypeHash2)

getAllRawMaterial

protected java.util.List<Item> getAllRawMaterial(Room R,
                                                 int material1,
                                                 int material2)

getAllItems

protected java.util.List<Item> getAllItems(ItemPossessor P)

getSomeRawMaterial

protected java.util.List<Item> getSomeRawMaterial(MOB M,
                                                  int material1,
                                                  int subTypeHash1,
                                                  int material2,
                                                  int subTypeHash2)

getAllRawMaterial

protected java.util.List<Item> getAllRawMaterial(MOB M,
                                                 int material1,
                                                 int material2)

fetchFoundOtherEncoded

public RawMaterial fetchFoundOtherEncoded(Room E,
                                          java.lang.String otherRequired)

Description copied from interface: MaterialLibrary

Searches the given room for specified qualifying resource items. The given string is either a full resource name, or a ! followed by a material type name, with optional subtype in parenthesis. If a resource name is given, this will return the first matching resource. If a material type is given, this will return the largest example of that material of a particular resource.

Specified by:

fetchFoundOtherEncoded in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

otherRequired - the resource name, or !material type

Returns:

the found raw material item, or null

See Also:

MaterialLibrary.fetchFoundOtherEncoded(MOB, String)

fetchFoundOtherEncoded

public RawMaterial fetchFoundOtherEncoded(MOB E,
                                          java.lang.String otherRequired)

Description copied from interface: MaterialLibrary

Searches the given mob for specified qualifying resource items. The given string is either a full resource name, or a ! followed by a material type name, with optional subtype in parenthesis. If a resource name is given, this will return the first matching resource. If a material type is given, this will return the largest example of that material of a particular resource.

Specified by:

fetchFoundOtherEncoded in interface MaterialLibrary

Parameters:

E - the possessor of possible raw material items

otherRequired - the resource name, or !material type

Returns:

the found raw material item, or null

See Also:

MaterialLibrary.fetchFoundOtherEncoded(Room, String)

fetchFoundOtherEncoded

protected RawMaterial fetchFoundOtherEncoded(java.util.List<Item> V,
                                             java.lang.String otherRequired)

getBurnDuration

public int getBurnDuration(Environmental E)

Description copied from interface: MaterialLibrary

Returns the number of ticks that the given item, whatever will burn, or 0 if it won't burn.

Specified by:

getBurnDuration in interface MaterialLibrary

Parameters:

E - the item to check

Returns:

the number of ticks to burn, or 0