wraplord/extension-dragonbones/dragonbones
Functions and constants for playing dragonbones animatios
- GitHub: wraplord/extension-dragonbones — pinned to
0.7.3(released while Defold 1.13.0 was current)- Pick a release from wraplord/extension-dragonbones releases and add its Source code (zip) URL (or a packaged
.zipasset, if the library ships one) togame.projectunder[project]dependencies, then Fetch Libraries in the Defold editor. - Run
bunx @defold-typescript/cli resolveto materialize its types. - Import it under a namespace alias of your choice:
import * as dragonbones from "dragonbones"
- Pick a release from wraplord/extension-dragonbones releases and add its Source code (zip) URL (or a packaged
- Asset Portal: extension-dragonbones
Functions
dragonbones.create(): userdatadragonbones.load_data(instance: userdata, skeleton_json: handle, tex_json: handle, aramture_index: integer)dragonbones.update(instance: userdata, dt: number)dragonbones.destroy(instance: userdata)dragonbones.get_no_slots(instance: userdata)dragonbones.get_buffers(instance: userdata): tabledragonbones.get_anination_names(instance: userdata): tabledragonbones.fade_in_animation(instance: userdata, animation_name: string, config: table)dragonbones.contains_point(instance: userdata, x: integer, y: integer): stringdragonbones.set_bone_position(instance: userdata, bone_name: string, x: number, y: number)dragonbones.set_bone_rotation(instance: userdata, bone_name: string, angle: number)dragonbones.set_bone_scale(instance: userdata, bone_name: string, scale_x: number, scale_y: number)dragonbones.reset_bone(instance: userdata, bone_name: string)dragonbones.stop_animation(instance: userdata, animation_name: string)dragonbones.get_batch_buffer(instance: userdata): LuaMultiReturn<[userdata, integer]>dragonbones.set_slot_visibility(instance: userdata, slot_name: string, visible: bool)dragonbones.set_slot_display_index(instance: userdata, slot_name: string, index: integer)dragonbones.set_slot_scale(instance: userdata, slot_name: string, scale_x: number, scale_y: number)dragonbones.add_event_callback(instance: userdata, callback: function)dragonbones.enable_event_callback(instance: userdata, enable: bool)dragonbones.set_flip_x(instance: userdata, flip: bool)dragonbones.set_flip_y(instance: userdata, flip: bool)dragonbones.get_frame_rate(instance: userdata): integerdragonbones.replace_skin(instance: userdata, armature_name: string)
dragonbones.create(): userdata
initialize dragonbones with viewport width and height. Get instance object to be pass to all functions. called destroy to free this object.
Returns
instance:userdata— Id of the game object
dragonbones.load_data(instance: userdata, skeleton_json: handle, tex_json: handle, aramture_index: integer)
Called after initialization. Pass in the skeleton and texture jsons as buffers.
Parameters
instance:userdata— dragonbones instance.skeleton_json:handle— A resource buffer of skeleton json.tex_json:handle— A resource buffer of atlas json.aramture_index:integer— Optional. The armature index to built. Default is 0. 0️⃣ 0-based; passed todragonbonesunchanged.
dragonbones.update(instance: userdata, dt: number)
advance dragobones world by the given time delta.
Parameters
instance:userdata— dragobones instance.dt:number— 1/fps, typically 1/60.0
dragonbones.destroy(instance: userdata)
destroy this world. Make sure to free the buffers first
Parameters
instance:userdata— dragobones instance.
dragonbones.get_no_slots(instance: userdata)
Get the available slots in this world. You can use this to create specific no of meshes.
Parameters
instance:userdata— dragobones instance.
dragonbones.get_buffers(instance: userdata): table
Get a table of slots. Sub table contain luaHBuffer buffer_trilist(a_position|a_texCoord|a_normal), matrix4 mtx_mvp , string slot_name, integer trilisit_count. buffer is vertices. mtx_mvp is the complete matrix. Use this data to create meshes.
Parameters
instance:userdata— dragobones instance.
Returns
slots_table:table— 2d table
dragonbones.get_anination_names(instance: userdata): table
Get a list of animations defined.
Parameters
instance:userdata— dragobones instance.
Returns
list:table— a lua table of available animations to be use in fade_in_animation
dragonbones.fade_in_animation(instance: userdata, animation_name: string, config: table)
Play the specify animation
Parameters
instance:userdata— dragobones instance.animation_name:stringconfig:table— field layer, blending layer default 0 field loop, -1 means use default value, 0 means loop infinitely, [1N] means repeat N times. field fade_in_time, fadeIn time to enable blending and layering. field time_scale, default 1.0 [(-N0) Reverse play, 0 Stop play, (01) Slow play, 1 Normal play, (1N) Fast play]
dragonbones.contains_point(instance: userdata, x: integer, y: integer): string
Return the slot name for the given x,y otherwise return nil
Parameters
instance:userdata— dragobones instance.x:integery:integer
Returns
slot_name:string
dragonbones.set_bone_position(instance: userdata, bone_name: string, x: number, y: number)
set bone position. Addictive.
Parameters
instance:userdata— dragobones instance.bone_name:stringx:numbery:number
dragonbones.set_bone_rotation(instance: userdata, bone_name: string, angle: number)
set bone rotation offset. Addictive.
Parameters
instance:userdata— dragobones instance.bone_name:stringangle:number— angle in radians
dragonbones.set_bone_scale(instance: userdata, bone_name: string, scale_x: number, scale_y: number)
set bone scale offset. Addictive.
Parameters
instance:userdata— dragobones instance.bone_name:stringscale_x:number— scalescale_y:number— scale
dragonbones.reset_bone(instance: userdata, bone_name: string)
reset bone transforms
Parameters
instance:userdata— dragobones instance.bone_name:string
dragonbones.stop_animation(instance: userdata, animation_name: string)
stop the given animation
Parameters
instance:userdata— dragobones instance.animation_name:string
dragonbones.get_batch_buffer(instance: userdata): LuaMultiReturn<[userdata, integer]>
Instead of a lot of buffers, get one big merged buffer
Parameters
instance:userdata— dragobones instance.
Returns
batch_buffer:userdata— Defold buffer objectbatch_buffer_count:integer— size of batch_buffer
dragonbones.set_slot_visibility(instance: userdata, slot_name: string, visible: bool)
Hide/Show a slot
Parameters
instance:userdata— dragobones instance.slot_name:string— name of the slotvisible:bool— false or true
dragonbones.set_slot_display_index(instance: userdata, slot_name: string, index: integer)
Switch slot image
Parameters
instance:userdata— dragobones instance.slot_name:string— name of the slotindex:integer— -1 .. N. 0️⃣ 0-based; passed todragonbonesunchanged.
dragonbones.set_slot_scale(instance: userdata, slot_name: string, scale_x: number, scale_y: number)
Scale a slot
Parameters
instance:userdata— dragobones instance.slot_name:string— name of the slotscale_x:number— x scalescale_y:number— y scale
dragonbones.add_event_callback(instance: userdata, callback: function)
add callback for events
Parameters
instance:userdata— dragobones instance.callback:function— callback(self, tbl) tbl has following fields type is in event_names, frame , name , custom in floats, ints and strings sub tables.
dragonbones.enable_event_callback(instance: userdata, enable: bool)
stop receiving events
Parameters
instance:userdata— dragobones instance.enable:bool
dragonbones.set_flip_x(instance: userdata, flip: bool)
flip aramture on x axis
Parameters
instance:userdata— dragobones instance.flip:bool— flip left or right
dragonbones.set_flip_y(instance: userdata, flip: bool)
flip aramture on y axis
Parameters
instance:userdata— dragobones instance.flip:bool— flip up or down
dragonbones.get_frame_rate(instance: userdata): integer
get current armature frame rate e.g 24
Parameters
instance:userdata— dragobones instance.
Returns
frame_rate:integer— frame rate e.g 24
dragonbones.replace_skin(instance: userdata, armature_name: string)
replace current armature' skin from a newly build armature. Alpha need testing.
Parameters
instance:userdata— dragobones instance.armature_name:string— The armature to get default skin out of, armature should be in skeleton data.