View source

class PointerTrigger

package feathers.utils

@:directlyUsed

Dispatches TriggerEvent.TRIGGER (or a custom event type) when the target is clicked or tapped.

Available since

1.0.0

.

See also:

Constructor

@:value({ target : null })new(?target:InteractiveObject, ?eventFactory:() ‑> Event)

Creates a new PointerTrigger object with the given arguments.

Available since

1.0.0

.

Variables

enabled:Bool

May be set to false to disable the trigger event temporarily until set back to true.

Available since

1.0.0

.

target:InteractiveObject

The target component that should dispatch the event.

Available since

1.0.0

.

customHitTest:(stageX:Float, stageY:Float) ‑> Bool

In addition to the normal hit testing for mouse/touch events, a custom function may impose additional rules that determine if the target should be triggered.

The function should return true if the target should be triggered, and false if it should not be triggered.

Available since

1.0.0

.

eventFactory:() ‑> Event

The event type to dispatch on trigger. If null, dispatches an instance of TriggerEvent.

Available since

1.0.0

.