ClosureEvents

This package is a comfort wrapper around wc3 events, for easy global and per-unit event listening via closures.

To listen to an event, simply #add, optionally passing a target unit:

	EventListener.add(EVENT_PLAYER_UNIT_DEATH) ->
	 <any unit death actions>

	EventListener.add(someUnit, EVENT_PLAYER_UNIT_DEATH) ->
	 <only 'someUnit' death actions>

For spell handling there are comfort wrappers via the on prefix:

EventListener.onCast(MY_SPELL_ID) (caster) ->
 <some non target spell event for all units>

EventListener.onCast(myUnit, MY_SPELL_ID) (caster) ->
 <some non target spell for 'myUnit'>

EventListener.onPointCast(myUnit, MY_SPELL_ID) (caster, target) ->
 <actions for a point cast spell. 'target' is the vec2 target point>

IMPORTANT: Make sure to always use the “EVENT_PLAYER_UNIT_” variants of the eventids. Other supported events: - EVENT_PLAYER_LEAVE - EVENT_UNIT_DAMAGED - EVENT_PLAYER_CHAT_FILTER - EVENT_PLAYER_ARROW_

Source on GitHub

📖 Read the detailed guide for hand-written examples and background.

Re-exports: EventHelper, RegisterEvents

Classes

OnCastListener

public abstract class OnCastListener

OnCast

public abstract class OnCast extends OnCastListener

Members:

• override function fire(unit caster)
• abstract function fireEx(int id)

OnPointCast

public abstract class OnPointCast extends OnCastListener

Members:

• override function fire(unit caster)
• abstract function fireEx(unit caster, vec2 target)

OnUnitCast

public abstract class OnUnitCast extends OnCastListener

Members:

• override function fire(unit caster)
• abstract function fireEx(unit caster, unit target)

EventListener

public abstract class EventListener

Members:

• abstract function onEvent()
• static function add(eventid eventId, EventListener listener) returns EventListener
• static function add(unit u, eventid eventId, EventListener listener) returns EventListener
• static function onCast(unit u, int abilId, OnCastListener listener) returns OnCastListener
• static function onTargetCast(unit u, int abilId, OnUnitCast listener) returns OnUnitCast
• static function onPointCast(unit u, int abilId, OnPointCast listener) returns OnPointCast
• static function onCast(int abilId, OnCastListener listener) returns OnCastListener
• static function onCast(unit u, OnCast listener) returns OnCast
• static function onTargetCast(int abilId, OnUnitCast listener) returns OnUnitCast
• static function onPointCast(int abilId, OnPointCast listener) returns OnPointCast
• static function generalEventCallback()
• static function onSpellEffect()

Functions

fireEvents

function fireEvents(unit _u) returns boolean

🔧 Configurable. Override it in your map’s config package.

Configure this function if you want some logic to prevent events being fired for specific units

unregisterEventsForUnit

public function unregisterEventsForUnit(unit u)

unregisterEvents

public function unregisterEvents(int id)

Extension Functions

eventid.toIntId

public function eventid.toIntId() returns int

Constants

EVENT_PLAYER_CHAT_FILTER

public constant EVENT_PLAYER_CHAT_FILTER = ConvertPlayerEvent(96)

Use this chat event if you want to access the entered message