class nape.callbacks.ConstraintListener extends Listener

Available on all platforms

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.

Instance Fields

var 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.

function new(event:CbEvent, options:Null<Dynamic>, handler:ConstraintCallback ->Void, ?precedence:Int = 0):Void

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. * *

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 *

function handler(:ConstraintCallback):Void

The callback handler for this event.