Package com.planet_ink.coffee_mud.Libraries

Class TimsLibrary

java.lang.Object

com.planet_ink.coffee_mud.Libraries.StdLibrary

com.planet_ink.coffee_mud.Libraries.TimsLibrary

All Implemented Interfaces:

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

public class TimsLibrary
extends StdLibrary
implements ItemBalanceLibrary

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
TimsLibrary()

Method Summary

Modifier and Type	Method	Description
void	balanceItemByLevel(Item I)	Adjusts the mundane stats of the given armor or weapon item to reflect its present level.
int	calculateBaseValue(Item I)	Calculates the base value of this armor or weapon.
Item	enchant(Item I, int pct)	Given a percent change, this method MIGHT add an enchantment or cuse of various levels to the give armor, ammunition, or weapon piece.
protected boolean	fixRejuvItem(Item I)
protected int[]	getArmorMaterialPointsArray(int materialCode)
Ability	getBaseAdjusterAbility(java.util.List<Ability> props)
Ability	getCombatSpell(boolean malicious)
java.util.List<Ability>	getCombatSpellSet()
java.util.Map<java.lang.Object,java.lang.Integer>	getItemLevels(Item I, java.util.List<Ability> props)
java.util.List<Ability>	getTimsAdjResCast(Item I)	Returns a list of all the effects on the given item that contribute to its power level.
java.lang.String	ID()	The CoffeeMud Java Class ID shared by all instances of this object.
boolean	itemFix(Item I, int lvlOr0, boolean preferMagic, java.lang.StringBuffer changes)	Given an item and a new level or 0, this will adjust the stats of the given item to reflect the desired level or its existing one.
protected int	levelsFromAbility(Item savedI)
protected double	timsAttackModifier(int weaponClass)
protected double	timsBaseAttackModifier(int weaponClass)
int	timsBaseLevel(Item I)	Returns the apparent power level of the item based entirely on basic mundane stats, even if some stats come from a property.
int	timsBaseLevel(Item I, Ability adjA)
protected double	timsDmgModifier(int weaponClass)
java.util.Map<java.lang.String,java.lang.String>	timsItemAdjustments(Item I, int level, int material, int hands, int wclass, int reach, long worndata)	Returns a map of key value pairs showing what various combat stats on the given item SHOULD be given the level and other particulars.
int	timsLevelCalculator(Item I)	Returns the full power level of the given armor, or weapon.
int	timsLevelCalculator(Item itemI, java.util.List<Ability> props)	Returns the full power level of the given armor, or weapon.
void	toneDownArmor(Armor A, Ability adjA)	Lowers the base armor of the give armor item based on its level and other characteristics.
boolean	toneDownValue(Item I)	Lowers the base gold value of the given armor or weapon item based on its level and other characteristics.
void	toneDownWeapon(Weapon W, Ability adjA)	Lowers the base attack and damage of the give weapon based on its level and other characteristics.
void	toneUpArmor(Armor A, Ability adjA)
void	toneUpWeapon(Weapon W, Ability adjA)
int	totalLevels(java.util.Map<java.lang.Object,java.lang.Integer> totalLevels)

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

TimsLibrary

public TimsLibrary()

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

timsLevelCalculator

public int timsLevelCalculator(Item I)

Description copied from interface: ItemBalanceLibrary

Returns the full power level of the given armor, or weapon. Will also inspect its affects.

Specified by:

timsLevelCalculator in interface ItemBalanceLibrary

Parameters:

I - the item to get the power level of

Returns:

the power level

timsDmgModifier

protected double timsDmgModifier(int weaponClass)

timsBaseAttackModifier

protected double timsBaseAttackModifier(int weaponClass)

timsAttackModifier

protected double timsAttackModifier(int weaponClass)

timsLevelCalculator

public int timsLevelCalculator(Item itemI,
                               java.util.List<Ability> props)

Description copied from interface: ItemBalanceLibrary

Returns the full power level of the given armor, or weapon.

Specified by:

timsLevelCalculator in interface ItemBalanceLibrary

Parameters:

itemI - the item to get the power level of

props - any power affecting effects

Returns:

the power level

fixRejuvItem

protected boolean fixRejuvItem(Item I)

getTimsAdjResCast

public java.util.List<Ability> getTimsAdjResCast(Item I)

Description copied from interface: ItemBalanceLibrary

Returns a list of all the effects on the given item that contribute to its power level.

Specified by:

getTimsAdjResCast in interface ItemBalanceLibrary

Parameters:

I - the item to inspect

Returns:

the effects that make it great

itemFix

public boolean itemFix(Item I,
                       int lvlOr0,
                       boolean preferMagic,
                       java.lang.StringBuffer changes)

Description copied from interface: ItemBalanceLibrary

Given an item and a new level or 0, this will adjust the stats of the given item to reflect the desired level or its existing one. It will return a description of the changes if you send a stringbuffer. Obviously, this only works on things like wands, ammunition, weapons, and armor.

Specified by:

itemFix in interface ItemBalanceLibrary

Parameters:

I - the item to potentially modify

lvlOr0 - 0 to use the existing level, or a level to adjust the item to

preferMagic - true to prefer adding magical bonuses, false to stay mundane

changes - null, or a strinbuffer to put changes list into

Returns:

true if a change was made, false otherwise

toneDownValue

public boolean toneDownValue(Item I)

Description copied from interface: ItemBalanceLibrary

Lowers the base gold value of the given armor or weapon item based on its level and other characteristics. A balancing method.

Specified by:

toneDownValue in interface ItemBalanceLibrary

Parameters:

I - the armor or weapon

Returns:

true if a change was made, false otherwise

balanceItemByLevel

public void balanceItemByLevel(Item I)

Description copied from interface: ItemBalanceLibrary

Adjusts the mundane stats of the given armor or weapon item to reflect its present level.

Specified by:

balanceItemByLevel in interface ItemBalanceLibrary

Parameters:

I - the item to adjust for balance

getArmorMaterialPointsArray

protected int[] getArmorMaterialPointsArray(int materialCode)

calculateBaseValue

public int calculateBaseValue(Item I)

Description copied from interface: ItemBalanceLibrary

Calculates the base value of this armor or weapon.

Specified by:

calculateBaseValue in interface ItemBalanceLibrary

Parameters:

I - the armor or weapon

Returns:

the base value.

timsItemAdjustments

public java.util.Map<java.lang.String,java.lang.String> timsItemAdjustments(Item I,
                                                                            int level,
                                                                            int material,
                                                                            int hands,
                                                                            int wclass,
                                                                            int reach,
                                                                            long worndata)

Description copied from interface: ItemBalanceLibrary

Returns a map of key value pairs showing what various combat stats on the given item SHOULD be given the level and other particulars. Weapon key values: MINRANGE, MAXRANGE, DAMAGE, ATTACK, VALUE Armor key values: ARMOR, VALUE, WEIGHT

Specified by:

timsItemAdjustments in interface ItemBalanceLibrary

Parameters:

I - the item type to inspect

level - the level you want the item to be

material - the material of the item

hands - the number of hands for the item (weapon)

wclass - the weapon class

reach - the weapon max range

worndata - the proper worn location bitmap

Returns:

the map of fields

toneDownWeapon

public void toneDownWeapon(Weapon W,
                           Ability adjA)

Description copied from interface: ItemBalanceLibrary

Lowers the base attack and damage of the give weapon based on its level and other characteristics.

Specified by:

toneDownWeapon in interface ItemBalanceLibrary

Parameters:

W - the weapon to adjust

adjA - any property that also impacts attack/dmg

toneDownArmor

public void toneDownArmor(Armor A,
                          Ability adjA)

Description copied from interface: ItemBalanceLibrary

Lowers the base armor of the give armor item based on its level and other characteristics.

Specified by:

toneDownArmor in interface ItemBalanceLibrary

Parameters:

A - the armor to adjust

adjA - any property that also impacts armor

toneUpWeapon

public void toneUpWeapon(Weapon W,
                         Ability adjA)

toneUpArmor

public void toneUpArmor(Armor A,
                        Ability adjA)

getItemLevels

public java.util.Map<java.lang.Object,java.lang.Integer> getItemLevels(Item I,
                                                                       java.util.List<Ability> props)

totalLevels

public int totalLevels(java.util.Map<java.lang.Object,java.lang.Integer> totalLevels)

getBaseAdjusterAbility

public Ability getBaseAdjusterAbility(java.util.List<Ability> props)

timsBaseLevel

public int timsBaseLevel(Item I)

Description copied from interface: ItemBalanceLibrary

Returns the apparent power level of the item based entirely on basic mundane stats, even if some stats come from a property.

Specified by:

timsBaseLevel in interface ItemBalanceLibrary

Parameters:

I - the weapon or armor to inspect

Returns:

the mundane power level

timsBaseLevel

public int timsBaseLevel(Item I,
                         Ability adjA)

levelsFromAbility

protected int levelsFromAbility(Item savedI)

getCombatSpellSet

public java.util.List<Ability> getCombatSpellSet()

getCombatSpell

public Ability getCombatSpell(boolean malicious)

enchant

public Item enchant(Item I,
                    int pct)

Description copied from interface: ItemBalanceLibrary

Given a percent change, this method MIGHT add an enchantment or cuse of various levels to the give armor, ammunition, or weapon piece.

Specified by:

enchant in interface ItemBalanceLibrary

Parameters:

I - the item to possibly enchant

pct - the % chance to enchant

Returns:

the item again