com.osroyale.content.skill.SkillAction Class Reference

Inheritance diagram for com.osroyale.content.skill.SkillAction:

Collaboration diagram for com.osroyale.content.skill.SkillAction:

Classes
class	SkillAnimation

Public Member Functions
	SkillAction (Mob mob, Optional< Position > position, int delay, boolean instant)
	SkillAction (Mob mob, Optional< Position > position, boolean instant)
final void	start ()
abstract boolean	canInit ()
abstract void	init ()
abstract void	onExecute ()
abstract Optional< SkillAnimation >	animation ()
abstract double	experience ()
abstract int	skill ()
boolean	ignore ()
Public Member Functions inherited from com.osroyale.game.action.Action< T extends Mob >
	Action (T mob, int delay, boolean instant)
	Action (T mob, int delay)
T	getMob ()
boolean	prioritized ()
abstract WalkablePolicy	getWalkablePolicy ()
abstract String	getName ()
Public Member Functions inherited from com.osroyale.game.task.Task
	Task (boolean instant, int delay)
	Task (int delay)
boolean	canRun ()
synchronized final void	cancel ()
synchronized final void	cancel (boolean logout)
Task	attach (Object newKey)
boolean	isInstant ()
int	getDelay ()
void	setDelay (int delay)
boolean	isRunning ()
Optional< Object >	getAttachment ()

Protected Member Functions
final void	onSchedule ()
final void	execute ()
Protected Member Functions inherited from com.osroyale.game.task.Task
boolean	canSchedule ()
void	onCancel (boolean logout)

Detailed Description

Author

Stand Up

Since

19-12-2016.

Definition at line 51 of file SkillAction.java.

Constructor & Destructor Documentation

SkillAction() [1/2]

com.osroyale.content.skill.SkillAction.SkillAction ( Mob mob, Optional< Position > position, int delay, boolean instant )

inline

Creates a new Action randomevent.

Parameters

mob	mob.
position	position.
delay	the delay to repeat this action on.
instant	instant.

Definition at line 66 of file SkillAction.java.

SkillAction() [2/2]

com.osroyale.content.skill.SkillAction.SkillAction ( Mob mob, Optional< Position > position, boolean instant )

inline

Creates a new Action randomevent.

Parameters

mob	mob.
position	position.
instant	instant.

Definition at line 78 of file SkillAction.java.

Member Function Documentation

animation()

abstract Optional< SkillAnimation > com.osroyale.content.skill.SkillAction.animation ( )

abstract

The skill animation to execute.

Returns

the skill animation to execute.

Reimplemented in com.osroyale.content.skill.impl.firemaking.FiremakingAction, com.osroyale.content.skill.impl.smithing.SmithingArmour, com.osroyale.game.action.impl.BuryBoneAction, and com.osroyale.game.action.impl.ScatterAshAction.

canInit()

abstract boolean com.osroyale.content.skill.SkillAction.canInit ( )

abstract

Determines if this action can be initialized.

Returns

true if it can, false otherwise.

Reimplemented in com.osroyale.content.skill.impl.firemaking.FiremakingAction, com.osroyale.content.skill.impl.smithing.SmithingArmour, com.osroyale.game.action.impl.BuryBoneAction, and com.osroyale.game.action.impl.ScatterAshAction.

execute()

final void com.osroyale.content.skill.SkillAction.execute ( )

inlineprotected

A function representing the unit of work that will be carried out.

Reimplemented from com.osroyale.game.task.Task.

Definition at line 162 of file SkillAction.java.

experience()

abstract double com.osroyale.content.skill.SkillAction.experience ( )

abstract

The experience given from this action.

Returns

the numerical value representing the amount of experience given.

Reimplemented in com.osroyale.content.skill.impl.firemaking.FiremakingAction, com.osroyale.content.skill.impl.smithing.SmithingArmour, com.osroyale.game.action.impl.BuryBoneAction, and com.osroyale.game.action.impl.ScatterAshAction.

ignore()

boolean com.osroyale.content.skill.SkillAction.ignore ( )

inline

Determines if future skill actions from the same type should be ignored.

Returns

Definition at line 140 of file SkillAction.java.

init()

abstract void com.osroyale.content.skill.SkillAction.init ( )

abstract

Any functionality that should be handled when this action is submitted.

Reimplemented in com.osroyale.content.skill.impl.firemaking.FiremakingAction, com.osroyale.content.skill.impl.smithing.SmithingArmour, com.osroyale.game.action.impl.BuryBoneAction, and com.osroyale.game.action.impl.ScatterAshAction.

onExecute()

abstract void com.osroyale.content.skill.SkillAction.onExecute ( )

abstract

The method which is called on intervals of the specified #delay;

Reimplemented in com.osroyale.content.skill.impl.DestructionSkillAction, com.osroyale.content.skill.impl.HarvestingSkillAction, com.osroyale.content.skill.impl.ProducingSkillAction, com.osroyale.game.action.impl.BuryBoneAction, and com.osroyale.game.action.impl.ScatterAshAction.

onSchedule()

final void com.osroyale.content.skill.SkillAction.onSchedule ( )

inlineprotected

A function executed on registration.

Reimplemented from com.osroyale.game.task.Task.

Definition at line 150 of file SkillAction.java.

skill()

abstract int com.osroyale.content.skill.SkillAction.skill ( )

abstract

The skill we should hand to experience to.

Reimplemented in com.osroyale.content.skill.impl.firemaking.FiremakingAction, com.osroyale.content.skill.impl.smithing.SmithingArmour, com.osroyale.game.action.impl.BuryBoneAction, and com.osroyale.game.action.impl.ScatterAshAction.

start()

final void com.osroyale.content.skill.SkillAction.start ( )

inline

Attempts to start the skill.

Definition at line 85 of file SkillAction.java.

---

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

• osroyale/content/skill/SkillAction.java