DoubleX RMMV Item Cooldown

0 Members and 1 Guest are viewing this topic.

***
Scripter
Rep:
Level 33
Changelog
Code: [Select]
*      v1.00a(GMT 1400 28-8-2016):                                           
 *      1. 1st version of this plugin finished                               

Authors
DoubleX

Credits
DoubleX(Optional)

Purpose
Lets you set skills/items causing users to cooldown after using

Games using this plugin
None so far

Parameters
Code: [Select]
* @param isEnabled
 * @desc Sets whether this plugin will be enabled
 *       It'll be stored as a boolean, and will be regarded as true if and only
 *       if it's true
 *       Don't change this during the same battle unless you really know what
 *       you're truly foing
 *       E.g.: Setting isEnabled as false will disable this plugin
 * @default true
 *
 * @param textColor
 * @desc Sets the text color of the text showing the number of turns needed to
 *       cooldown the skill/item user on the skill/item window
 *       It'll be stored as a Number
 *       Don't change this when it's shown to ensure proper text displays
 *       E.g.: Setting textColor as 26 will set the text color of the text
 *             showing the number of turns needed to cooldown the skill/item
 *             user on the skill/item window as 26
 * @default 19

Notetags
Code: [Select]
*    # Skill/Item Notetags:                                                 
 *      1. <item cooldown: turns>                                             
 *         - Sets the number of turns needed to cooldown the skill/item user 
 *           after using it as turns                                         
 *         - E.g.:                                                           
 *           <item cooldown: 1> will set the number of turns needed to       
 *           cooldown the skill/item user after using it as 1                 
 *         - Only the 1st notetag will be used                               

Plugin Calls
Code: [Select]
*    # Configuration manipulations                                           
 *      1. $gameSystem.itemCooldown.param                                     
 *         - Returns the stored value of param listed in the plugin manager   
 *         - E.g.:                                                           
 *           $gameSystem.itemCooldown.textColor will return the stored value 
 *           of parameter textColor shown on the plugin manager               
 *      2. $gameSystem.itemCooldown.param = val                               
 *         - Sets the stored value of param listed in plugin manager as val   
 *         - E.g.:                                                           
 *           $gameSystem.itemCooldown.isEnabled = false will set the stored   
 *           value of parameter isEnabled shown on the plugin manager as false
 *         - All $gameSystem.itemCooldown.param changes will be saved         
 *    # Skill/Item notetag manipulations                                     
 *      1. meta.itemCooldown                                                 
 *         - Returns the <item cooldown: turns> notetag value turns as a     
 *           Number                                                           
 *         - E.g.:                                                           
 *           $dataSkills[1].meta.itemCooldown will return the                 
 *           <item cooldown: turns> notetag value of skill with id 1         
 *      2. meta.itemCooldown = turns                                         
 *         - Sets the <item cooldown: turns> notetag value turns as a Number 
 *         - E.g.:                                                           
 *           $dataItems[2].meta.itemCooldown = 0 will set the                 
 *           <item cooldown: turns> notetag value of item with id 2 as 0     
 *         - All meta.itemCooldown changes can be saved if                   
 *           DoubleX RMMV Dynamic Data is used                               

Video
DoubleX RMMV Item Cooldown

Prerequisites
Abilities:
1. Nothing special for most ordinary use cases
2. Little RMMV plugin development proficiency to fully utilize this

Instructions
Code: [Select]
* The skill/item window cooldown turn display can be problematic if the
 * number of turn's 1000 or above
 * The default plugin file name is DoubleX RMMV Item Cooldown v100a
 * If you want to change that, you must edit the value of
 * DoubleX_RMMV.Item_Cooldown_File, which must be done via opening this plugin
 * js file directly

Terms Of Use
Code: [Select]
*      1. Commercial use's always allowed and crediting me's always optional.
 *      2. You shall keep this plugin's Plugin Info part's contents intact.   
 *      3. You shalln't claim that this plugin's written by anyone other than
 *         DoubleX or my aliases. I always reserve the right to deny you from
 *         using any of my plugins anymore if you've violated this.           
 *      4. CC BY 4.0, except those conflicting with any of the above, applies
 *         to this plugin, unless you've my permissions not needing follow so.
 *      5. I always reserve the right to deny you from using this plugin     
 *         anymore if you've violated any of the above.                       

Download
DoubleX RMMV Item Cooldown