Difference between revisions of "Template:Action Sequences MZ"

From Yanfly.moe Wiki
Jump to navigation Jump to search
(Action Sequences - Animations)
Line 98: Line 98:
 
=== Action Sequences - Animations ===
 
=== Action Sequences - Animations ===
  
[[File:BattleCoreCastAni.gif|400px]]
+
[[File:BattleCoreCastAni.gif]]
  
 
These Action Sequences are related to the 'Animations' that can be found in
 
These Action Sequences are related to the 'Animations' that can be found in

Revision as of 15:24, 7 August 2020


BattleCoreActSeq.png

Skills and items, when used in battle, have a pre-determined series of actions to display to the player as a means of representing what's going on with the action. For some game devs, this may not be enough and they would like to get more involved with the actions themselves.

Action Sequences, added through this plugin, enable this. To give a skill or item a Custom Action Sequence, a couple of steps must be followed:

---

1. Insert the <Custom Action Sequence> notetag into the skill or item's notebox (or else this would not work as intended). 2. Give that skill/item a Common Event through the Effects box. The selected Common Event will contain all the Action Sequence data. 3. Create the Common Event with Action Sequence Plugin Commands and/or event commands to make the skill/item do what you want it to do.

---

The Plugin Commands added through the Battle Core plugin focus entirely on Action Sequences. However, despite the fact that they're made for skills and items, some of these Action Sequence Plugin Commands can still be used for regular Troop events and Common Events.

---

Action Sequence - Action Sets

BattleCoreActSeqSet.gif

Action Sequence Action Sets are groups of commonly used Action Sequence Commands put together for more efficient usage.

---

ACSET: Setup Action Set
- The generic start to most actions.

  Display Action:
  Immortal: On:
  Battle Step:
  Wait For Movement:
  Cast Animation:
  Wait For Animation:
  - Use this part of the action sequence?

---

ACSET: All Targets Action Set
- Affects all targets simultaneously performing the following.

  Perform Action:
  Wait Count:
  Action Animation:
  Wait For Animation:
  Action Effect:
  Immortal: Off:
  - Use this part of the action sequence?
  - Insert values for the Wait Count(s).

---

ACSET: Each Target Action Set
- Goes through each target one by one to perform the following.

  Perform Action:
  Wait Count:
  Action Animation:
  Wait Count:
  Action Effect:
  Immortal: Off:
  - Use this part of the action sequence?
  - Insert values for the Wait Count(s).

---

ACSET: Finish Action
- The generic ending to most actions.

  Wait For New Line:
  Wait For Effects:
  Clear Battle Log:
  Home Reset:
  Wait For Movement:
  - Use this part of the action sequence?

---

Action Sequences - Animations

BattleCoreCastAni.gif

These Action Sequences are related to the 'Animations' that can be found in the Animations tab of the Database.

---

ANIM: Action Animation
- Plays the animation associated with the action.

  Targets:
  - Select unit(s) to play the animation on.

  Mirror Animation:
  - Mirror the animation?

  Wait For Animation?:
  - Wait for animation to complete before performing next command?

---

ANIM: Attack Animation
- Plays the animation associated with the user's weapon.

  Targets:
  - Select unit(s) to play the animation on.

  Mirror Animation:
  - Mirror the animation?

  Wait For Animation?:
  - Wait for animation to complete before performing next command?

---

ANIM: Cast Animation
- Plays the cast animation associated with the action.

  Targets:
  - Select unit(s) to play the animation on.

  Mirror Animation:
  - Mirror the animation?

  Wait For Animation?:
  - Wait for animation to complete before performing next command?

---

ANIM: Change Battle Portrait
- Changes the battle portrait of the actor (if it's an actor).
- Can be used outside of battle/action sequences.

  Targets:
  - Select unit(s) to play the animation on.
  - Valid units can only be actors.

  Filename:
  - Select the file to change the actor's portrait to.

---

ANIM: Show Animation
- Plays the a specific animation on unit(s).

  Targets:
  - Select unit(s) to play the animation on.

  Animation ID:
  - Select which animation to play on unit(s).

  Mirror Animation:
  - Mirror the animation?

  Wait For Animation?:
  - Wait for animation to complete before performing next command?

---

ANIM: Wait For Animation
- Causes the interpreter to wait for any animation(s) to finish.

---

Action Sequences - Battle Log

These Action Sequences are related to the Battle Log Window, the window found at the top of the battle screen.

---

BTLOG: Add Text
- Adds a new line of text into the Battle Log.

  Text:
  - Add this text into the Battle Log.
  - Text codes allowed.

---

BTLOG: Clear Battle Log
- Clears all the text in the Battle Log.

---

BTLOG: Display Action
- plays the current action in the Battle Log.

---

BTLOG: Pop Base Line
- Removes the Battle Log's last added base line and  all text up to its
  former location.

---

BTLOG: Push Base Line
- Adds a new base line to where the Battle Log currently is at.

---

BTLOG: Refresh Battle Log
- Refreshes the Battle Log.

---

BTLOG: UI Show/Hide
- Shows or hides the Battle UI (including the Battle Log).

  Show/Hide?:
  - Shows/hides the Battle UI.

---

BTLOG: Wait For Battle Log
- Causes the interpreter to wait for the Battle Log to finish.

---

BTLOG: Wait For New Line
- Causes the interpreter to wait for a new line in the Battle Log.

---

Action Sequences - Camera

These Action Sequences are battle camera-related. Requires VisuMZ_3_ActSeqCamera!

---

CAMERA: Clamp ON/OFF
- Turns battle camera clamping on/off.
- Requires VisuMZ_3_ActSeqCamera!

  Setting:
  - Turns camera clamping on/off.

---

CAMERA: Focus Point
- Focus the battle camera on a certain point in the screen.
- Requires VisuMZ_3_ActSeqCamera!

  X Coordinate:
  - Insert the point to focus the camera on.
  - You may use JavaScript code.

  Y Coordinate:
  - Insert the point to focus the camera on.
  - You may use JavaScript code.

  Duration:
  - Duration in frames for camera focus change.

  Camera Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Camera?
  - Wait for camera changes to complete before performing next command?

---

CAMERA: Focus Target(s)
- Focus the battle camera on certain battler target(s).
- Requires VisuMZ_3_ActSeqCamera!

  Targets:
  - Select unit(s) to focus the battle camera on.

  Duration:
  - Duration in frames for camera focus change.

  Camera Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Camera?
  - Wait for camera changes to complete before performing next command?

---

CAMERA: Offset
- Offset the battle camera from the focus target.
- Requires VisuMZ_3_ActSeqCamera!

  Offset X:
  - How much to offset the camera X by.
  - Negative: left. Positive: right.

  Offset Y:
  - How much to offset the camera Y by.
  - Negative: up. Positive: down.

  Duration:
  - Duration in frames for offset change.

  Camera Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Camera?
  - Wait for camera changes to complete before performing next command?

---

CAMERA: Reset
- Reset the battle camera settings.
- Requires VisuMZ_3_ActSeqCamera!

  Reset Focus?:
  - Reset the focus point?

  Reset Offset?:
  - Reset the camera offset?

  Duration:
  - Duration in frames for reset change.

  Camera Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Camera?
  - Wait for camera changes to complete before performing next command?

---

CAMERA: Wait For Camera
- Waits for camera changes to complete before performing next command.
- Requires VisuMZ_3_ActSeqCamera!

---

Action Sequences - Dragonbones

These Action Sequences are Dragonbones-related. Requires VisuMZ_2_DragonbonesUnion!

---

DB: Dragonbones Animation
- Causes the unit(s) to play a Dragonbones motion animation.
- Requires VisuMZ_2_DragonbonesUnion!

  Targets:
  - Select which unit(s) to perform a motion animation.

  Motion Animation:
  - What is the name of the Dragonbones motion animation you wish to play?

---

DB: Dragonbones Time Scale
- Causes the unit(s) to change their Dragonbones time scale.
- Requires VisuMZ_2_DragonbonesUnion!

  Targets:
  - Select which unit(s) to perform a motion animation.

  Time Scale:
  - Change the value of the Dragonbones time scale to this.

---

Action Sequences - Elements

These Action Sequences can change up the element(s) used for the action's damage calculation midway through an action.

They also require the VisuMZ_1_ElementStatusCore plugin to be present in order for them to work.

---

ELE: Add Elements
- Adds element(s) to be used when calculating damage.
- Requires VisuMZ_1_ElementStatusCore!

  Elements:
  - Select which element ID to add onto the action.
  - Insert multiple element ID's to add multiple at once.

---

ELE: Clear Element Changes
- Clears all element changes made through Action Sequences.
- Requires VisuMZ_1_ElementStatusCore!

---

ELE: Force Elements
- Forces only specific element(s) when calculating damage.
- Requires VisuMZ_1_ElementStatusCore!

  Elements:
  - Select which element ID to force in the action.
  - Insert multiple element ID's to force multiple at once.

---

ELE: Null Element
- Forces no element to be used when calculating damage.
- Requires VisuMZ_1_ElementStatusCore!

---

Action Sequences - Mechanics

These Action Sequences are related to various mechanics related to the battle system.

---

MECH: Action Effect
- Causes the unit(s) to take damage/healing from action and incurs any
  changes made such as buffs and states.

  Targets:
  - Select unit(s) to receive the current action's effects.

---

MECH: Add Buff/Debuff
- Adds buff(s)/debuff(s) to unit(s).
- Determine which parameters are affected and their durations.

  Targets:
  - Select unit(s) to receive the buff(s) and/or debuff(s).

  Buff Parameters:
  - Select which parameter(s) to buff.
  - Insert a parameter multiple times to raise its stacks.

  Debuff Parameters:
  - Select which parameter(s) to debuff.
  - Insert a parameter multiple times to raise its stacks.

  Turns:
  - Number of turns to set the parameter(s) buffs to.
  - You may use JavaScript code.

---

MECH: Add State
- Adds state(s) to unit(s).

  Targets:
  - Select unit(s) to receive the buff(s).

  States:
  - Select which state ID(s) to add to unit(s).
  - Insert multiple state ID's to add multiple at once.

---

MECH: Armor Penetration
- Adds an extra layer of defensive penetration/reduction.
- You may use JavaScript code for any of these.

  Armor/Magic Penetration:

    Rate:
    - Penetrates an extra multiplier of armor by this value.

    Flat:
    - Penetrates a flat amount of armor by this value.

  Armor/Magic Reduction:

    Rate:
    - Reduces an extra multiplier of armor by this value.

    Flat:
    - Reduces a flat amount of armor by this value.

---

MECH: ATB Gauge
- Alters the ATB/TPB Gauges.
- Requires VisuMZ_2_BattleSystemATB!

  Targets:
  - Select unit(s) to alter the ATB/TPB Gauges for.

  Charging:

    Charge Rate:
    - Changes made to the ATB Gauge if it is currently charging.

  Casting:

    Cast Rate:
    - Changes made to the ATB Gauge if it is currently casting.

    Interrupt?:
    - Interrupt the ATB Gauge if it is currently casting?

---

MECH: Collapse
- Causes the unit(s) to perform its collapse animation if the unit(s)
  has died.

  Targets:
  - Select unit(s) to process a death collapse.

  Force Death:
  - Force death even if the unit has not reached 0 HP?
  - This will remove immortality.

  Wait For Effect?:
  - Wait for the collapse effect to complete before performing next command?

---

MECH: Damage Popup
- Causes the unit(s) to display the current state of damage received
  or healed.

  Targets:
  - Select unit(s) to prompt a damage popup.

---

MECH: Dead Label Jump
- If the active battler is dead, jump to a specific label in the
  common event.

  Jump To Label:
  - If the active battler is dead, jump to this specific label in the
    common event.

---

MECH: HP, MP, TP
- Alters the HP, MP, and TP values for unit(s).
- Positive values for healing. Negative values for damage.

  Targets:
  - Select unit(s) to receive the current action's effects.

  HP, MP, TP:

    Rate:
    - Changes made to the parameter based on rate.
    - Positive values for healing. Negative values for damage.

    Flat:
    - Flat changes made to the parameter.
    - Positive values for healing. Negative values for damage.

  Damage Popup?:
  - Display a damage popup after?

---

MECH: Immortal
- Changes the immortal flag of targets. If immortal flag is removed and a
  unit would die, collapse that unit.

  Targets:
  - Alter the immortal flag of these groups. If immortal flag is removed and
    a unit would die, collapse that unit.

  Immortal:
  - Turn immortal flag for unit(s) on/off?

---

MECH: Multipliers
- Changes the multipliers for the current action.
- You may use JavaScript code for any of these.

  Critical Hit%:

    Rate:
    - Affects chance to land a critical hit by this multiplier.

    Flat:
    - Affects chance to land a critical hit by this flat bonus.

  Critical Damage

    Rate:
    - Affects critical damage by this multiplier.

    Flat:
    - Affects critical damage by this flat bonus.

  Damage/Healing

    Rate:
    - Sets the damage/healing multiplier for current action.

    Flat:
    - Sets the damage/healing bonus for current action.

  Hit Rate

    Rate:
    - Affects chance to connect attack by this multiplier.

    Flat:
    - Affects chance to connect attack by this flat bonus.

---

MECH: Remove Buff/Debuff
- Removes buff(s)/debuff(s) from unit(s).
- Determine which parameters are removed.

  Targets:
  - Select unit(s) to have the buff(s) and/or debuff(s) removed.

  Buff Parameters:
  - Select which buffed parameter(s) to remove.

  Debuff Parameters:
  - Select which debuffed parameter(s) to remove.

---

MECH: Remove State
- Remove state(s) from unit(s).

  Targets:
  - Select unit(s) to have states removed from.

  States:
  - Select which state ID(s) to remove from unit(s).
  - Insert multiple state ID's to remove multiple at once.

---

MECH: Text Popup
- Causes the unit(s) to display a text popup.

  Targets:
  - Select unit(s) to prompt a text popup.

  Text:
  - What text do you wish to display?

  Text Color:
  - Use #rrggbb for custom colors or regular numbers for text colors from
    the Window Skin.

  Flash Color:
  - Adjust the popup's flash color.
  - Format: [red, green, blue, alpha]

  Flash Duration:
  - What is the frame duration of the flash effect?

---

MECH: Wait For Effect
- Waits for the effects to complete before performing next command.

---

Action Sequences - Motion

These Action Sequences allow you the ability to control the motions of sideview sprites.

---

MOTION: Motion Type
- Causes the unit(s) to play the selected motion.

  Targets:
  - Select which unit(s) to perform a motion.

  Motion Type:
  - Play this motion for the unit(s).

  Show Weapon?:
  - If using 'attack', 'thrust', 'swing', or 'missile', display the
    weapon sprite?

---

MOTION: Perform Action
- Causes the unit(s) to play the proper motion based on the current action.

  Targets:
  - Select which unit(s) to perform a motion.

---

MOTION: Refresh Motion
- Cancels any set motions unit(s) has to do and use their most natural
  motion at the moment.

  Targets:
  - Select which unit(s) to refresh their motion state.

---

MOTION: Wait By Motion Frame
- Creates a wait equal to the number of motion frames passing.
- Time is based on Plugin Parameters => Actors => Motion Speed.

  Motion Frames to Wait?:
  - Each "frame" is equal to the value found in
    Plugin Parameters => Actors => Motion Speed

---

Action Sequences - Movement

These Action Sequences allow you the ability to control the sprites of actors and enemies in battle.

---

MOVE: Battle Step
- Causes the unit(s) to move forward past their home position to prepare
  for action.

  Targets:
  - Select which unit(s) to move.

  Wait For Movement?:
  - Wait for movement to complete before performing next command?

---

MOVE: Face Direction
- Causes the unit(s) to face forward or backward.
- Sideview-only!

  Targets:
  - Select which unit(s) to change direction.

  Direction:
  - Select which direction to face.

---

MOVE: Face Point
- Causes the unit(s) to face a point on the screen.
- Sideview-only!

  Targets:
  - Select which unit(s) to change direction.

  Point:
  - Select which point to face.
    - Home
    - Center
    - Point X, Y
      - Replace 'x' and 'y' with coordinates

  Face Away From?:
  - Face away from the point instead?

---

MOVE: Face Target(s)
- Causes the unit(s) to face other targets on the screen.
- Sideview-only!

  Targets (facing):
  - Select which unit(s) to change direction.

  Targets (destination):
  - Select which unit(s) for the turning unit(s) to face.

  Face Away From?:
  - Face away from the unit(s) instead?

---

MOVE: Float
- Causes the unit(s) to float above the ground.
- Sideview-only!

  Targets:
  - Select which unit(s) to make float.

  Desired Height:
  - Vertical distance to float upward.
  - You may use JavaScript code.

  Duration:
  - Duration in frames for total float amount.

  Float Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Float?:
  - Wait for floating to complete before performing next command?

---

MOVE: Home Reset
- Causes the unit(s) to move back to their home position(s) and face back to
  their original direction(s).

  Targets:
  - Select which unit(s) to move.

  Wait For Movement?:
  - Wait for movement to complete before performing next command?

---

MOVE: Jump
- Causes the unit(s) to jump into the air.
- Sideview-only!

  Targets:
  - Select which unit(s) to make jump.

  Desired Height:
  - Max jump height to go above the ground
  - You may use JavaScript code.

  Duration:
  - Duration in frames for total jump amount.

  Wait For Jump?:
  - Wait for jumping to complete before performing next command?

---

MOVE: Move Distance
- Moves unit(s) by a distance from their current position(s).
- Sideview-only!

  Targets:
  - Select which unit(s) to move.

  Distance Adjustment:
  - Makes adjustments to distance values to determine which direction to
    move unit(s).
    - Normal - No adjustments made
    - Horizontal - Actors adjust left, Enemies adjust right
    - Vertical - Actors adjust Up, Enemies adjust down
    - Both - Applies both Horizontal and Vertical

    Distance: X:
    - Horizontal distance to move.
    - You may use JavaScript code.

    Distance: Y:
    - Vertical distance to move.
    - You may use JavaScript code.

  Duration:
  - Duration in frames for total movement amount.

  Face Destination?:
  - Turn and face the destination?

  Movement Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Movement Motion:
  - Play this motion for the unit(s).

  Wait For Movement?:
  - Wait for movement to complete before performing next command?

---

MOVE: Move To Point
- Moves unit(s) to a designated point on the screen.
- Sideview-only! Points based off Graphics.boxWidth/Height.

  Targets:
  - Select which unit(s) to move.

  Destination Point:
  - Select which point to face.
    - Home
    - Center
    - Point X, Y
      - Replace 'x' and 'y' with coordinates

  Offset Adjustment:
  - Makes adjustments to offset values to determine which direction to
    adjust the destination by.

    Offset: X:
    - Horizontal offset to move.
    - You may use JavaScript code.

    Offset: Y:
    - Vertical offset to move.
    - You may use JavaScript code.

  Duration:
  - Duration in frames for total movement amount.

  Face Destination?:
  - Turn and face the destination?

  Movement Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Movement Motion:
  - Play this motion for the unit(s).

  Wait For Movement?:
  - Wait for movement to complete before performing next command?

---

MOVE: Move To Target(s)
- Moves unit(s) to another unit(s) on the battle field.
- Sideview-only!

  Targets (Moving):
  - Select which unit(s) to move.

  Targets (Destination):
  - Select which unit(s) to move to.

    Target Location:
    - Select which part target group to move to.
      - front head
      - front center
      - front base
      - middle head
      - middle center
      - middle base
      - back head
      - back center
      - back base

    Melee Distance:
    - The melee distance away from the target location in addition to the
      battler's width.

  Offset Adjustment:
  - Makes adjustments to offset values to determine which direction to
    adjust the destination by.

    Offset: X:
    - Horizontal offset to move.
    - You may use JavaScript code.

    Offset: Y:
    - Vertical offset to move.
    - You may use JavaScript code.

  Duration:
  - Duration in frames for total movement amount.

  Face Destination?:
  - Turn and face the destination?

  Movement Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Movement Motion:
  - Play this motion for the unit(s).

  Wait For Movement?:
  - Wait for movement to complete before performing next command?

---

MOVE: Opacity
- Causes the unit(s) to change opacity.
- Sideview-only!

  Targets:
  - Select which unit(s) to make float.

  Desired Opacity:
  - Change to this opacity value.
  - You may use JavaScript code.

  Duration:
  - Duration in frames for opacity change.

  Opacity Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Opacity?:
  - Wait for opacity changes to complete before performing next command?

---

MOVE: Wait For Float
- Waits for floating to complete before performing next command.

---

MOVE: Wait For Jump
- Waits for jumping to complete before performing next command.

---

MOVE: Wait For Movement
- Waits for movement to complete before performing next command.

---

MOVE: Wait For Opacity
- Waits for opacity changes to complete before performing next command.

---

Action Sequences - Target

If using a manual target by target Action Sequence, these commands will give you full control over its usage.

---

TARGET: Current Index
- Sets the current index to this value.
- Then decide to jump to a label (optional).

  Set Index To:
  - Sets current targeting index to this value.
  - 0 is the starting index of a target group.

  Jump To Label:
  - If a target is found after the index change, jump to this label in the
    Common Event.

---

TARGET: Next Target
- Moves index forward by 1 to select a new current target.
- Then decide to jump to a label (optional).

  Jump To Label:
  - If a target is found after the index change, jump to this label in the
    Common Event.

---

TARGET: Previous Target
- Moves index backward by 1 to select a new current target.
- Then decide to jump to a label (optional).

  Jump To Label:
  - If a target is found after the index change, jump to this label in the
    Common Event.

---

TARGET: Random Target
- Sets index randomly to determine new currernt target.
- Then decide to jump to a label (optional).

  Force Random?:
  - Index cannot be its previous index amount after random.

  Jump To Label:
  - If a target is found after the index change, jump to this label in the
    Common Event.

---

Action Sequences - Zoom

These Action Sequences are zoom-related. Requires VisuMZ_3_ActSeqCamera!

---

ZOOM: Reset
- Reset any zoom settings.
- Requires VisuMZ_3_ActSeqCamera!

  Duration:
  - Duration in frames to reset battle zoom.

  Zoom Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Zoom?
  - Wait for zoom changes to complete before performing next command?

---

ZOOM: Scale
- Changes the zoom scale.
- Requires VisuMZ_3_ActSeqCamera!

  Scale:
  - The zoom scale to change to.

  Duration:
  - Duration in frames to reset battle zoom.

  Zoom Easing:
  - Select which easing type you wish to apply.
  - Requires VisuMZ_0_CoreEngine.

  Wait For Zoom?
  - Wait for zoom changes to complete before performing next command?

---

ZOOM: Wait For Zoom
- Waits for zoom changes to complete before performing next command.
Requires VisuMZ_3_ActSeqCamera!

---