gameforge - v0.1.12
    Preparing search index...

    Interface IFederatedDisplayObject

    interface IFederatedDisplayObject {
        _internalEventMode: EventMode;
        _internalInteractive: boolean;
        eventMode: EventMode;
        hitArea: null | IHitArea;
        interactive: boolean;
        interactiveChildren: boolean;
        isInteractive: () => boolean;
        onclick: null | FederatedEventHandler<FederatedPointerEvent>;
        onglobalmousemove: null | FederatedEventHandler<FederatedPointerEvent>;
        onglobalpointermove: null | FederatedEventHandler<FederatedPointerEvent>;
        onglobaltouchmove: null | FederatedEventHandler<FederatedPointerEvent>;
        onmousedown: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseenter: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseleave: null | FederatedEventHandler<FederatedPointerEvent>;
        onmousemove: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseout: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseover: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseup: null | FederatedEventHandler<FederatedPointerEvent>;
        onmouseupoutside: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointercancel: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerdown: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerenter: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerleave: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointermove: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerout: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerover: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointertap: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerup: null | FederatedEventHandler<FederatedPointerEvent>;
        onpointerupoutside: null | FederatedEventHandler<FederatedPointerEvent>;
        onrightclick: null | FederatedEventHandler<FederatedPointerEvent>;
        onrightdown: null | FederatedEventHandler<FederatedPointerEvent>;
        onrightup: null | FederatedEventHandler<FederatedPointerEvent>;
        onrightupoutside: null | FederatedEventHandler<FederatedPointerEvent>;
        ontap: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchcancel: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchend: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchendoutside: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchmove: null | FederatedEventHandler<FederatedPointerEvent>;
        ontouchstart: null | FederatedEventHandler<FederatedPointerEvent>;
        onwheel: null | FederatedEventHandler<FederatedWheelEvent>;
        addEventListener<
            K extends (keyof FederatedEventMap)
            | (keyof GlobalFederatedEventMap),
        >(
            type: K,
            listener: (e: AllFederatedEventMap[K]) => any,
            options?: AddListenerOptions,
        ): void;
        addEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: AddListenerOptions,
        ): void;
        dispatchEvent(event: Event): boolean;
        removeEventListener<
            K extends (keyof FederatedEventMap)
            | (keyof GlobalFederatedEventMap),
        >(
            type: K,
            listener: (e: AllFederatedEventMap[K]) => any,
            options?: RemoveListenerOptions,
        ): void;
        removeEventListener(
            type: string,
            listener: EventListenerOrEventListenerObject,
            options?: RemoveListenerOptions,
        ): void;
    }

    Hierarchy

    Index

    Properties

    _internalEventMode: EventMode
    _internalInteractive: boolean
    eventMode: EventMode

    The mode of interaction for this object

    hitArea: null | IHitArea

    The hit-area specifies the area for which pointer events should be captured by this event target.

    interactive: boolean

    Whether this event target should fire UI events.

    interactiveChildren: boolean

    Whether this event target has any children that need UI events. This can be used optimize event propagation.

    isInteractive: () => boolean

    Returns true if the DisplayObject has interactive 'static' or 'dynamic'

    Handler for 'click' event

    onglobalmousemove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'globalmousemove' event

    onglobalpointermove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'globalpointermove' event

    onglobaltouchmove: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'globaltouchmove' event

    Handler for 'mousedown' event

    Handler for 'mouseenter' event

    Handler for 'mouseleave' event

    Handler for 'mousemove' event

    Handler for 'mouseout' event

    Handler for 'mouseover' event

    Handler for 'mouseup' event

    Handler for 'mouseupoutside' event

    Handler for 'pointercancel' event

    Handler for 'pointerdown' event

    Handler for 'pointerenter' event

    Handler for 'pointerleave' event

    Handler for 'pointermove' event

    Handler for 'pointerout' event

    Handler for 'pointerover' event

    Handler for 'pointertap' event

    Handler for 'pointerup' event

    onpointerupoutside: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'pointerupoutside' event

    Handler for 'rightclick' event

    Handler for 'rightdown' event

    Handler for 'rightup' event

    Handler for 'rightupoutside' event

    Handler for 'tap' event

    Handler for 'touchcancel' event

    Handler for 'touchend' event

    ontouchendoutside: null | FederatedEventHandler<FederatedPointerEvent>

    Handler for 'touchendoutside' event

    Handler for 'touchmove' event

    Handler for 'touchstart' event

    Handler for 'wheel' event

    Methods

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Type Parameters

      • K extends (keyof FederatedEventMap) | (keyof GlobalFederatedEventMap)

      Parameters

      Returns void

    • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

      The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

      When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

      When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in § 2.8 Observing event listeners.

      When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

      If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

      The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

      MDN Reference

      Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: AddListenerOptions

      Returns void

    • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

      MDN Reference

      Parameters

      • event: Event

      Returns boolean

    • Removes the event listener in target's event listener list with the same type, callback, and options.

      MDN Reference

      Type Parameters

      • K extends (keyof FederatedEventMap) | (keyof GlobalFederatedEventMap)

      Parameters

      Returns void

    • Removes the event listener in target's event listener list with the same type, callback, and options.

      MDN Reference

      Parameters

      • type: string
      • listener: EventListenerOrEventListenerObject
      • Optionaloptions: RemoveListenerOptions

      Returns void