ATOA Chanting Battle Animations

[DerVVulfman]

ATOA Chanting Battle Animations
Version: 1.0

Introduction
This script, an add-on to ATOA's ACBS system, adds the ability to apply battle animations to battlers that are delayed by the ATB/CTB casting time delays, known as Chanting Times. It is only for use with the ACBS and requires either the ATB or CTB add-on.


Script

"Script Time!"

Code:

#==============================================================================
# ** ATOA Chanting Battle Animations
#------------------------------------------------------------------------------
#    by DerVVulfman
#    version 1.0
#    01-03-2016 (mm/dd/yyyy)
#    RGSS / RPGMaker XP
#
#==============================================================================
#  
#  INTRODUCTION:
#
#  This script adds the ability to apply battle animations to battlers that
#  are delayed by the ATB/CTB casting time delays, known as Chanting Times.
#
#  This script is an add-on for Atoa's ACBS  in tandem with either  his ATB
#  or CTB addons, included with his demo.
#
#------------------------------------------------------------------------------
#
#  INSTALLATION:
#
#  Paste below either the Atoa ATB or CTB code.
#
#  The configurations are explained below.
#
#==============================================================================
#
#  TERMS AND CONDITIONS:
#
#  Free for use, even in commercial games.  And as this script was requested
#  by Noctis, you have to give both of us credit for this script.
#
#==============================================================================



module Atoa  
  #¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤
  # CAST SETTINGS
  #¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤
  # Chanting default animation ID.
  # Set to 0 by default,  assuming all chanting delays have no animation unless
  # set in their individual skills/items settings.
  #
  Chanting_Anim = 0
  
  
  # To add a battle animation to a skill or item that has a set delay, add
  # this effect to the setting of the  skill or the item:
  # "CHANTANIM/**"
  #   ** must be the battle animation's ID.
  #
  #  EX:
  #  Altering the potion in the ACBS | Config 2 - Advanced page:
  #
  #  Item_Settings[1] = ["MOVETYPE/STEPFOWARD","CHANTING/5","CHANTANIM/2"]
  #
  #  This applies  the chanting delay of '5' to the potion,  preventing its use
  #  until the delay is over.  And it renders the 'Cast Magic' battle animation
  #  to the item until the actual use of the item is performed.
  #
  #  NOTE:  If the skill or item has  a delay but no animation is set by way of
  #         the 'CHANTANIM/**'  parameter,  the system  will apply  the default
  #         setting (Chanting_Anim).
  #
  #
  #¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤¤
  
end



#==============================================================================
# ** Atoa Module
#==============================================================================
$atoa_script = {} if $atoa_script.nil?
unless $atoa_script.include?('Atoa CTB') or $atoa_script.include?('Atoa ATB')
  # Apply message
  p "Error:  Necessary ATB/CTB script not included.  Exiting now."
  # Forces termination
  exit
end
$atoa_script['Atoa CastAnims'] = true



#==============================================================================
# ** Game_Battler
#------------------------------------------------------------------------------
#  This class deals with battlers. It's used as a superclass for the Game_Actor
#  and Game_Enemy classes.
#==============================================================================

class Game_Battler
  #--------------------------------------------------------------------------
  # * Public Instance Variables
  #--------------------------------------------------------------------------
  attr_accessor :animation_wait           # animation hit flag
  attr_accessor :animation_chant          # animation hit flag
  #--------------------------------------------------------------------------
  # * Object Initialization
  #--------------------------------------------------------------------------
  alias meebers initialize
  def initialize
    meebers
    @animation_wait   = 0
    @animation_chant  = 0
  end
end



#==============================================================================
# ** Sprite_Battler
#------------------------------------------------------------------------------
#  This sprite is used to display the battler.It observes the Game_Character
#  class and automatically changes sprite conditions.
#==============================================================================

class Sprite_Battler < RPG::Sprite
  #--------------------------------------------------------------------------
  # * Alias Listings
  #--------------------------------------------------------------------------
  alias set_idle_pose_chantinganim set_idle_pose
  alias update_idle_anim_chantinganim update_idle_anim
  #--------------------------------------------------------------------------
  # * Get idle pose ID
  #--------------------------------------------------------------------------
  def set_idle_pose
    # Perform the original call and get pose as normal
    pose = set_idle_pose_chantinganim
    # Perform the attached code
    set_idle_pose_chantanim
    # Return pose from system
    return pose
  end
  #--------------------------------------------------------------------------
  # * Get chanting pose animation for action
  #--------------------------------------------------------------------------
  def set_idle_pose_chantanim
    action = @battler.cast_action
    return if action.nil?
    cast_anim_id = Atoa::Chanting_Anim
    ext = check_extension(action, 'CHANTANIM/')
    if ext != nil
      ext.slice!('CHANTANIM/')
      cast_anim_id = ext.to_i
    end
    @battler.animation_chant = cast_anim_id
  end
  #--------------------------------------------------------------------------
  # * Idle pose update
  #--------------------------------------------------------------------------
  def update_idle_anim
    # Perform the original call
    update_idle_anim_chantinganim
    # Perform the attached code
    update_idle_anim_chantanim
  end
  #--------------------------------------------------------------------------
  # * Idle pose update chanting animation
  #--------------------------------------------------------------------------
  def update_idle_anim_chantanim
    return if update_idle_anim_waiting?
    return unless @battler.animation_id == 0
    animation_id = @battler.animation_chant
    @battler.animation_chant = 0
    return if animation_id == 0
    @battler.animation_id = animation_id
    update_idle_anim_delay(animation_id)
  end
  #--------------------------------------------------------------------------
  # * Idle pose Animation : Number of frames in animation
  #     id : animation_id
  #--------------------------------------------------------------------------
  def update_idle_anim_delay(id)
    # Obtain animation by ID
    animation = $data_animations[id]
    # Set battler's wait time by animation's number of frames (times 2)
    @battler.animation_wait = animation.frame_max * 2
  end
  #--------------------------------------------------------------------------
  # * Idle pose Animation : Determine if animation should be over
  #--------------------------------------------------------------------------
  def update_idle_anim_waiting?
    @battler.animation_wait = 0 if @battler.animation_wait.nil?
    @battler.animation_wait -= 1
    @battler.animation_wait = 0 if @battler.animation_wait < 0
    return (@battler.animation_wait != 0)
  end
end

Instructions
In the script as always.


Compatibility
For use with Atoa's (Victor Sant's) ACBS system and either its ATB or CTB add-on.


Terms and Conditions
Free for use, even in commercial games. And as this script was requested by Noctis, you have to give both of us credit for this script.

[Noctis]

Sorry, for resurrecting this old topic, but there a problem that I encounter.
If a hero has a chanting animation, the chanting animation is above the caster. And in addition the animation is also above the other actors which looks kinda odd. XD.
Can you do a little edit where I can determine if the chanting animation is above or under the caster and I also want to determine if the animation should be above or under other actors. ^^

Sorry for such a late reply.

[DerVVulfman]

I don't need to. :Tongue: It appears that Vic handled that already within ACBS | Config 1 - Basic

Look around the 300 line area and you will see a section where you can define x, y and even Z (depth) offsets for battle animations. And it would be the Z depth you will be having fun with.

[Noctis]

Hell, why didint I  notice that line? It really amazes me how much Vic included into his battle system. Okay, that problem can be considered fixed, but there is a problem thats remaining for me. I dont know how to express it in a proper way. And I also dont know what could causes it.
Sometimes, when I use a skill that has a chanting animation, the animation of the chanting does not fully circle, at one point it repeats without finishing the full animation. Looks like that a one frame of the chanting animation vanishes for a single moment, its the fist frame. But it doesnt happen all the time.
Heres a video file that I recorded. You'll understand if you look at the cast animation at the beginning and then near the end.
https://workupload.com/file/JTANuM7

[Noctis]

I hope I can bump this...
So...
BUMP

[DerVVulfman]

I apologize. However, the animation sequences are based upon the same systems that Vic/Atoa used in the rest of his systems. And with that, the edits he made to the animation system as a whole.

It is possible that you may need a shorter battle animation sequence, one that allows the entire sequence to finish its animation before it is called to re-loop. Have you attempted to use these animations in other Atoa defined animation sequences?

The only other thing I can think of is that the animation, as it is tied to the skill/item/whatever's ID.... it may also be tied to the battle animation delay settings for the actual 'hit effect'. The value of "TIMEBEFOREANIM/**" in the default system delays the battle animation effect by ** frames after the hit is performed. and "TIMEAFTERANIM/**" causes a delay after the animation is performed.

[Noctis]

You dont need to apologize, for some reasons the script section in this forum is always full of new problems.^^
Well, I didint use the animation in any other way than just in your script, also I didint bound it to a certain skill.
Well, how much shorter can I make the animations? They're already only 11 or 12 frames, I mean they're called animations for a certain reason. I could give it a try for testing reasons. Im going to test something anyway.
Isnt it possible to make the animation somehow untouched from the core script?
From what I see, the main problem is, that theres a delay or a gap when the animation should be replayed, dont know what it causes it.

Btw. on ACBS | Config 1 - Basic line 312 I found a interesting line.

 # State cycle times.

  State_Cycle_Time = 2

Dont know what it does.^^

Btw. It doesnt have a effect if the animation is short or not. Its the opposite. Even if a animation is made of 3 frames, there will be a delay if the animation needs to load again. It has nothing to do with the animations frames. It would be even better to make larger animation, because then the delay can will be delayed. Well, thats also not a  solution. Because there will be a delay for sure.
For some reasons however sometimes the animation doesnt have a delay, sometimes it does. Im not sure what it is caused by.

[Noctis]

Okay, i think its time for a bug report.
I tried various things out to get this script right,
remember the cyle loop bug where the animaion isnt fully looped or where the animation has a delay until it will reloop - I actually think I manged to solve this.
Im not 100% sure if it works.
I added the line:
update_idle_anim_chantanim
two times more on the end of the script.
under line 181 and under line 190

However, there are still some in the script which I cant solve on my own. And these two bugs are not caused by my edit as I tried.
1. When a hero is casting a skill which has a chantannim and another hero will kill all enemies before the Hero can cast his skill, his chantanim will stay there even in the victory pose without going away. Additionally, the chantanim will even be in the next battle for a while until it vanishes after some seconds.

2. What troubles me even more is: When an enemy is attacking a hero which is casting a skill with a chantanim the chantanim will reloop again even if the animation isnt fully finished will looks very odd. it looks like double casting.
Heres my edited version...
The edits are marked with a edit:

Edit: I removed it because its not solving the problem.

[DerVVulfman]

Kinda busy right now. HOWEVER, there are two issues on your edits which I do not recommend.

The first edit is where you add the update_idle_anim_chantanim to the end of the update_idle_anim_delay method. When update_idle_anim_chantanim runs, it goes through several statements until it runs the update_idle_anim_delay. But the update_idle_anim_delay needs to be the last thing run within the chant animation itself in the animations system. But by your edit, it re-runs the update_idle_anim_chantanim system again which will run over... and over. That's referred to as an infinite loop. Not recommended at all.

As to your other edit, you put update_idle_anim_chantanim at the end of the update_idle_anim_waiting? method. Initially, the update_idle_anim_chantanim method checks the anim_waiting? method to see if there is a delay, and then skip out. It appears to me that you wanted it to re-run the method after the check which is certainly NOT desirable. ............ It won't work. Thankfully, you put the edit after the 'return' statement that not only passes a true/false value, but exits the method BEFORE it gets to your edit. If it didn't exit, you would end up with another infinite loop. Again, not recommended at all.

[Noctis]

Oh I see, then, Im going to remove my edit above.