ItemPickupEvent

Version:

Home Commands Examples Getting Started With Scripts Global Keywords

Importing the class

If you need to reference this type directly, like when casting an Array, or as a parameter, you will need to import it. Simply add the import at the top of the file.

import crafttweaker.forge.api.event.item.ItemPickupEvent;

Extends

ItemPickupEvent extends PlayerEvent.

Listening to the event

This event can be listened to like so:

events.register<crafttweaker.forge.api.event.item.ItemPickupEvent>(event => {
    println("ItemPickupEvent ran!");
});

Members

Cancels the event. Same as setCanceled(true)

// ItemPickupEvent.cancel();
event.cancel();

// ItemPickupEvent.cancelable as bool
event.cancelable

Return Type: bool

// ItemPickupEvent.cancelable() as bool;
event.cancelable();

Return Type: bool

// ItemPickupEvent.canceled as bool
event.canceled

Return Type: bool

// ItemPickupEvent.canceled = (cancel as bool);
event.canceled = myBool;

Parameters:

cancel: bool Type: bool

// ItemPickupEvent.canceled() as bool;
event.canceled();

Return Type: bool

// ItemPickupEvent.canceled(cancel as bool);
event.canceled(myBool);

Parameters:

cancel: bool Type: bool

// ItemPickupEvent.entity as Player
event.entity

Return Type: Player

// ItemPickupEvent.entity as LivingEntity
event.entity

Return Type: LivingEntity

// ItemPickupEvent.entity as Entity
event.entity

Return Type: Entity

// ItemPickupEvent.hasResult as bool
event.hasResult

Return Type: bool

// ItemPickupEvent.hasResult() as bool;
event.hasResult();

Return Type: bool

// ItemPickupEvent.originalEntity as ItemEntity
event.originalEntity

Return Type: ItemEntity

// ItemPickupEvent.result as EventResult
event.result

Return Type: EventResult

// ItemPickupEvent.result = (result as EventResult);
event.result = myResult;

Parameters:

result: EventResult Type: EventResult

// ItemPickupEvent.result() as EventResult;
event.result();

Return Type: EventResult

// ItemPickupEvent.result(result as EventResult);
event.result(myResult);

Parameters:

result: EventResult Type: EventResult

sets the event's result to allow

// ItemPickupEvent.setAllow();
event.setAllow();

sets the event's result to default

// ItemPickupEvent.setDefault();
event.setDefault();

sets the event's result to deny

// ItemPickupEvent.setDeny();
event.setDeny();

// ItemPickupEvent.stack as IItemStack
event.stack

Return Type: IItemStack