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

Nested Class Summary

static class

MaterialLibrary.DeadResourceRecord A record detailing information about destoryed resources, used mostly for common skills that consume them.

Method Summary

void	addEffectsToResource(Item I)
void	adjustResourceName(Item I)
MaterialLibrary.DeadResourceRecord	destroyResources(MOB M, int howMuch, int finalMaterial, int otherMaterial, Item never, Container C)
MaterialLibrary.DeadResourceRecord	destroyResources(Room R, int howMuch, int finalMaterial, int otherMaterial, Item never, Container C)
int	destroyResourcesAmt(java.util.List<Item> V, int howMuch, int finalMaterial, Container C)
int	destroyResourcesAmt(MOB E, int howMuch, int finalMaterial, Container C)
int	destroyResourcesAmt(Room E, int howMuch, int finalMaterial, Container C)
int	destroyResourcesValue(java.util.List<Item> V, int howMuch, int finalMaterial, int otherMaterial, Item never, Container C)
int	destroyResourcesValue(MOB E, int howMuch, int finalMaterial, int otherMaterial, Item never)
int	destroyResourcesValue(Room E, int howMuch, int finalMaterial, int otherMaterial, Item never)
RawMaterial	fetchFoundOtherEncoded(MOB E, java.lang.String otherRequired)
RawMaterial	fetchFoundOtherEncoded(Room E, java.lang.String otherRequired)
RawMaterial	findFirstResource(MOB E, int resource)
RawMaterial	findFirstResource(MOB E, java.lang.String other)
RawMaterial	findFirstResource(Room E, int resource)
RawMaterial	findFirstResource(Room E, java.lang.String other)
RawMaterial	findMostOfMaterial(MOB E, int material)
RawMaterial	findMostOfMaterial(MOB E, java.lang.String other)
RawMaterial	findMostOfMaterial(Room E, int material)
RawMaterial	findMostOfMaterial(Room E, java.lang.String other)
int	findNumberOfResource(MOB E, RawMaterial resource)
int	findNumberOfResource(Room E, RawMaterial resource)
java.lang.String	genericType(Item I)
int	getBurnDuration(Environmental E) Returns the number of ticks that the given item, whatever will burn, or 0 if it won't burn.
int	getMaterialCode(java.lang.String s, boolean exact)
java.lang.String	getMaterialDesc(int MASK)
int	getMaterialRelativeInt(java.lang.String s)
int	getRandomResourceOfMaterial(int material)
int	getResourceCode(java.lang.String s, boolean exact)
java.lang.String	getResourceDesc(int MASK)
Item	makeItemResource(int type)
Item	makeItemResource(int type, java.lang.String subType)
PhysicalAgent	makeResource(int myResource, java.lang.String localeCode, boolean noAnimals, java.lang.String fullName, java.lang.String subType)
java.lang.String	makeResourceDescriptiveName(int rscCode, java.lang.String subType, boolean plural)
java.lang.String	makeResourceSimpleName(int rscCode, java.lang.String subType)
boolean	quickDestroy(Item I)
boolean	rebundle(Item I)
Environmental	splitBundle(Item I, int size, Container C)
Environmental	unbundle(Item I, int number, Container C)

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

unbundle

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

splitBundle

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

getMaterialRelativeInt

int getMaterialRelativeInt(java.lang.String s)

getMaterialCode

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

getResourceCode

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

getResourceDesc

java.lang.String getResourceDesc(int MASK)

getMaterialDesc

java.lang.String getMaterialDesc(int MASK)

makeItemResource

Item makeItemResource(int type)

makeItemResource

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

makeResource

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

addEffectsToResource

void addEffectsToResource(Item I)

getRandomResourceOfMaterial

int getRandomResourceOfMaterial(int material)

rebundle

boolean rebundle(Item I)

quickDestroy

boolean quickDestroy(Item I)

destroyResources

MaterialLibrary.DeadResourceRecord destroyResources(Room R,
                                                    int howMuch,
                                                    int finalMaterial,
                                                    int otherMaterial,
                                                    Item never,
                                                    Container C)

destroyResources

MaterialLibrary.DeadResourceRecord destroyResources(MOB M,
                                                    int howMuch,
                                                    int finalMaterial,
                                                    int otherMaterial,
                                                    Item never,
                                                    Container C)

destroyResourcesValue

int destroyResourcesValue(MOB E,
                          int howMuch,
                          int finalMaterial,
                          int otherMaterial,
                          Item never)

destroyResourcesValue

int destroyResourcesValue(Room E,
                          int howMuch,
                          int finalMaterial,
                          int otherMaterial,
                          Item never)

destroyResourcesValue

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

destroyResourcesAmt

int destroyResourcesAmt(MOB E,
                        int howMuch,
                        int finalMaterial,
                        Container C)

destroyResourcesAmt

int destroyResourcesAmt(Room E,
                        int howMuch,
                        int finalMaterial,
                        Container C)

destroyResourcesAmt

int destroyResourcesAmt(java.util.List<Item> V,
                        int howMuch,
                        int finalMaterial,
                        Container C)

fetchFoundOtherEncoded

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

fetchFoundOtherEncoded

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

findMostOfMaterial

RawMaterial findMostOfMaterial(Room E,
                               int material)

findMostOfMaterial

RawMaterial findMostOfMaterial(MOB E,
                               int material)

findNumberOfResource

int findNumberOfResource(Room E,
                         RawMaterial resource)

findNumberOfResource

int findNumberOfResource(MOB E,
                         RawMaterial resource)

findMostOfMaterial

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

findMostOfMaterial

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

findFirstResource

RawMaterial findFirstResource(Room E,
                              int resource)

findFirstResource

RawMaterial findFirstResource(MOB E,
                              int resource)

findFirstResource

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

findFirstResource

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

adjustResourceName

void adjustResourceName(Item I)

makeResourceSimpleName

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

makeResourceDescriptiveName

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

genericType

java.lang.String genericType(Item I)

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