@tawaship/pixim-animate-runtime - v0.1.0
    Preparing search index...

    Interface IButtonTarget

    Members ButtonHelper needs from its target (a MovieClip).

    interface IButtonTarget {
        _bounds: Rectangle | null;
        _captureListeners: IListenerMap | null;
        _listeners: IListenerMap | null;
        _maskHost: Container | null;
        _maskTargets: DisplayObject[];
        actionsEnabled: boolean;
        bitmapCache: ICacheState | null;
        children: DisplayObject[];
        cursor: string | null;
        frameBounds?: Rectangle[] | null;
        hitArea: DisplayObject | null;
        id: number;
        mouseChildren: boolean;
        mouseEnabled: boolean;
        nominalBounds?: Rectangle | null;
        parent: Container | null;
        paused: boolean;
        pixi: IOwnedNode;
        shadow: null;
        snapToPixel: boolean;
        tickChildren: boolean;
        tickEnabled: boolean;
        get _eventParent(): EventDispatcher | null;
        get _off(): boolean | undefined;
        set _off(value: boolean | undefined): void;
        get alpha(): number;
        set alpha(value: number): void;
        get compositeOperation(): string | null;
        set compositeOperation(value: string | null): void;
        get filters(): IFilterLike[] | null;
        set filters(value: IFilterLike[] | null): void;
        get mask(): DisplayObject | null;
        set mask(value: DisplayObject | null): void;
        get name(): string | null;
        set name(value: string | null): void;
        get numChildren(): number;
        get regX(): number;
        set regX(value: number): void;
        get regY(): number;
        set regY(value: number): void;
        get rotation(): number;
        set rotation(value: number): void;
        get scaleX(): number;
        set scaleX(value: number): void;
        get scaleY(): number;
        set scaleY(value: number): void;
        get skewX(): number;
        set skewX(value: number): void;
        get skewY(): number;
        set skewY(value: number): void;
        get visible(): boolean;
        set visible(value: boolean): void;
        get x(): number;
        set x(value: number): void;
        get y(): number;
        set y(value: number): void;
        _applyComposite(): void;
        _attachMask(child: DisplayObject): void;
        _clipsAsMask(): boolean;
        _detachMask(child: DisplayObject): void;
        _dispatchEvent(event: Event, phase: number): void;
        _effectiveComposite(): string | null;
        _pixiMaskNode(): Container | null;
        _releaseMaskNode(): void;
        _removeChildAt(index: number, silent?: boolean): boolean;
        _reset(): void;
        _setBlendMode(mode: BLEND_MODES): void;
        _setInheritedComposite(value: string | null): void;
        _tick(event: Event): void;
        _updatePixiMask(): void;
        _updateRenderable(): void;
        addChild(...children: DisplayObject[]): DisplayObject | null;
        addChildAt(child: DisplayObject, index: number): DisplayObject;
        addEventListener(
            type: string,
            listener: TEventListener,
            useCapture?: boolean,
        ): TEventListener;
        cache(
            x: number,
            y: number,
            width: number,
            height: number,
            scale?: number,
        ): void;
        contains(child: DisplayObject | null): boolean;
        dispatchEvent(
            eventOrType: string | Event,
            bubbles?: boolean,
            cancelable?: boolean,
        ): boolean;
        getChildAt(index: number): DisplayObject | undefined;
        getChildByName(name: string): DisplayObject | null;
        getChildDepth(): number;
        getChildIndex(child: DisplayObject): number;
        gotoAndPlay(frame: string | number): void;
        gotoAndStop(frame: string | number): void;
        hasEventListener(type: string): boolean;
        isVisible(): boolean;
        off(type: string, listener: TEventListener, useCapture?: boolean): void;
        on(
            type: string,
            listener: TEventListener,
            scope?: object,
            once?: boolean,
            data?: TEventData,
            useCapture?: boolean,
        ): TEventListener;
        removeAllChildren(): void;
        removeAllEventListeners(type?: string): void;
        removeChild(...children: DisplayObject[]): boolean;
        removeChildAt(...indexes: number[]): boolean;
        removeEventListener(
            type: string,
            listener: TEventListener,
            useCapture?: boolean,
        ): void;
        set(props: { [key: string]: string | number | boolean | null }): this;
        setBounds(
            x: number | null,
            y?: number,
            width?: number,
            height?: number,
        ): void;
        setChildIndex(child: DisplayObject, index: number): void;
        setTransform(
            x?: number,
            y?: number,
            scaleX?: number,
            scaleY?: number,
            rotation?: number,
            skewX?: number,
            skewY?: number,
            regX?: number,
            regY?: number,
        ): this;
        sortChildren(compare: (a: DisplayObject, b: DisplayObject) => number): void;
        swapChildren(child1: DisplayObject, child2: DisplayObject): void;
        swapChildrenAt(index1: number, index2: number): void;
        toString(): string;
        uncache(): void;
        updateCache(): void;
        willTrigger(type: string): boolean;
    }

    Hierarchy (View Summary)

    Index
    _bounds _captureListeners _listeners _maskHost _maskTargets actionsEnabled bitmapCache children cursor frameBounds? hitArea id mouseChildren mouseEnabled nominalBounds? parent paused pixi shadow snapToPixel tickChildren tickEnabled
    _eventParent _off alpha compositeOperation filters mask name numChildren regX regY rotation scaleX scaleY skewX skewY visible x y
    _applyComposite _attachMask _clipsAsMask _detachMask _dispatchEvent _effectiveComposite _pixiMaskNode _releaseMaskNode _removeChildAt _reset _setBlendMode _setInheritedComposite _tick _updatePixiMask _updateRenderable addChild addChildAt addEventListener cache contains dispatchEvent getChildAt getChildByName getChildDepth getChildIndex gotoAndPlay gotoAndStop hasEventListener isVisible off on removeAllChildren removeAllEventListeners removeChild removeChildAt removeEventListener set setBounds setChildIndex setTransform sortChildren swapChildren swapChildrenAt toString uncache updateCache willTrigger

    _bounds

    _bounds: Rectangle | null

    _captureListeners

    _captureListeners: IListenerMap | null

    _listeners

    _listeners: IListenerMap | null

    _maskHost

    _maskHost: Container | null

    The parent whose Pixi node holds this object's mask node

    _maskTargets

    _maskTargets: DisplayObject[]

    The objects this object masks (while they are on a display list)

    actionsEnabled: boolean
    bitmapCache: ICacheState | null

    The cache createjs would draw through (filters show in Pixi without one)

    children: DisplayObject[]
    cursor: string | null
    frameBounds?: Rectangle[] | null
    hitArea: DisplayObject | null
    id: number
    mouseChildren: boolean
    mouseEnabled: boolean
    nominalBounds?: Rectangle | null

    Set only when the symbol has them (createjs leaves them undefined otherwise)

    parent: Container | null
    paused: boolean
    pixi: IOwnedNode

    The Pixi node this object shows

    shadow: null
    snapToPixel: boolean
    tickChildren: boolean
    tickEnabled: boolean

    _eventParent

    • get _eventParent(): EventDispatcher | null

      The parent the bubble and capture phases walk through (a display object's parent)

      Returns EventDispatcher | null

    _off

    • get _off(): boolean | undefined

      Returns boolean | undefined

    • set _off(value: boolean | undefined): void

      Parameters

      • value: boolean | undefined

      Returns void

    • get alpha(): number

      Returns number

    • set alpha(value: number): void

      Parameters

      • value: number

      Returns void

    • get compositeOperation(): string | null

      Returns string | null

    • set compositeOperation(value: string | null): void

      Parameters

      • value: string | null

      Returns void

    • get filters(): IFilterLike[] | null

      Returns IFilterLike[] | null

    • set filters(value: IFilterLike[] | null): void

      Parameters

      Returns void

    • get mask(): DisplayObject | null

      Returns DisplayObject | null

    • set mask(value: DisplayObject | null): void

      Parameters

      Returns void

    • get name(): string | null

      Returns string | null

    • set name(value: string | null): void

      Parameters

      • value: string | null

      Returns void

    • get numChildren(): number

      Returns number

    • get regX(): number

      Returns number

    • set regX(value: number): void

      Parameters

      • value: number

      Returns void

    • get regY(): number

      Returns number

    • set regY(value: number): void

      Parameters

      • value: number

      Returns void

    • get rotation(): number

      Returns number

    • set rotation(value: number): void

      Parameters

      • value: number

      Returns void

    • get scaleX(): number

      Returns number

    • set scaleX(value: number): void

      Parameters

      • value: number

      Returns void

    • get scaleY(): number

      Returns number

    • set scaleY(value: number): void

      Parameters

      • value: number

      Returns void

    • get skewX(): number

      Returns number

    • set skewX(value: number): void

      Parameters

      • value: number

      Returns void

    • get skewY(): number

      Returns number

    • set skewY(value: number): void

      Parameters

      • value: number

      Returns void

    • get visible(): boolean

      Returns boolean

    • set visible(value: boolean): void

      Parameters

      • value: boolean

      Returns void

    • get x(): number

      Returns number

    • set x(value: number): void

      Parameters

      • value: number

      Returns void

    • get y(): number

      Returns number

    • set y(value: number): void

      Parameters

      • value: number

      Returns void

    _applyComposite

    • _applyComposite(): void

      Pixi blends per drawing node (a container has no blend mode of its own), so the composite operation in effect is set on this object's drawing node and handed down to the children

      Returns void

    _attachMask

    • _attachMask(child: DisplayObject): void

      Puts the node of a child's mask into this container's node, and sets it as the Pixi mask

      Parameters

      Returns void

    _clipsAsMask

    • _clipsAsMask(): boolean

      Whether this object clips when used as a mask (createjs clips only with a non-empty Graphics)

      Returns boolean

    _detachMask

    _dispatchEvent

    • _dispatchEvent(event: Event, phase: number): void

      Phase 1 is capture, 2 the target, 3 bubbling. At the target, the capture listeners run first and then the others (createjs runs the target phase twice, the second time as phase 2.1, which reads the non-capture listeners).

      Parameters

      • event: Event
      • phase: number

      Returns void

    _effectiveComposite

    • _effectiveComposite(): string | null

      The composite operation createjs draws this object with: its own, or else the nearest ancestor's (createjs sets it on the context and draws the children under it, each child saving and restoring the context)

      Returns string | null

    _pixiMaskNode

    • _pixiMaskNode(): Container | null

      The node Pixi masks with when this object is a mask

      Returns Container | null

    _releaseMaskNode

    • _releaseMaskNode(): void

      Called when this object stops being some object's Pixi mask

      Returns void

    _removeChildAt

    • _removeChildAt(index: number, silent?: boolean): boolean

      Parameters

      • index: number
      • Optionalsilent: boolean

      Returns boolean

    _reset

    • _reset(): void

      Returns void

    _setBlendMode

    • _setBlendMode(mode: BLEND_MODES): void

      Blend mode for the Pixi node(s) that draw this object

      Parameters

      Returns void

    _setInheritedComposite

    • _setInheritedComposite(value: string | null): void

      Told by the parent when the composite operation in effect on it changes

      Parameters

      • value: string | null

      Returns void

    _tick

    • _tick(event: Event): void

      createjs tick phase: children in reverse order (live array), then this object's listeners

      Parameters

      Returns void

    _updatePixiMask

    • _updatePixiMask(): void

      Sets the Pixi mask from the createjs one: Pixi masks only while the createjs mask would clip

      Returns void

    _updateRenderable

    • _updateRenderable(): void

      The node is drawn unless Pixi uses it as a mask, or it is in a parent's node only to carry the mask shape of a sibling (a createjs mask is not on any display list and is not drawn itself)

      Returns void

    • Parameters

      • x: number
      • y: number
      • width: number
      • height: number
      • Optionalscale: number

      Returns void

    • Parameters

      • eventOrType: string | Event
      • Optionalbubbles: boolean
      • Optionalcancelable: boolean

      Returns boolean

    • Returns number

    • Parameters

      • frame: string | number

      Returns void

    • Parameters

      • frame: string | number

      Returns void

    • Parameters

      • type: string

      Returns boolean

    • Returns boolean

    • Parameters

      Returns void

    • Parameters

      • type: string
      • listener: TEventListener
      • Optionalscope: object
      • Optionalonce: boolean
      • Optionaldata: TEventData
      • OptionaluseCapture: boolean

      Returns TEventListener

    • Returns void

    • Parameters

      • Optionaltype: string

      Returns void

    • Parameters

      • ...indexes: number[]

      Returns boolean

    • Parameters

      Returns void

    • Parameters

      • props: { [key: string]: string | number | boolean | null }

      Returns this

    • Parameters

      • x: number | null
      • Optionaly: number
      • Optionalwidth: number
      • Optionalheight: number

      Returns void

    • Parameters

      • Optionalx: number
      • Optionaly: number
      • OptionalscaleX: number
      • OptionalscaleY: number
      • Optionalrotation: number
      • OptionalskewX: number
      • OptionalskewY: number
      • OptionalregX: number
      • OptionalregY: number

      Returns this

    • Parameters

      • index1: number
      • index2: number

      Returns void

    • Returns a string representation of an object.

      Returns string

    • Returns void

    • Returns void

    • Parameters

      • type: string

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Accessors
    Methods