com.mindgene.d20.common.game.spell

Class SpellEffectTemplate

java.lang.Object

com.mindgene.d20.common.game.spell.SpellEffectTemplate

All Implemented Interfaces:

java.io.Serializable

public final class SpellEffectTemplate
extends java.lang.Object
implements java.io.Serializable

Information about an effect that a spell is creating.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
java.lang.String	_durationMode
static int	NO_DURATION
static int	NO_SAVE

Constructor Summary

Constructors

Constructor and Description
SpellEffectTemplate() Deprecated. - XML Only
SpellEffectTemplate(java.lang.String name, int duration, int saveDC, byte saveType, java.lang.String saveResult, com.mindgene.d20.common.game.effect.EffectModifiers effectModifiers)

Method Summary

Modifier and Type	Method and Description
int	accessDurationInRounds()
static SpellEffectTemplate	buildDefault()
java.lang.String	formatDuration()
java.lang.String	formatSave()
int	getDuration() The duration in units specified by _durationMode.
java.lang.String	getDurationMode()
com.mindgene.d20.common.game.effect.EffectModifiers	getEffectModifiers()
java.lang.String	getName()
int	getSaveDC()
java.lang.String	getSaveResult()
byte	getSaveType()
short	getSpellResistanceRoll()
boolean	hasDuration()
boolean	hasSavingThrow()
boolean	isInfinite()
boolean	isInstant()
void	setDuration(int duration)
void	setDurationMode(java.lang.String durationMode)
void	setEffectModifiers(com.mindgene.d20.common.game.effect.EffectModifiers mod)
void	setName(java.lang.String name)
void	setSaveDC(int saveDC)
void	setSaveResult(java.lang.String saveResult)
void	setSaveType(byte saveType)
void	setSpellResistanceRoll(short spellResistanceRoll)

Methods inherited from class java.lang.Object

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

Field Detail

NO_DURATION

public static final int NO_DURATION

See Also:

Constant Field Values

NO_SAVE

public static final int NO_SAVE

See Also:

Constant Field Values

_durationMode

public java.lang.String _durationMode

Constructor Detail

SpellEffectTemplate

public SpellEffectTemplate(java.lang.String name,
                           int duration,
                           int saveDC,
                           byte saveType,
                           java.lang.String saveResult,
                           com.mindgene.d20.common.game.effect.EffectModifiers effectModifiers)

SpellEffectTemplate

public SpellEffectTemplate()

Deprecated. - XML Only

Method Detail

buildDefault

public static SpellEffectTemplate buildDefault()

getName

public java.lang.String getName()

hasDuration

public boolean hasDuration()

getDuration

public int getDuration()

The duration in units specified by _durationMode.

Returns:

int

isInstant

public boolean isInstant()

isInfinite

public boolean isInfinite()

accessDurationInRounds

public int accessDurationInRounds()

hasSavingThrow

public boolean hasSavingThrow()

getSaveDC

public int getSaveDC()

getSaveType

public byte getSaveType()

getSaveResult

public java.lang.String getSaveResult()

getEffectModifiers

public com.mindgene.d20.common.game.effect.EffectModifiers getEffectModifiers()

getSpellResistanceRoll

public short getSpellResistanceRoll()

setEffectModifiers

public void setEffectModifiers(com.mindgene.d20.common.game.effect.EffectModifiers mod)

setDuration

public void setDuration(int duration)

setName

public void setName(java.lang.String name)

setSaveDC

public void setSaveDC(int saveDC)

setSaveResult

public void setSaveResult(java.lang.String saveResult)

setSaveType

public void setSaveType(byte saveType)

setSpellResistanceRoll

public void setSpellResistanceRoll(short spellResistanceRoll)

getDurationMode

public java.lang.String getDurationMode()

setDurationMode

public void setDurationMode(java.lang.String durationMode)

formatDuration

public java.lang.String formatDuration()

formatSave

public java.lang.String formatSave()