net.risingworld.api.events.world

Class ItemTransformEvent

java.lang.Object

net.risingworld.api.events.Event

net.risingworld.api.events.world.ItemTransformEvent

All Implemented Interfaces:

Cancellable

public class ItemTransformEvent
extends Event
implements Cancellable

Called when an item transforms, i.e. if the item id changes. Usually this happens when cooking food or smelting ores (so this event is triggered when the item changes its state from raw to cooked, or if the ore is smelted into an ingot etc)

Example: If ore gets crushed by grinder, randomly turn it into a gold ingot

1	@EventMethod
2	public void onItemTransform(ItemTransformEvent e){
3	Item item = e.getItem();
4
5	//Check if item is ore
6	if(item.getName().equals("ore")){
7	//Check if item was crushed by grinder
8	if(e.getTrigger() == Trigger.Grinder){
9	//Now get a random value. We want a chance of 10% to turn this item
10	//into a gold ingot. We use the MathUtils for that
11	if(Utils.MathUtils.nextRandomInt(1, 10) == 1){
12	//Get the gold ingot item def (to retrieve the id)
13	Definitions.ItemDefinition itemDef = Definitions.getItemDefinition("goldingot");
14
15	//Set the new item type id
16	e.setNewTypeID(itemDef.getID());
17	}
18	}
19	}
20	}

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ItemTransformEvent.Trigger Determines why the ItemTransformEvent was triggered exactly (i.e. what caused the item to transform).

Constructor Summary

Constructors

Constructor and Description
ItemTransformEvent(Item item, short newTypeID, int newStacksize, int objectInfoID, ItemTransformEvent.Trigger trigger)

Method Summary

Modifier and Type	Method and Description
Item	getItem() Gets the item that's about to transform.
int	getNewStacksize()
short	getNewTypeID() Gets the new target item type ID.
int	getObjectInfoID() Gets the info ID of the object which processed this item (e.g. the furnace ID).
ItemTransformEvent.Trigger	getTrigger() Gets the trigger of the item transformation, i.e. what caused the item to transform.
boolean	isCancelled() Determines if the event is cancelled.
void	setCancelled(boolean cancel) Cancels this event.
void	setNewStacksize(int newStacksize)
void	setNewTypeID(short newTypeID)

Methods inherited from class java.lang.Object

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

Constructor Detail

ItemTransformEvent

public ItemTransformEvent(Item item,
                          short newTypeID,
                          int newStacksize,
                          int objectInfoID,
                          ItemTransformEvent.Trigger trigger)

Method Detail

getItem

public Item getItem()

Gets the item that's about to transform.

Returns:

the current item that's about to transform.

getNewTypeID

public short getNewTypeID()

Gets the new target item type ID. This means this item will transform to this item (e.g. if getItem() returns a raw steak, getNewTypeID() usually returns the type ID of a cooked steak).

Returns:

the new type ID.

getNewStacksize

public int getNewStacksize()

setNewTypeID

public void setNewTypeID(short newTypeID)

setNewStacksize

public void setNewStacksize(int newStacksize)

getObjectInfoID

public int getObjectInfoID()

Gets the info ID of the object which processed this item (e.g. the furnace ID). Returns -1 if the transform wasn't triggered by a furnace or a grinder.

Returns:

the furnace/grinder info ID.

getTrigger

public ItemTransformEvent.Trigger getTrigger()

Gets the trigger of the item transformation, i.e. what caused the item to transform.

Returns:

the trigger of the item transformation.

isCancelled

public boolean isCancelled()

Description copied from interface: Cancellable

Determines if the event is cancelled. If an event is cancelled, it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

isCancelled in interface Cancellable

Returns:

true if the event is cancelled, or false if not.

setCancelled

public void setCancelled(boolean cancel)

Description copied from interface: Cancellable

Cancels this event. This means it will no longer be executed, but other plugins will still receive the event.

Please note: If the event is threaded, cancellation has no effect, i.e. the event will still be executed.

Specified by:

setCancelled in interface Cancellable

Parameters:

cancel - set to true if you want to cancel this event.