pl.isangeles.senlin.core.skill

Class Skill

java.lang.Object

pl.isangeles.senlin.core.skill.Skill

All Implemented Interfaces:

EffectSource, SaveElement, SlotContent

Direct Known Subclasses:

Attack, Buff, Passive

public abstract class Skill
extends java.lang.Object
implements SlotContent, SaveElement, EffectSource

Class for character skills like attacks, spells, etc.

Author:

Isangeles

Constructor Summary

Constructors

Constructor and Description
Skill(Character character, java.lang.String id, java.lang.String imgName, EffectType type, java.util.List<Requirement> reqs, int castTime, int cooldown, java.util.List<java.lang.String> effects) Skill constructor

Method Summary

Modifier and Type	Method and Description
abstract void	activate() Activates skill prepared skill
void	draw(float x, float y, boolean scaledPos) Draws skill UI icon
org.newdawn.slick.Sound	getActivateSound() Returns skill activation audio effect
SimpleAnim	getActiveAnim() Returns activation animation
AvatarAnimType	getAvatarAnimType() Returns required type of avatar animation
SimpleAnim	getCastAnim() Returns casting animation
org.newdawn.slick.Sound	getCastSound() Returns casting audio effect
float	getCastTime() Returns skill casting speed
int	getCooldown() Returns skill cooldown
Effect	getEffect(java.lang.String effectId) Return new instance of effect with specified ID from skill effects list
java.util.List<Effect>	getEffects() Returns all skill activation effects
java.util.List<java.lang.String>	getEffectsIds() Returns list with all IDs of effects from this skill
EffectType	getEffectType() Return type of skill effect
java.lang.String	getId() Returns skill ID
int	getMaxStack() Returns maximal amount of this content in one stack
java.lang.String	getName() Returns skill name
Character	getOwner() Returns skill owner
org.w3c.dom.Element	getSave(org.w3c.dom.Document doc) Parses object to XML document element
java.lang.String	getSerialId() Returns serial ID
Targetable	getTarget() Returns current skill target (may return NULL!)
SkillTile	getTile() Returns skill UI icon
boolean	isActive() Checks if skill is active
boolean	isInstant()
boolean	isMagic() Checks if skill is magical
boolean	isReady() Checks if skill is ready
abstract CharacterOut	prepare(Character user, Targetable target) Prepares skill
void	reset() Resets skill to default state
void	setCooldownTime(int time) Sets specified time as current cooldown time
void	setReady(boolean ready) Sets skill ready or unready
void	update(int delta) Updates skill

Methods inherited from class java.lang.Object

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

Constructor Detail

Skill

public Skill(Character character,
             java.lang.String id,
             java.lang.String imgName,
             EffectType type,
             java.util.List<Requirement> reqs,
             int castTime,
             int cooldown,
             java.util.List<java.lang.String> effects)

Skill constructor

Parameters:

character - Skill owner

id - Skill ID

name - Skill Name

info - Basic informations about this skill

imgName - Skill icon image

type - Skill effect type

magickaCost - Mana cost

castTime - Casting time

cooldown - Cooldown time

useWeapon - If weapon is needed to use this skill

effects - Skill effect list

Method Detail

draw

public void draw(float x,
                 float y,
                 boolean scaledPos)

Draws skill UI icon

Specified by:

draw in interface SlotContent

Parameters:

x - Position on x-axis

y - Position on y-axis

scaledPos - If position should be scaled to resolution

update

public void update(int delta)

Updates skill

Parameters:

delta - Time between game updates

setReady

public void setReady(boolean ready)

Sets skill ready or unready

Parameters:

ready - True if skill should be ready, false otherwise

setCooldownTime

public void setCooldownTime(int time)

Sets specified time as current cooldown time

Parameters:

time - Time in milliseconds

getCastTime

public float getCastTime()

Returns skill casting speed

Returns:

Casting speed

getCooldown

public int getCooldown()

Returns skill cooldown

Returns:

Skill cooldown

getId

public java.lang.String getId()

Returns skill ID

Specified by:

getId in interface EffectSource

Specified by:

getId in interface SlotContent

Returns:

String with ID

getSerialId

public java.lang.String getSerialId()

Returns serial ID

Specified by:

getSerialId in interface EffectSource

Specified by:

getSerialId in interface SlotContent

Returns:

String with content serial ID

getMaxStack

public int getMaxStack()

Description copied from interface: SlotContent

Returns maximal amount of this content in one stack

Specified by:

getMaxStack in interface SlotContent

Returns:

Maximal amount of this content in one stack

getName

public java.lang.String getName()

Returns skill name

Returns:

String with name

getTile

public SkillTile getTile()

Returns skill UI icon

Specified by:

getTile in interface SlotContent

Returns:

Graphical icon

getCastSound

public org.newdawn.slick.Sound getCastSound()

Returns casting audio effect

Returns:

Sound to play

getActivateSound

public org.newdawn.slick.Sound getActivateSound()

Returns skill activation audio effect

Returns:

Sound to play

getCastAnim

public SimpleAnim getCastAnim()

Returns casting animation

Returns:

Simple animated object

getActiveAnim

public SimpleAnim getActiveAnim()

Returns activation animation

Returns:

Simple animated object

getAvatarAnimType

public AvatarAnimType getAvatarAnimType()

Returns required type of avatar animation

Returns:

Avatar anim type enum

getTarget

public Targetable getTarget()

Returns current skill target (may return NULL!)

Returns:

Targetable object or null if this skill has no target

getEffectType

public EffectType getEffectType()

Return type of skill effect

Returns:

Effect type enumeration

getEffects

public java.util.List<Effect> getEffects()

Returns all skill activation effects

Specified by:

getEffects in interface EffectSource

Returns:

List with effects

getEffectsIds

public java.util.List<java.lang.String> getEffectsIds()

Returns list with all IDs of effects from this skill

Specified by:

getEffectsIds in interface EffectSource

Returns:

List with effects IDs

getEffect

public Effect getEffect(java.lang.String effectId)

Return new instance of effect with specified ID from skill effects list

Specified by:

getEffect in interface EffectSource

Parameters:

effectId - ID of desired effect

Returns:

New instance of effect with specified ID or null if there is no such effect in skill effects list

isMagic

public boolean isMagic()

Checks if skill is magical

Returns:

True if skill is magical, false otherwise

isInstant

public boolean isInstant()

isReady

public boolean isReady()

Checks if skill is ready

Returns:

True if skill is ready, false otherwise

isActive

public boolean isActive()

Checks if skill is active

Returns:

True if skill is active, false otherwise

getOwner

public Character getOwner()

Returns skill owner

Specified by:

getOwner in interface EffectSource

Returns:

Character thats own this skill

activate

public abstract void activate()

Activates skill prepared skill

reset

public void reset()

Resets skill to default state

getSave

public org.w3c.dom.Element getSave(org.w3c.dom.Document doc)

Description copied from interface: SaveElement

Parses object to XML document element

Specified by:

getSave in interface SaveElement

Parameters:

doc - XML document for save game

Returns:

XML document element

prepare

public abstract CharacterOut prepare(Character user,
                                     Targetable target)

Prepares skill

Parameters:

user - Character thats use skill

target - Character targeted by skill user

Returns:

True if skill was successfully activate, false otherwise