Package dev.magicmq.pyspigot.bukkit.event.custom

Class CustomEvent

java.lang.Object

org.bukkit.event.Event

dev.magicmq.pyspigot.bukkit.event.ScriptEvent

dev.magicmq.pyspigot.bukkit.event.custom.CustomEvent

All Implemented Interfaces:

Cancellable

public class CustomEvent
extends ScriptEvent
implements Cancellable

A custom event that scripts may instantiate and call for other plugins/scripts to listen to.

Nested Class Summary

Nested classes/interfaces inherited from class org.bukkit.event.Event

Event.Result

Constructor Summary

Constructors

Constructor	Description
CustomEvent(String name, PyObject data)	Note: This class should be instantiated from scripts only!
CustomEvent(String name, PyObject data, boolean async)	Note: This class should be instantiated from scripts only!

Method Summary

Modifier and Type	Method	Description
PyObject	getData()	Get the data attached to this event.
<T> T	getDataAsType(Class<T> clazz)	Attempt to convert the data attached to this event to a provided type.
Object	getDataAsType(String clazz)	Attempt to convert the data attached to this event to a provided type.
static HandlerList	getHandlerList()
HandlerList	getHandlers()
String	getName()	Get the name of this event.
boolean	isCancelled()
void	setCancelled(boolean cancelled)

Methods inherited from class dev.magicmq.pyspigot.bukkit.event.ScriptEvent

getScript

Methods inherited from class org.bukkit.event.Event

callEvent, getEventName, isAsynchronous

Methods inherited from class java.lang.Object

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

Constructor Details

CustomEvent

public CustomEvent(String name,
 PyObject data)

Note: This class should be instantiated from scripts only!

Parameters:

name - The name of the event being created. Can be used to create subtypes of the generic custom event

data - The data to attach to the event

CustomEvent

public CustomEvent(String name,
 PyObject data,
 boolean async)

Note: This class should be instantiated from scripts only!

Parameters:

name - The name of the event being created. Can be used to create subtypes of the generic custom event

data - The data to attach to the event

async - Whether the event is being called from an asynchronous context

Method Details

getName

public String getName()

Get the name of this event.

Returns:

The name of this event

getData

public PyObject getData()

Get the data attached to this event.

Returns:

The data attached to this event

getDataAsType

public Object getDataAsType(String clazz)

Attempt to convert the data attached to this event to a provided type.

Parameters:

clazz - The type that the data should be converted to

Returns:

An object of the specified type representing the converted data

Throws:

PyException - If the data could not be converted to the provided type

getDataAsType

public <T> T getDataAsType(Class<T> clazz)

Attempt to convert the data attached to this event to a provided type.

Type Parameters:

T - The type to which the data should be converted

Parameters:

clazz - The type that the data should be converted to

Returns:

An object of the specified type representing the converted data

Throws:

PyException - If the data could not be converted to the provided type

isCancelled

public boolean isCancelled()

Specified by:

isCancelled in interface Cancellable

setCancelled

public void setCancelled(boolean cancelled)

Specified by:

setCancelled in interface Cancellable

getHandlers

public HandlerList getHandlers()

Overrides:

getHandlers in class ScriptEvent

getHandlerList

public static HandlerList getHandlerList()