com.mindgene.d20.dm.game

Class CreatureInPlay

java.lang.Object

com.mindgene.d20.common.map.GenericMapObject

com.mindgene.d20.common.game.AbstractCreatureInPlay

com.mindgene.d20.dm.game.CreatureInPlay

All Implemented Interfaces:

com.mindgene.d20.common.creature.GenericCreatureModel, Tethered, com.mindgene.d20.common.util.Matchable, com.sengent.common.control.Named, java.io.Serializable

public final class CreatureInPlay
extends AbstractCreatureInPlay

A creature created by a CreatureTemplate with all in game information.

See Also:

Serialized Form

Field Summary

Fields inherited from class com.mindgene.d20.common.game.AbstractCreatureInPlay

_template, PUBLICLY_OWNED

Fields inherited from class com.mindgene.d20.common.map.GenericMapObject

CLIP_TAB

Fields inherited from interface com.mindgene.d20.common.creature.GenericCreatureModel

DAMAGE_RATIO_UNKNOWN

Constructor Summary

Constructors

Constructor and Description
CreatureInPlay() Deprecated. - XML Only
CreatureInPlay(CreatureTemplate template) Default constructor.

Method Summary

Modifier and Type	Method and Description
void	addEffect(com.mindgene.d20.dm.game.EffectInPlay effect)
void	adjustStatModifiers(com.mindgene.d20.dm.game.EffectInPlay effectToRemove)
int	applyDamageOverTime(int rounds)
int	applyFastHealing(int rounds, com.mindgene.d20.common.AbstractApp<?> app)
void	bindEffect(com.mindgene.d20.dm.game.EffectInPlay effect) Replace the equivalent feat with the instance of the given effect.
void	cancelExistingEffect(com.mindgene.d20.dm.game.GameModel game, java.lang.Class<?> classToCancel)
CreatureTemplate	cloneTemplate()
boolean	determineIfCreatureIsVisible(com.mindgene.d20.dm.DM dm)
boolean	determineIfCreatureIsVisible(com.mindgene.d20.dm.DM dm, com.mindgene.d20.dm.map.MapAccess mapAccess)
CreatureTemplate	dupeTemplate() Returns a duplicate of this creature by cloning the template.
void	enlarge()
java.util.ArrayList<com.mindgene.d20.dm.game.EffectInPlay>	getEffects()
java.awt.Rectangle	getFootprint()
int	getInit()
int	getStatMask()
CreatureTemplate	getTemplate()
int	getVisibilityMask()
boolean	hasEffects()
void	initCharge(com.mindgene.d20.dm.game.GameModel game)
void	initDelay(com.mindgene.d20.dm.game.GameModel game)
boolean	initNeitherDelayNorReady()
void	initReady(com.mindgene.d20.dm.game.GameModel game)
void	initReleaseDelayAndReady(com.mindgene.d20.dm.game.GameModel game)
boolean	isActionable(java.lang.String thatOwner) Always actionable.
boolean	isBefore(CreatureInPlay otherCreature) Indicates if this creature should go before another creature with the same init score.
boolean	isVisible()
com.mindgene.d20.common.game.PublicCreatureInPlay	makePublic(boolean isOwned, boolean isVisible, boolean revealDamageExtent)
void	mimic(CreatureInPlay mob) Make this creature take on certain characteristics of another mob.
void	reduce()
void	removeAllEffects()
com.mindgene.d20.dm.game.EffectInPlay	removeEffectIfPresent(com.mindgene.d20.dm.game.EffectInPlay effectToRemove)
void	rollInit() Rolls an initiative score for the creature.
void	sanityCheck(com.mindgene.d20.common.AbstractApp app)
void	setEffects(java.util.ArrayList effects) Deprecated. - XML Only
void	setInit(int init)
void	setStatMask(int mask)
void	setTemplate(CreatureTemplate template) Deprecated. - XML Only
void	setVisibilityMask(int mask)
void	undoStatModifierChanges(com.mindgene.d20.dm.game.EffectInPlay effectToRemove) UndoStatModifierChanges will check to see if there was any ability score changes then undo any hitpoints of modifiers to saving throws.

Methods inherited from class com.mindgene.d20.common.game.AbstractCreatureInPlay

accessSize, addAppliedFeatureEffect, addStatus, assignSize, attach, byUIN, clone, cloneAndSanityCheck, createColorizeOp, declareConsole, declareTooltip, detach, getAppliedFeatureBehaviorList, getImageID, getName, getOwner, getStatusList, hasOwner, hasStatus, isImmobilized, isOwnedBy, isOwnedByOrPublic, paint, paint, paintStatus, peekPrimaryImage, recognizeMobMoved, removeStatus, resolveAllAttacks, rollSave, rotateImage, setAppliedFeatureBehaviorList, setImmobilized, setOwner, toArrayByUIN

Methods inherited from class com.mindgene.d20.common.map.GenericMapObject

assignMap, clip_RoundedRectangle, equals, getElevation, getLights, getLocation, getLocationClosestTo, getMapName, getMapUIN, getMarkers, getMovement, getOffset, getPoint, getPoint2D, getTemplates, getTethers, getUIN, hashCode, hasMovement, inLimbo, isOnMap, isRotated, isTetheredTo, matches, mimic, notifyMobMoved, peekUIN, putInLimbo, removeAllLights, removeLights, removeTetherTo, resolveCenter, setElevation, setLights, setLocation, setLocation, setMapName, setMapUIN, setMarkers, setMovement, setOffset, setRotated, setTemplates, setTethers, setUIN, toString, translate

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.mindgene.d20.common.creature.GenericCreatureModel

getUIN

Methods inherited from interface com.mindgene.d20.common.util.Matchable

matches

Constructor Detail

CreatureInPlay

public CreatureInPlay(CreatureTemplate template)

Default constructor.

Parameters:

template -

CreatureInPlay

@Deprecated
public CreatureInPlay()

Deprecated. - XML Only

Method Detail

dupeTemplate

public CreatureTemplate dupeTemplate()

Returns a duplicate of this creature by cloning the template.

Returns:

mimic

public void mimic(CreatureInPlay mob)

Make this creature take on certain characteristics of another mob.

Parameters:

mob -

getTemplate

public CreatureTemplate getTemplate()

cloneTemplate

public CreatureTemplate cloneTemplate()

getInit

public int getInit()

getVisibilityMask

public int getVisibilityMask()

setVisibilityMask

public void setVisibilityMask(int mask)

getStatMask

public int getStatMask()

setStatMask

public void setStatMask(int mask)

hasEffects

public boolean hasEffects()

getEffects

public java.util.ArrayList<com.mindgene.d20.dm.game.EffectInPlay> getEffects()

addEffect

public void addEffect(com.mindgene.d20.dm.game.EffectInPlay effect)

removeAllEffects

public void removeAllEffects()

removeEffectIfPresent

public com.mindgene.d20.dm.game.EffectInPlay removeEffectIfPresent(com.mindgene.d20.dm.game.EffectInPlay effectToRemove)

undoStatModifierChanges

public void undoStatModifierChanges(com.mindgene.d20.dm.game.EffectInPlay effectToRemove)

UndoStatModifierChanges will check to see if there was any ability score changes then undo any hitpoints of modifiers to saving throws. It will also checks for tempory hitpoints that need to be removed

Parameters:

effectToRemove -

adjustStatModifiers

public void adjustStatModifiers(com.mindgene.d20.dm.game.EffectInPlay effectToRemove)

bindEffect

public void bindEffect(com.mindgene.d20.dm.game.EffectInPlay effect)

Replace the equivalent feat with the instance of the given effect.

Parameters:

effect - the new object to use

getFootprint

public java.awt.Rectangle getFootprint()

Specified by:

getFootprint in class GenericMapObject

rollInit

public void rollInit()

Rolls an initiative score for the creature. Dex modifier and improved init feat are considered.

isBefore

public boolean isBefore(CreatureInPlay otherCreature)

Indicates if this creature should go before another creature with the same init score.

Parameters:

otherCreature -

Returns:

isVisible

public boolean isVisible()

determineIfCreatureIsVisible

public boolean determineIfCreatureIsVisible(com.mindgene.d20.dm.DM dm)

determineIfCreatureIsVisible

public boolean determineIfCreatureIsVisible(com.mindgene.d20.dm.DM dm,
                                            com.mindgene.d20.dm.map.MapAccess mapAccess)

makePublic

public com.mindgene.d20.common.game.PublicCreatureInPlay makePublic(boolean isOwned,
                                                                    boolean isVisible,
                                                                    boolean revealDamageExtent)

setInit

public void setInit(int init)

sanityCheck

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

isActionable

public boolean isActionable(java.lang.String thatOwner)

Always actionable.

Parameters:

thatOwner - String

Returns:

boolean

initNeitherDelayNorReady

public boolean initNeitherDelayNorReady()

Returns:

true if neither delay or ready effect found

cancelExistingEffect

public void cancelExistingEffect(com.mindgene.d20.dm.game.GameModel game,
                                 java.lang.Class<?> classToCancel)

initReady

public void initReady(com.mindgene.d20.dm.game.GameModel game)

initDelay

public void initDelay(com.mindgene.d20.dm.game.GameModel game)

initCharge

public void initCharge(com.mindgene.d20.dm.game.GameModel game)

initReleaseDelayAndReady

public void initReleaseDelayAndReady(com.mindgene.d20.dm.game.GameModel game)

enlarge

public void enlarge()

reduce

public void reduce()

applyFastHealing

public int applyFastHealing(int rounds,
                            com.mindgene.d20.common.AbstractApp<?> app)

applyDamageOverTime

public int applyDamageOverTime(int rounds)

setTemplate

@Deprecated
public void setTemplate(CreatureTemplate template)

Deprecated. - XML Only

setEffects

@Deprecated
public void setEffects(java.util.ArrayList effects)

Deprecated. - XML Only