1
0
mirror of https://github.com/Rogiel/l2jserver2 synced 2025-12-09 08:52:51 +00:00

Completed documentation

Signed-off-by: Rogiel <rogiel@rogiel.com>
This commit is contained in:
2011-05-14 13:27:28 -03:00
parent e9c6f1b027
commit 4b9d52e724
56 changed files with 716 additions and 26 deletions

View File

@@ -1,7 +1,16 @@
package com.l2jserver.model.template.capability;
import com.l2jserver.model.template.Template;
import com.l2jserver.model.world.capability.Attacker;
/**
* Defines an {@link Template template} {@link TemplateCapability capability}
* that an {@link Attacker} can use to attack an
* {@link com.l2jserver.model.world.capability.Attackable}
*
* @author <a href="http://www.rogiel.com">Rogiel</a>
*
*/
public interface Attackable extends TemplateCapability {
void attack(Attacker source,
com.l2jserver.model.world.capability.Attackable target);

View File

@@ -1,7 +1,16 @@
package com.l2jserver.model.template.capability;
import com.l2jserver.model.template.Template;
import com.l2jserver.model.world.capability.Caster;
/**
* Defines an {@link Template template} {@link TemplateCapability capability}
* that an {@link Caster} can cast on an
* {@link com.l2jserver.model.world.capability.Castable}.
*
* @author <a href="http://www.rogiel.com">Rogiel</a>
*
*/
public interface Castable extends TemplateCapability {
void cast(Caster caster,
com.l2jserver.model.world.capability.Castable... targets);

View File

@@ -1,7 +1,14 @@
package com.l2jserver.model.template.capability;
import com.l2jserver.model.template.Template;
import com.l2jserver.model.world.capability.Attacker;
/**
* Defines an {@link Template template} {@link TemplateCapability capability}
* that can be consumed.
*
* @author <a href="http://www.rogiel.com">Rogiel</a>
*/
public interface Consumable extends TemplateCapability {
void consume(Attacker source,
com.l2jserver.model.world.capability.Attackable target);

View File

@@ -1,7 +1,15 @@
package com.l2jserver.model.template.capability;
import com.l2jserver.model.template.Template;
import com.l2jserver.model.world.capability.Attacker;
/**
* Defines an {@link Template template} {@link TemplateCapability capability}
* that an {@link com.l2jserver.model.world.capability.Attackable} can use to
* defend from an {@link Attacker}.
*
* @author <a href="http://www.rogiel.com">Rogiel</a>
*/
public interface Defendable extends TemplateCapability {
void defend(Attacker source,
com.l2jserver.model.world.capability.Attackable target);

View File

@@ -1,5 +1,13 @@
package com.l2jserver.model.template.capability;
import com.l2jserver.model.template.Template;
/**
* Defines an {@link Template template} {@link TemplateCapability capability}
* for an object that can be enchanted.
*
* @author <a href="http://www.rogiel.com">Rogiel</a>
*/
public interface Enchantable extends TemplateCapability {
void enchant(com.l2jserver.model.world.capability.Enchantable target);
}

View File

@@ -1,7 +1,15 @@
package com.l2jserver.model.template.capability;
import com.l2jserver.model.template.Template;
import com.l2jserver.model.world.capability.Equiper;
/**
* Defines an {@link Template template} {@link TemplateCapability capability}
* for an object that acn be equipable by an {@link Equiper}.
*
* @author <a href="http://www.rogiel.com">Rogiel</a>
*
*/
public interface Equipable extends TemplateCapability {
void equip(Equiper equiper);
}

View File

@@ -5,7 +5,7 @@ import com.l2jserver.model.world.capability.Equiper;
/**
* Indicated than an {@link AbstractTemplate} can add penalties to an given
* user.
* {@link Equiper}.
*
* @author <a href="http://www.rogiel.com">Rogiel</a>
*/

View File

@@ -1,5 +1,12 @@
package com.l2jserver.model.template.capability;
public interface TemplateCapability {
import com.l2jserver.model.template.Template;
/**
* Defines an {@link Template template} {@link TemplateCapability capability}.
* Each capability is something that the template "knows" and "can" do.
*
* @author <a href="http://www.rogiel.com">Rogiel</a>
*/
public interface TemplateCapability {
}