Represents an action an entity can execute. More...

Inheritance diagram for com.runehive.game.action.Action< T extends Mob >:

Collaboration diagram for com.runehive.game.action.Action< T extends Mob >:

Public Member Functions
	Action (T mob, int delay)
	Creates a new `Action` randomevent.
	Action (T mob, int delay, boolean instant)
	Creates a new `Action` randomevent.
boolean	cancellableInProgress ()
T	getMob ()
	Gets the player.
abstract String	getName ()
	Gets the name of this action.
abstract WalkablePolicy	getWalkablePolicy ()
	Gets the WalkablePolicy of this action.
boolean	prioritized ()
	Determines if this action is prioritized.
Public Member Functions inherited from com.runehive.game.task.Task
Task	attach (Object newKey)
	Attaches a new key.
synchronized final void	cancel ()
	Cancels all subsequent executions.
synchronized final void	cancel (boolean logout)
	Cancels all subsequent executions.
boolean	canRun ()
	Determines if the task can be ran.
Optional< Object >	getAttachment ()
String	getCreationStackTraceStr ()
int	getDelay ()
Long	getElapsedTimeFromRunStartTime ()
Optional< Long >	getRunStartTime ()
long	getTaskCreationTime ()
String	getTaskId ()
boolean	isInstant ()
boolean	isRunning ()
void	setDelay (int delay)
	Sets the cyclic delay.
void	setExecutionTime ()
	Task (boolean instant, int delay)
	Creates a new `Task`.
	Task (int delay)
	Creates a new `Task` that doesn't execute instantly.

Private Attributes
final T	mob
	The `Mob` associated with this ActionEvent.

Additional Inherited Members
Protected Member Functions inherited from com.runehive.game.task.Task
void	baseExecute ()
boolean	canSchedule ()
	A function executed on registration.
abstract void	execute ()
	A function representing the unit of work that will be carried out.
void	onCancel (boolean logout)
	A function executed on cancellation.
void	onSchedule ()
	A function executed on registration.
Package Functions inherited from com.runehive.game.task.Task
void	onException (Exception e)
	A function executed on thrown exceptions.
void	onLoop ()
	A function executed when iterated over.
final synchronized void	process ()
synchronized void	setRunning (boolean running)

Detailed Description

Represents an action an entity can execute.

Author: Stand Up

Definition at line 12 of file Action.java.

Constructor & Destructor Documentation

◆ Action() [1/2]

com.runehive.game.action.Action< T extends Mob >.Action	(	T	mob,
		int	delay,
		boolean	instant )

Creates a new Action randomevent.

Parameters

mob	`mob`.
instant	`instant`.
delay	`delay`.

Definition at line 24 of file Action.java.

                                                     {
        super(instant, delay);
        this.mob = mob;
    }

References com.runehive.game.task.Task.delay, com.runehive.game.task.Task.instant, and mob.

◆ Action() [2/2]

com.runehive.game.action.Action< T extends Mob >.Action	(	T	mob,
		int	delay )

Creates a new Action randomevent.

Parameters

mob	`mob`.
delay	`delay`.

Definition at line 35 of file Action.java.

                                    {
        this(mob, delay, false);
    }

References com.runehive.game.task.Task.delay, and mob.

Member Function Documentation

◆ cancellableInProgress()

boolean com.runehive.game.action.Action< T extends Mob >.cancellableInProgress ( )

Reimplemented in com.runehive.game.action.impl.RevShortcutAction.

Definition at line 73 of file Action.java.

                                           {
        return true;
    }

◆ getMob()

T com.runehive.game.action.Action< T extends Mob >.getMob ( )

Gets the player.

Returns: The player.

Definition at line 44 of file Action.java.

                      {
        return mob;
    }

References mob.

Here is the caller graph for this function:

◆ getName()

abstract String com.runehive.game.action.Action< T extends Mob >.getName ( )

abstract

Gets the name of this action.

Returns: The name of this action.

◆ getWalkablePolicy()

abstract WalkablePolicy com.runehive.game.action.Action< T extends Mob >.getWalkablePolicy ( )

abstract

Gets the WalkablePolicy of this action.

Returns: The walkable policy of this action.

◆ prioritized()

boolean com.runehive.game.action.Action< T extends Mob >.prioritized ( )

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.

Definition at line 55 of file Action.java.

                                 {
        return false;
    }

Member Data Documentation

◆ mob

final T com.runehive.game.action.Action< T extends Mob >.mob

private

The Mob associated with this ActionEvent.

Definition at line 15 of file Action.java.

Referenced by Action(), Action(), com.runehive.content.skill.impl.DestructionSkillAction.DestructionSkillAction(), com.runehive.content.wintertodt.actions.FlameWalk.FlameWalk(), getMob(), com.runehive.content.skill.impl.HarvestingSkillAction.HarvestingSkillAction(), com.runehive.content.skill.impl.HarvestingSkillAction.HarvestingSkillAction(), com.runehive.game.action.impl.LadderAction.LadderAction(), com.runehive.game.action.impl.LadderAction.LadderAction(), com.runehive.game.action.impl.LeverAction.LeverAction(), com.runehive.game.action.impl.LeverAction.LeverAction(), com.runehive.content.skill.SkillAction.SkillAction(), com.runehive.content.skill.SkillAction.SkillAction(), and com.runehive.content.skill.impl.woodcutting.WoodcuttingAction.WoodcuttingAction().

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

java/com/runehive/game/action/Action.java

Public Member Functions

Private Attributes

Additional Inherited Members