Hierarchy

  • Container
    • SS6Player

Constructors

  • SS6Player (extends PIXI.Container)

    Parameters

    • ss6project: SS6Project

      SS6Project that contains animations.

    • animePackName: string = null

      The name of animePack(SSAE).

    • animeName: string = null

      The name of animation.

    Returns SS6Player

Properties

_bounds: Bounds

The bounds object, this is used to calculate and store the bounds of the displayObject.

_boundsID: number

Flags the cached bounds as dirty.

_boundsRect: Rectangle

Cache of this display-object's bounds-rectangle.

_destroyed: boolean

If the object has been destroyed via destroy(). If true, it should not be used.

_enabledFilters: Filter[]

Currently enabled filters.

_height: number
_lastSortedIndex: number

Which index in the children array the display component was before the previous zIndex sort. Used by containers to help sort objects with the same zIndex, by using previous array index as the decider.

_localBounds: Bounds

Local bounds object, swapped with _bounds when using getLocalBounds().

_localBoundsRect: Rectangle

Cache of this display-object's local-bounds rectangle.

_mask: Container<DisplayObject> | MaskData

The original, cached mask of the object.

_width: number
_zIndex: number

The zIndex of the displayObject. A higher value will mean it will be rendered on top of other displayObjects within the same container.

alpha: number

The opacity of the object.

children: DisplayObject[]

The array of children of this container.

containerUpdateTransform: (() => void)
cullable: boolean

Should this object be rendered if the bounds of this object are out of frame?

Culling has no effect on whether updateTransform is called.

cullArea: Rectangle

If set, this shape is used for culling instead of the bounds of this object. It can improve the culling performance of objects with many children. The culling area is defined in local space.

displayObjectUpdateTransform: (() => void)
filterArea: Rectangle

The area the filter is applied to. This is used as more of an optimization rather than figuring out the dimensions of the displayObject each frame you can set this rectangle.

Also works as an interaction mask.

filters: Filter[]

Sets the filters for the displayObject. IMPORTANT: This is a WebGL only feature and will be ignored by the canvas renderer. To remove filters simply set this property to 'null'.

isMask: boolean

Does any other displayObject use this object as a mask?

isSprite: boolean

Used to fast check if a sprite is.. a sprite!

name: string
onUserDataCallback: ((data: any) => void)
parent: Container<DisplayObject>

The display object container that contains this display object.

playEndCallback: ((player: SS6Player) => void)
playerLib: Player
renderable: boolean

Can this object be rendered, if false the object will not be drawn but the updateTransform methods will still be called.

Only affects recursive calls from parent. You can ask for bounds manually.

skipEnabled: boolean
sortableChildren: boolean

If set to true, the container will sort its children by zIndex value when updateTransform() is called, or manually if sortChildren() is called.

This actually changes the order of elements in the array, so should be treated as a basic solution that is not performant compared to other solutions, such as

PIXI.settings.SORTABLE_CHILDREN

sortDirty: boolean

Should children be sorted by zIndex at the next updateTransform call.

Will get automatically set to true if a new child is added, or if a child's zIndex changes.

transform: Transform

World transform and local transform of this object. This will become read-only later, please do not assign anything there unless you know what are you doing.

visible: boolean

The visibility of the object. If false the object will not be drawn, and the updateTransform function will not be called.

Only affects recursive calls from parent. You can ask for bounds or call updateTransform manually.

worldAlpha: number

The multiplied alpha of the displayObject.

prefixed: string | boolean

Accessors

  • get _tempDisplayObjectParent(): TemporaryDisplayObject
  • Protected

    Returns TemporaryDisplayObject

  • get angle(): number
  • The angle of the object in degrees. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

    Returns number

  • set angle(value): void
  • Parameters

    • value: number

    Returns void

  • get destroyed(): boolean
  • Readonly flag for destroyed display objects.

    Returns boolean

  • get height(): number
  • The height of the Container, setting this will actually modify the scale to achieve the value set.

    Returns number

  • set height(value): void
  • Parameters

    • value: number

    Returns void

  • get localTransform(): Matrix
  • Current transform of the object based on local factors: position, scale, other stuff.

    Returns Matrix

  • get mask(): Container<DisplayObject> | MaskData
  • Sets a mask for the displayObject. A mask is an object that limits the visibility of an object to the shape of the mask applied to it. In PixiJS a regular mask must be a PIXI.Graphics or a PIXI.Sprite object. This allows for much faster masking in canvas as it utilities shape clipping. Furthermore, a mask of an object must be in the subtree of its parent. Otherwise, getLocalBounds may calculate incorrect bounds, which makes the container's width and height wrong. To remove a mask, set this property to null.

    For sprite mask both alpha and red channel are used. Black mask is the same as transparent mask.

    Returns Container<DisplayObject> | MaskData

    const graphics = new PIXI.Graphics();
    graphics.beginFill(0xFF3300);
    graphics.drawRect(50, 250, 100, 100);
    graphics.endFill();

    const sprite = new PIXI.Sprite(texture);
    sprite.mask = graphics;

    At the moment, PIXI.CanvasRenderer doesn't support PIXI.Sprite as mask.

  • set mask(value): void
  • Parameters

    • value: Container<DisplayObject> | MaskData

    Returns void

  • get pivot(): ObservablePoint<any>
  • The center of rotation, scaling, and skewing for this display object in its local space. The position is the projection of pivot in the parent's local space.

    By default, the pivot is the origin (0, 0).

    Returns ObservablePoint<any>

    4.0.0

  • set pivot(value): void
  • Parameters

    • value: IPointData

    Returns void

  • get position(): ObservablePoint<any>
  • The coordinate of the object relative to the local coordinates of the parent.

    Returns ObservablePoint<any>

    4.0.0

  • set position(value): void
  • Parameters

    • value: IPointData

    Returns void

  • get rotation(): number
  • The rotation of the object in radians. 'rotation' and 'angle' have the same effect on a display object; rotation is in radians, angle is in degrees.

    Returns number

  • set rotation(value): void
  • Parameters

    • value: number

    Returns void

  • get scale(): ObservablePoint<any>
  • The scale factors of this object along the local coordinate axes.

    The default scale is (1, 1).

    Returns ObservablePoint<any>

    4.0.0

  • set scale(value): void
  • Parameters

    • value: IPointData

    Returns void

  • get skew(): ObservablePoint<any>
  • The skew factor for the object in radians.

    Returns ObservablePoint<any>

    4.0.0

  • set skew(value): void
  • Parameters

    • value: IPointData

    Returns void

  • get width(): number
  • The width of the Container, setting this will actually modify the scale to achieve the value set.

    Returns number

  • set width(value): void
  • Parameters

    • value: number

    Returns void

  • get worldTransform(): Matrix
  • Current transform of the object based on world (parent) factors.

    Returns Matrix

  • get worldVisible(): boolean
  • Indicates if the object is globally visible.

    Returns boolean

  • get x(): number
  • The position of the displayObject on the x axis relative to the local coordinates of the parent. An alias to position.x

    Returns number

  • set x(value): void
  • Parameters

    • value: number

    Returns void

  • get y(): number
  • The position of the displayObject on the y axis relative to the local coordinates of the parent. An alias to position.y

    Returns number

  • set y(value): void
  • Parameters

    • value: number

    Returns void

  • get zIndex(): number
  • The zIndex of the displayObject.

    If a container has the sortableChildren property set to true, children will be automatically sorted by zIndex value; a higher value will mean it will be moved towards the end of the array, and thus rendered on top of other display objects within the same container.

    Returns number

    PIXI.Container#sortableChildren

  • set zIndex(value): void
  • Parameters

    • value: number

    Returns void

Methods

  • Protected

    Recalculates the content bounds of this object. This should be overriden to calculate the bounds of this specific object (not including children).

    Returns void

  • Recursively updates transform of all objects from the root to this one internal function for toLocal()

    Returns void

  • To be overridden by the subclasses.

    Parameters

    • _renderer: Renderer

      The renderer

    Returns void

  • Protected

    Renders this object and its children with culling.

    Parameters

    • renderer: Renderer

      The renderer

    Returns void

  • Adds one or more children to the container.

    Multiple items can be added like so: myContainer.addChild(thingOne, thingTwo, thingThree)

    Type Parameters

    • U extends DisplayObject[]

    Parameters

    • Rest...children: U

      The DisplayObject(s) to add to the container

    Returns U[0]

    • The first child that was added.
  • Adds a child to the container at a specified index. If the index is out of bounds an error will be thrown

    Type Parameters

    • U extends DisplayObject

    Parameters

    • child: U

      The child to add

    • index: number

      The index to place the child in

    Returns U

    The child that was added.

  • Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optionalcontext: any

    Returns this

  • Recalculates the bounds of the container.

    This implementation will automatically fit the children's bounds into the calculation. Each child's bounds is limited to its mask's bounds or filterArea, if any is applied.

    Returns void

  • 名前を指定してパーツの再生するインスタンスアニメを変更します。 指定したパーツがインスタンスパーツでない場合、falseを返します. インスタンスパーツ名はディフォルトでは「ssae名:モーション名」とつけられています。 再生するアニメの名前は アニメパック名 と アニメ名 で指定してください。 現在再生しているアニメを指定することは入れ子となり無限ループとなるためできません。

    変更するアニメーションは同じ ssfb に含まれる必要があります。 インスタンスパーツが再生するアニメを変更します

    インスタンスキーは

    Parameters

    • partName: string

      SS上のパーツ名

    • animePackName: string

      参照するアニメパック名

    • animeName: string

      参照するアニメ名

    • overWrite: boolean

      インスタンスキーの上書きフラグ

    • keyParam: SS6PlayerInstanceKeyParam = null

      インスタンスキー

    Returns boolean

  • Removes all internal references and listeners as well as removes children from the display list. Do not use a Container after calling destroy.

    Parameters

    • Optionaloptions: boolean | IDestroyOptions

      Options parameter. A boolean will act as if all options have been set to that value

    Returns void

  • Pair method for enableTempParent

    Parameters

    • cacheParent: Container<DisplayObject>

      Actual parent of element

    Returns void

  • Calls each of the listeners registered for a given event.

    Parameters

    • event: string | symbol
    • Rest...args: any[]

    Returns boolean

  • Used in Renderer, cacheAsBitmap and other places where you call an updateTransform on root

    const cacheParent = elem.enableTempParent();
    elem.updateTransform();
    elem.disableTempParent(cacheParent);

    Returns Container<DisplayObject>

    • current parent
  • Return an array listing the events for which the emitter has registered listeners.

    Returns (string | symbol)[]

  • Calculates and returns the (world) bounds of the display object as a [Rectangle]PIXI.Rectangle.

    This method is expensive on containers with a large subtree (like the stage). This is because the bounds of a container depend on its children's bounds, which recursively causes all bounds in the subtree to be recalculated. The upside, however, is that calling getBounds once on a container will indeed update the bounds of all children (the whole subtree, in fact). This side effect should be exploited by using displayObject._bounds.getRectangle() when traversing through all the bounds in a scene graph. Otherwise, calling getBounds on each object in a subtree will cause the total cost to increase quadratically as its height increases.

    The transforms of all objects in a container's subtree and of all ancestors are updated. The world bounds of all display objects in a container's subtree will also be recalculated.

    The _bounds object stores the last calculation of the bounds. You can use to entirely skip bounds calculation if needed.

    const lastCalculatedBounds = displayObject._bounds.getRectangle(optionalRect);
    

    Do know that usage of getLocalBounds can corrupt the _bounds of children (the whole subtree, actually). This is a known issue that has not been solved. See [getLocalBounds]PIXI.DisplayObject#getLocalBounds for more details.

    getBounds should be called with skipUpdate equal to true in a render() call. This is because the transforms are guaranteed to be update-to-date. In fact, recalculating inside a render() call may cause corruption in certain cases.

    Parameters

    • OptionalskipUpdate: boolean

      Setting to true will stop the transforms of the scene graph from being updated. This means the calculation returned MAY be out of date BUT will give you a nice performance boost.

    • Optionalrect: Rectangle

      Optional rectangle to store the result of the bounds calculation.

    Returns Rectangle

    • The minimum axis-aligned rectangle in world space that fits around this object.
  • Returns the child at the specified index

    Parameters

    • index: number

      The index to get the child at

    Returns DisplayObject

    • The child at the given index, if any.
  • Type Parameters

    • T extends DisplayObject = DisplayObject

    Parameters

    • name: string
    • Optionaldeep: boolean

    Returns T

  • Returns the index position of a child DisplayObject instance

    Parameters

    • child: DisplayObject

      The DisplayObject instance to identify

    Returns number

    • The index position of the child display object to identify
  • Retrieves the local bounds of the displayObject as a rectangle object.

    Calling getLocalBounds may invalidate the _bounds of the whole subtree below. If using it inside a render() call, it is advised to call getBounds() immediately after to recalculate the world bounds of the subtree.

    Parameters

    • Optionalrect: Rectangle

      Optional rectangle to store the result of the bounds calculation.

    • OptionalskipChildrenUpdate: boolean

      Setting to true will stop re-calculation of children transforms, it was default behaviour of pixi 4.0-5.2 and caused many problems to users.

    Returns Rectangle

    • The rectangular bounding area.
  • Return the number of listeners listening to a given event.

    Parameters

    • event: string | symbol

    Returns number

  • Return the listeners registered for a given event.

    Parameters

    • event: string | symbol

    Returns ListenerFn[]

  • Parameters

    • event: string | symbol
    • Optionalfn: ListenerFn
    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

  • Add a listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optionalcontext: any

    Returns this

  • Add a one-time listener for a given event.

    Parameters

    • event: string | symbol
    • fn: ListenerFn
    • Optionalcontext: any

    Returns this

  • Overridable method that can be used by Container subclasses whenever the children array is modified.

    Parameters

    • Optional_length: number

    Returns void

  • Remove all listeners, or those of the specified event.

    Parameters

    • Optionalevent: string | symbol

    Returns this

  • Removes one or more children from the container.

    Type Parameters

    • U extends DisplayObject[]

    Parameters

    • Rest...children: U

      The DisplayObject(s) to remove

    Returns U[0]

    The first child that was removed.

  • Removes a child from the specified index position.

    Parameters

    • index: number

      The index to get the child from

    Returns DisplayObject

    The child that was removed.

  • Removes all children from this container that are within the begin and end indexes.

    Parameters

    • OptionalbeginIndex: number

      The beginning position.

    • OptionalendIndex: number

      The ending position. Default value is size of the container.

    Returns DisplayObject[]

    • List of removed children
  • Remove the listeners of a given event.

    Parameters

    • event: string | symbol
    • Optionalfn: ListenerFn
    • Optionalcontext: any
    • Optionalonce: boolean

    Returns this

  • Renders the object using the WebGL renderer.

    The [_render]PIXI.Container#_render method is be overriden for rendering the contents of the container itself. This render method will invoke it, and also invoke the render methods of all children afterward.

    If renderable or visible is false or if worldAlpha is not positive or if cullable is true and the bounds of this object are out of frame, this implementation will entirely skip rendering. See PIXI.DisplayObject for choosing between renderable or visible. Generally, setting alpha to zero is not recommended for purely skipping rendering.

    When your scene becomes large (especially when it is larger than can be viewed in a single screen), it is advised to employ culling to automatically skip rendering objects outside of the current screen. See [cullable]PIXI.DisplayObject#cullable and [cullArea]PIXI.DisplayObject#cullArea. Other culling methods might be better suited for a large number static objects; see [@pixi-essentials/cull]https://www.npmjs.com/package/@pixi-essentials/cull and [pixi-cull]https://www.npmjs.com/package/pixi-cull.

    The [renderAdvanced]PIXI.Container#renderAdvanced method is internally used when when masking or filtering is applied on a container. This does, however, break batching and can affect performance when masking and filtering is applied extensively throughout the scene graph.

    Parameters

    • renderer: Renderer

      The renderer

    Returns void

  • Render the object using the WebGL renderer and advanced features.

    Parameters

    • renderer: Renderer

      The renderer

    Returns void

  • アニメーションの速度を設定する (deprecated この関数は削除される可能性があります)

    Parameters

    • fps: number

      アニメーション速度(frame per sec.)

    • _skipEnabled: boolean = true

      描画更新が間に合わないときにフレームをスキップするかどうか

    Returns void

  • アニメーション再生設定

    Parameters

    • _startframe: number = -1

      開始フレーム番号(マイナス設定でデフォルト値を変更しない)

    • _endframe: number = -1

      終了フレーム番号(マイナス設定でデフォルト値を変更しない)

    • _loops: number = -1

      ループ回数(ゼロもしくはマイナス設定で無限ループ)

    Returns void

  • アニメーションの速度を設定する

    Parameters

    • fpsRate: number

      アニメーション速度(設定値に対する乗率)負数設定で逆再生

    • _skipEnabled: boolean = true

      描画更新が間に合わないときにフレームをスキップするかどうか

    Returns void

  • Changes the position of an existing child in the display object container

    Parameters

    • child: DisplayObject

      The child DisplayObject instance for which you want to change the index number

    • index: number

      The resulting index number for the child display object

    Returns void

  • 1フレーム分のアニメーション描画

    Parameters

    • frameNumber: number

      フレーム番号

    • ds: number = 0.0

      delta step

    Returns void

  • Set the parent Container of this DisplayObject.

    Parameters

    • container: Container<DisplayObject>

      The Container to add this DisplayObject to.

    Returns Container<DisplayObject>

    • The Container that this DisplayObject was added to.
  • Convenience function to set the position, scale, skew and pivot at once.

    Parameters

    • Optionalx: number

      The X position

    • Optionaly: number

      The Y position

    • OptionalscaleX: number

      The X scale value

    • OptionalscaleY: number

      The Y scale value

    • Optionalrotation: number

      The rotation

    • OptionalskewX: number

      The X skew value

    • OptionalskewY: number

      The Y skew value

    • OptionalpivotX: number

      The X pivot value

    • OptionalpivotY: number

      The Y pivot value

    Returns this

    • The DisplayObject instance
  • Sorts children by zIndex. Previous order is maintained for 2 children with the same zIndex.

    Returns void

  • Swaps the position of 2 Display Objects within this container.

    Parameters

    • child: DisplayObject

      First display object to swap

    • child2: DisplayObject

      Second display object to swap

    Returns void

  • Calculates the global position of the display object.

    Type Parameters

    • P extends IPointData = Point

    Parameters

    • position: IPointData

      The world origin to calculate from.

    • Optionalpoint: P

      A Point object in which to store the value, optional (otherwise will create a new Point).

    • OptionalskipUpdate: boolean

      Should we skip the update transform.

    Returns P

    • A point object representing the position of this object.
  • Calculates the local position of the display object relative to another point.

    Type Parameters

    • P extends IPointData = Point

    Parameters

    • position: IPointData

      The world origin to calculate from.

    • Optionalfrom: DisplayObject

      The DisplayObject to calculate the global position from.

    • Optionalpoint: P

      A Point object in which to store the value, optional (otherwise will create a new Point).

    • OptionalskipUpdate: boolean

      Should we skip the update transform

    Returns P

    • A point object representing the position of this object
  • Update is called PIXI.ticker

    Parameters

    • delta: number

      expected 1

    • rewindAfterReachingEndFrame: boolean = true

    Returns void

  • Updates the transform on all children of this container for rendering.

    Returns void

  • Mixes all enumerable properties and methods from a source object to DisplayObject.

    Parameters

    • source: Dict<any>

      The source of properties and methods to mix in.

    Returns void