com.runehive.game.action.impl.ChestAction Class Reference

Handles opening a chest. More...

Inheritance diagram for com.runehive.game.action.impl.ChestAction:

Collaboration diagram for com.runehive.game.action.impl.ChestAction:

Public Member Functions
	ChestAction (Player player, int key, Item... items)
void	execute ()
	A function representing the unit of work that will be carried out.
String	getName ()
	Gets the name of this action.
WalkablePolicy	getWalkablePolicy ()
	Gets the WalkablePolicy of this action.
boolean	prioritized ()
	Determines if this action is prioritized.
Public Member Functions inherited from com.runehive.game.action.Action< T extends Mob >
	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.
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.

Protected Member Functions
boolean	canSchedule ()
	A function executed on registration.
void	onCancel (boolean logout)
	A function executed on cancellation.
void	onSchedule ()
	A function executed on registration.
Protected Member Functions inherited from com.runehive.game.task.Task
void	baseExecute ()

Private Attributes
final Item[]	items
final int	key

Additional Inherited Members
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

Handles opening a chest.

Author

Daniel

Definition at line 18 of file ChestAction.java.

Constructor & Destructor Documentation

ChestAction()

com.runehive.game.action.impl.ChestAction.ChestAction	(	Player	player,
		int	key,
		Item...	items )

Definition at line 22 of file ChestAction.java.

                                                              {
        super(player, 1);
        this.key = key;
        this.items = items;
    }

References items, and key.

Member Function Documentation

canSchedule()

boolean com.runehive.game.action.impl.ChestAction.canSchedule ( )

protected

A function executed on registration.

Reimplemented from com.runehive.game.task.Task.

Definition at line 29 of file ChestAction.java.

                                    {
        if (!getMob().inventory.hasCapacityFor(items)) {
            getMob().message("You do not have enough free inventory spaces to do this!");
            return false;
        }
        return true;
    }

References com.runehive.game.action.Action< T extends Mob >.getMob(), and items.

Here is the call graph for this function:

execute()

void com.runehive.game.action.impl.ChestAction.execute

(

)

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

Reimplemented from com.runehive.game.task.Task.

Definition at line 46 of file ChestAction.java.

                          {
        cancel();
    }

References com.runehive.game.task.Task.cancel().

Here is the call graph for this function:

getName()

String com.runehive.game.action.impl.ChestAction.getName

(

)

Gets the name of this action.

Returns

The name of this action.

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

Definition at line 64 of file ChestAction.java.

                            {
        return "chest action";
    }

getWalkablePolicy()

WalkablePolicy com.runehive.game.action.impl.ChestAction.getWalkablePolicy

(

)

Gets the WalkablePolicy of this action.

Returns

The walkable policy of this action.

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

Definition at line 74 of file ChestAction.java.

                                              {
        return WalkablePolicy.NON_WALKABLE;
    }

References com.runehive.game.action.policy.WalkablePolicy.NON_WALKABLE.

onCancel()

void com.runehive.game.action.impl.ChestAction.onCancel ( boolean logout )

protected

A function executed on cancellation.

Reimplemented from com.runehive.game.task.Task.

Definition at line 51 of file ChestAction.java.

                                            {
        getMob().inventory.addOrDrop(items);
        getMob().send(new SendMessage("...you find a few items inside of the chest.", true));
 
        if (key == 989) {
            getMob().activityLogger.add(ActivityLog.CRYSTAL_CHEST);
            AchievementHandler.activate(getMob(), AchievementKey.CRYSTAL_CHEST, 1);
        } else if (key == 20608) {
            getMob().activityLogger.add(ActivityLog.BLOOD_MONEY_CHEST);
        }
    }

References com.runehive.content.achievement.AchievementHandler.activate(), com.runehive.content.ActivityLog.BLOOD_MONEY_CHEST, com.runehive.content.achievement.AchievementKey.CRYSTAL_CHEST, com.runehive.content.ActivityLog.CRYSTAL_CHEST, com.runehive.game.action.Action< T extends Mob >.getMob(), items, and key.

Here is the call graph for this function:

onSchedule()

void com.runehive.game.action.impl.ChestAction.onSchedule ( )

protected

A function executed on registration.

Reimplemented from com.runehive.game.task.Task.

Definition at line 38 of file ChestAction.java.

                                {
        getMob().locking.lock(2);
        getMob().inventory.remove(key, 1);
        getMob().animate(new Animation(881));
        getMob().send(new SendMessage("You attempt to unlock the chest..."));
    }

References com.runehive.game.action.Action< T extends Mob >.getMob(), and key.

Here is the call graph for this function:

prioritized()

boolean com.runehive.game.action.impl.ChestAction.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.

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

Definition at line 69 of file ChestAction.java.

                                 {
        return false;
    }

Member Data Documentation

items

final Item [] com.runehive.game.action.impl.ChestAction.items

private

Definition at line 20 of file ChestAction.java.

Referenced by canSchedule(), ChestAction(), and onCancel().

key

final int com.runehive.game.action.impl.ChestAction.key

private

Definition at line 19 of file ChestAction.java.

Referenced by ChestAction(), onCancel(), and onSchedule().

---

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

• java/com/runehive/game/action/impl/ChestAction.java