pixi-dragonbones-runtime
Version:
DragonBones Runtime for Pixi.js
77 lines (76 loc) • 2.51 kB
TypeScript
/**
* The MIT License (MIT)
*
* Copyright (c) 2012-2018 DragonBones team and other contributors
*
* Permission is hereby granted, free of charge, to any person obtaining a copy of
* this software and associated documentation files (the "Software"), to deal in
* the Software without restriction, including without limitation the rights to
* use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
* the Software, and to permit persons to whom the Software is furnished to do so,
* subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in all
* copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
* FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
* COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
* IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
* CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*/
import { IEventDispatcher } from "../event/index.js";
import { Armature } from "./Armature.js";
import { Animation } from "../animation/index.js";
/**
* [en] The armature proxy interface, the docking engine needs to implement it concretely.
*
* [zh] 骨架代理接口，对接的引擎需要对其进行具体实现。
*
* @see Armature
* @version DragonBones 5.0
*/
export interface IArmatureProxy extends IEventDispatcher {
/**
* @internal
*/
dbInit(armature: Armature): void;
/**
* @internal
*/
dbClear(): void;
/**
* @internal
*/
dbUpdate(): void;
/**
* [en] Dispose the instance and the Armature instance. (The Armature instance will return to the object pool)
*
* [zh] 释放该实例和骨架。 （骨架会回收到对象池）
*
* @example
* ```ts
* removeChild(armatureDisplay);
* armatureDisplay.dispose();
* ```
* @version DragonBones 4.5
*/
dispose(disposeProxy: boolean): void;
/**
* [en] The armature.
*
* [zh] 骨架。
*
* @version DragonBones 4.5
*/
readonly armature: Armature;
/**
* [en] The animation player.
*
* [zh] 动画播放器。
*
* @version DragonBones 3.0
*/
readonly animation: Animation;
}