Author: DK
Version: Public 0.92 Beta
Description: API. Contains elements for creating plugins.
Warning: may contain bugs in some elements
4 steps to use DKTools
1. Create Element
Create element from DKTools through "new" operator, like: var object = new DKTools_Sprite(x, y, width);
2. Set parameters through "setup" functions
Each element contain "setup" functions, who set the parameters. All functions have default parameters.
3. Start element
Call start function of element.
4. Add element to your scene
Use "addChild" function for add element to your scene.
List of elements:
3 main reasons for use DKTools:
1. No need to waste time creating special sprites or windows
2. Large number of element parameters and all parameters have default values
3. Many different functions in each element
FAQ
Project on GitHub: GitHub
Version: Public 0.92 Beta
Description: API. Contains elements for creating plugins.
Warning: may contain bugs in some elements
4 steps to use DKTools
1. Create Element
Create element from DKTools through "new" operator, like: var object = new DKTools_Sprite(x, y, width);
2. Set parameters through "setup" functions
Each element contain "setup" functions, who set the parameters. All functions have default parameters.
3. Start element
Call start function of element.
4. Add element to your scene
Use "addChild" function for add element to your scene.
List of elements:
- DKTools_Sprite - Based on standard Sprite. Base class for other elements. Contain all required functions.
- DKTools_Text - Element for drawing text.
- DKTools_Container_Base - Stores and processes the elements.
- DKTools_Text_Container - Based on DKTools_Container_Base. Stores and processes the elements. First element - DKTools_Text.
- DKTools_Container - Based on DKTools_Text_Container. Stores and processes only two elements. First element - DKTools_Text.
- DKTools_Progress_Bar_Base - Progress bar.
- DKTools_Progress_Bar - Based on DKTools_Container. First element - DKTools_Text. Second - DKTools_Progress_Bar_Base.
- DKTools_Input_Base - Element for input text from keyboard
- DKTools_Input - Based on DKTools_Container. First element - DKTools_Text. Second - DKTools_Input_Base.
- DKTools_CheckBox_Base - CheckBox.
- DKTools_CheckBox - Based on DKTools_Container. First element - DKTools_Text. Second - DKTools_CheckBox_Base.
- DKTools_Radio_Button_Base - Based on DKTools_Container_Base. Contains DKTools_CheckBox elements as buttons.
- DKTools_Radio_Button - Based on DKTools_Container. First element - DKTools_Text. Second - DKTools_Radio_Button_Base.
- DKTools_Clicker_Base - Simple "clicker". Сycles through the images by clicking on the sprite.
- DKTools_Clicker - Based on DKTools_Container. First element - DKTools_Text. Second - DKTools_Clicker_Base.
- DKTools_ColorPicker_Base - ColorPicker.
- DKTools_ColorPicker - Based on DKTools_Container. First element - DKTools_Text. Second - DKTools_ColorPicker_Base.
- DKTools_Slider_Base - Slider.
- DKTools_Slider - Based on DKTools_Container. First element - DKTools_Text. Second - DKTools_Slider_Base.
- DKTools_Window_Base - Based on standard Window_Base. Base class for other elements. Contain all required functions.
- DKTools_Window_Selectable - Based on DKTools_Window_Base. Base class for windows with the commands.
- DKTools_Window_Command - Based on DKTools_Window_Selectable. Window with the commands.
3 main reasons for use DKTools:
1. No need to waste time creating special sprites or windows
2. Large number of element parameters and all parameters have default values
3. Many different functions in each element
FAQ
Q: What is "DKTools_Sprite" ?
A: This is a class, who contain standard Sprite functions, Sprite_Button functions and many new functions. The most significant features are: avoid errors when changing parameters, event support, new features for click and mouse (long press, mouse enter/stay on element and mouse leave from element.
Q: What is "Event support" ?
A: I developed special class "DKToolsEvent", that handles a variety of activities that take place with the elements.
Q: What types of activities can take place with the elements?
A: Base class "DKTools_Sprite" includes the following types of events:
Q: Сurrently DKTools has incomplete documentation and only in Russian. Will the English documentation ?
A: Yes, of course. Currently the documentation is not a primary task, but I try to make time for it. I use JSDoc documentation.
A: This is a class, who contain standard Sprite functions, Sprite_Button functions and many new functions. The most significant features are: avoid errors when changing parameters, event support, new features for click and mouse (long press, mouse enter/stay on element and mouse leave from element.
Q: What is "Event support" ?
A: I developed special class "DKToolsEvent", that handles a variety of activities that take place with the elements.
Q: What types of activities can take place with the elements?
A: Base class "DKTools_Sprite" includes the following types of events:
- wait - events that caused each time an element is updated (blocking update events)
- update - events that caused each time an element is updated
- start - events, which are caused when calling the function start element
- ready - events, which are caused when element is ready (images loaded)
- free - events, which are caused when element is ready and element have not the wait events
- activate - events, which are caused when calling the activation function of the element
- deactivate - events, which are caused when calling the deactivation function of the element
- mouseEnter - events that are called when you hover over the element (triggered once)
- mouseStay - similar to the previous type, but triggered every frame until the mouse is stay on element
- mouseLeave - events that are called when the mouse leaves an element (triggered once)
- click - events that are called when a user clicks on an element (a simple click)
- longPress - event that are called when the user clicks long press on element
- wheelX - event that are called when the user scrolls the mouse wheel on the X axis
- wheelY - event that are called when the user scrolls the mouse wheel on the Y axis
Q: Сurrently DKTools has incomplete documentation and only in Russian. Will the English documentation ?
A: Yes, of course. Currently the documentation is not a primary task, but I try to make time for it. I use JSDoc documentation.
Project on GitHub: GitHub
Hi.
For more than half a year, I'm developing a plugin.
This plugin called "DKTools".
The plugin is a "API" for plugin developers. The plugin contains the basic elements, such as: improved sprites and windows, checkbox, radio button, slider, color picker, text input, progress bar etc.
Each element has a plurality of functions. Each function has a documentation "JSDoc" (but now only in Russian).
All elements have a lot of pre-defined parameters to reduce the number of bugs and facilitating development. Elements practically do not consume resources of the game and do not reduce the FPS, because only updated when necessary.
In the future, I will translate all documentation into English. And I will lay out a beta version of the plugin. Now the plugin is version 0.92
Here are some videos showing features:
On the basis of this plugin, I will produce a variety of other plugins such as: volume options with sliders and check boxes, item list with search field, system of hunger and stamina etc., add-on for DK Custom Vehicles (Vehicle fuel) and many others.
Thanks.
For more than half a year, I'm developing a plugin.
This plugin called "DKTools".
The plugin is a "API" for plugin developers. The plugin contains the basic elements, such as: improved sprites and windows, checkbox, radio button, slider, color picker, text input, progress bar etc.
Each element has a plurality of functions. Each function has a documentation "JSDoc" (but now only in Russian).
All elements have a lot of pre-defined parameters to reduce the number of bugs and facilitating development. Elements practically do not consume resources of the game and do not reduce the FPS, because only updated when necessary.
In the future, I will translate all documentation into English. And I will lay out a beta version of the plugin. Now the plugin is version 0.92
Here are some videos showing features:
On the basis of this plugin, I will produce a variety of other plugins such as: volume options with sliders and check boxes, item list with search field, system of hunger and stamina etc., add-on for DK Custom Vehicles (Vehicle fuel) and many others.
Thanks.
Last edited:
