com.mindgene.d20.common.creature

Class CreatureTemplate

java.lang.Object

com.mesamundi.magehand.data.DataMap

com.mindgene.d20.common.creature.CreatureTemplate

All Implemented Interfaces:

com.mesamundi.magehand.data.DataAccess, com.mindgene.util.CryptUtil.Encryptable, java.io.Serializable, java.lang.Cloneable

public class CreatureTemplate
extends com.mesamundi.magehand.data.DataMap
implements java.lang.Cloneable, java.io.Serializable, com.mindgene.util.CryptUtil.Encryptable

Bean containing all template information about a creature.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
boolean	_calculating
boolean	_calculatingSaves
java.lang.String	_customSheetURL
boolean	_historical
static java.lang.String	DEFAULT_MODULE_NAME
boolean	dirtyTraits
static byte	EMPTY Constant used when an ability has no value
static byte	NO_ABILITY
static java.lang.String	NO_ABILITY_TXT
static short	NO_INIT_OVERRIDE

Constructor Summary

Constructors

Constructor and Description
CreatureTemplate()
CreatureTemplate(java.lang.String name, short imageID, byte team)

Method Summary

Modifier and Type	Method and Description
int	accessAbilityScoreMod(byte idAbility)
byte	accessAC(int idAC)
byte	accessACWithMod(byte idAC)
java.lang.String	accessCR()
com.mindgene.d20.common.creature.CreatureSpeeds	accessSpeeds()
java.util.List<java.lang.String>	accessStatusList()
void	addStatus(java.lang.String name)
void	addToAbilitiesNotesLog(java.lang.String newLine)
void	addToBackground(java.lang.String newLine)
void	addToDescription(java.lang.String newLine)
void	addToErrorLog(java.lang.Exception e)
void	addToErrorLog(java.lang.String newLine)
void	addToErrorLog(java.lang.String message, java.lang.Exception e)
void	addToNotes(java.lang.String newLine)
boolean	addTraitByName(java.lang.String name) method is used to add a trait to a creature during play (via the Rules->Scripting engine)
void	applyAbilityScoreMods(byte idAbility, byte value)
void	applyNewHPTemp(short hpTemp)
void	assignAC(byte idAC, byte value)
void	buildFullNotes()
void	calculateSaves()
java.lang.String	call(java.lang.String method, java.lang.String parameters) Invoke a method located at the indicated path
void	clearCreatureStatus()
void	clearCreatureTemplateModifiers()
void	clearTraits()
java.lang.Object	clone()
com.mindgene.d20.common.creature.capability.CreatureCapability_SpellCaster	extractSpellCasting(java.lang.String nameOfClass) Access a spellcasting class by name.
java.util.ArrayList<GenericCreatureClass>	extractSpellCastingClasses()
java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait>	fetchTraitsFromClasses(com.mindgene.d20.common.AbstractApp abstractApp, boolean byLevel)
byte[]	getAbilities()
byte[]	getAbilitiesBase()
byte[]	getAbilitiesMods() Deprecated. - XML Only
byte	getAbilityScore(byte idAbility) pass through method to default getAbilityScore calls to always refresh
byte	getAbilityScore(byte idAbility, boolean refresh) Calculate and return the modified ability score for a creature.
byte	getAbilityScoreBase(byte idAbility) returns the currently stored base ability score for id
byte	getAbilityScoreMods(byte idAbility)
byte[]	getAC() XML.
java.lang.String	getAlignment()
java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait>	getAllAvailTraits(com.mindgene.d20.common.AbstractApp app)
java.util.ArrayList<com.mindgene.d20.common.creature.attack.CreatureAttack>	getAttacks()
com.mindgene.d20.common.creature.CreatureLabel	getBottomLabel()
boolean	getCalculating()
com.mindgene.d20.common.creature.CreatureTemplate_Classes	getClasses()
int[]	getCoins() Deprecated. - XML Only
java.lang.String	getCR()
com.d20pro.temp_extraction.plugin.feature.model.pool.CreaturePoolContainer	getCreaturePoolContainer()
com.mindgene.d20.common.creature.CreatureTemplateModifiers	getCreatureTemplateModifiers()
short[]	getCustomDefense()
java.lang.String	getCustomSheetURL()
com.mindgene.d20.common.game.trait.GenericTrait	getCustomTraitByName(java.lang.String name)
java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait>	getCustomTraits()
com.mindgene.d20.common.creature.CreatureDamageReduction	getDamageReduction() for mappers reflection
byte	getDeathSavesFailure()
byte	getDeathSavesSuccess()
java.lang.String	getDescription()
com.mindgene.d20.common.creature.CreatureDamageReduction	getDR()
com.mindgene.d20.common.creature.CreatureElementalResistance	getElementalResistance() for mappers reflection
com.mindgene.d20.common.creature.CreatureElementalResistance	getER()
java.lang.String	getExperiencePoints()
java.awt.Dimension	getFace() The face of the creature in units (1 unit == 5 feet).
int	getFacing()
int	getFastHeal()
com.mindgene.d20.common.creature.CreatureTemplate_Feats	getFeats()
com.d20pro.temp_extraction.plugin.feature.service.pool.CreatureFeatureTriggersManager	getFeatureTriggersManager()
com.mindgene.d20.common.creature.capability.CreatureCapability_FreeformCaster	getFreeformCasting()
java.lang.String	getGameSystem()
java.lang.String	getGMNotes()
java.lang.String	getGMQuickNotes()
byte	getHeight()
boolean	getHistorical()
java.lang.String	getHitDice()
short	getHP()
short	getHPMax()
short	getHPPrior()
short	getHPRaw()
short	getHPTemp()
short	getImageID()
short	getInitOverride()
boolean	getInspiration()
com.mindgene.d20.common.item.ItemTemplate	getItemByName(java.lang.String name)
com.mindgene.d20.common.creature.capability.CreatureCapability_ItemCaster	getItemCasting()
com.mindgene.d20.common.creature.CreatureTemplate_Items	getItems()
int	getLevel()
FeatureBehaviorContainer	getLocalBehaviorsContainer()
short	getMaxDexBonus()
short	getMaxDexFeatureBonus()
java.lang.String	getModuleName()
byte[]	getMoney() Deprecated. - LEGACY SUPPORT ONLY
int	getMoney(byte idAbility)
java.lang.String	getName()
java.lang.String	getNotes() ENCODED description only! Should only be used by CreatureTemplateFactory.
java.lang.Integer	getOverrideBAB()
byte	getProficiencyBonus()
java.lang.String	getQuickNotes()
byte	getReach() The reach of a creature is in units (1 unit == 5 feet)
boolean	getRegenerates()
int	getRotation()
java.lang.String	getRulesNotes()
byte	getSave(byte idSave)
byte	getSaveBase(byte idSave)
byte	getSaveMod(byte idSave)
byte[]	getSaves()
byte[]	getSaves(boolean calculate) XML.
byte[]	getSavesBase() XML.
byte[]	getSavesMod() XML.
java.awt.Dimension	getScaledFace()
byte[]	getSelectedACByType(com.mindgene.d20.common.rules.ArmorClassType type)
byte	getSize()
com.mindgene.d20.common.creature.SkillPenalty	getSkillPenalty()
com.mindgene.d20.common.creature.CreatureTemplate_Skills	getSkills()
com.mindgene.d20.common.creature.CreatureTemplate_Abilities	getSpecialAbilities()
byte	getSpeed() Deprecated. replaced by CreatureSpeeds
com.mindgene.d20.common.creature.CreatureSpeeds	getSpeeds() Deprecated. XML Only
java.lang.String	getSpeedType()
short	getSpellResistance()
java.util.List<AppliedFeatureBehavior>	getStashForEquippedEffects()
java.util.ArrayList<java.lang.String>	getStatus() Deprecated. - XML Only
java.lang.String	getSubType()
byte	getTeam()
com.mindgene.d20.common.creature.CreatureLabel	getTopLabel()
java.lang.String	getTotalAC()
com.mindgene.d20.common.game.trait.GenericTrait	getTraitByName(java.lang.String name)
com.mindgene.d20.common.game.trait.GenericTrait	getTraitFromLibrary(java.lang.String name)
java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait>	getTraits()
java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait>	getTraitsByLevel()
java.lang.String	getType()
java.lang.String	getVersion()
byte	getWidth()
boolean	hasCreatureTemplateModifiers()
boolean	hasOverrideBAB()
boolean	hasStatus(java.lang.String name)
int	heal(int healing, boolean allowSurplus) Apply the given healing to the creature.
void	hideDamageExtent()
int	hurt(int damage) Apply the following damage to the creature and return the current HP of the creature.
void	initCustomTraits()
java.lang.Object	invokeMethod(java.lang.String method, java.lang.Object... params)
boolean	isCalculating()
void	isCalculating(boolean v)
boolean	isEncrypted()
boolean	isHistorical()
void	isHistorical(boolean h)
boolean	isRegenerates()
boolean	isStabilized()
CreatureTemplate	makePublic(boolean revealDamageExtent) Build a new template with only publicly available items filled in.
void	mimic(CreatureTemplate template, com.mindgene.d20.common.game.creatureclass.CreatureClassBinder binder) Causes this template to take on all the properties of the given template.
void	refreshAbilityScore(byte id) Method to recalculate the current ability
void	refreshAbilityScores() Method to recalculate all ability scores
void	refreshCustomDefense()
void	refreshTraits()
void	removeCreatureStatus(java.lang.String name)
boolean	removeTraitByName(java.lang.String name) method is used to remove a trait from a creature during play (via the Rules->Scripting engine)
void	removeTraitsForClass(CreatureClassTemplate template)
java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait>	resetClassTraits(com.mindgene.d20.common.AbstractApp app)
void	resetDeathSaves()
java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait>	resetKnownTraits(com.mindgene.d20.common.AbstractApp app)
void	resizeSaves()
int	resolveBAB() calculate the base attack bonus based on all classes
int	resolveGrappleModifier()
int	resolveGrappleModifier(com.mindgene.d20.common.AbstractApp app)
void	restoreTransientReferences(com.mindgene.d20.common.AbstractApp app) When a template is serialized, certain references that are transient must be restored.
void	restSpellLevel(int value, int level)
void	restSpells() All spellcasting classes have their spells rested, including freeform and items.
com.mindgene.d20.common.dice.Dice.RollResult	rollDice(java.lang.String roll)
void	rotate(int degrees)
void	setAbilities(byte[] abilities) Deprecated. - XML Only
void	setAbilitiesBase(byte[] abilitiesBase) Deprecated. - XML Only
void	setAbilitiesMods(byte[] abilitiesMods) Deprecated. - XML Only
void	setAbilityScore(byte idAbility, byte value) This method sets the modified ability score for a creature.
void	setAbilityScoreBase(byte idAbility, byte value, boolean refresh) Sets the base Ability score for a creature.
void	setAbilityScoreMods(byte idAbility, byte value) Overrides the abilitiesmod[id] value such that it can be updated by effects, powers, or manual entry.
void	setAC(byte[] acblock) XML.
void	setAlignment(java.lang.String Alignment)
void	setAttacks(java.util.ArrayList<com.mindgene.d20.common.creature.attack.CreatureAttack> attacks)
void	setBottomLabel(com.mindgene.d20.common.creature.CreatureLabel bottomLabel)
void	setCalculating(boolean calculating)
void	setClasses(com.mindgene.d20.common.creature.CreatureTemplate_Classes classes)
void	setCoins(int[] money) Deprecated. - XML Only
void	setCR(int cr)
void	setCR(java.lang.String cr)
void	setCreaturePoolContainer(com.d20pro.temp_extraction.plugin.feature.model.pool.CreaturePoolContainer creaturePoolContainer)
void	setCreatureTemplateModifiers(com.mindgene.d20.common.creature.CreatureTemplateModifiers creatureTemplateModifiers)
void	setCustomDefense(short[] defense) Deprecated. - XML Only
void	setCustomSheetURL(java.lang.String url)
void	setDamageReduction(com.mindgene.d20.common.creature.CreatureDamageReduction damageReduction) for mappers reflection
void	setDeathSavesFailure(byte failure)
void	setDeathSavesSuccess(byte success)
void	setDescription(java.lang.String description)
void	setDR(com.mindgene.d20.common.creature.CreatureDamageReduction dr)
void	setElementalResistance(com.mindgene.d20.common.creature.CreatureElementalResistance _elementalResistance) for mappers reflection
void	setEncrypted(boolean encrypted)
void	setER(com.mindgene.d20.common.creature.CreatureElementalResistance er)
void	setExperiencePoints(java.lang.String ExperiencePoints)
void	setFace(byte w, byte h)
void	setFace(java.awt.Dimension face)
void	setFacing(int facing)
void	setFastHeal(int fastHeal)
void	setFeats(com.mindgene.d20.common.creature.CreatureTemplate_Feats feats)
void	setFeatureTriggersManager(com.d20pro.temp_extraction.plugin.feature.service.pool.CreatureFeatureTriggersManager featureTriggersManager)
void	setFreeformCasting(com.mindgene.d20.common.creature.capability.CreatureCapability_FreeformCaster freeformCasting)
void	setGameSystem(java.lang.String gameSystem)
void	setGMNotes(java.lang.String gmNotes)
void	setGMQuickNotes(java.lang.String gmQuickNotes)
void	setHistorical(boolean historical)
void	setHitDice(java.lang.String hitDice)
void	setHP(short hp)
void	setHPMax(short hpMax) Sets the max HP of the creature.
void	setHPRaw(short hpRaw)
void	setHPTemp(short hpTemp)
void	setImageID(short idImg)
void	setInitOverride(short initOverride)
void	setInspiration(boolean inspiration)
void	setItemCasting(com.mindgene.d20.common.creature.capability.CreatureCapability_ItemCaster itemCasting)
void	setItems(com.mindgene.d20.common.creature.CreatureTemplate_Items items)
void	setLocalBehaviorsContainer(FeatureBehaviorContainer localBehaviorsContainer)
void	setMaxDexBonus(short maxDexBonus)
void	setMaxDexFeatureBonus(short maxDexFeatureBonus)
void	setModuleName(java.lang.String name)
void	setMoney(byte[] money) Deprecated. - LEGACY SUPPORT ONLY
void	setMoney(byte idAbility, int value)
void	setName(java.lang.String name)
void	setNotes(java.lang.String notes)
void	setOverrideBAB(java.lang.Integer overrideBAB)
void	setProficiencyBonus(byte bonus)
void	setQuickNotes(java.lang.String quickNotes)
void	setReach(byte reach)
void	setRegenerates(boolean regenerates)
void	setRotation(int rotation)
void	setRulesNotes(java.lang.String rulesNotes)
void	setSave(byte idSave, byte value)
void	setSaveBase(byte idSave, byte value, boolean calculate)
void	setSaveMod(byte idSave, byte value, boolean calculate)
void	setSaves(byte[] saves) XML.
void	setSavesBase(byte[] base) XML.
void	setSavesMod(byte[] mods) XML.
void	setSelectedACByType(com.mindgene.d20.common.rules.ArmorClassType type)
void	setSize(byte size)
void	setSkillPenalty(com.mindgene.d20.common.creature.SkillPenalty skillPenalty)
void	setSkills(com.mindgene.d20.common.creature.CreatureTemplate_Skills skills)
void	setSpecialAbilities(com.mindgene.d20.common.creature.CreatureTemplate_Abilities specialAbilities)
void	setSpeed(byte speed) Deprecated. replaced by CreatureSpeeds
void	setSpeeds(com.mindgene.d20.common.creature.CreatureSpeeds speeds) Deprecated. XML Only
void	setSpeedType(java.lang.String type)
void	setSpellResistance(short SpellResistance)
void	setStablized(boolean stablized)
void	setStashForEquippedEffects(java.util.List<AppliedFeatureBehavior> stashForEquippedEffects)
void	setStatus(java.util.ArrayList<java.lang.String> list) Deprecated. - XML Only
void	setSubType(java.lang.String subType)
void	setTeam(byte idTeam)
void	setTopLabel(com.mindgene.d20.common.creature.CreatureLabel topLabel)
void	setTraits(java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> traits)
void	setType(java.lang.String type)
void	setVersion(java.lang.String version)
boolean	shouldBeEncrypted()
boolean	testBool(boolean b)
byte	testByte(byte b)
char[]	testChar(char[] b)
double	testDouble(double b)
float	testFloat(float b)
int	testInt(int b)
java.awt.Point	testPoint(java.awt.Point b)
java.lang.String	testString(java.lang.String b)
java.lang.String	toString()
void	updatePriorHP()

Methods inherited from class com.mesamundi.magehand.data.DataMap

filter, getData, ifPresent, isPresent, markData, observeData, optionData, peekData, pokeData, removeData, setData, toggleMarker

Methods inherited from class java.lang.Object

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

Field Detail

NO_INIT_OVERRIDE

public static final short NO_INIT_OVERRIDE

See Also:

Constant Field Values

DEFAULT_MODULE_NAME

public static final java.lang.String DEFAULT_MODULE_NAME

See Also:

Constant Field Values

EMPTY

public static final byte EMPTY

Constant used when an ability has no value

See Also:

Constant Field Values

NO_ABILITY

public static final byte NO_ABILITY

See Also:

Constant Field Values

NO_ABILITY_TXT

public static final java.lang.String NO_ABILITY_TXT

See Also:

Constant Field Values

_calculating

public boolean _calculating

_calculatingSaves

public boolean _calculatingSaves

_historical

public boolean _historical

_customSheetURL

public java.lang.String _customSheetURL

dirtyTraits

public boolean dirtyTraits

Constructor Detail

CreatureTemplate

public CreatureTemplate()

CreatureTemplate

public CreatureTemplate(java.lang.String name,
                        short imageID,
                        byte team)

Method Detail

getStashForEquippedEffects

public java.util.List<AppliedFeatureBehavior> getStashForEquippedEffects()

setStashForEquippedEffects

public void setStashForEquippedEffects(java.util.List<AppliedFeatureBehavior> stashForEquippedEffects)

getCreaturePoolContainer

public com.d20pro.temp_extraction.plugin.feature.model.pool.CreaturePoolContainer getCreaturePoolContainer()

setCreaturePoolContainer

public void setCreaturePoolContainer(com.d20pro.temp_extraction.plugin.feature.model.pool.CreaturePoolContainer creaturePoolContainer)

getFeatureTriggersManager

public com.d20pro.temp_extraction.plugin.feature.service.pool.CreatureFeatureTriggersManager getFeatureTriggersManager()

setFeatureTriggersManager

public void setFeatureTriggersManager(com.d20pro.temp_extraction.plugin.feature.service.pool.CreatureFeatureTriggersManager featureTriggersManager)

getLocalBehaviorsContainer

public FeatureBehaviorContainer getLocalBehaviorsContainer()

setLocalBehaviorsContainer

public void setLocalBehaviorsContainer(FeatureBehaviorContainer localBehaviorsContainer)

getStatus

@Deprecated
public java.util.ArrayList<java.lang.String> getStatus()

Deprecated. - XML Only

setStatus

@Deprecated
public void setStatus(java.util.ArrayList<java.lang.String> list)

Deprecated. - XML Only

addStatus

public void addStatus(java.lang.String name)

removeCreatureStatus

public void removeCreatureStatus(java.lang.String name)

rollDice

public com.mindgene.d20.common.dice.Dice.RollResult rollDice(java.lang.String roll)

clearCreatureStatus

public void clearCreatureStatus()

hasStatus

public boolean hasStatus(java.lang.String name)

accessStatusList

public java.util.List<java.lang.String> accessStatusList()

getProficiencyBonus

public byte getProficiencyBonus()

setProficiencyBonus

public void setProficiencyBonus(byte bonus)

getHistorical

public boolean getHistorical()

getCustomSheetURL

public java.lang.String getCustomSheetURL()

setCustomSheetURL

public void setCustomSheetURL(java.lang.String url)

getInspiration

public boolean getInspiration()

setInspiration

public void setInspiration(boolean inspiration)

getDeathSavesSuccess

public byte getDeathSavesSuccess()

setDeathSavesSuccess

public void setDeathSavesSuccess(byte success)

getDeathSavesFailure

public byte getDeathSavesFailure()

setDeathSavesFailure

public void setDeathSavesFailure(byte failure)

getCustomDefense

public short[] getCustomDefense()

setCustomDefense

@Deprecated
public void setCustomDefense(short[] defense)

Deprecated. - XML Only

refreshCustomDefense

public void refreshCustomDefense()

resetDeathSaves

public void resetDeathSaves()

getAlignment

public java.lang.String getAlignment()

setAlignment

public void setAlignment(java.lang.String Alignment)

getExperiencePoints

public java.lang.String getExperiencePoints()

setExperiencePoints

public void setExperiencePoints(java.lang.String ExperiencePoints)

getSpellResistance

public short getSpellResistance()

setSpellResistance

public void setSpellResistance(short SpellResistance)

getGameSystem

public java.lang.String getGameSystem()

setGameSystem

public void setGameSystem(java.lang.String gameSystem)

getMoney

public int getMoney(byte idAbility)

setMoney

public void setMoney(byte idAbility,
                     int value)

getMaxDexFeatureBonus

public short getMaxDexFeatureBonus()

setMaxDexFeatureBonus

public void setMaxDexFeatureBonus(short maxDexFeatureBonus)

getMaxDexBonus

public short getMaxDexBonus()

setMaxDexBonus

public void setMaxDexBonus(short maxDexBonus)

getInitOverride

public short getInitOverride()

setInitOverride

public void setInitOverride(short initOverride)

getFastHeal

public int getFastHeal()

setFastHeal

public void setFastHeal(int fastHeal)

getDR

public com.mindgene.d20.common.creature.CreatureDamageReduction getDR()

setDR

public void setDR(com.mindgene.d20.common.creature.CreatureDamageReduction dr)

getER

public com.mindgene.d20.common.creature.CreatureElementalResistance getER()

setER

public void setER(com.mindgene.d20.common.creature.CreatureElementalResistance er)

getDamageReduction

public com.mindgene.d20.common.creature.CreatureDamageReduction getDamageReduction()

for mappers reflection

setDamageReduction

public void setDamageReduction(com.mindgene.d20.common.creature.CreatureDamageReduction damageReduction)

for mappers reflection

getElementalResistance

public com.mindgene.d20.common.creature.CreatureElementalResistance getElementalResistance()

for mappers reflection

setElementalResistance

public void setElementalResistance(com.mindgene.d20.common.creature.CreatureElementalResistance _elementalResistance)

for mappers reflection

getName

public java.lang.String getName()

setName

public void setName(java.lang.String name)

getModuleName

public java.lang.String getModuleName()

setModuleName

public void setModuleName(java.lang.String name)

getType

public java.lang.String getType()

setType

public void setType(java.lang.String type)

getSubType

public java.lang.String getSubType()

setSubType

public void setSubType(java.lang.String subType)

getHitDice

public java.lang.String getHitDice()

setHitDice

public void setHitDice(java.lang.String hitDice)

setCR

public void setCR(int cr)

getCR

public java.lang.String getCR()

setCR

public void setCR(java.lang.String cr)

getSize

public byte getSize()

setSize

public void setSize(byte size)

getRotation

public int getRotation()

setRotation

public void setRotation(int rotation)

getHP

public short getHP()

setHP

public void setHP(short hp)

getHPPrior

public short getHPPrior()

getHPMax

public short getHPMax()

setHPMax

public void setHPMax(short hpMax)

Sets the max HP of the creature. maxHP must be >= 1.

Parameters:

hpMax -

getHPTemp

public short getHPTemp()

setHPTemp

public void setHPTemp(short hpTemp)

getHPRaw

public short getHPRaw()

setHPRaw

public void setHPRaw(short hpRaw)

applyNewHPTemp

public void applyNewHPTemp(short hpTemp)

getAbilityScoreBase

public byte getAbilityScoreBase(byte idAbility)

returns the currently stored base ability score for id

Parameters:

idAbility - - id of score to retrieve

Returns:

byte score.

setAbilityScoreBase

public void setAbilityScoreBase(byte idAbility,
                                byte value,
                                boolean refresh)

Sets the base Ability score for a creature. Changing this value should immediately prompt for a refresh. To ensure the calculation is correct, we put the new value in the creaturetemplate first.

Parameters:

idAbility - - id of ability to modify

value - - new score value

refresh - - refresh after update

getAbilityScore

public byte getAbilityScore(byte idAbility)

pass through method to default getAbilityScore calls to always refresh

Parameters:

idAbility -

Returns:

getAbilityScore

public byte getAbilityScore(byte idAbility,
                            boolean refresh)

Calculate and return the modified ability score for a creature. Flagging refresh will recalculate the ability with updated modifiers

Parameters:

idAbility -

Returns:

setAbilityScore

public void setAbilityScore(byte idAbility,
                            byte value)

This method sets the modified ability score for a creature. it does not need to refresh or calculate as it sets an "override" value which is generally created by the refresh/calculate functions.

Parameters:

idAbility - - id of ability to override

value - - score to inject

getAbilityScoreMods

public byte getAbilityScoreMods(byte idAbility)

setAbilityScoreMods

public void setAbilityScoreMods(byte idAbility,
                                byte value)

Overrides the abilitiesmod[id] value such that it can be updated by effects, powers, or manual entry.

Parameters:

idAbility -

value -

applyAbilityScoreMods

public void applyAbilityScoreMods(byte idAbility,
                                  byte value)

accessAbilityScoreMod

public int accessAbilityScoreMod(byte idAbility)

refreshAbilityScore

public void refreshAbilityScore(byte id)

Method to recalculate the current ability

Parameters:

id - - id of score to recalculate ability value for

refreshAbilityScores

public void refreshAbilityScores()

Method to recalculate all ability scores

resizeSaves

public void resizeSaves()

calculateSaves

public void calculateSaves()

isCalculating

public boolean isCalculating()

isCalculating

public void isCalculating(boolean v)

getCalculating

public boolean getCalculating()

setCalculating

public void setCalculating(boolean calculating)

isHistorical

public boolean isHistorical()

setHistorical

public void setHistorical(boolean historical)

isHistorical

public void isHistorical(boolean h)

getSaveBase

public byte getSaveBase(byte idSave)

setSaveBase

public void setSaveBase(byte idSave,
                        byte value,
                        boolean calculate)

getSaveMod

public byte getSaveMod(byte idSave)

setSaveMod

public void setSaveMod(byte idSave,
                       byte value,
                       boolean calculate)

getSave

public byte getSave(byte idSave)

setSave

public void setSave(byte idSave,
                    byte value)

getSpeeds

@Deprecated
public com.mindgene.d20.common.creature.CreatureSpeeds getSpeeds()

Deprecated. XML Only

setSpeeds

@Deprecated
public void setSpeeds(com.mindgene.d20.common.creature.CreatureSpeeds speeds)

Deprecated. XML Only

accessSpeeds

public com.mindgene.d20.common.creature.CreatureSpeeds accessSpeeds()

getSpeedType

public java.lang.String getSpeedType()

setSpeedType

public void setSpeedType(java.lang.String type)

accessCR

public java.lang.String accessCR()

getSpeed

@Deprecated
public byte getSpeed()

Deprecated. replaced by CreatureSpeeds

Returns:

setSpeed

@Deprecated
public void setSpeed(byte speed)

Deprecated. replaced by CreatureSpeeds

Parameters:

speed -

accessACWithMod

public byte accessACWithMod(byte idAC)

accessAC

public byte accessAC(int idAC)

assignAC

public void assignAC(byte idAC,
                     byte value)

getSelectedACByType

public byte[] getSelectedACByType(com.mindgene.d20.common.rules.ArmorClassType type)

setSelectedACByType

public void setSelectedACByType(com.mindgene.d20.common.rules.ArmorClassType type)

hasCreatureTemplateModifiers

public boolean hasCreatureTemplateModifiers()

clearCreatureTemplateModifiers

public void clearCreatureTemplateModifiers()

getCreatureTemplateModifiers

public com.mindgene.d20.common.creature.CreatureTemplateModifiers getCreatureTemplateModifiers()

setCreatureTemplateModifiers

public void setCreatureTemplateModifiers(com.mindgene.d20.common.creature.CreatureTemplateModifiers creatureTemplateModifiers)

getFace

public java.awt.Dimension getFace()

The face of the creature in units (1 unit == 5 feet).

Returns:

getScaledFace

public java.awt.Dimension getScaledFace()

setFace

public void setFace(java.awt.Dimension face)

setFace

public void setFace(byte w,
                    byte h)

getWidth

public byte getWidth()

getHeight

public byte getHeight()

getReach

public byte getReach()

The reach of a creature is in units (1 unit == 5 feet)

Returns:

setReach

public void setReach(byte reach)

getSkills

public com.mindgene.d20.common.creature.CreatureTemplate_Skills getSkills()

setSkills

public void setSkills(com.mindgene.d20.common.creature.CreatureTemplate_Skills skills)

getFeats

public com.mindgene.d20.common.creature.CreatureTemplate_Feats getFeats()

setFeats

public void setFeats(com.mindgene.d20.common.creature.CreatureTemplate_Feats feats)

getItems

public com.mindgene.d20.common.creature.CreatureTemplate_Items getItems()

setItems

public void setItems(com.mindgene.d20.common.creature.CreatureTemplate_Items items)

getClasses

public com.mindgene.d20.common.creature.CreatureTemplate_Classes getClasses()

setClasses

public void setClasses(com.mindgene.d20.common.creature.CreatureTemplate_Classes classes)

clearTraits

public void clearTraits()

getLevel

public int getLevel()

initCustomTraits

public void initCustomTraits()

refreshTraits

public void refreshTraits()

removeTraitsForClass

public void removeTraitsForClass(CreatureClassTemplate template)

getTraits

public java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> getTraits()

getCustomTraits

public java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> getCustomTraits()

setTraits

public void setTraits(java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> traits)

getTraitByName

public com.mindgene.d20.common.game.trait.GenericTrait getTraitByName(java.lang.String name)

getItemByName

public com.mindgene.d20.common.item.ItemTemplate getItemByName(java.lang.String name)

getTraitFromLibrary

public com.mindgene.d20.common.game.trait.GenericTrait getTraitFromLibrary(java.lang.String name)

addTraitByName

public boolean addTraitByName(java.lang.String name)

method is used to add a trait to a creature during play (via the Rules->Scripting engine)

Parameters:

name -

Returns:

removeTraitByName

public boolean removeTraitByName(java.lang.String name)

method is used to remove a trait from a creature during play (via the Rules->Scripting engine)

Parameters:

name -

Returns:

getCustomTraitByName

public com.mindgene.d20.common.game.trait.GenericTrait getCustomTraitByName(java.lang.String name)

getTraitsByLevel

public java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> getTraitsByLevel()

resetKnownTraits

public java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> resetKnownTraits(com.mindgene.d20.common.AbstractApp app)

resetClassTraits

public java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> resetClassTraits(com.mindgene.d20.common.AbstractApp app)

getAllAvailTraits

public java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> getAllAvailTraits(com.mindgene.d20.common.AbstractApp app)

fetchTraitsFromClasses

public java.util.Map<java.lang.String,com.mindgene.d20.common.game.trait.GenericTrait> fetchTraitsFromClasses(com.mindgene.d20.common.AbstractApp abstractApp,
                                                                                                              boolean byLevel)

getImageID

public short getImageID()

setImageID

public void setImageID(short idImg)

getTeam

public byte getTeam()

setTeam

public void setTeam(byte idTeam)

getAttacks

public java.util.ArrayList<com.mindgene.d20.common.creature.attack.CreatureAttack> getAttacks()

setAttacks

public void setAttacks(java.util.ArrayList<com.mindgene.d20.common.creature.attack.CreatureAttack> attacks)

setStablized

public void setStablized(boolean stablized)

isStabilized

public boolean isStabilized()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

public java.lang.Object clone()

Overrides:

clone in class java.lang.Object

hurt

public int hurt(int damage)

Apply the following damage to the creature and return the current HP of the creature.

Parameters:

damage -

Returns:

total hp after damage

updatePriorHP

public void updatePriorHP()

heal

public int heal(int healing,
                boolean allowSurplus)

Apply the given healing to the creature.

Parameters:

healing -

allowSurplus - whether or not to allow more than 100% hitpoints.

Returns:

total hp after heal

resolveBAB

public int resolveBAB()

calculate the base attack bonus based on all classes

Returns:

integer value for base attack bonus

resolveGrappleModifier

public int resolveGrappleModifier(com.mindgene.d20.common.AbstractApp app)

resolveGrappleModifier

public int resolveGrappleModifier()

mimic

public void mimic(CreatureTemplate template,
                  com.mindgene.d20.common.game.creatureclass.CreatureClassBinder binder)

Causes this template to take on all the properties of the given template.

hideDamageExtent

public void hideDamageExtent()

makePublic

public CreatureTemplate makePublic(boolean revealDamageExtent)

Build a new template with only publicly available items filled in.

Returns:

getCoins

@Deprecated
public int[] getCoins()

Deprecated. - XML Only

setCoins

@Deprecated
public void setCoins(int[] money)

Deprecated. - XML Only

getMoney

@Deprecated
public byte[] getMoney()

Deprecated. - LEGACY SUPPORT ONLY

setMoney

@Deprecated
public void setMoney(byte[] money)

Deprecated. - LEGACY SUPPORT ONLY

getAbilities

public byte[] getAbilities()

setAbilities

@Deprecated
public void setAbilities(byte[] abilities)

Deprecated. - XML Only

getAbilitiesBase

public byte[] getAbilitiesBase()

setAbilitiesBase

@Deprecated
public void setAbilitiesBase(byte[] abilitiesBase)

Deprecated. - XML Only

getAbilitiesMods

@Deprecated
public byte[] getAbilitiesMods()

Deprecated. - XML Only

setAbilitiesMods

@Deprecated
public void setAbilitiesMods(byte[] abilitiesMods)

Deprecated. - XML Only

getSavesBase

public byte[] getSavesBase()

XML.

setSavesBase

public void setSavesBase(byte[] base)

XML.

getSavesMod

public byte[] getSavesMod()

XML.

setSavesMod

public void setSavesMod(byte[] mods)

XML.

getSaves

public byte[] getSaves(boolean calculate)

XML.

getSaves

public byte[] getSaves()

setSaves

public void setSaves(byte[] saves)

XML.

getTotalAC

public java.lang.String getTotalAC()

getAC

public byte[] getAC()

XML.

setAC

public void setAC(byte[] acblock)

XML.

getDescription

public java.lang.String getDescription()

setDescription

public void setDescription(java.lang.String description)

addToDescription

public void addToDescription(java.lang.String newLine)

getNotes

public java.lang.String getNotes()

ENCODED description only! Should only be used by CreatureTemplateFactory.

Returns:

setNotes

public void setNotes(java.lang.String notes)

getGMNotes

public java.lang.String getGMNotes()

setGMNotes

public void setGMNotes(java.lang.String gmNotes)

addToNotes

public void addToNotes(java.lang.String newLine)

addToErrorLog

public void addToErrorLog(java.lang.String newLine)

addToErrorLog

public void addToErrorLog(java.lang.Exception e)

addToErrorLog

public void addToErrorLog(java.lang.String message,
                          java.lang.Exception e)

addToBackground

public void addToBackground(java.lang.String newLine)

addToAbilitiesNotesLog

public void addToAbilitiesNotesLog(java.lang.String newLine)

buildFullNotes

public void buildFullNotes()

restoreTransientReferences

public void restoreTransientReferences(com.mindgene.d20.common.AbstractApp app)

When a template is serialized, certain references that are transient must be restored. Many subcomponents rely on the references for quick lookups.

extractSpellCasting

public com.mindgene.d20.common.creature.capability.CreatureCapability_SpellCaster extractSpellCasting(java.lang.String nameOfClass)

Access a spellcasting class by name.

Parameters:

nameOfClass - String

Returns:

GenericCreatureClass

extractSpellCastingClasses

public java.util.ArrayList<GenericCreatureClass> extractSpellCastingClasses()

isRegenerates

public boolean isRegenerates()

getRegenerates

public boolean getRegenerates()

setRegenerates

public void setRegenerates(boolean regenerates)

getFreeformCasting

public com.mindgene.d20.common.creature.capability.CreatureCapability_FreeformCaster getFreeformCasting()

setFreeformCasting

public void setFreeformCasting(com.mindgene.d20.common.creature.capability.CreatureCapability_FreeformCaster freeformCasting)

getItemCasting

public com.mindgene.d20.common.creature.capability.CreatureCapability_ItemCaster getItemCasting()

setItemCasting

public void setItemCasting(com.mindgene.d20.common.creature.capability.CreatureCapability_ItemCaster itemCasting)

getSpecialAbilities

public com.mindgene.d20.common.creature.CreatureTemplate_Abilities getSpecialAbilities()

setSpecialAbilities

public void setSpecialAbilities(com.mindgene.d20.common.creature.CreatureTemplate_Abilities specialAbilities)

getQuickNotes

public java.lang.String getQuickNotes()

setQuickNotes

public void setQuickNotes(java.lang.String quickNotes)

getRulesNotes

public java.lang.String getRulesNotes()

setRulesNotes

public void setRulesNotes(java.lang.String rulesNotes)

getGMQuickNotes

public java.lang.String getGMQuickNotes()

setGMQuickNotes

public void setGMQuickNotes(java.lang.String gmQuickNotes)

restSpells

public void restSpells()

All spellcasting classes have their spells rested, including freeform and items.

restSpellLevel

public void restSpellLevel(int value,
                           int level)

getVersion

public java.lang.String getVersion()

setVersion

public void setVersion(java.lang.String version)

hasOverrideBAB

public boolean hasOverrideBAB()

getOverrideBAB

public java.lang.Integer getOverrideBAB()

setOverrideBAB

public void setOverrideBAB(java.lang.Integer overrideBAB)

getFacing

public int getFacing()

setFacing

public void setFacing(int facing)

rotate

public void rotate(int degrees)

shouldBeEncrypted

public boolean shouldBeEncrypted()

isEncrypted

public boolean isEncrypted()

Specified by:

isEncrypted in interface com.mindgene.util.CryptUtil.Encryptable

setEncrypted

public void setEncrypted(boolean encrypted)

Specified by:

setEncrypted in interface com.mindgene.util.CryptUtil.Encryptable

getBottomLabel

public com.mindgene.d20.common.creature.CreatureLabel getBottomLabel()

setBottomLabel

public void setBottomLabel(com.mindgene.d20.common.creature.CreatureLabel bottomLabel)

getTopLabel

public com.mindgene.d20.common.creature.CreatureLabel getTopLabel()

setTopLabel

public void setTopLabel(com.mindgene.d20.common.creature.CreatureLabel topLabel)

getSkillPenalty

public com.mindgene.d20.common.creature.SkillPenalty getSkillPenalty()

setSkillPenalty

public void setSkillPenalty(com.mindgene.d20.common.creature.SkillPenalty skillPenalty)

call

public java.lang.String call(java.lang.String method,
                             java.lang.String parameters)
                      throws java.lang.Exception

Invoke a method located at the indicated path

Parameters:

path - - the path to the method to invoke

params - - array of parameters to pass to the method

Returns:

- returns the results of the method

Throws:

java.lang.Exception - Sample usageRules.getInstance().invokeMethod("Rules.Ability.getName", new Object[] { i } )

invokeMethod

public java.lang.Object invokeMethod(java.lang.String method,
                                     java.lang.Object... params)
                              throws java.lang.Exception

Throws:

java.lang.Exception

testString

public java.lang.String testString(java.lang.String b)

testBool

public boolean testBool(boolean b)

testDouble

public double testDouble(double b)

testByte

public byte testByte(byte b)

testInt

public int testInt(int b)

testChar

public char[] testChar(char[] b)

testFloat

public float testFloat(float b)

testPoint

public java.awt.Point testPoint(java.awt.Point b)