@next2d/player 1.14.7 → 1.14.9

package/dist/player/next2d/display/MovieClip.d.ts

@@ -0,0 +1,312 @@
+import { Sprite } from "./Sprite";
+import { FrameLabel } from "./FrameLabel";
+import { Sound } from "../media/Sound";
+import type { LoopConfigImpl } from "../../../interface/LoopConfigImpl";
+import type { ParentImpl } from "../../../interface/ParentImpl";
+import type { MovieClipCharacterImpl } from "../../../interface/MovieClipCharacterImpl";
+import type { DictionaryTagImpl } from "../../../interface/DictionaryTagImpl";
+/**
+ * MovieClip クラスは、Sprite、DisplayObjectContainer、InteractiveObject、DisplayObject
+ * および EventDispatcher クラスを継承します。
+ * MovieClip オブジェクトには、Sprite オブジェクトとは違ってタイムラインがあります。
+ * タイムラインの再生ヘッドが停止されても、その MovieClip オブジェクトの子 MovieClip オブジェクトの再生ヘッドは停止しません。
+ *
+ * The MovieClip class inherits from the following classes: Sprite, DisplayObjectContainer,
+ * InteractiveObject, DisplayObject, and EventDispatcher.
+ * Unlike the Sprite object, a MovieClip object has a timeline.
+ * When the playback head of the timeline is stopped,
+ * the playback head of the child MovieClip object of that MovieClip object will not be stopped.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  Sprite
+ */
+export declare class MovieClip extends Sprite {
+    private _$labels;
+    _$currentFrame: number;
+    _$stopFlag: boolean;
+    _$canAction: boolean;
+    private _$childRemove;
+    _$canSound: boolean;
+    _$actionProcess: boolean;
+    _$actions: Map<number, Function[]>;
+    _$frameCache: Map<string, any>;
+    _$sounds: Map<number, Sound[]>;
+    _$actionOffset: number;
+    _$actionLimit: number;
+    _$totalFrames: number;
+    _$isPlaying: boolean;
+    _$loopConfig: LoopConfigImpl | null;
+    private _$tweenFrame;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class MovieClip]
+     * @method
+     * @static
+     */
+    static toString(): string;
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.display.MovieClip
+     * @const
+     * @static
+     */
+    static get namespace(): string;
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object MovieClip]
+     * @method
+     * @public
+     */
+    toString(): string;
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.display.MovieClip
+     * @const
+     * @public
+     */
+    get namespace(): string;
+    /**
+     * @description MovieClip インスタンスのタイムライン内の再生ヘッドが置かれているフレームの番号を示します。
+     *              Specifies the number of the frame in which the playhead is located
+     *              in the timeline of the MovieClip instance.
+     *
+     * @member {number}
+     * @default 1
+     * @readonly
+     * @public
+     */
+    get currentFrame(): number;
+    /**
+     * @description MovieClip インスタンスのタイムライン内の現在のフレームにあるラベルです。
+     *              The label at the current frame in the timeline of the MovieClip instance.
+     *
+     * @member  {FrameLabel|null}
+     * @readonly
+     * @public
+     */
+    get currentFrameLabel(): FrameLabel | null;
+    /**
+     * @description 現在のシーンの FrameLabel オブジェクトの配列を返します。
+     *              Returns an array of FrameLabel objects from the current scene.
+     *
+     * @member  {array|null}
+     * @readonly
+     * @public
+     */
+    get currentLabels(): FrameLabel[] | null;
+    /**
+     * @description ムービークリップが現在再生されているかどうかを示すブール値です。
+     *              A Boolean value that indicates whether a movie clip is curently playing.
+     *
+     * @member  {boolean}
+     * @default false
+     * @readonly
+     * @public
+     */
+    get isPlaying(): boolean;
+    /**
+     * @description MovieClip インスタンス内のフレーム総数です。
+     *              The total number of frames in the MovieClip instance.
+     *
+     * @member  {number}
+     * @default 1
+     * @readonly
+     * @public
+     */
+    get totalFrames(): number;
+    /**
+     * @description MovieClipのフレームヘッダーの移動方法の設定オブジェクトを返します。
+     *              Returns a configuration object for how MovieClip's frame headers are moved.
+     *
+     * @member  {object}
+     * @default null
+     * @public
+     */
+    get loopConfig(): LoopConfigImpl | null;
+    set loopConfig(loop_config: LoopConfigImpl | null);
+    /**
+     * @description 指定されたフレームで SWF ファイルの再生を開始します。
+     *              Starts playing the SWF file at the specified frame.
+     *
+     * @param  {number|string} frame
+     * @return {void}
+     * @method
+     * @public
+     */
+    gotoAndPlay(frame: string | number): void;
+    /**
+     * @description このムービークリップの指定されたフレームに再生ヘッドを送り、そこで停止させます。
+     *              Brings the playhead to the specified frame
+     *              of the movie clip and stops it there.
+     *
+     * @param  {number|string} frame
+     * @return {void}
+     * @method
+     * @public
+     */
+    gotoAndStop(frame: string | number): void;
+    /**
+     * @description 次のフレームに再生ヘッドを送り、停止します。
+     *              Sends the playhead to the next frame and stops it.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    nextFrame(): void;
+    /**
+     * @description ムービークリップのタイムライン内で再生ヘッドを移動します。
+     *              Moves the playhead in the timeline of the movie clip.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    play(): void;
+    /**
+     * @description 直前のフレームに再生ヘッドを戻し、停止します。
+     *              Sends the playhead to the previous frame and stops it.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    prevFrame(): void;
+    /**
+     * @description ムービークリップ内の再生ヘッドを停止します。
+     *              Stops the playhead in the movie clip.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stop(): void;
+    /**
+     * @description タイムラインに対して動的にLabelを追加できます。
+     *              Labels can be added dynamically to the timeline.
+     *
+     * @example <caption>Example1 usage of addFrameLabel.</caption>
+     * // case 1
+     * const {MovieClip, FrameLabel} = next2d.display;
+     * const movieClip = new MovieClip();
+     * movieClip.addFrameLabel(new FrameLabel(1, "start"));
+     *
+     * @param  {FrameLabel} frame_label
+     * @return {void}
+     * @public
+     */
+    addFrameLabel(frame_label: FrameLabel): void;
+    /**
+     * @description 指定のフレームのアクションを追加できます
+     *              You can add an action for a given frame.
+     *
+     * @example <caption>Example1 usage of addFrameScript.</caption>
+     * // case 1
+     * const {MovieClip} = next2d.display;
+     * const movieClip = new MovieClip();
+     * movieClip.addFrameScript(1 , function ()
+     * {
+     *     this.stop();
+     * });
+     *
+     * @example <caption>Example3 usage of addFrameScript.</caption>
+     * // case 2
+     * const {MovieClip} = next2d.display;
+     * const movieClip = new MovieClip();
+     * movieClip.addFrameScript(1, method_1, 2, method_2, 10, method_10);
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    addFrameScript(...args: any[]): void;
+    /**
+     * @param  {string} name
+     * @return {number}
+     * @private
+     */
+    _$getFrameForLabel(name: string): number;
+    /**
+     * @param  {number}   frame
+     * @param  {function} script
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$addAction(frame: number, script: Function): void;
+    /**
+     * @return {void}
+     * @private
+     */
+    _$setAction(): void;
+    /**
+     * @param  {number|string} value
+     * @return {void}
+     * @private
+     */
+    _$goToFrame(value: string | number): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$prepareActions(): void;
+    /**
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$nextFrame(): boolean;
+    /**
+     * @param  {LoopConfig} loop_config
+     * @return {number}
+     * @method
+     * @private
+     */
+    _$getLoopFrame(loop_config: LoopConfigImpl): number;
+    /**
+     * @param  {object} character
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$buildCharacter(character: MovieClipCharacterImpl): void;
+    /**
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$sync(): any;
+    /**
+     * @param  {object} tag
+     * @param  {DisplayObjectContainer} parent
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$build(tag: DictionaryTagImpl, parent: ParentImpl<any>): MovieClipCharacterImpl;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$soundPlay(): void;
+}