Describes a Crossfire spell. More...

Collaboration diagram for com.realtime.crossfire.jxclient.spells.Spell:

Public Member Functions
void	addSpellListener (@NotNull final SpellListener listener)
	Adds a SpellListener to be notified of changes. More...

int	getCastingTime ()
	Returns the casting time. More...

int	getDamage ()
	Returns the damage done by the spell. More...

int	getFaceNum ()
	Returns the face number. More...

int	getGrace ()
	Returns the grace needed to cast the spell. More...

int	getLevel ()
	Returns the spell level. More...

int	getMana ()
	Returns the mana needed to cast the spell. More...

String	getMessage ()
	Returns the description. More...

String	getName ()
	Returns the spell name. More...

int	getPath ()
	Returns the spell path. More...

int	getSkill ()
	Returns the spell's skill. More...

int	getTag ()
	Returns the tag ID. More...

String	getTooltipText ()
	Returns a description for this spell to be used in tooltips. More...

boolean	isUnknown ()
	Returns whether this spell is unknown to the character. More...

void	removeSpellListener (@NotNull final SpellListener listener)
	Removes a SpellListener to be notified of changes. More...

void	setParameters (final int faceNum, final int tag, @NotNull final String message, final int level, final int castingTime, final int mana, final int grace, final int damage, final int skill, final int path)
	Updates the spell's parameters. More...

void	setUnknown (final boolean unknown)
	Marks this spell as known or unknown for the character. More...

	Spell (@NotNull final String name, @NotNull final SkillSet skillSet, @NotNull final Stats stats)
	Creates a new instance. More...

String	toString ()

void	updateParameters (final boolean updateMana, final int mana, final boolean updateGrace, final int grace, final boolean updateDamage, final int damage)
	Updates the spell's parameters. More...

Private Member Functions
void	fireChanged ()
	Notifies all listeners. More...

Private Attributes
int	castingTime
	The casting time. More...

int	damage
	The damage done by the spell. More...

int	faceNum
	The face number. More...

int	grace
	The grace needed to cast the spell. More...

int	level
	The spell level. More...

final EventListenerList2< SpellListener >	listeners = new EventListenerList2<>()
	The SpellListeners to be notified of changes. More...

int	mana
	The mana needed to cast the spell. More...

String	message = ""
	The description. More...

final String	name
	The spell name. More...

int	path
	The spell path. More...

int	skill
	The spell's skill. More...

final SkillSet	skillSet
	To get the skill's name, see SkillSet. More...

final Stats	stats
	Attuned, repelled or denied information. More...

int	tag
	The tag ID. More...

boolean	unknown
	Whether this spell is unknown to the character. More...

Detailed Description

Describes a Crossfire spell.

Author: Lauwenmark

Definition at line 36 of file Spell.java.

Constructor & Destructor Documentation

◆ Spell()

com.realtime.crossfire.jxclient.spells.Spell.Spell	(	@NotNull final String	name,
		@NotNull final SkillSet	skillSet,
		@NotNull final Stats	stats
	)

Creates a new instance.

Parameters

name	the spell name
skillSet	the skills
stats	the stats instance

Definition at line 122 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.name, com.realtime.crossfire.jxclient.spells.Spell.skillSet, and com.realtime.crossfire.jxclient.spells.Spell.stats.

Member Function Documentation

◆ addSpellListener()

void com.realtime.crossfire.jxclient.spells.Spell.addSpellListener ( @NotNull final SpellListener listener )

Adds a SpellListener to be notified of changes.

Parameters

listener the listener to add

Definition at line 425 of file Spell.java.

References com.realtime.crossfire.jxclient.util.EventListenerList2< T extends EventListener >.add().

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setSpell(), and com.realtime.crossfire.jxclient.shortcuts.ShortcutSpell.ShortcutSpell().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ fireChanged()

void com.realtime.crossfire.jxclient.spells.Spell.fireChanged ( )

private

Notifies all listeners.

Definition at line 415 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.setParameters(), com.realtime.crossfire.jxclient.spells.Spell.setUnknown(), and com.realtime.crossfire.jxclient.spells.Spell.updateParameters().

Here is the caller graph for this function:

◆ getCastingTime()

int com.realtime.crossfire.jxclient.spells.Spell.getCastingTime ( )

Returns the casting time.

Returns: the casting time

Definition at line 148 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.castingTime.

◆ getDamage()

int com.realtime.crossfire.jxclient.spells.Spell.getDamage ( )

Returns the damage done by the spell.

Returns: the damage

Definition at line 172 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.damage.

◆ getFaceNum()

int com.realtime.crossfire.jxclient.spells.Spell.getFaceNum ( )

Returns the face number.

Returns: the face number

Definition at line 214 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.faceNum.

Referenced by com.realtime.crossfire.jxclient.shortcuts.ShortcutSpell.displaysFace(), and com.realtime.crossfire.jxclient.items.SpellsView.getItem().

Here is the caller graph for this function:

◆ getGrace()

int com.realtime.crossfire.jxclient.spells.Spell.getGrace ( )

Returns the grace needed to cast the spell.

Returns: the grace

Definition at line 164 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.grace.

◆ getLevel()

int com.realtime.crossfire.jxclient.spells.Spell.getLevel ( )

Returns the spell level.

Returns: the spell level

Definition at line 140 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.level.

◆ getMana()

int com.realtime.crossfire.jxclient.spells.Spell.getMana ( )

Returns the mana needed to cast the spell.

Returns: the mana

Definition at line 156 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.mana.

◆ getMessage()

String com.realtime.crossfire.jxclient.spells.Spell.getMessage ( )

Returns the description.

Returns: the description

Definition at line 206 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.message.

◆ getName()

String com.realtime.crossfire.jxclient.spells.Spell.getName ( )

Returns the spell name.

Returns: the spell name

Definition at line 197 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.name.

Referenced by com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.button1Clicked(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.button2Clicked(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.button3Clicked(), com.realtime.crossfire.jxclient.spells.SpellsManager.deleteSpellByIndex(), com.realtime.crossfire.jxclient.items.SpellsView.getItem(), com.realtime.crossfire.jxclient.spells.SpellsManager.getSpell(), and com.realtime.crossfire.jxclient.window.ShortcutsLoader.saveShortcuts().

Here is the caller graph for this function:

◆ getPath()

int com.realtime.crossfire.jxclient.spells.Spell.getPath ( )

Returns the spell path.

Returns: the spell path

Definition at line 188 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.path.

◆ getSkill()

int com.realtime.crossfire.jxclient.spells.Spell.getSkill ( )

Returns the spell's skill.

See Stats#CS_STAT_SKILLINFO.

Returns: the spell's skill

Definition at line 180 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.skill.

◆ getTag()

int com.realtime.crossfire.jxclient.spells.Spell.getTag ( )

Returns the tag ID.

Returns: the tag ID

Definition at line 132 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.tag.

Referenced by com.realtime.crossfire.jxclient.shortcuts.ShortcutSpell.execute(), and com.realtime.crossfire.jxclient.items.SpellsView.getItem().

Here is the caller graph for this function:

◆ getTooltipText()

String com.realtime.crossfire.jxclient.spells.Spell.getTooltipText ( )

Returns a description for this spell to be used in tooltips.

Returns: the tooltip text

Definition at line 359 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.shortcuts.ShortcutSpell.getTooltipText(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setSpell(), and com.realtime.crossfire.jxclient.gui.list.GUISpellList.updateTooltip().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isUnknown()

boolean com.realtime.crossfire.jxclient.spells.Spell.isUnknown ( )

Returns whether this spell is unknown to the character.

Returns: whether this spell is unknown

Definition at line 222 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.unknown.

Referenced by com.realtime.crossfire.jxclient.shortcuts.ShortcutSpell.execute().

Here is the caller graph for this function:

◆ removeSpellListener()

void com.realtime.crossfire.jxclient.spells.Spell.removeSpellListener ( @NotNull final SpellListener listener )

Removes a SpellListener to be notified of changes.

Parameters

listener the listener to remove

Definition at line 433 of file Spell.java.

References com.realtime.crossfire.jxclient.util.EventListenerList2< T extends EventListener >.remove().

Referenced by com.realtime.crossfire.jxclient.shortcuts.ShortcutSpell.dispose(), com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.dispose(), and com.realtime.crossfire.jxclient.gui.item.GUIItemSpell.setSpell().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setParameters()

void com.realtime.crossfire.jxclient.spells.Spell.setParameters	(	final int	faceNum,
		final int	tag,
		@NotNull final String	message,
		final int	level,
		final int	castingTime,
		final int	mana,
		final int	grace,
		final int	damage,
		final int	skill,
		final int	path
	)

Updates the spell's parameters.

Parameters

faceNum	the face number
tag	the tag ID
message	the description
level	the spell level
castingTime	the casting time
mana	the mana needed to cast the spell
grace	the grace needed to cast the spell
damage	the damage done by the spell
skill	the spell's skill
path	the spell path

Definition at line 250 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.SpellsManager.addSpell().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setUnknown()

void com.realtime.crossfire.jxclient.spells.Spell.setUnknown ( final boolean unknown )

Marks this spell as known or unknown for the character.

Parameters

unknown whether this spell is unknown

Definition at line 230 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.fireChanged(), and com.realtime.crossfire.jxclient.spells.Spell.unknown.

Referenced by com.realtime.crossfire.jxclient.spells.SpellsManager.deleteSpellByIndex(), and com.realtime.crossfire.jxclient.spells.SpellsManager.getSpell().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ toString()

String com.realtime.crossfire.jxclient.spells.Spell.toString ( )

Definition at line 350 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.unknown.

◆ updateParameters()

void com.realtime.crossfire.jxclient.spells.Spell.updateParameters	(	final boolean	updateMana,
		final int	mana,
		final boolean	updateGrace,
		final int	grace,
		final boolean	updateDamage,
		final int	damage
	)

Updates the spell's parameters.

Parameters

updateMana	whether to update the mana
mana	the mana needed to cast the spell
updateGrace	whether to update the grace
grace	the grace needed to cast the spell
updateDamage	whether to update the damage
damage	the damage done by the spell

Definition at line 322 of file Spell.java.

References com.realtime.crossfire.jxclient.spells.Spell.damage, com.realtime.crossfire.jxclient.spells.Spell.fireChanged(), com.realtime.crossfire.jxclient.spells.Spell.grace, and com.realtime.crossfire.jxclient.spells.Spell.mana.

Here is the call graph for this function:

Member Data Documentation

◆ castingTime

int com.realtime.crossfire.jxclient.spells.Spell.castingTime

private

The casting time.

Definition at line 74 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getCastingTime(), and com.realtime.crossfire.jxclient.spells.Spell.setParameters().

◆ damage

int com.realtime.crossfire.jxclient.spells.Spell.damage

private

The damage done by the spell.

Definition at line 89 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getDamage(), com.realtime.crossfire.jxclient.spells.Spell.setParameters(), and com.realtime.crossfire.jxclient.spells.Spell.updateParameters().

◆ faceNum

int com.realtime.crossfire.jxclient.spells.Spell.faceNum

private

The face number.

Definition at line 53 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getFaceNum(), and com.realtime.crossfire.jxclient.spells.Spell.setParameters().

◆ grace

int com.realtime.crossfire.jxclient.spells.Spell.grace

private

The grace needed to cast the spell.

Definition at line 84 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getGrace(), com.realtime.crossfire.jxclient.spells.Spell.setParameters(), and com.realtime.crossfire.jxclient.spells.Spell.updateParameters().

◆ level

int com.realtime.crossfire.jxclient.spells.Spell.level

private

The spell level.

Definition at line 69 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getLevel(), com.realtime.crossfire.jxclient.spells.Spell.getTooltipText(), and com.realtime.crossfire.jxclient.spells.Spell.setParameters().

◆ listeners

final EventListenerList2<SpellListener> com.realtime.crossfire.jxclient.spells.Spell.listeners = new EventListenerList2<>()

private

The SpellListeners to be notified of changes.

Definition at line 48 of file Spell.java.

◆ mana

int com.realtime.crossfire.jxclient.spells.Spell.mana

private

The mana needed to cast the spell.

Definition at line 79 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getMana(), com.realtime.crossfire.jxclient.spells.Spell.setParameters(), and com.realtime.crossfire.jxclient.spells.Spell.updateParameters().

◆ message

String com.realtime.crossfire.jxclient.spells.Spell.message = ""

private

The description.

Definition at line 64 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getMessage(), and com.realtime.crossfire.jxclient.spells.Spell.setParameters().

◆ name

final String com.realtime.crossfire.jxclient.spells.Spell.name

private

The spell name.

Definition at line 42 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getName(), and com.realtime.crossfire.jxclient.spells.Spell.Spell().

◆ path

int com.realtime.crossfire.jxclient.spells.Spell.path

private

The spell path.

Definition at line 99 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getPath(), and com.realtime.crossfire.jxclient.spells.Spell.setParameters().

◆ skill

int com.realtime.crossfire.jxclient.spells.Spell.skill

private

The spell's skill.

See Stats#CS_STAT_SKILLINFO.

Definition at line 94 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getSkill(), and com.realtime.crossfire.jxclient.spells.Spell.setParameters().

◆ skillSet

final SkillSet com.realtime.crossfire.jxclient.spells.Spell.skillSet

private

To get the skill's name, see SkillSet.

Definition at line 109 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.Spell().

◆ stats

final Stats com.realtime.crossfire.jxclient.spells.Spell.stats

private

Attuned, repelled or denied information.

Definition at line 114 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.Spell().

◆ tag

int com.realtime.crossfire.jxclient.spells.Spell.tag

private

The tag ID.

Definition at line 58 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.getTag(), and com.realtime.crossfire.jxclient.spells.Spell.setParameters().

◆ unknown

boolean com.realtime.crossfire.jxclient.spells.Spell.unknown

private

Whether this spell is unknown to the character.

Definition at line 104 of file Spell.java.

Referenced by com.realtime.crossfire.jxclient.spells.Spell.isUnknown(), com.realtime.crossfire.jxclient.spells.Spell.setUnknown(), and com.realtime.crossfire.jxclient.spells.Spell.toString().

The documentation for this class was generated from the following file:

crossfire-code/jxclient/trunk/src/model/src/main/java/com/realtime/crossfire/jxclient/spells/Spell.java

Public Member Functions

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ Spell()

Member Function Documentation

◆ addSpellListener()

◆ fireChanged()

◆ getCastingTime()

◆ getDamage()

◆ getFaceNum()

◆ getGrace()

◆ getLevel()

◆ getMana()

◆ getMessage()

◆ getName()

◆ getPath()

◆ getSkill()

◆ getTag()

◆ getTooltipText()

◆ isUnknown()

◆ removeSpellListener()

◆ setParameters()

◆ setUnknown()

◆ toString()

◆ updateParameters()

Member Data Documentation

◆ castingTime

◆ damage

◆ faceNum

◆ grace

◆ level

◆ listeners

◆ mana

◆ message

◆ name

◆ path

◆ skill

◆ skillSet

◆ stats

◆ tag

◆ unknown