Event listener for Constraint type events.
The events that can be caught are WAKE, SLEEP and BREAK type events.
Theses listeners will only operate on Constraints.
Constructor
new(event:CbEvent, options:Null<Dynamic>, handler:ConstraintCallback ‑> Void, precedence:Int = 0)
Construct a new ConstraintListener.
The possible event types are WAKE, SLEEP and BREAK.
The options argument is typed Dynamic, and is permitted to be either an
OptionType or one of:
CbType, CbTypeList, Array<CbType>, flash.Vector<CbType>
In which case the input CbType's will be used to construct an OptionType
whose included types will be the set of CbTypes supplied.
Parameters:
event | The event type to listen for. |
|---|---|
options | The OptionType to match Constraints against, passing null will equate to an empty OptionType. |
handler | The callback handler for this listener. |
precedence | The precedence of this listener used to sort the order of callbacks in the case of more than one suitable ConstraintListener existing for the same event on the same Constraint. (default 0) |
Returns:
The newly constructed ConstraintListener
Throws:
# | If handler is null. |
|---|---|
# | If the event type is not permitted for this listener. |
# | If options is not of the expected Type. |
Variables
options:OptionType
The OptionType used to match against Constraints.
When added to the same Space, any Constraint who's CbType list matches
against this OptionType will be issued a callback when the relevant
event occurs.