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

    Class MovieClip

    createjs-compatible MovieClip. Plays its symbol's timeline from the shared definition with createjs's rules: the two phases (tick: advance the playhead; then resolve: write the tweens and settle the children), the write rule (a tween writes only when its position changes), synched / single children taking their frame from the parent's step, the reset of an independent child when it comes back on the display list, and when frame scripts run.

    Hierarchy (View Summary)

    Index
    • Parameters

      • Optionalmode: string | null
      • OptionalstartPosition: number | null
      • Optionalloop: number | boolean | null
      • Optionaltimeline: Timeline
      • Optionalpixi: IOwnedNode

      Returns MovieClip

    _bounds: Rectangle | null
    _captureListeners: IListenerMap | null
    _framerate: number | null
    _listeners: IListenerMap | null
    _managed: { [id: number]: number }

    Display objects the timeline placed, with the resolve that last placed them (_resolveCount at that time). One placed in an earlier resolve and not in the current one is removed at its end (createjs marks every entry 1 at the start of a resolve and placed ones 2: an earlier count is its 1)

    _maskHost: Container | null

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

    _maskTargets: DisplayObject[]

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

    _rawPosition: number
    _synchOffset: number
    _t: number
    actionsEnabled: boolean
    autoReset: boolean
    bitmapCache: ICacheState | null

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

    children: DisplayObject[]
    contentFps: number | null

    The frame rate the content was published with (lib.properties.fps), set on the content's symbols

    currentFrame: number
    cursor: string | null
    filterCacheList?: IFilterCacheEntry[]

    Instances to re-cache within frame ranges, read by the filter cache handling (published code sets it in the symbol's constructor)

    frameBounds?: Rectangle[] | null
    framerate: number | null
    hitArea: DisplayObject | null
    id: number
    loop: number
    mode: string
    mouseChildren: boolean
    mouseEnabled: boolean
    nominalBounds?: Rectangle | null

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

    parent: Container | null
    paused: boolean

    The Pixi node this object shows

    shadow: null
    snapToPixel: boolean
    startPosition: number
    tickChildren: boolean
    tickEnabled: boolean
    timeline: Timeline
    INDEPENDENT: string
    SINGLE_FRAME: string
    SYNCHED: string
    • get _eventParent(): EventDispatcher | null

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

      Returns EventDispatcher | null

    • 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 currentLabel(): string | null

      Returns string | null

    • get duration(): number

      Returns number

    • get filters(): IFilterLike[] | null

      Returns IFilterLike[] | null

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

      Parameters

      Returns void

    • get labels(): ILabelDef[]

      Returns ILabelDef[]

    • 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 totalFrames(): number

      Returns number

    • 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

    • Parameters

      Returns 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

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

      Parameters

      Returns void

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

      Returns boolean

    • 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

    • 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

    • Stops skipping placements: the children placed so far (the top of the block, from the expected index up) are moved to the bottom as createjs's placements would have left them, with no events (moves within the same parent are silent in createjs).

      Returns void

    • Parameters

      • positionOrLabel: string | number

      Returns void

    • The node Pixi masks with when this object is a mask

      Returns Container | null

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

      Returns void

    • Parameters

      • index: number
      • Optionalsilent: boolean

      Returns boolean

    • Returns void

    • Returns void

    • MovieClip._resolveState: places every tween target (and state entry) at the bottom of the display list in turn, then removes the children placed before and not now. The placements are skipped while they would leave the display list as it is (_addManagedChild); otherwise everything is done as createjs does it.

      Returns void

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

      Parameters

      Returns void

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

      Parameters

      • value: string | null

      Returns void

    • Parameters

      • state: string | number | boolean | object | IStateEntryDef[] | null | undefined
      • scope: ITweenScope
      • offset: number

      Returns void

    • createjs tick phase: advance the playhead, then the children (reverse), then tick listeners

      Parameters

      Returns void

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

      Returns 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

    • createjs resolve phase (MovieClip draw / Stage update)

      Returns void

    • Parameters

      • rawPosition: number
      • jump: boolean

      Returns void

    • Parameters

      • Optionaltime: number | null

      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

      • positionOrLabel: string | number

      Returns void

    • Parameters

      • positionOrLabel: 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

    • 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

    • Returns void

    • 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