org.cloudburstmc.server.inventory.transaction.action

Class SlotChangeAction

java.lang.Object

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

org.cloudburstmc.server.inventory.transaction.action.SlotChangeAction

public class SlotChangeAction
extends InventoryAction

Author:

CreeperFace

Field Summary

Fields

Modifier and Type	Field and Description
protected Inventory	inventory

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

sourceItem, targetItem

Constructor Summary

Constructors

Constructor and Description
SlotChangeAction(Inventory inventory, int inventorySlot, Item sourceItem, Item targetItem)

Method Summary

Modifier and Type	Method and Description
boolean	execute(Player source) Sets the item into the target inventory.
Inventory	getInventory() Returns the inventory involved in this action.
int	getSlot() Returns the inventorySlot in the inventory which this action modified.
boolean	isValid(Player source) Checks if the item in the inventory at the specified inventorySlot is the same as this action's source item.
void	onAddToTransaction(InventoryTransaction transaction) Called when the action is added to the specified InventoryTransaction.
void	onExecuteFail(Player source) Sends the original inventorySlot contents to the source player to revert the action.
void	onExecuteSuccess(Player source) Sends inventorySlot changes to other viewers of the inventory.

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

getCreationTime, getSourceItem, getTargetItem, onPreExecute

Methods inherited from class java.lang.Object

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

Field Detail

inventory

protected Inventory inventory

Constructor Detail

SlotChangeAction

public SlotChangeAction(Inventory inventory,
                        int inventorySlot,
                        Item sourceItem,
                        Item targetItem)

Method Detail

getInventory

public Inventory getInventory()

Returns the inventory involved in this action.

Returns:

inventory

getSlot

public int getSlot()

Returns the inventorySlot in the inventory which this action modified.

Returns:

slot

isValid

public boolean isValid(Player source)

Checks if the item in the inventory at the specified inventorySlot is the same as this action's source item.

Specified by:

isValid in class InventoryAction

Parameters:

source - player

Returns:

valid

execute

public boolean execute(Player source)

Sets the item into the target inventory.

Specified by:

execute in class InventoryAction

Parameters:

source - player

Returns:

successfully executed

onExecuteSuccess

public void onExecuteSuccess(Player source)

Sends inventorySlot changes to other viewers of the inventory. This will not send any change back to the source Player.

Specified by:

onExecuteSuccess in class InventoryAction

Parameters:

source - player

onExecuteFail

public void onExecuteFail(Player source)

Sends the original inventorySlot contents to the source player to revert the action.

Specified by:

onExecuteFail in class InventoryAction

Parameters:

source - player

onAddToTransaction

public void onAddToTransaction(InventoryTransaction transaction)

Description copied from class: InventoryAction

Called when the action is added to the specified InventoryTransaction.

Overrides:

onAddToTransaction in class InventoryAction

Parameters:

transaction - to add