[MZ] DoubleX RMMZ State Triggers

Started by DoubleX, August 29, 2020, 09:35:52 am

Previous topic - Next topic

DoubleX

August 29, 2020, 09:35:52 am Last Edit: Today at 10:29:00 am by DoubleX
DoubleX RMMZ State Triggers
Authors: DoubleX
Version: v1.00a
Type: State Add-on
Key Term: Battle Add-on

Purpose
Lets you run some codes set by your notetags on some important state timings

Introduction
 *    1. This plugin lets you use notetags to set what happens when a state's
 *      added/removed/expired/turn's updated/turn's reset on the battler
 *      involved
 *    2. You're expected to write JavaScript codes directly, as there are so
 *      much possibilities that most of them are just impossible to be
 *      covered by this plugin itself, so this plugin just lets you write
 *      JavaScript codes that are executed on some important timings

Video

Games using this plugin
None so far

Parameters
 * @param addNotetagDataTypePriorities
 * @type select[]
 * @option Data of the actor
 * @value actor
 * @option Data of the current class
 * @value class
 * @option Data of learnt skills/action list(Shouldn't be used with Data of usable skills)
 * @value skills
 * @option Data of usable skills(Shouldn't be used with Data of learnt skills)
 * @value usableSkills
 * @option Data of possessed items(Shouldn't be used with Data of usable items)
 * @value items
 * @option Data of usable items(Shouldn't be used with Data of possessed items)
 * @value usableItems
 * @option Data of the latest skill/item being used(Can double-count with skills/items/usableSkills/usableItems)
 * @value latestSkillItem
 * @option Data of equipped weapons
 * @value weapons
 * @option Data of equipped armors
 * @value armors
 * @option Data of the enemy
 * @value enemy
 * @option Data of effective states
 * @value states
 * @option Data of the state to have triggers run
 * @value thisState
 * @desc Sets data type priorities of the add notetags
 * You can use script calls/plugin commands to change this
 * @default ["thisState"]
 *
 * @param removeNotetagDataTypePriorities
 * @type select[]
 * @option Data of the actor
 * @value actor
 * @option Data of the current class
 * @value class
 * @option Data of learnt skills/action list(Shouldn't be used with Data of usable skills)
 * @value skills
 * @option Data of usable skills(Shouldn't be used with Data of learnt skills)
 * @value usableSkills
 * @option Data of possessed items(Shouldn't be used with Data of usable items)
 * @value items
 * @option Data of usable items(Shouldn't be used with Data of possessed items)
 * @value usableItems
 * @option Data of the latest skill/item being used(Can double-count with skills/items/usableSkills/usableItems)
 * @value latestSkillItem
 * @option Data of equipped weapons
 * @value weapons
 * @option Data of equipped armors
 * @value armors
 * @option Data of the enemy
 * @value enemy
 * @option Data of effective states
 * @value states
 * @option Data of the state to have triggers run
 * @value thisState
 * @desc Sets data type priorities of the remove notetags
 * You can use script calls/plugin commands to change this
 * @default ["thisState"]
 *
 * @param resetNotetagDataTypePriorities
 * @type select[]
 * @option Data of the actor
 * @value actor
 * @option Data of the current class
 * @value class
 * @option Data of learnt skills/action list(Shouldn't be used with Data of usable skills)
 * @value skills
 * @option Data of usable skills(Shouldn't be used with Data of learnt skills)
 * @value usableSkills
 * @option Data of possessed items(Shouldn't be used with Data of usable items)
 * @value items
 * @option Data of usable items(Shouldn't be used with Data of possessed items)
 * @value usableItems
 * @option Data of the latest skill/item being used(Can double-count with skills/items/usableSkills/usableItems)
 * @value latestSkillItem
 * @option Data of equipped weapons
 * @value weapons
 * @option Data of equipped armors
 * @value armors
 * @option Data of the enemy
 * @value enemy
 * @option Data of effective states
 * @value states
 * @option Data of the state to have triggers run
 * @value thisState
 * @desc Sets data type priorities of the reset notetags
 * You can use script calls/plugin commands to change this
 * @default ["thisState"]
 *
 * @param expireNotetagDataTypePriorities
 * @type select[]
 * @option Data of the actor
 * @value actor
 * @option Data of the current class
 * @value class
 * @option Data of learnt skills/action list(Shouldn't be used with Data of usable skills)
 * @value skills
 * @option Data of usable skills(Shouldn't be used with Data of learnt skills)
 * @value usableSkills
 * @option Data of possessed items(Shouldn't be used with Data of usable items)
 * @value items
 * @option Data of usable items(Shouldn't be used with Data of possessed items)
 * @value usableItems
 * @option Data of the latest skill/item being used(Can double-count with skills/items/usableSkills/usableItems)
 * @value latestSkillItem
 * @option Data of equipped weapons
 * @value weapons
 * @option Data of equipped armors
 * @value armors
 * @option Data of the enemy
 * @value enemy
 * @option Data of effective states
 * @value states
 * @option Data of the state to have triggers run
 * @value thisState
 * @desc Sets data type priorities of the expire notetags
 * You can use script calls/plugin commands to change this
 * @default ["thisState"]
 *
 * @param turnNotetagDataTypePriorities
 * @type select[]
 * @option Data of the actor
 * @value actor
 * @option Data of the current class
 * @value class
 * @option Data of learnt skills/action list(Shouldn't be used with Data of usable skills)
 * @value skills
 * @option Data of usable skills(Shouldn't be used with Data of learnt skills)
 * @value usableSkills
 * @option Data of possessed items(Shouldn't be used with Data of usable items)
 * @value items
 * @option Data of usable items(Shouldn't be used with Data of possessed items)
 * @value usableItems
 * @option Data of the latest skill/item being used(Can double-count with skills/items/usableSkills/usableItems)
 * @value latestSkillItem
 * @option Data of equipped weapons
 * @value weapons
 * @option Data of equipped armors
 * @value armors
 * @option Data of the enemy
 * @value enemy
 * @option Data of effective states
 * @value states
 * @option Data of the state to have triggers run
 * @value thisState
 * @desc Sets data type priorities of the turn notetags
 * You can use script calls/plugin commands to change this
 * @default ["thisState"]

Notetags
 *    ## Notetag Info
 *      1. Among all the same notetag types in the same data, all can be
 *          effective
 *      2. Each line can only have at most 1 notetag
 *      3. The following is the structure of all notetags in this plugin:
 *          - <doublex rmmz state triggers>
 *          - <state triggers>
 *          Where contents are in the form of type suffixes: entries
 *          Either of the above can be used, but the 1st one reduce the chance
 *          of causing other plugins to treat the notetags of this plugin as
 *          theirs, while the 2nd one is more user-friendly
 *          - type is one of the following:
 *            1. add
 *            2. remove
 *            3. reset
 *            4. expire
 *            5. turn
 *          - suffixes is the list of suffixes in the form of:
 *            suffix1 suffix2 suffix3 ... suffixn
 *            Where each suffix is either of the following:
 *            val(The notetag value will be used as-is)
 *            switch(The value of the game switch with id as the notetag value
 *                  will be used)
 *            event(The common event with id as the notetag value will be
 *                  reserved)
 *            (Advanced)script(The value of the game variable with id as the
 *                            notetag value will be used as the contents of
 *                            the functions to be called upon using the
 *                            notetag)
 *          - The this pointer of the script suffix is the action involved
 *            (Game_Battler.prototype)
 *          - entries is the list of entries in the form of:
 *            entry1, entry2, entry3, ..., entryn
 *            Where entryi must conform with the suffixi specifications
 *----------------------------------------------------------------------------
 *    # Actor/Class/Learnt Skills/Usable Skills/Posessed Items/Usable Items/
 *      Inputted Skill Or Item/Weapon/Armor/Enemy/States/This State Notetags
 *      1. add condSuffix eventSuffix: condEntry, eventEntry
 *        - Triggers what specified in eventEntry when the state's just added
 *          to the battler involved(not when the state already exists before)
 *          if condEntry returns a truthy result
 *        - condSuffix can be val, switch or script
 *        - eventEntry can be event or script
 *        - The result of condEntry can be anything as only whether it's
 *          truthy matters
 *        - If the result of condEntry is falsy, this notetag will be
 *          discarded upon such use cases
 *        - The result of eventEntry can be anything as it's supposed to run
 *          commands instead of returning results
 *        - E.g.:
 *          <state triggers add switch event: 1, 2> will reserve the common
 *          event with id 2 when the state's just added to the battler
 *          involved(not when it already exists before) if the game switch
 *          with id 1 is on
 *      2. remove condSuffix eventSuffix: condEntry, eventEntry
 *        - Triggers what specified in eventEntry when the state's just
 *          removed from the battler involved(not when the state turn just
 *          expired causing the removal) if condEntry returns a truthy result
 *        - condSuffix can be val, switch or script
 *        - eventEntry can be event or script
 *        - The result of condEntry can be anything as only whether it's
 *          truthy matters
 *        - If the result of condEntry is falsy, this notetag will be
 *          discarded upon such use cases
 *        - The result of eventEntry can be anything as it's supposed to run
 *          commands instead of returning results
 *        - E.g.:
 *          <state triggers remove val script: true, 3> will always run the
 *          JavaScript codes stored as a string in variable with id 3 when
 *          the state's just removed from the battler involved(not when the
 *          state turn just expired causing the removal)
 *      3. reset condSuffix eventSuffix: condEntry, eventEntry
 *        - Triggers what specified in eventEntry when the state's turn's
 *          just reset due to trying to add that state to the battler
 *          involved if condEntry returns a truthy result
 *        - condSuffix can be val, switch or script
 *        - eventEntry can be event or script
 *        - The result of condEntry can be anything as only whether it's
 *          truthy matters
 *        - If the result of condEntry is falsy, this notetag will be
 *          discarded upon such use cases
 *        - The result of eventEntry can be anything as it's supposed to run
 *          commands instead of returning results
 *        - E.g.:
 *          <state triggers reset switch event: 1, 2> will reserve the common
 *          event with id 2 when the state's turn's just reset due to trying
 *          to add that state to the battler involved if the game switch with
 *          id 1 is on
 *      4. expire condSuffix eventSuffix: condEntry, eventEntry
 *        - Triggers what specified in eventEntry when the state's turn's
 *          just expired causing the state to be removed from the battler
 *          involved if condEntry returns a truthy result
 *        - condSuffix can be val, switch or script
 *        - eventEntry can be event or script
 *        - The result of condEntry can be anything as only whether it's
 *          truthy matters
 *        - If the result of condEntry is falsy, this notetag will be
 *          discarded upon such use cases
 *        - The result of eventEntry can be anything as it's supposed to run
 *          commands instead of returning results
 *        - E.g.:
 *          <state triggers expire val script: true, 3> will always run the
 *          JavaScript codes stored as a string in variable with id 3 when
 *          the state's turn's just expired causing the state to be removed
 *          from the battler involved
 *      5. turn condSuffix eventSuffix: condEntry, eventEntry
 *        - Triggers what specified in eventEntry when the state's turn's
 *          just updated without being expired for the battler involved if
 *          condEntry returns a truthy result
 *        - condSuffix can be val, switch or script
 *        - eventEntry can be event or script
 *        - The result of condEntry can be anything as only whether it's
 *          truthy matters
 *        - If the result of condEntry is falsy, this notetag will be
 *          discarded upon such use cases
 *        - The result of eventEntry can be anything as it's supposed to run
 *          commands instead of returning results
 *        - E.g.:
 *          <state triggers turn val event: true, 2> will always reserve the
 *          common event with id 2 when the state's turn's just updated
 *          without being expired for the battler involved

Script Calls
*    # Parameter manipulations
 *      1. $gameSystem.setStateTriggersParam(param, val)
 *        - Sets the fully parsed value of the parameter param as val
 *        - param must be the name of a valid parameter of this plugin
 *        - val must be a valid new fully parsed value of the parameter param
 *        - Such parameter value changes will be saved
 *        - E.g.:
 *          $gameSystem.setStateTriggersParam("addNotetagDataTypePriorities", [
 *              "thisState"
 *          ]) sets the fully parsed value of the parameter
 *          addNotetagDataTypePriorities as ["thisState"]
 *      2. $gameSystem.stateTriggersParam(param)
 *        - Returns the fully parsed value of the parameter param
 *        - param must be the name of a valid parameter of this plugin
 *        - E.g.:
 *          $gameSystem.setStateTriggersParam("removeNotetagDataTypePriorities")
 *          returns the fully parsed value of the parameter
 *          removeNotetagDataTypePriorities, which should be
 *          ["thisState"] if it uses its default parameter value

Plugin Commands
 * @command setStateTriggersParam
 * @desc Applies script call $gameSystem.setStateTriggersParam(param, val)
 * @arg param
 * @desc The name of a valid parameter of this plugin
 * @arg val
 * @desc A valid new fully parsed value of the parameter param

Prerequisites
Plugins:
1. DoubleX RMMZ Enhanced Codebase
Abilities:
1. Some RMMV plugin development proficiency
(Basic knowledge on what RMMV plugin development does in general with several easy, simple and small plugins written without nontrivial bugs up to 1000 LoC scale but still being inexperienced)

Terms Of Use
*      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. If you repost this plugin directly(rather than just linking back),
 *        you shall inform me of these direct repostings. I always reserve
 *        the right to request you to edit those direct repostings.
 *      5. 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.
 *      6. I always reserve the right to deny you from using this plugin
 *        anymore if you've violated any of the above.

Instructions
 *      1. The default plugin parameters file name is
 *        DoubleX RMMZ State Triggers
 *        If you want to change that, you must edit the value of
 *        DoubleX_RMMZ.State_Triggers.PLUGIN_NAME, which must be done via
 *        opening this plugin js file directly

Contributors
*      Authors:
 *      1. DoubleX
 *      Plugin Development Collaborators:
 *      - None So Far
 *      Bug Reporters:
 *      - None So Far
 *      Compatibility Issue Raisers:
 *      - None So Far
 *      Feature Requesters:
 *      - None So Far

Changelog
*      { codebase: "1.0.0", plugin: "v1.00a" }(2020 Aug 29 GMT 1300):
 *      1. 1st version of this plugin finished

Download Link
Demo Link
My RMVXA/RMMV/RMMZ scripts/plugins: http://rpgmaker.net/users/DoubleX/scripts/

DoubleX

My RMVXA/RMMV/RMMZ scripts/plugins: http://rpgmaker.net/users/DoubleX/scripts/