Crossfire JXClient, Trunk
Public Member Functions | Private Member Functions | Private Attributes | List of all members
com.realtime.crossfire.jxclient.skills.Skill Class Reference
Collaboration diagram for com.realtime.crossfire.jxclient.skills.Skill:
Collaboration graph

Public Member Functions

void addSkillListener (@NotNull final SkillListener listener)
 
long getExperience ()
 
int getFace ()
 
int getLevel ()
 
String getTooltipText ()
 
void removeSkillListener (@NotNull final SkillListener listener)
 
void set (final int level, final long experience)
 
void setFace (final int face)
 
void setMessage (@Nullable final String message)
 
 Skill (@NotNull final String name)
 
String toString ()
 

Private Member Functions

void fireAddSkill ()
 
void fireDelSkill ()
 
void fireEvents (final boolean oldKnown)
 
void fireUpdSkill ()
 
boolean isKnown ()
 

Private Attributes

long experience
 
int face = -1
 
int level
 
final EventListenerList2< SkillListenerlisteners = new EventListenerList2<>()
 
String message
 
final String name
 

Detailed Description

One skill of the character.

Author
Lauwenmark
Andreas Kirschbaum

Definition at line 35 of file Skill.java.

Constructor & Destructor Documentation

◆ Skill()

com.realtime.crossfire.jxclient.skills.Skill.Skill ( @NotNull final String  name)

Creates a new instance.

Parameters
namethe skill name

Definition at line 75 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.name.

Member Function Documentation

◆ addSkillListener()

void com.realtime.crossfire.jxclient.skills.Skill.addSkillListener ( @NotNull final SkillListener  listener)

◆ fireAddSkill()

void com.realtime.crossfire.jxclient.skills.Skill.fireAddSkill ( )
private

Notifies all listeners about a gained skill.

Definition at line 186 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.listeners.

Referenced by com.realtime.crossfire.jxclient.skills.Skill.fireEvents().

Here is the caller graph for this function:

◆ fireDelSkill()

void com.realtime.crossfire.jxclient.skills.Skill.fireDelSkill ( )
private

Notifies all listeners about a lost attribute.

Definition at line 195 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.listeners.

Referenced by com.realtime.crossfire.jxclient.skills.Skill.fireEvents().

Here is the caller graph for this function:

◆ fireEvents()

void com.realtime.crossfire.jxclient.skills.Skill.fireEvents ( final boolean  oldKnown)
private

Notifies all listeners about changes.

Parameters
oldKnownwhether the skill was known before the update

Definition at line 170 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.fireAddSkill(), com.realtime.crossfire.jxclient.skills.Skill.fireDelSkill(), com.realtime.crossfire.jxclient.skills.Skill.fireUpdSkill(), and com.realtime.crossfire.jxclient.skills.Skill.isKnown().

Referenced by com.realtime.crossfire.jxclient.skills.Skill.set().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ fireUpdSkill()

void com.realtime.crossfire.jxclient.skills.Skill.fireUpdSkill ( )
private

Notifies all listeners about an updated attribute.

Definition at line 204 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.listeners.

Referenced by com.realtime.crossfire.jxclient.skills.Skill.fireEvents().

Here is the caller graph for this function:

◆ getExperience()

long com.realtime.crossfire.jxclient.skills.Skill.getExperience ( )

Returns the skill experience.

Returns
the skill experience

Definition at line 99 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.experience.

Referenced by com.realtime.crossfire.jxclient.scripts.AbstractScriptProcess.cmdRequest(), and com.realtime.crossfire.jxclient.gui.gauge.ActiveSkillGaugeUpdater2.update().

Here is the caller graph for this function:

◆ getFace()

int com.realtime.crossfire.jxclient.skills.Skill.getFace ( )

Returns the skill's face.

Returns
face number, -1 if no face defined.

Definition at line 115 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.face.

Referenced by com.realtime.crossfire.jxclient.items.SpellSkillView.getItem().

Here is the caller graph for this function:

◆ getLevel()

int com.realtime.crossfire.jxclient.skills.Skill.getLevel ( )

◆ getTooltipText()

String com.realtime.crossfire.jxclient.skills.Skill.getTooltipText ( )

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

Returns
the tooltip text or
null
if unknown

Definition at line 154 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.message, and com.realtime.crossfire.jxclient.util.StringSplitter.splitAsHtml().

Referenced by com.realtime.crossfire.jxclient.gui.gauge.ActiveSkillGaugeUpdater2.update().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ isKnown()

boolean com.realtime.crossfire.jxclient.skills.Skill.isKnown ( )
private

Returns whether the skill is known.

Returns
whether the skill is known

Definition at line 139 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.experience, and com.realtime.crossfire.jxclient.skills.Skill.level.

Referenced by com.realtime.crossfire.jxclient.skills.Skill.fireEvents(), and com.realtime.crossfire.jxclient.skills.Skill.set().

Here is the caller graph for this function:

◆ removeSkillListener()

void com.realtime.crossfire.jxclient.skills.Skill.removeSkillListener ( @NotNull final SkillListener  listener)

◆ set()

void com.realtime.crossfire.jxclient.skills.Skill.set ( final int  level,
final long  experience 
)

Updates the skill attributes.

Parameters
levelthe new skill level
experiencethe new skill experience

Definition at line 84 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.experience, com.realtime.crossfire.jxclient.skills.Skill.fireEvents(), com.realtime.crossfire.jxclient.skills.Skill.isKnown(), and com.realtime.crossfire.jxclient.skills.Skill.level.

Referenced by com.realtime.crossfire.jxclient.skills.SkillSet.addSkill(), and com.realtime.crossfire.jxclient.stats.Stats.setStatSkill().

Here is the call graph for this function:
Here is the caller graph for this function:

◆ setFace()

void com.realtime.crossfire.jxclient.skills.Skill.setFace ( final int  face)

Defines the skill's face.

Parameters
facenew face index

Definition at line 123 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.face.

Referenced by com.realtime.crossfire.jxclient.skills.SkillSet.getNamedSkill().

Here is the caller graph for this function:

◆ setMessage()

void com.realtime.crossfire.jxclient.skills.Skill.setMessage ( @Nullable final String  message)

Defines the skill's message.

Parameters
messagenew message, may be null

Definition at line 131 of file Skill.java.

References com.realtime.crossfire.jxclient.skills.Skill.message.

Referenced by com.realtime.crossfire.jxclient.skills.SkillSet.addSkill(), and com.realtime.crossfire.jxclient.skills.SkillSet.setSkillExtra().

Here is the caller graph for this function:

◆ toString()

String com.realtime.crossfire.jxclient.skills.Skill.toString ( )

Member Data Documentation

◆ experience

long com.realtime.crossfire.jxclient.skills.Skill.experience
private

◆ face

int com.realtime.crossfire.jxclient.skills.Skill.face = -1
private

◆ level

int com.realtime.crossfire.jxclient.skills.Skill.level
private

◆ listeners

final EventListenerList2<SkillListener> com.realtime.crossfire.jxclient.skills.Skill.listeners = new EventListenerList2<>()
private

◆ message

String com.realtime.crossfire.jxclient.skills.Skill.message
private

The message associated to the skill (description), as given by the server.

Definition at line 69 of file Skill.java.

Referenced by com.realtime.crossfire.jxclient.skills.Skill.getTooltipText(), and com.realtime.crossfire.jxclient.skills.Skill.setMessage().

◆ name

final String com.realtime.crossfire.jxclient.skills.Skill.name
private

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