Class DragonBones

Hierarchy

  • BaseFactory<this>
    • DragonBones

Constructors

Properties

_dataParser: DataParser
_dragonBones: DragonBones
_dragonBonesDataMap: Map<DragonBonesData>
_dragonBonesInstance: DragonBones
_textureAtlasDataMap: Map<TextureAtlasData[]>
autoSearch: boolean
clock: WorldClock
  • 由引擎驱动的 WorldClock 实例。

Version

DragonBones 5.7

Language

zh_CN

display: MiniGLArmatureDisplay
dragonBones: DragonBones
miniGL: MiniGL
_binaryParser: BinaryDataParser
_objectParser: ObjectDataParser

Methods

  • 复现方法

    Parameters

    • dataPackage: any

    Returns Armature

  • Parameters

    • dataPackage: BuildArmaturePackage
    • armature: Armature

    Returns void

  • Parameters

    • dataPackage: BuildArmaturePackage
    • _slot: Slot
    • displayData: ArmatureDisplayData

    Returns Armature

  • Parameters

    • dataPackage: BuildArmaturePackage
    • armature: Armature

    Returns void

  • Parameters

    • _dataPackage: any
    • slotData: any
    • armature: any

    Returns MiniGLSlot

  • Private

    Parameters

    • dataPackage: BuildArmaturePackage
    • armature: Armature

    Returns void

  • Parameters

    • textureAtlasData: any
    • textureAtlas: any

    Returns any

  • Parameters

    • dataPackage: BuildArmaturePackage
    • dragonBonesName: string
    • armatureName: string
    • skinName: string
    • textureAtlasName: string

    Returns boolean

  • Parameters

    • dataPackage: BuildArmaturePackage
    • displayData: DisplayData
    • slot: Slot

    Returns any

  • Parameters

    • textureAtlasName: string
    • textureName: string

    Returns TextureData

    • 将 DragonBonesData 实例缓存到工厂中。

    Parameters

    • data: DragonBonesData

      DragonBonesData 实例。

    • Optional name: string

      为该实例指定一个缓存名称,以便可以通过此名称获取该实例。 (如果未设置,则使用该实例中的名称)

    Returns void

    See

    • #parseDragonBonesData()
    • #getDragonBonesData()
    • #removeDragonBonesData()
    • dragonBones.DragonBonesData

    Version

    DragonBones 3.0

    Language

    zh_CN

    • 将 TextureAtlasData 实例缓存到工厂中。

    Parameters

    • data: TextureAtlasData

      TextureAtlasData 实例。

    • Optional name: string

      为该实例指定一个缓存名称,以便可以通过此名称获取该实例。 (如果未设置,则使用该实例中的名称)

    Returns void

    See

    • #parseTextureAtlasData()
    • #getTextureAtlasData()
    • #removeTextureAtlasData()
    • dragonBones.TextureAtlasData

    Version

    DragonBones 3.0

    Language

    zh_CN

    • 通过缓存的 DragonBonesData 实例和 TextureAtlasData 实例创建一个骨架。 注意,创建的骨架不再使用时,需要显式释放 #dragonBones.Armature#dispose()。

    Parameters

    • armatureName: string

      骨架数据名称。

    • Optional dragonBonesName: string

      DragonBonesData 实例的缓存名称。 (如果未设置,将检索所有的 DragonBonesData 实例,当多个 DragonBonesData 实例中包含同名的骨架数据时,可能无法准确的创建出特定的骨架)

    • Optional skinName: string

      皮肤名称,可以设置一个其他骨架数据名称来共享其皮肤数据。(如果未设置,则使用默认的皮肤数据)

    • Optional textureAtlasName: string

    Returns Armature

    骨架。

    Example

    <pre>
    let armature = factory.buildArmature("armatureName", "dragonBonesName");
    armature.clock = factory.clock;
    </pre>

    See

    • dragonBones.DragonBonesData
    • dragonBones.ArmatureData

    Version

    DragonBones 3.0

    Language

    zh_CN

  • Parameters

    • armatureName: any
    • dragonBonesName: string = ""
    • skinName: string = ""
    • textureAtlasName: string = ""

    Returns any

    • 清除缓存的所有 DragonBonesData 实例和 TextureAtlasData 实例。

    Parameters

    • Optional disposeData: boolean

      是否释放数据。

    Returns void

    Version

    DragonBones 4.5

    Language

    zh_CN

  • Private

    Returns Map<DragonBonesData>

  • Private

    Returns Map<TextureAtlasData[]>

    • 获取特定的骨架数据。

    Parameters

    • name: string

      骨架数据名称。

    • Optional dragonBonesName: string

      DragonBonesData 实例的缓存名称。

    Returns ArmatureData

    See

    dragonBones.ArmatureData

    Version

    DragonBones 5.1

    Language

    zh_CN

    • 获取特定的 DragonBonesData 实例。

    Parameters

    • name: string

      DragonBonesData 实例的缓存名称。

    Returns DragonBonesData

    DragonBonesData 实例

    See

    • #parseDragonBonesData()
    • #addDragonBonesData()
    • #removeDragonBonesData()
    • dragonBones.DragonBonesData

    Version

    DragonBones 3.0

    Language

    zh_CN

    • 获取特定的 TextureAtlasData 实例列表。

    Parameters

    • name: string

      TextureAtlasData 实例缓存名称。

    Returns TextureAtlasData[]

    See

    • #parseTextureAtlasData()
    • #addTextureAtlasData()
    • #removeTextureAtlasData()
    • dragonBones.TextureAtlasData

    Version

    DragonBones 3.0

    Language

    zh_CN

    • 将原始数据解析为 DragonBonesData 实例,并缓存到工厂中。

    Parameters

    • rawData: any

      原始数据。

    • Optional name: string

      为该实例指定一个缓存名称,以便可以通过此名称获取该实例。 (如果未设置,则使用该实例中的名称)

    • Optional scale: number

      为所有的骨架指定一个缩放值。 (默认: 1.0)

    Returns DragonBonesData

    DragonBonesData 实例

    See

    • #getDragonBonesData()
    • #addDragonBonesData()
    • #removeDragonBonesData()
    • dragonBones.DragonBonesData

    Version

    DragonBones 4.5

    Language

    zh_CN

    • 将原始贴图集数据和贴图集对象解析为 TextureAtlasData 实例,并缓存到工厂中。

    Parameters

    • rawData: any

      原始贴图集数据。

    • textureAtlas: any

      贴图集对象。

    • Optional name: string

      为该实例指定一个缓存名称,以便可以通过此名称获取该实例。 (如果未设置,则使用该实例中的名称)

    • Optional scale: number

      为贴图集指定一个缩放值。 (默认: 1.0)

    Returns TextureAtlasData

    TextureAtlasData 实例

    See

    • #getTextureAtlasData()
    • #addTextureAtlasData()
    • #removeTextureAtlasData()
    • dragonBones.TextureAtlasData

    Version

    DragonBones 4.5

    Language

    zh_CN

    • 移除 DragonBonesData 实例。

    Parameters

    • name: string

      DragonBonesData 实例缓存名称。

    • Optional disposeData: boolean

      是否释放数据。 (默认: true)

    Returns void

    See

    • #parseDragonBonesData()
    • #getDragonBonesData()
    • #addDragonBonesData()
    • dragonBones.DragonBonesData

    Version

    DragonBones 3.0

    Language

    zh_CN

    • 移除 TextureAtlasData 实例。

    Parameters

    • name: string

      TextureAtlasData 实例的缓存名称。

    • Optional disposeData: boolean

      是否释放数据。

    Returns void

    See

    • #parseTextureAtlasData()
    • #getTextureAtlasData()
    • #addTextureAtlasData()
    • dragonBones.TextureAtlasData

    Version

    DragonBones 3.0

    Language

    zh_CN

    • 用特定骨架数据的动画数据替换特定骨架现有的动画数据。 这样就能实现制作一个骨架动画模板,让其他没有制作动画的骨架共享该动画。

    Parameters

    • armature: Armature

      骨架。

    • armatureData: ArmatureData

      骨架数据。

    • Optional isOverride: boolean

      是否完全覆盖原来的动画。(默认: false)

    Returns boolean

    Example

    <pre>
    let armatureA = factory.buildArmature("armatureA", "dragonBonesA");
    let armatureDataB = factory.getArmatureData("armatureB", "dragonBonesB");
    if (armatureDataB) {
    factory.replaceAnimation(armatureA, armatureDataB);
    }
    </pre>

    See

    • dragonBones.Armature
    • dragonBones.ArmatureData

    Version

    DragonBones 5.6

    Language

    zh_CN

  • Private

    Parameters

    • slot: Slot
    • displayData: DisplayData
    • Optional displayIndex: number

    Returns void

    • 将特定的皮肤数据共享给特定的骨架使用。

    Parameters

    • armature: Armature

      骨架。

    • skin: SkinData

      皮肤数据。

    • Optional isOverride: boolean

      是否完全覆盖原来的皮肤。 (默认: false)

    • Optional exclude: string[]

      不需要被替换的插槽名称列表。

    Returns boolean

    Example

    <pre>
    let armatureA = factory.buildArmature("armatureA", "dragonBonesA");
    let armatureDataB = factory.getArmatureData("armatureB", "dragonBonesB");
    if (armatureDataB && armatureDataB.defaultSkin) {
    factory.replaceSkin(armatureA, armatureDataB.defaultSkin, false, ["arm_l", "weapon_l"]);
    }
    </pre>

    See

    • dragonBones.Armature
    • dragonBones.SkinData

    Version

    DragonBones 5.6

    Language

    zh_CN

    • 用特定的显示对象数据替换特定插槽当前的显示对象数据。 用 "dragonBonesName/armatureName/slotName/displayName" 指定显示对象数据。

    Parameters

    • dragonBonesName: string

      DragonBonesData 实例的缓存名称。

    • armatureName: string

      骨架数据名称。

    • slotName: string

      插槽数据名称。

    • displayName: string

      显示对象数据名称。

    • slot: Slot

      插槽。

    • Optional displayIndex: number

      被替换的显示对象数据的索引。 (如果未设置,则替换当前的显示对象数据)

    Returns boolean

    Example

    <pre>
    let slot = armature.getSlot("weapon");
    factory.replaceSlotDisplay("dragonBonesName", "armatureName", "slotName", "displayName", slot);
    </pre>

    Version

    DragonBones 4.5

    Language

    zh_CN

  • Private

    Parameters

    • dragonBonesName: string
    • armatureName: string
    • slotName: string
    • slot: Slot

    Returns boolean

    • 更新贴图集对象。

    Parameters

    • textureAtlases: any[]

      多个贴图集对象。

    • name: string

      贴图集名称。

    Returns void

    Version

    DragonBones 5.7

    Language

    zh_CN

Generated using TypeDoc