Package com.planet_ink.coffee_mud.Libraries.interfaces

Interface MaterialLibrary

All Superinterfaces:

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

All Known Implementing Classes:

RawCMaterial

public interface MaterialLibrary
extends CMLibrary

At the center of CoffeeMuds crafting system are raw resources. These are represented as item objects of a particular material code or resource code. Normal non-resource items are also made of the same material/resource codes. Material/Resource codes are numbers which are composed of a resource type and a material type, with the material type being a high-order-bitmask over the ordinal resource type. This Library handles raw resource item object and more, mostly supporting the gathering and crafting systems.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MaterialLibrary.DeadResourceRecord	A record detailing information about destoryed resources, used mostly for common skills that consume them.

Field Summary

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

idConverter

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 finalOtherHash)	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
int	destroyResourcesAmt(Room E, int howMuch, int resourceCode, 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 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	destroyResourcesAmt(java.util.List<Item> V, 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	destroyResourcesValue(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 NO container, destroys that many pounds of the resource, and then returns the value of what was destroyed.
int	destroyResourcesValue(MOB M, 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.
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.
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.
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.
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.
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
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.
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 I)	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, ID, initializeClass, name, newInstance

Methods inherited from interface java.lang.Comparable

compareTo

Method Detail

findMaterialRelativeInt

int findMaterialRelativeInt(java.lang.String s)

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

Parameters:

s - the possible material type

Returns:

the ordinal value of the material

See Also:

findMaterialCode(String, boolean), findResourceCode(String, boolean)

findMaterialCode

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

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

Parameters:

s - the possible material type

exact - true for exact match only, false for startswith

Returns:

the material code

See Also:

findResourceCode(String, boolean), findMaterialRelativeInt(String)

findResourceCode

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

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

Parameters:

s - the possible resource codes name

exact - true for exact match only, false for startswith

Returns:

the resource code

See Also:

findMaterialCode(String, boolean), findMaterialRelativeInt(String)

getResourceDesc

java.lang.String getResourceDesc(int resourceCode)

Returns the name of the given resource type code

Parameters:

resourceCode - the given resource type code

Returns:

the name of the given resource type code

See Also:

getMaterialDesc(int)

getMaterialDesc

java.lang.String getMaterialDesc(int materialCode)

Returns the name of the given material type code

Parameters:

materialCode - the material type code

Returns:

the name of the material type code

See Also:

getResourceDesc(int)

makeItemResource

Item makeItemResource(int type)

Creates a resource item of one pound.

Parameters:

type - the resource code

Returns:

the newly created resource item

See Also:

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

makeItemResource

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

Creates a resource item of one pound.

Parameters:

type - the resource code

subType - "" or the subType of the resource

Returns:

the newly created resource item

See Also:

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

makeResource

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.

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:

makeItemResource(int), makeItemResource(int, String)

getRandomResourceOfMaterial

int getRandomResourceOfMaterial(int material)

Returns a random resource code of the given material type

Parameters:

material - the material type code

Returns:

a random resource code of that material

destroyResources

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

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

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

finalOtherHash - 0 or the hash of the subtype

Returns:

the dead resource record of statistics

See Also:

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

destroyResourcesValue

int destroyResourcesValue(MOB M,
                          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.

Parameters:

M - 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:

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

destroyResourcesValue

int destroyResourcesValue(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 NO container, destroys that many pounds of the resource, and then returns the value of what was destroyed.

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 value of what was destroyed

See Also:

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

destroyResourcesValue

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.

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:

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

destroyResourcesAmt

int destroyResourcesAmt(MOB E,
                        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.

Parameters:

E - the possessor 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:

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

destroyResourcesAmt

int destroyResourcesAmt(Room E,
                        int howMuch,
                        int resourceCode,
                        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.

Parameters:

E - the possessor 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:

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

destroyResourcesAmt

int destroyResourcesAmt(java.util.List<Item> V,
                        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.

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

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:

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

fetchFoundOtherEncoded

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

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.

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:

fetchFoundOtherEncoded(MOB, String)

fetchFoundOtherEncoded

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

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.

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:

fetchFoundOtherEncoded(Room, String)

findNumberOfResourceLike

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. The items must not be in a container.

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:

findNumberOfResourceLike(MOB, RawMaterial)

findNumberOfResourceLike

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. The items must not be in a container.

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:

findNumberOfResourceLike(Room, RawMaterial)

findMostOfMaterial

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. The items must not be in a container.

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:

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

findMostOfMaterial

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. The items must not be in a container.

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:

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

findMostOfMaterial

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. The items must not be in a container.

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:

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

findMostOfMaterial

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. The items must not be in a container.

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:

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

findFirstResource

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.

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:

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

findFirstResource

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.

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:

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

findFirstResource

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.

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:

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

findFirstResource

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.

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:

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

unbundle

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. One of those is then returned. The container of the item is also required, for some reason.

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:

splitBundle(Item, int, Container)

splitBundle

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. The container of the item is also required, for some reason.

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:

unbundle(Item, int, Container)

rebundle

boolean rebundle(Item I)

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.

Parameters:

I - the raw material item to rebundle

Returns:

true if the rebundle happened, false otherwise

See Also:

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

addEffectsToResource

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.

Parameters:

I - the raw material item

quickDestroy

boolean quickDestroy(Item I)

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.

Parameters:

I - null, or an item to destroy

Returns:

true if it was destroyed, or false if null

adjustResourceName

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.

Parameters:

I - the raw material item to name

See Also:

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

makeResourceSimpleName

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. The name is always broad, like "iron ore".

Parameters:

rscCode - the resource code

subType - "", null, or a subType

Returns:

a broad name for the resource

See Also:

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

makeResourceBetterName

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. Differentiates between ores and cloth bolts and liquid pools, which is why it is a "better" name.

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:

makeResourceSimpleName(int, String), adjustResourceName(Item)

getGeneralItemType

java.lang.String getGeneralItemType(Item I)

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

Parameters:

I - the item to get the general type of

Returns:

the general type of the item

isResourceCodeRoomMapped

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.

Parameters:

resourceCode - the resource code

Returns:

true if its used somewhere.

getBurnDuration

int getBurnDuration(Environmental E)

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

Parameters:

E - the item to check

Returns:

the number of ticks to burn, or 0