io.lurkers.server.scripting.interfaces.lua

Class Event

java.lang.Object

io.lurkers.server.scripting.interfaces.lua.Event

public class Event
extends java.lang.Object

Provides functions that enables listening to events happening in the game.

Constructor Summary

Constructors

Constructor and Description
Event()

Method Summary

Modifier and Type	Method and Description
static void	addBeforePeerClosedListener(LuaClosure closure) Add a callback to be invoked before a peer leaves.
static LuaClosure	addEventListener(LuaClosure closure) Add a callback to be invoked when an event occurs.
static void	addPeerClosedListener(LuaClosure closure) Add a callback to be invoked when a peer leaves.
static void	addPeerOpenedListener(LuaClosure closure) Add a callback to be invoked when a peer joins.
static void	addPeerReadyListener(LuaClosure closure) Add a callback to be invoked when a peer is ready to play.
static void	dispose()
static boolean	removeEventListener(LuaClosure closure)
static boolean	triggerBeforePeerClosedListeners(io.lurkers.server.Peer peer)
static void	triggerEventListeners(MessageType type, java.lang.Object... args)
static void	triggerPeerClosedListeners(io.lurkers.server.Peer peer)
static void	triggerPeerOpenedListeners(io.lurkers.server.Peer peer)
static void	triggerPeerReadyListeners(io.lurkers.server.Peer peer)

Methods inherited from class java.lang.Object

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

Constructor Detail

Event

public Event()

Method Detail

dispose

public static void dispose()

addEventListener

public static LuaClosure addEventListener(LuaClosure closure)

Add a callback to be invoked when an event occurs. The first argument passed to the callback will be the event type as a string. Any following arguments will be VarArgs and will depend on the event type.

Parameters:

closure -

removeEventListener

public static boolean removeEventListener(LuaClosure closure)

addPeerOpenedListener

public static void addPeerOpenedListener(LuaClosure closure)

Add a callback to be invoked when a peer joins. A Peer object is passed as an argument.

Parameters:

closure -

addPeerReadyListener

public static void addPeerReadyListener(LuaClosure closure)

Add a callback to be invoked when a peer is ready to play. A Peer object is passed as an argument.

Parameters:

closure -

addBeforePeerClosedListener

public static void addBeforePeerClosedListener(LuaClosure closure)

Add a callback to be invoked before a peer leaves. A Peer object is passed as an argument. Return `true` to make the player dispose instead of get killed when leaving. Disposing will make the player vanish and not drop items.

Parameters:

closure -

addPeerClosedListener

public static void addPeerClosedListener(LuaClosure closure)

Add a callback to be invoked when a peer leaves. A Peer object is passed as an argument.

Parameters:

closure -

triggerEventListeners

public static void triggerEventListeners(MessageType type,
                                         java.lang.Object... args)

triggerPeerOpenedListeners

public static void triggerPeerOpenedListeners(io.lurkers.server.Peer peer)

triggerPeerReadyListeners

public static void triggerPeerReadyListeners(io.lurkers.server.Peer peer)

triggerPeerClosedListeners

public static void triggerPeerClosedListeners(io.lurkers.server.Peer peer)

triggerBeforePeerClosedListeners

public static boolean triggerBeforePeerClosedListeners(io.lurkers.server.Peer peer)