RuneHive-Tarnish
Neural OSRS Enhancement Framework
Loading...
Searching...
No Matches
com.osroyale.content.skill.impl.ProducingSkillAction Class Referenceabstract
Inheritance diagram for com.osroyale.content.skill.impl.ProducingSkillAction:
Collaboration diagram for com.osroyale.content.skill.impl.ProducingSkillAction:

Public Member Functions

 ProducingSkillAction (Player player, Optional< Position > position, boolean instant)
 ProducingSkillAction (Player player, Optional< Position > position, int delay, boolean instant)
final boolean canRun ()
final void onExecute ()
void onProduce (boolean success)
abstract Optional< Item[]> removeItem ()
abstract Optional< Item[]> produceItem ()
Optional< String > message ()
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< SkillAnimationanimation ()
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)
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)
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

The skill action that represents an action where one item in an inventory is replaced with a new one. This type of skill action is somewhat basic and requires that a player have the item to be removed.

The skills that may use this type skill action include, but are not limited to COOKING.

Author
lare96 http://github.com/lare96
See also
SkillAction
DestructionSkillAction
HarvestingSkillAction

Definition at line 60 of file ProducingSkillAction.java.

Constructor & Destructor Documentation

◆ ProducingSkillAction() [1/2]

com.osroyale.content.skill.impl.ProducingSkillAction.ProducingSkillAction ( Player player,
Optional< Position > position,
boolean instant )
inline

Creates a new ProducingSkillAction.

Parameters
playerthe player this skill action is for.
positionthe position the player should face.
instantdetermines if this action should be ran instantly.

Definition at line 68 of file ProducingSkillAction.java.

◆ ProducingSkillAction() [2/2]

com.osroyale.content.skill.impl.ProducingSkillAction.ProducingSkillAction ( Player player,
Optional< Position > position,
int delay,
boolean instant )
inline

Creates a new ProducingSkillAction.

Parameters
playerthe player this skill action is for.
positionthe position the player should face.
delaythe delay between these producing skill actions.
instantdetermines if this action should be ran instantly.

Definition at line 79 of file ProducingSkillAction.java.

Member Function Documentation

◆ canRun()

final boolean com.osroyale.content.skill.impl.ProducingSkillAction.canRun ( )
inline

Determines if the task can be ran.

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

Definition at line 84 of file ProducingSkillAction.java.

◆ message()

Optional< String > com.osroyale.content.skill.impl.ProducingSkillAction.message ( )
inline

The message that will be sent when the player doesn't have the items required.

Returns
the alphabetic value which represents the message.

Definition at line 147 of file ProducingSkillAction.java.

◆ onExecute()

final void com.osroyale.content.skill.impl.ProducingSkillAction.onExecute ( )
inline

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

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

Definition at line 115 of file ProducingSkillAction.java.

◆ onProduce()

void com.osroyale.content.skill.impl.ProducingSkillAction.onProduce ( boolean success)
inline

The method executed upon production of an item.

Parameters
successdetermines if the production was successful or not.

Reimplemented in com.osroyale.content.skill.impl.smithing.SmithingArmour.

Definition at line 126 of file ProducingSkillAction.java.

◆ produceItem()

abstract Optional< Item[]> com.osroyale.content.skill.impl.ProducingSkillAction.produceItem ( )
abstract

The item that will be added upon production.

Returns
the item that will be added.

Reimplemented in com.osroyale.content.skill.impl.smithing.SmithingArmour.

◆ removeItem()

abstract Optional< Item[]> com.osroyale.content.skill.impl.ProducingSkillAction.removeItem ( )
abstract

The item that will be removed upon production.

Returns
the item that will be removed.

Reimplemented in com.osroyale.content.skill.impl.smithing.SmithingArmour.


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