Crossfire JXClient, Trunk  R20561
Spell.java
Go to the documentation of this file.
1 /*
2  * This file is part of JXClient, the Fullscreen Java Crossfire Client.
3  *
4  * JXClient is free software; you can redistribute it and/or modify
5  * it under the terms of the GNU General Public License as published by
6  * the Free Software Foundation; either version 2 of the License, or
7  * (at your option) any later version.
8  *
9  * JXClient is distributed in the hope that it will be useful,
10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12  * GNU General Public License for more details.
13  *
14  * You should have received a copy of the GNU General Public License
15  * along with JXClient; if not, write to the Free Software
16  * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
17  *
18  * Copyright (C) 2005-2008 Yann Chachkoff.
19  * Copyright (C) 2006-2011 Andreas Kirschbaum.
20  */
21 
22 package com.realtime.crossfire.jxclient.spells;
23 
29 import org.jetbrains.annotations.NotNull;
30 import org.jetbrains.annotations.Nullable;
31 
36 public class Spell {
37 
41  @NotNull
42  private final String name;
43 
47  @NotNull
49 
53  private int faceNum;
54 
58  private int tag;
59 
63  @NotNull
64  private String message = "";
65 
69  private int level;
70 
74  private int castingTime;
75 
79  private int mana;
80 
84  private int grace;
85 
89  private int damage;
90 
94  private int skill;
95 
99  private int path;
100 
104  private boolean unknown;
105 
109  private final SkillSet skillSet;
110 
114  private final Stats stats;
115 
122  public Spell(@NotNull final String name, @NotNull final SkillSet skillSet, @NotNull final Stats stats) {
123  this.name = name;
124  this.skillSet = skillSet;
125  this.stats = stats;
126  }
127 
132  public int getTag() {
133  return tag;
134  }
135 
140  public int getLevel() {
141  return level;
142  }
143 
148  public int getCastingTime() {
149  return castingTime;
150  }
151 
156  public int getMana() {
157  return mana;
158  }
159 
164  public int getGrace() {
165  return grace;
166  }
167 
172  public int getDamage() {
173  return damage;
174  }
175 
180  public int getSkill() {
181  return skill;
182  }
183 
188  public int getPath() {
189  return path;
190  }
191 
196  @NotNull
197  public String getName() {
198  return name;
199  }
200 
205  @NotNull
206  public String getMessage() {
207  return message;
208  }
209 
214  public int getFaceNum() {
215  return faceNum;
216  }
217 
222  public boolean isUnknown() {
223  return unknown;
224  }
225 
230  public void setUnknown(final boolean unknown) {
231  if (this.unknown != unknown) {
232  this.unknown = unknown;
233  fireChanged();
234  }
235  }
236 
250  public 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) {
251  boolean changed = false;
252 
253  if (this.faceNum != faceNum) {
254  this.faceNum = faceNum;
255  changed = true;
256  }
257 
258  if (this.tag != tag) {
259  this.tag = tag;
260  changed = true;
261  }
262 
263  if (!this.message.equals(message)) {
264  this.message = message;
265  changed = true;
266  }
267 
268  if (this.level != level) {
269  this.level = level;
270  changed = true;
271  }
272 
273  if (this.castingTime != castingTime) {
274  this.castingTime = castingTime;
275  changed = true;
276  }
277 
278  if (this.mana != mana) {
279  this.mana = mana;
280  changed = true;
281  }
282 
283  if (this.grace != grace) {
284  this.grace = grace;
285  changed = true;
286  }
287 
288  if (this.damage != damage) {
289  this.damage = damage;
290  changed = true;
291  }
292 
293  if (this.skill != skill) {
294  this.skill = skill;
295  changed = true;
296  }
297 
298  if (this.path != path) {
299  this.path = path;
300  changed = true;
301  }
302 
303  if (unknown) {
304  unknown = false;
305  changed = true;
306  }
307 
308  if (changed) {
309  fireChanged();
310  }
311  }
312 
322  public void updateParameters(final boolean updateMana, final int mana, final boolean updateGrace, final int grace, final boolean updateDamage, final int damage) {
323  boolean changed = false;
324 
325  if (updateMana && this.mana != mana) {
326  this.mana = mana;
327  changed = true;
328  }
329 
330  if (updateGrace && this.grace != grace) {
331  this.grace = grace;
332  changed = true;
333  }
334 
335  if (updateDamage && this.damage != damage) {
336  this.damage = damage;
337  changed = true;
338  }
339 
340  if (changed) {
341  fireChanged();
342  }
343  }
344 
348  @NotNull
349  @Override
350  public String toString() {
351  return "Name:"+name+" ID:"+tag+" Level:"+level+" Time:"+castingTime+" Mana:"+mana+" Grace:"+grace+" Damage:"+damage+" Skill:"+skill+" Path:"+path+" Unknown:"+unknown;
352  }
353 
358  @NotNull
359  public String getTooltipText() {
360  final StringBuilder sb = new StringBuilder("<b>");
361  sb.append(name.substring(0, 1).toUpperCase()).append(name.substring(1));
362  sb.append("</b>");
363  if (unknown) {
364  sb.append(" (unknown)");
365  }
366  if ((path&stats.getStat(Stats.CS_STAT_SPELL_DENY)) == 0) {
367  final Skill sk = skillSet.getSkill(skill);
368  if (sk != null) {
369  sb.append("<br>Skill: ").append(sk);
370  }
371  if (level > 0) {
372  sb.append("<br>Level: ");
373  if (sk != null && level <= sk.getLevel()) {
374  int effective = sk.getLevel()-level;
375  @Nullable final String supp;
376  if ((path&stats.getStat(Stats.CS_STAT_SPELL_ATTUNE)) != 0) {
377  effective += 2;
378  supp = " (attuned)";
379  } else if ((path&stats.getStat(Stats.CS_STAT_SPELL_REPEL)) != 0) {
380  effective -= 2;
381  supp = " (repelled)";
382  } else {
383  supp = null;
384  }
385  sb.append(effective);
386  if (supp != null) {
387  sb.append(supp);
388  }
389  } else {
390  sb.append(level);
391  }
392  }
393  if (mana > 0) {
394  sb.append("<br>Mana: ").append(mana);
395  }
396  if (grace > 0) {
397  sb.append("<br>Grace: ").append(grace);
398  }
399  if (damage > 0) {
400  sb.append("<br>Damage: ").append(damage);
401  }
402  } else {
403  sb.append("<br><b>Denied</b>");
404  }
405  if (!message.isEmpty()) {
406  sb.append("<br>");
407  sb.append(StringSplitter.splitAsHtml(message));
408  }
409  return sb.toString();
410  }
411 
415  private void fireChanged() {
416  for (final SpellListener listener : listeners) {
417  listener.spellChanged();
418  }
419  }
420 
425  public void addSpellListener(@NotNull final SpellListener listener) {
426  listeners.add(listener);
427  }
428 
433  public void removeSpellListener(@NotNull final SpellListener listener) {
434  listeners.remove(listener);
435  }
436 
437 }
static final int CS_STAT_SPELL_ATTUNE
Attuned spell paths of a spell.
Definition: Stats.java:199
int mana
The mana needed to cast the spell.
Definition: Spell.java:79
String getName()
Returns the spell name.
Definition: Spell.java:197
int getDamage()
Returns the damage done by the spell.
Definition: Spell.java:172
int getGrace()
Returns the grace needed to cast the spell.
Definition: Spell.java:164
static final int CS_STAT_SPELL_DENY
Denied spell paths of a spell.
Definition: Stats.java:209
final String name
The spell name.
Definition: Spell.java:42
int grace
The grace needed to cast the spell.
Definition: Spell.java:84
final Stats stats
Attuned, repelled or denied information.
Definition: Spell.java:114
static String splitAsHtml(@NotNull final String message)
Splits the given string into lines and returns the lines separated by "&lt;br&gt;".
int getLevel()
Returns the skill level.
Definition: Skill.java:97
int getMana()
Returns the mana needed to cast the spell.
Definition: Spell.java:156
int getSkill()
Returns the spell&#39;s skill.
Definition: Spell.java:180
int getFaceNum()
Returns the face number.
Definition: Spell.java:214
int damage
The damage done by the spell.
Definition: Spell.java:89
Spell(@NotNull final String name, @NotNull final SkillSet skillSet, @NotNull final Stats stats)
Creates a new instance.
Definition: Spell.java:122
int getCastingTime()
Returns the casting time.
Definition: Spell.java:148
String getMessage()
Returns the description.
Definition: Spell.java:206
boolean isUnknown()
Returns whether this spell is unknown to the character.
Definition: Spell.java:222
One skill of the character.
Definition: Skill.java:32
void addSpellListener(@NotNull final SpellListener listener)
Adds a SpellListener to be notified of changes.
Definition: Spell.java:425
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&#39;s parameters.
Definition: Spell.java:250
Describes a Crossfire spell.
Definition: Spell.java:36
int getTag()
Returns the tag ID.
Definition: Spell.java:132
String getTooltipText()
Returns a description for this spell to be used in tooltips.
Definition: Spell.java:359
void add(@NotNull final T listener)
Adds a listener.
Skill getSkill(final int id)
Returns the given skill as a Skill object.
Definition: SkillSet.java:172
static final int CS_STAT_SPELL_REPEL
Repelled spell paths of a spell.
Definition: Stats.java:204
int getPath()
Returns the spell path.
Definition: Spell.java:188
Utility class for splitting strings.
void fireChanged()
Notifies all listeners.
Definition: Spell.java:415
int skill
The spell&#39;s skill.
Definition: Spell.java:94
void removeSpellListener(@NotNull final SpellListener listener)
Removes a SpellListener to be notified of changes.
Definition: Spell.java:433
boolean unknown
Whether this spell is unknown to the character.
Definition: Spell.java:104
This is the representation of all the statistics of a player, like its speed or its experience...
Definition: Stats.java:43
void updateParameters(final boolean updateMana, final int mana, final boolean updateGrace, final int grace, final boolean updateDamage, final int damage)
Updates the spell&#39;s parameters.
Definition: Spell.java:322
Maintain the set of skills as sent by the server.
Definition: SkillSet.java:38
int getLevel()
Returns the spell level.
Definition: Spell.java:140
void setUnknown(final boolean unknown)
Marks this spell as known or unknown for the character.
Definition: Spell.java:230
void remove(@NotNull final T listener)
Removes a listener.
final SkillSet skillSet
To get the skill&#39;s name, see SkillSet.
Definition: Spell.java:109
final EventListenerList2< SpellListener > listeners
The SpellListeners to be notified of changes.
Definition: Spell.java:48
int getStat(final int statNo)
Returns the numerical value of the given statistic.
Definition: Stats.java:615
Interface for listeners interested in Spell related events.