Variable-Based Battle Victory MEs

[PK8]

Variable-Based Victory MEs
Version: 1

Introduction
This script allows developers to set victory MEs depending on the value of a game variable. Useful if you want your project's victory ME changed when the player has progressed pretty far in the game.

Features

• Set variable ID and control victory MEs through the variable's value.

Screenshots
No screencaps.

Demo
No demo.

Script

Code:

=begin
????????????????????????????????????????????????????????????????????????????????
? Variable-Based Battle Victory MEs                                            ?
? by PK8                                                                       ?
? September 29th, 2009                                                         ?
? http://rmvxp.com                                                             ?
????????????????????????????????????????????????????????????????????????????????
? ? Table of Contents                                                          ?
? ?? Author's Notes                - Line 16?18                                ?
? ?? Introduction & Description    - Line 20?23                                ?
? ?? Features                      - Line 25,26                                ?
? ?? How to Use                    - Line 28?35                                ?
? ?? Methods Aliased               - Line 37,38                                ?
? ?? Thanks                        - Line 40?42                                ?
????????????????????????????????????????????????????????????????????????????????
? ? Author's Notes                                                             ?
? After working on Individual Troop Victory MEs, I wanted to work on this      ?
? script. I was pretty bored so yeah.                                          ?
????????????????????????????????????????????????????????????????????????????????
? ? Introduction & Description                                                 ?
? This script allows developers to set victory MEs depending on the value of a ?
? game variable. Useful if you want your project's victory ME changed when the ?
? player has progressed pretty far in the game.                                ?
????????????????????????????????????????????????????????????????????????????????
? ? Features                                                                   ?
? ? Set variable ID and control victory MEs through the variable's value.      ?
????????????????????????????????????????????????????????????????????????????????
? ? How to Use                                                                 ?
? Varba_Victory_Var: Set game variable ID.                                     ?
?                                                                              ?
? Varba_Victory[variable id value] = ["file", volume, pitch]                   ?
? ^ Sets victory ME based on the value of the variable ID.                     ?
?                                                                              ?
? Note: If you're using Individual Troop Victory MEs, please paste this script ?
?       above it. It's so Individual Troop Victory MEs can override this script?
????????????????????????????????????????????????????????????????????????????????
? ? Methods Aliased                                                            ?
? ? start_phase5 of Scene_Battle                                               ?
????????????????????????????????????????????????????????????????????????????????
? ? Thanks                                                                     ?
? ? If it weren't for JoeYoung's original request, I wouldn't have worked on   ?
?   this script.                                                               ?
????????????????????????????????????????????????????????????????????????????????
=end

#------------------------------------------------------------------------------
# * Customise
#------------------------------------------------------------------------------
class PK8
  Varba_Victory = {} # Do not touch this.
  
  Varba_Victory_Var = 2 # Set variable ID.
  
  # The value of PK8::Varba_Victory_Var controls the battle theme.
  #          [id] = [Music File, Volume, Pitch]
  Varba_Victory[1] = ["002-Victory02", 100, 100]
  Varba_Victory[2] = ["003-Victory03", 100, 100]
end

#==============================================================================
# ** Scene_Battle
#------------------------------------------------------------------------------
#  This class performs battle screen processing.
#==============================================================================
class Scene_Battle
  alias_method(:pk8_var_battle_victoryme_start_phase_5, :start_phase5)
  def start_phase5
    pk8_var_battle_victoryme_start_phase_5
    start_var_battle_victoryme
  end
  
  #----------------------------------------------------------------------------
  # * Start Troop Victory
  #----------------------------------------------------------------------------
  def start_var_battle_victoryme
    PK8::Varba_Victory.each_key { | i |
    # If Variable ID value equals the key.
    if $game_variables[PK8::Varba_Victory_Var] == i
      if PK8::Varba_Victory[i][0] != nil and !PK8::Varba_Victory[i][0].empty?
        # Sets ME volume to 100 if nil.
        PK8::Varba_Victory[i][1] = 100 if PK8::Varba_Victory[i][1] == nil
        # Sets ME pitch to 100 if nil.
        PK8::Varba_Victory[i][2] = 100 if PK8::Varba_Victory[i][2] == nil
        # Plays ME.
        Audio.me_play("Audio/ME/#{PK8::Varba_Victory[i][0]}",
        PK8::Varba_Victory[i][1], PK8::Varba_Victory[i][2])
      end
      break
    end }
  end
end

Instructions
Instructions are in the script.

FAQ
Awaiting question.

Compatibility
Aliases start_phase5 of Scene_Battle.

Credits and Thanks
If it weren't for JoeYoung's original request, I wouldn't have made this script.

Author's Notes
After working on Individual Troop Victory MEs, I wanted to work on this script. I was pretty bored so yeah.

Terms and Conditions
Credit me. :3

[Charlie Fleed]

I can't really figure out the use of this script, given that there's a command to change the battle end ME...

[PK8]

I'm pretty bad at explaining this (and I'm getting super sleepy).

So... you set the variable ID.
Varba_Victory_Var = 2 <- Variable ID.

And you need to set which music effects would turn on depending on the value of the above variable.
Varba_Victory[1] = ["002-Victory02", 100, 100]

If Variable 2's value was equal to 1, it would play "002-Victory02" as the victory theme.

And I just wanted to go streamline things.

[Charlie Fleed]

Ok, I mean, what's the difference with just using the "Change Battle End ME" command?

[Alpha-Mad]

Well, this (and Punk's variable based battle theme) could be good because lets say you have a player that you want to be level 20 before the victory and battle theme to change. You could set it in here so that you don't have to use a common event to do it.

I hope this is what Punk was thinking (that's what I would use it as)