com.osroyale.content.skill.impl.HarvestingSkillAction Class Reference

Inheritance diagram for com.osroyale.content.skill.impl.HarvestingSkillAction:

Collaboration diagram for com.osroyale.content.skill.impl.HarvestingSkillAction:

Classes
enum	DoubleReward

Public Member Functions
	HarvestingSkillAction (Mob mob, Optional< Position > position, boolean instant)
	HarvestingSkillAction (Mob mob, Optional< Position > position, int delay, boolean instant)
void	onHarvest (Item[] items, boolean success)
DoubleReward	doubleReward ()
abstract double	successFactor ()
abstract Optional< Item[]>	removeItems ()
abstract Item[]	harvestItems ()
final boolean	canRun ()
void	onExecute ()
boolean	prioritized ()
WalkablePolicy	getWalkablePolicy ()
Public Member Functions inherited from com.osroyale.content.skill.SkillAction
	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 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 ()
abstract String	getName ()
Public Member Functions inherited from com.osroyale.game.task.Task
	Task (boolean instant, int delay)
	Task (int delay)
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 ()

Additional Inherited Members
Protected Member Functions inherited from com.osroyale.content.skill.SkillAction
final void	onSchedule ()
final void	execute ()
Protected Member Functions inherited from com.osroyale.game.task.Task
boolean	canSchedule ()
void	onCancel (boolean logout)

Detailed Description

Holds functionality for skills such as woodcutting and mining.

Author

Stand Up

Since

19-12-2016.

Definition at line 43 of file HarvestingSkillAction.java.

Constructor & Destructor Documentation

HarvestingSkillAction() [1/2]

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

inline

Creates a new Action randomevent.

Parameters

mob	mob.
position	position.
instant	instant.

Definition at line 72 of file HarvestingSkillAction.java.

HarvestingSkillAction() [2/2]

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

inline

Creates a new Action randomevent.

Parameters

mob	mob.
position	position.
delay	delay.
instant	instant.

Definition at line 84 of file HarvestingSkillAction.java.

Member Function Documentation

canRun()

final boolean com.osroyale.content.skill.impl.HarvestingSkillAction.canRun ( )

inline

Determines if the task can be ran.

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

Definition at line 130 of file HarvestingSkillAction.java.

doubleReward()

DoubleReward com.osroyale.content.skill.impl.HarvestingSkillAction.doubleReward ( )

inline

If mob will get a double onReward.

Returns

If mob will get a double onReward.

Definition at line 103 of file HarvestingSkillAction.java.

getWalkablePolicy()

WalkablePolicy com.osroyale.content.skill.impl.HarvestingSkillAction.getWalkablePolicy ( )

inline

Gets the WalkablePolicy of this action.

Returns

The walkable policy of this action.

Reimplemented from com.osroyale.game.action.Action< T extends Mob >.

Definition at line 203 of file HarvestingSkillAction.java.

harvestItems()

abstract Item[] com.osroyale.content.skill.impl.HarvestingSkillAction.harvestItems ( )

abstract

The items to be harvested upon a successful harvest.

Returns

the items to be harvested.

onExecute()

void com.osroyale.content.skill.impl.HarvestingSkillAction.onExecute ( )

inline

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

Reimplemented from com.osroyale.content.skill.SkillAction.

Definition at line 155 of file HarvestingSkillAction.java.

onHarvest()

void com.osroyale.content.skill.impl.HarvestingSkillAction.onHarvest ( Item[] items, boolean success )

inline

The method executed upon harvest of the items.

Parameters

items	the items being harvested.
success	determines if the harvest was successful or not.

Definition at line 94 of file HarvestingSkillAction.java.

prioritized()

boolean com.osroyale.content.skill.impl.HarvestingSkillAction.prioritized ( )

inline

Determines if this action is prioritized.

When making an action prioritized, the next action will be ignored if not queued.

Returns

true if this action is prioritized, false otherwise.

Reimplemented from com.osroyale.game.action.Action< T extends Mob >.

Definition at line 193 of file HarvestingSkillAction.java.

removeItems()

abstract Optional< Item[]> com.osroyale.content.skill.impl.HarvestingSkillAction.removeItems ( )

abstract

The items to be removed upon a successful harvest.

Returns

the items to be removed.

successFactor()

abstract double com.osroyale.content.skill.impl.HarvestingSkillAction.successFactor ( )

abstract

The success factor for the harvest. The higher the number means the more frequently harvest will be obtained.

Returns

the success factor.

---

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

• osroyale/content/skill/impl/HarvestingSkillAction.java