org.cloudburstmc.server.inventory.transaction.action

Class DropItemAction

java.lang.Object

org.cloudburstmc.server.inventory.transaction.action.InventoryAction

org.cloudburstmc.server.inventory.transaction.action.DropItemAction

public class DropItemAction
extends InventoryAction

Author:

CreeperFace

Field Summary

Fields inherited from class org.cloudburstmc.server.inventory.transaction.action.InventoryAction

sourceItem, targetItem

Constructor Summary

Constructors

Constructor and Description
DropItemAction(Item source, Item target)

Method Summary

Modifier and Type	Method and Description
boolean	execute(Player source) Drops the target item in front of the player.
boolean	isValid(Player source) Verifies that the source item of a drop-item action must be air.
void	onExecuteFail(Player source) Performs additional actions when this inventory-action did not complete successfully.
void	onExecuteSuccess(Player source) Performs additional actions when this inventory-action completed successfully.
boolean	onPreExecute(Player source) Called by inventory transactions before any actions are processed.

Methods inherited from class org.cloudburstmc.server.inventory.transaction.action.InventoryAction

getCreationTime, getSourceItem, getTargetItem, onAddToTransaction

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DropItemAction

public DropItemAction(Item source,
                      Item target)

Method Detail

isValid

public boolean isValid(Player source)

Verifies that the source item of a drop-item action must be air. This is not strictly necessary, just a sanity check.

Specified by:

isValid in class InventoryAction

Parameters:

source - player

Returns:

valid

onPreExecute

public boolean onPreExecute(Player source)

Description copied from class: InventoryAction

Called by inventory transactions before any actions are processed. If this returns false, the transaction will be cancelled.

Overrides:

onPreExecute in class InventoryAction

Parameters:

source - player

Returns:

cancelled

execute

public boolean execute(Player source)

Drops the target item in front of the player.

Specified by:

execute in class InventoryAction

Parameters:

source - player

Returns:

successfully executed

onExecuteSuccess

public void onExecuteSuccess(Player source)

Description copied from class: InventoryAction

Performs additional actions when this inventory-action completed successfully.

Specified by:

onExecuteSuccess in class InventoryAction

Parameters:

source - player

onExecuteFail

public void onExecuteFail(Player source)

Description copied from class: InventoryAction

Performs additional actions when this inventory-action did not complete successfully.

Specified by:

onExecuteFail in class InventoryAction

Parameters:

source - player