Announcement

[Reedo]

Reedo's Simple Side Battle System (RSSBS)

Version 1.0
January 07, 2010

By Reedo


References
None. This is an original script by Reedo.

Description
While there are a number of existing SBS scripts out there, most of them require a fair-to-significant amount of configuration to use, and are often incompatible with many other scripts.

However, for a simple, classic "Final Fantasy" feel, the SBS does not have to be all that complex. And it can be written in such a way as to maintain a high level of compatibility.

This script is my attempt at doing just that; creating a simple to use (plug-and-play), highly compatible, side-battle-system.

The script has gone through a fair amount of testing and has proven pretty solid so far. The original support thread can be found here:
http://www.rpgmakervx.net/index.php?showtopic=24587

Please read it first if you have any problems, or find an incompatibility with another script.

I also plan to release additional functionality in a series of expansion scripts. These will be optional scripts to further enhance the SBS experience. The first of these is an enhancement for the YEZ Victory Aftermath script, and is attached to this post. Watch for updates, as I will continue to add expansions to this post until it becomes unreasonable to do so.

Features

The Simple SBS provides a classic "FF"-style side-battle experience.

This script will:

Spoiler:

• Draw the party on the right side of the screen, facing left, during batle.
• Cause actors to perform their stepping animation when they are on the ground, and have no state restrictions applied.
• Place a shadow under the actor.
• Provide a target for animations, and optionally, animations themselves.
• Line up actors in a staggerd row, top to bottom, with adjustable spacing, recessed according to the position value of their class.
• Cause actors to step forward when performing an action.
• Draw actors lying down, whitened, and semi-transparent when dead.
• Cause living actors to do a victory dance at the end of battle.
• Provide the option to horizontally flip enemy images by enemy ID.

Screen Shots

These are screen shots of just the SBS by itself:

Spoiler:

The battle begins!



An actor attacks the enemy...



The party wins, and does their default "hop-and-twirl" victory dance.

These are screen shots of the YEZ-RSSBS demo with all scripts in place:

Spoiler:

The battle begins!



An actor attacks the enemy...



An enemy attacks an actor!



The party wins the battle, and victory is displayed!



Finally the Victory Aftermath is displayed.

Known Bugs
None.

Please report any on the support thread if found: http://www.rpgmakervx.net/index.php?showtopic=24587

Requirements
None. This is a stand-alone script.

However, for the best experience, the use of YEZ is suggested.

Installation
Plug-and-Play

Just drop it under materials; be sure to install under all YEZ scripts if used.

Compatibility
Should be compatible with most other scripts.

This script only does a minor overwrite of one method. It should be compatible with other scripts providing they do no overwrite, and highly-modify, the default battle system.

Demo
Two demos are attached. RSSBS-Demo contains just the SBS script. DemoYEZ-with-RSBSS is the Yanfly YEZ demo with the SBS, the Victory Splash & Wait - RSSBS-YEZ Victory Aftermath enhancement script, and Reedo's Tile Based Battle Backgrounds installed.

Script
This is the complete script.

Spoiler:

CODE

###############################################################################
##  RSSBS - Reedo's Simple Side Battle System
##  Version 1.0
##  January 7, 2010
##  By Reedo
###############################################################################
##  SOURCE
##
##  Source thread:
##
##
##  Support thread:
##    http://www.rpgmakervx.net/index.php?showtopic=24587
###############################################################################
##  REFERENCES
##
##  None.  This is an original script by Reedo.
##  However other people have contributed ideas and bug finds. Please see the
##  support thread link above for details.
###############################################################################
##  DESCRIPTION
##
##  This script provides a plug-and-play Side Battle System for the default
##  battle system. This is purely an asthetic script, and as such, it only
##  modifies the visuals of the battle. It does not modify battle mechanics
##  when used by itself.
##
##  This script will:
##  1) Draw the party on the right side of the screen, facing left, during batle.
##  2) Cause actors to perform their stepping animation when they are on the
##     ground, and have no state restrictions applied.
##  3) Place a shadow under the actor.
##  4) Provide a target for animations, and optionally, animations themselves.
##  5) Line up actors in a staggerd row, top to bottom, with adjustable spacing,
##     recessed according to the position value of their class.
##  6) Cause actors to step forward when performing an action.
##  7) Draw actors lying down, whitened, and semi-transparent when dead.
##  8) Cause living actors to do a victory dance at the end of battle.
##  9) Provide the option to horizontally flip enemy images by enemy ID.
##
##  When used with the YERD or YEZ battle scripts, you then get even more
##  animation options (such as casting animations) and popups for most battle
##  event messages.  This SBS and YEZ combine to form an amazing SBS experience!
##     YEZ Script Link:  http://www.pockethouse.com/yez/
###############################################################################
##  COMPATIBILITY
##
##  Should be compatible with most other scripts.
##
##  This script overwrites 1 method: Spriteset_Battle.update_actors
##  All other methods are aliased, and those aliases are called.
##  The one overwrite should not cause an issue as the only functionality it
##  supresses is setting the party members to the current battle sprites. The
##  rest of the original method is maintained, and this script handles the
##  relationship between party members and battle sprites.
###############################################################################
##  REQUIREMENTS
##
##  None
###############################################################################
##  INSTALLATION
##
##  Plug-and-play. (and this time I mean it for reals!)
##
##  Insert below Materials, above other Reedo scripts.
##  All Reedo scripts should be below all YERD/YEZ scripts.
###############################################################################
##  RIGHTS & RESTRICTIONS
##
##  As with most Reedo scripts, this script is free to re-use, as-is,
##  in personal, educational, and commercial RPGVX development projects,
##  providing that:  this script, as well as the rpgmakervx.net forum link  
##  from which it was obtained, are credited in writing displayed readily
##  to the user of the final compiled code assembly.
##
##  Reedo and rgpmakervx.net retain all rights of intellect and ownership.
##  You forego all rights of warranty by utilizing this script.
###############################################################################
##  USAGE
##
##  Plug and play.  Suggested to use YEZ Battle Engine Zealous, and Reedo's
##  Tile-Based Battle Backgrounds scripts.
##
##  Some visual options can be modified below.
###############################################################################

###############################################################################
##  USER OPTIONS
###############################################################################
module REEDO_SBS

# If desired, you can modify the default script options using the constants
# below. In most cases though, you should not need to adjust these values.
  
###############################################################################
## This section controls the battle animations provided by this script
###############################################################################
  # This controls whether or not this script will provide animations during
  # battle. Set to 'true' when using this script without any other battle scene
  # enhancements. Set to 'false' when using battle scene enhancements such
  # as YEZ/YERD. Default is 'false'.
  SBS_ACTION_ANIMES = false
  
  # If this script is providing animations, then you can specify which
  # animations to use a default.
  SBS_DEFAULT_ATTACK_ANIME = 19
  # Skill and item animations will use the animation assigned to the skill or
  # item, if any. If none is assigned, then the default will be used. Specify
  # a value of 0 if you do not want a default animation. These values have no
  # effect if SBS_ACTION_ANIMES is set to 'false'.
  SBS_DEFAULT_SKILL_ANIME = 1
  SBS_DEFAULT_ITEM_ANIME = 1
  
###############################################################################
## This section adjusts the actors positions on screen
###############################################################################
  ACTOR_START_LINE = 432        # The left-most position of the first actor
  ACTOR_START_TOP = 80          # The top-most position of the first actor
  ACTOR_STAGGER_HORZ = 8        # The amount to recess each actor to the right
  ACTOR_STAGGER_VERT = 16       # The vertical spacing between characters
  ACTOR_CLASS_POS_STAGGER = 16  # The extra distance to the right for class position
  ACTOR_STEP_IN_DISTANCE = 64   # The distance an actor steps in during an action
  ACTOR_STEP_IN_RATE = 8        # The rate at which the actor covers the distance
  
###############################################################################
## This section controls when an actor displays their stepping animation
###############################################################################
  # If an actor has a state applied which has a restriction value listed in
  # the following array, the actor will not display their stepping animation
  # until the state is removed.
  NO_STEP_RESTRICTIONS = [4, 5]
  # Has the same effect as above, but halts the stepping animation based on
  # the state's ID, without regard to the state's restriction.
  NO_STEP_STATES = []
  
###############################################################################
## This section adjusts the appearance of an actor when dead
###############################################################################
  ACTOR_DEATH_OPACITY = 175              # The tranparency of dead actors
  ACTOR_DEATH_ANGLE = 270                # The angle to rotate the body
  ACTOR_DEATH_TONE = [128, 128, 128, 0]  # A color tone to apply to the image
  ACTOR_DEATH_OFFSET_X = -8              # A horizontal offset to move the body by
  ACTOR_DEATH_OFFSET_Y = -8              # A vertical offset to move the body by
  
###############################################################################
## This section adjusts the actor's shadow
###############################################################################
  ACTOR_SHADOW_IMAGE = "Shadow"       # The name of the system image to use
  ACTOR_SHADOW_CUSTOM_PICTURE = nil   # The name of a resource picture to use instead; nil to use system image
  ACTOR_SHADOW_OFFSET_X = 0           # The horizontal offset to the actor's position
  ACTOR_SHADOW_OFFSET_Y = 8           # The vertical offset to the actor's position
  ACTOR_DEATH_SHADOW_OFFSET_X = 8     # Additional X offset added when dead
  ACTOR_DEATH_SHADOW_OFFSET_Y = 2     # Additional Y offset added when dead
  
###############################################################################
## This section adjusts the victory dance
###############################################################################
  VICTORY_DANCE_JUMP_HEIGHT = 16    # The height of the jump
  VICTORY_DANCE_JUMP_INCREMENT = 2  # The rate of jump movement
  VICTORY_DANCE_JUMP_HOVER = 4      # The number of frames to wait in the air
  VICTORY_DANCE_JUMP_WAIT = 70      # The number of frames before jumping again
  VICTORY_DANCE_JUMP_TWIST = true   # True to twirl when jumping; false to face forward
  
###############################################################################
## This section adjusts the battle floor location
###############################################################################
  BATTLE_FLOOR_TOP = 128  # Allows you to set the top of the battle floor
  
###############################################################################
## This section adjusts enemy images
###############################################################################
  # Specify the ID of enemies who should have their image flipped in battle
  FLIP_ENEMY = [
                2, 3, 4, 5, 8, 10, 12, 13, 14, 16, 17,
                18, 19, 21, 22, 23, 25, 28, 29,
                
               ]
  
end
###############################################################################
##  MAIN SCRIPT
###############################################################################
##  EDITS BEYOND THIS POINT ARE AT YOUR OWN RISK!!!
###############################################################################
class Game_Battler
  alias reedo_sbs_gb_add_state add_state
  def add_state(state_id)
    reedo_sbs_gb_add_state(state_id)
    if self.is_a?(Game_Actor) and $scene.is_a?(Scene_Battle)
      bs = $scene.reedo_get_battle_sprite(reedo_battle_sprite_id)
      return if bs == nil
      bs.reedo_bc_sprite.character.step_anime = reedo_check_step_anime
      reedo_update_life_state
    end
  end
  
  alias reedo_sbs_gb_remove_state remove_state
  def remove_state(state_id)
    reedo_sbs_gb_remove_state(state_id)
    if self.is_a?(Game_Actor) and $scene.is_a?(Scene_Battle)
      bs = $scene.reedo_get_battle_sprite(reedo_battle_sprite_id)
      return if bs == nil
      bs.reedo_bc_sprite.character.step_anime = reedo_check_step_anime
      reedo_update_life_state
    end    
  end
  
  def reedo_check_step_anime
    return false if dead?
    for state in states
      return false if REEDO_SBS::NO_STEP_STATES.include?(state.id)
      return false if REEDO_SBS::NO_STEP_RESTRICTIONS.include?(state.restriction)
    end
    return true
  end
  
  def reedo_update_life_state(battle_sprite = nil)
    if dead?
      if !@reedo_dead_set
        reedo_set_dead_state(battle_sprite)
        @reedo_dead_set = true
      end
    else
      if @reedo_dead_set
        reedo_set_live_state(battle_sprite)
        @reedo_dead_set = false
      end
    end
  end
  
  def reedo_reset_dead_set
    @reedo_dead_set = false
  end
  
  def reedo_set_dead_state(battle_sprite = nil)
    if battle_sprite == nil
      bs = $scene.reedo_get_battle_sprite(reedo_battle_sprite_id)
    else
      bs = battle_sprite
    end
    return if bs == nil
    return if bs.reedo_bc_sprite.is_dead
    bs.reedo_bc_sprite.angle = REEDO_SBS::ACTOR_DEATH_ANGLE
    tone = REEDO_SBS::ACTOR_DEATH_TONE
    bs.reedo_bc_sprite.tone.set(tone[0], tone[1], tone[2], tone[3])
    bs.reedo_bc_sprite.character.opacity = REEDO_SBS::ACTOR_DEATH_OPACITY
    bs.reedo_bc_sprite.character.screen_x += REEDO_SBS::ACTOR_DEATH_OFFSET_X
    bs.reedo_bc_sprite.character.screen_y += REEDO_SBS::ACTOR_DEATH_OFFSET_Y
    bs.reedo_bc_sprite.shadow_sprite.x += REEDO_SBS::ACTOR_DEATH_SHADOW_OFFSET_X
    bs.reedo_bc_sprite.shadow_sprite.y += REEDO_SBS::ACTOR_DEATH_SHADOW_OFFSET_Y    
    bs.reedo_bc_sprite.is_dead = true
  end
  
  def reedo_set_live_state(battle_sprite = nil)
    if battle_sprite == nil
      bs = $scene.reedo_get_battle_sprite(reedo_battle_sprite_id)
    else
      bs = battle_sprite
    end
    return if bs == nil
    return if bs.reedo_bc_sprite.is_dead != true
    bs.reedo_bc_sprite.angle = 0
    bs.reedo_bc_sprite.tone.set(0, 0, 0, 0)
    bs.reedo_bc_sprite.character.opacity = 255
    bs.reedo_bc_sprite.character.screen_x -= REEDO_SBS::ACTOR_DEATH_OFFSET_X
    bs.reedo_bc_sprite.character.screen_y -= REEDO_SBS::ACTOR_DEATH_OFFSET_Y
    bs.reedo_bc_sprite.shadow_sprite.x -= REEDO_SBS::ACTOR_DEATH_SHADOW_OFFSET_X
    bs.reedo_bc_sprite.shadow_sprite.y -= REEDO_SBS::ACTOR_DEATH_SHADOW_OFFSET_Y
    bs.reedo_bc_sprite.is_dead = false
  end
end

class Game_Actor
  attr_accessor :reedo_battle_sprite_id
  attr_accessor :screen_x
  attr_accessor :screen_y
end

class Game_Actors
  def members
    return @data
  end
end

class Game_Troop
  def troop_id
    return @troop_id
  end
end

class Game_Character  
  alias reedo_sbs_gc_screen_x screen_x
  def screen_x
    if $scene.is_a?(Scene_Battle)
      return @battle_screen_x
    else
      return reedo_sbs_gc_screen_x
    end
  end

  alias reedo_sbs_gc_screen_y screen_y
  def screen_y
    if $scene.is_a?(Scene_Battle)
      return @battle_screen_y
    else
      return reedo_sbs_gc_screen_y
    end
  end
  
  def opacity=(value)
    @opacity = value
  end
  def screen_x=(value)
    @battle_screen_x = value
  end
  def screen_y=(value)
    @battle_screen_y = value
  end
  def step_anime
    return @step_anime
  end
  def step_anime=(value)
    @step_anime = value
  end
end

class Sprite_Base
  attr_accessor :reedo_victory_wait
end

class Sprite_Character
  attr_accessor :shadow_sprite
  attr_accessor :is_dead
  
  alias reedo_sbs_sc_dispose dispose
  def dispose
    @shadow_sprite.dispose if @shadow_sprite != nil
    reedo_sbs_sc_dispose
  end
  
  def create_shadow_sprite
    @shadow_sprite = Sprite_Base.new(self.viewport)
    bmp = Cache.picture(REEDO_SBS::ACTOR_SHADOW_CUSTOM_PICTURE) if REEDO_SBS::ACTOR_SHADOW_CUSTOM_PICTURE != nil
    bmp = Cache.system(REEDO_SBS::ACTOR_SHADOW_IMAGE) if bmp == nil
    @shadow_sprite.bitmap = bmp
    @shadow_sprite.src_rect = Rect.new(0, 0, bmp.width, bmp.height)
    @shadow_sprite.x = self.x - self.ox + REEDO_SBS::ACTOR_SHADOW_OFFSET_X
    @shadow_sprite.y = self.y - self.oy + REEDO_SBS::ACTOR_SHADOW_OFFSET_Y
    @shadow_sprite.z = self.z - 1
  end
  
  alias reedo_sbs_sc_update update
  def update
    reedo_sbs_sc_update
    @shadow_sprite.update if @shadow_sprite != nil
  end
end

class Sprite_Battler
  attr_accessor :reedo_bc_sprite

  alias reedo_sbs_sb_dispose dispose
  def dispose
    @reedo_bc_sprite.dispose if @reedo_bc_sprite != nil
    reedo_sbs_sb_dispose
  end
  
  alias reedo_sbs_sb_update update
  def update
    reedo_sbs_sb_update
    @reedo_bc_sprite.update if @reedo_bc_sprite != nil
  end
end

class Spriteset_Battle
  alias reedo_sbs_ssb_create_battlefloor create_battlefloor
  def create_battlefloor
    reedo_sbs_ssb_create_battlefloor
    @battlefloor_sprite.y = REEDO_SBS::BATTLE_FLOOR_TOP
  end
  
  alias reedo_sbs_ssb_create_actors create_actors
  def create_actors
    if @actor_sprites != nil
      dispose_actors
    end
    reedo_sbs_ssb_create_actors
    @reedo_start_points = {}
    @actor_sprites = []
    i = 1
    for actor in $game_party.members
      actor.reedo_battle_sprite_id = i - 1        
      gc = Game_Character.new
      gc.set_graphic(actor.character_name, actor.character_index)
      gc.set_direction(4)
      gc.screen_x = 0; gc.screen_y = 0
      bc = Sprite_Character.new(@viewport1, gc)
      gc.screen_x = REEDO_SBS::ACTOR_START_LINE +
                    ($data_classes[actor.class_id].position *
                    REEDO_SBS::ACTOR_CLASS_POS_STAGGER) +
                    ((i - 1) * REEDO_SBS::ACTOR_STAGGER_HORZ)
      gc.screen_y = REEDO_SBS::ACTOR_START_TOP + ((bc.height * i) +
                    (REEDO_SBS::ACTOR_STAGGER_VERT * i))
      actor.screen_x = gc.screen_x; actor.screen_y = gc.screen_y
      sb = Sprite_Battler.new(@viewport1, actor)
      sb.reedo_victory_wait = REEDO_SBS::VICTORY_DANCE_JUMP_HOVER
      sb.reedo_bc_sprite = bc
      gc.step_anime = actor.reedo_check_step_anime
      @reedo_start_points[sb] = [gc.screen_x, gc.screen_y]
      @actor_sprites.push(sb)  
      bc.update
      bc.create_shadow_sprite
      actor.reedo_reset_dead_set
      actor.reedo_update_life_state(sb)
      i += 1
    end
  end
  
  alias reedo_sbs_ssb_create_enemies create_enemies
  def create_enemies
    reedo_sbs_ssb_create_enemies
    for sprite in @enemy_sprites
      if REEDO_SBS::FLIP_ENEMY.include?(sprite.battler.enemy_id)
        sprite.mirror = true
      end
    end
  end
  
  def update_actors
    if $scene.is_a?(Scene_Battle)
      if $scene.victory_dance_time
        reedo_update_victory_dance
      end
    end    
    for sprite in @actor_sprites
      sprite.reedo_bc_sprite.character.update
      sprite.update
    end
  end
  
  def reedo_get_battle_sprite(sprite_id)
    return nil if !sprite_id.is_a?(Fixnum)
    return nil if sprite_id < 0
    return nil if sprite_id >= @actor_sprites.length
    return @actor_sprites[sprite_id]
  end
  
  def reedo_update_victory_dance
    if @victory_delta == nil
      @victory_delta = -REEDO_SBS::VICTORY_DANCE_JUMP_INCREMENT
      for sp in @actor_sprites
        sp.reedo_bc_sprite.character.step_anime = false
      end
    end
    for sp in @actor_sprites
      next if sp.battler.reedo_check_step_anime == false
      stpt = @reedo_start_points[sp]
      if sp.reedo_bc_sprite.character.screen_y < stpt[1] - REEDO_SBS::VICTORY_DANCE_JUMP_HEIGHT
        if sp.reedo_victory_wait <= 0
          @victory_delta = REEDO_SBS::VICTORY_DANCE_JUMP_INCREMENT
          sp.reedo_victory_wait = REEDO_SBS::VICTORY_DANCE_JUMP_WAIT
        else
          @victory_delta = 0
          sp.reedo_victory_wait -= 1
        end
      end
      if sp.reedo_bc_sprite.character.screen_y > stpt[1]
        if sp.reedo_victory_wait <= 0
          @victory_delta = -REEDO_SBS::VICTORY_DANCE_JUMP_INCREMENT
          sp.reedo_victory_wait = REEDO_SBS::VICTORY_DANCE_JUMP_HOVER
          sp.reedo_bc_sprite.character.step_anime = false
        else
          @victory_delta = 0
          sp.reedo_victory_wait -= 1
          sp.reedo_bc_sprite.character.step_anime = true if !sp.reedo_bc_sprite.character.step_anime
        end
      end
      if REEDO_SBS::VICTORY_DANCE_JUMP_TWIST
        if sp.reedo_bc_sprite.character.screen_y <= stpt[1]
          if (sp.reedo_bc_sprite.character.screen_y - stpt[1]) % (REEDO_SBS::VICTORY_DANCE_JUMP_HEIGHT / 4) == 0
            case sp.reedo_bc_sprite.character.direction
            when 4; sp.reedo_bc_sprite.character.set_direction(2)
            when 2; sp.reedo_bc_sprite.character.set_direction(6)
            when 6; sp.reedo_bc_sprite.character.set_direction(8)
            when 8; sp.reedo_bc_sprite.character.set_direction(4)
            end
          end
        else
          sp.reedo_bc_sprite.character.set_direction(4) if sp.reedo_bc_sprite.character.direction != 4
        end
      end
      sp.reedo_bc_sprite.character.screen_y += @victory_delta
      sp.battler.screen_y += @victory_delta
    end
  end
end

class Scene_Battle
  attr_reader :victory_dance_time
  
  alias reedo_sbs_sb_start start
  def start
    reedo_sbs_sb_start
    @current_party = $game_party.members
  end
  
  alias reedo_sbs_sb_terminate terminate
  def terminate
    reedo_teardown_actors
    reedo_sbs_sb_terminate
  end
  
  alias reedo_sbs_sb_update update
  def update
    if @current_party != $game_party.members
      @spriteset.create_actors
      @current_party = $game_party.members
    end
    reedo_sbs_sb_update
  end
  
  alias reedo_sbs_sb_execute_action_attack execute_action_attack
  def execute_action_attack
    reedo_do_execute_action("attack")
  end

  alias reedo_sbs_sb_execute_action_skill execute_action_skill
  def execute_action_skill
    reedo_do_execute_action("skill")
  end
  
  alias reedo_sbs_sb_execute_action_item execute_action_item
  def execute_action_item
    reedo_do_execute_action("item")
  end
  
  alias reedo_sbs_sb_process_victory process_victory
  def process_victory
    @victory_dance_time = true
    reedo_sbs_sb_process_victory
  end
  
  def reedo_get_battle_sprite(sprite_id)
    return @spriteset.reedo_get_battle_sprite(sprite_id)
  end
  
  def reedo_teardown_actors
    for actor in $game_actors.members
      actor.reedo_battle_sprite_id = nil if actor != nil
    end
  end
  
  def reedo_do_execute_action(action_method)
    targets = @active_battler.action.make_targets
    if @active_battler.is_a?(Game_Actor)
      reedo_actor_step_in
      if REEDO_SBS::SBS_ACTION_ANIMES
        targets.each do |t|
          if t.is_a?(Game_Actor)
            bs = reedo_get_battle_sprite(t.reedo_battle_sprite_id)
            bs.reedo_bc_sprite.character.animation_id = eval("reedo_get_" + action_method + "_animation") if bs != nil
          end
        end
      end
      eval("reedo_sbs_sb_execute_action_" + action_method)
      reedo_actor_step_back
    else
      if REEDO_SBS::SBS_ACTION_ANIMES
        targets.each do |t|
          if t.is_a?(Game_Actor)
            bs = reedo_get_battle_sprite(t.reedo_battle_sprite_id)
            bs.reedo_bc_sprite.character.animation_id = eval("reedo_get_" + action_method + "_animation") if bs != nil
          end
        end
      end
      eval("reedo_sbs_sb_execute_action_" + action_method)
    end
  end
  
  def reedo_get_attack_animation
    return REEDO_SBS::SBS_DEFAULT_ATTACK_ANIME
  end
  
  def reedo_get_skill_animation
    skill = $data_skills[@active_battler.action.skill_id]
    aid = REEDO_SBS::SBS_DEFAULT_SKILL_ANIME
    aid = skill.animation_id if skill.animation_id > 0    
    return aid
  end

  def reedo_get_item_animation
    item = $data_items[@active_battler.action.item_id]
    aid = REEDO_SBS::SBS_DEFAULT_ITEM_ANIME
    aid = item.animation_id if item.animation_id > 0    
    return aid
  end
  
  def reedo_actor_step_in
    delta = 0
    dr = REEDO_SBS::ACTOR_STEP_IN_RATE
    while delta < REEDO_SBS::ACTOR_STEP_IN_DISTANCE
      bs = reedo_get_battle_sprite(@active_battler.reedo_battle_sprite_id)
      return if bs == nil
      bs.reedo_bc_sprite.shadow_sprite.x -= dr
      bs.reedo_bc_sprite.character.screen_x -= dr
      bs.battler.screen_x -= dr
      Graphics.update
      @spriteset.update
      delta += dr
    end
  end
  
  def reedo_actor_step_back
    delta = 0
    dr = REEDO_SBS::ACTOR_STEP_IN_RATE
    while delta < REEDO_SBS::ACTOR_STEP_IN_DISTANCE
      bs = reedo_get_battle_sprite(@active_battler.reedo_battle_sprite_id)
      return if bs == nil
      bs.reedo_bc_sprite.shadow_sprite.x += dr
      bs.reedo_bc_sprite.character.screen_x += dr
      bs.battler.screen_x += dr
      Graphics.update
      @spriteset.update
      delta += dr
    end
  end
end

Victory Splash & Wait - RSSBS-YEZ Victory Aftermath Enhancement

This enhancement script provides a victory "scene" before the YEZ Victory Aftermath scene is shown. During this wait, a victory splash image can be shown and an additional sound effect can be played. This wait gives the player a chance to view the actor's victory dance. The player presses "C" or "A" to continue to the YEZ Victory Aftermath.

Script
This is the complete script.

Spoiler:

CODE

###############################################################################
##  Victory Splash & Wait
##  RSSBS-YEZ Victory Aftermath Enhancement
##  Version 1.0
##  January 5, 2010
##  By Reedo
###############################################################################
##  SOURCE
##
##  Source thread:
##
##
##  Support thread:
##    http://www.rpgmakervx.net/index.php?showtopic=24587
###############################################################################
##  REFERENCES
##
##  None.  This is an original script by Reedo.
##  However other people have contributed ideas and bug finds. Please see the
##  support thread link above for details.
###############################################################################
##  DESCRIPTION
##
##  This script adds a delay between the victory in battle, and the display of
##  the YEZ Victory Aftermath scene. This gives the player a chance to view
##  your SBS victory dance, before going into the Aftermath. The player will
##  need to press A or C to continue to the aftermath. During this wait, you
##  may display a victory splash graphic to the user and play a sound effect.
##  If a victory splash image is used, it will start at 1% of its original
##  size and zoom out to 100% before the wait delay begins.
###############################################################################
##  COMPATIBILITY
##
##  Compatible with RSSBS and YEZ.  
##  Should be compatible with other YEZ-compatible scripts.
###############################################################################
##  REQUIREMENTS
##
##  YEZ Victory Aftermath (and any subsequent required scripts)
##  Reedo's Simple SBS
###############################################################################
##  INSTALLATION
##
##  Plug-and-play, however, the victory splash image must be added if used.
##
##  Insert below Simple SBS.
###############################################################################
##  RIGHTS & RESTRICTIONS
##
##  As with most Reedo scripts, this script is free to re-use, as-is,
##  in personal, educational, and commercial RPGVX development projects,
##  providing that:  this script, as well as the rpgmakervx.net forum link  
##  from which it was obtained, are credited in writing displayed readily
##  to the user of the final compiled code assembly.
##
##  Reedo and rgpmakervx.net retain all rights of intellect and ownership.
##  You forego all rights of warranty by utilizing this script.
###############################################################################
##  USAGE
##
##  Add a victory splash image to resources/pictures if you want to use a
##  splash image during victory wait.
##
##  Some options can be modified below.
###############################################################################

###############################################################################
##  USER OPTIONS
###############################################################################
module REEDO_SSBS_VEX
  # This value sets a picture to show during victory. This picture will initially
  # be displayed at 1% of it's original size.  It will then zoom in at the
  # increment specified below, until it has reached 100% of its original size.
  VICTORY_SPLASH_IMAGE = "Victory"
  
  # This is the amount by which the victory splash image will zoom in on each
  # frame, after intially being displayed, until it has reached 100%.
  VICTORY_SPLASH_ZOOM_RATE = 0.02  # Zoom increases by 2% per frame
  
  # This is a sound effect played in conjunciton with showing the splash image.
  VICTORY_SPLASH_SE = RPG::SE.new("Flash2")
  
  # This is the number of frames to wait, after a splash image has finished
  # displaying, before the user can press C or A to advance to the Aftermath.
  VICTORY_SPLASH_WAIT = 30
  
  # By default, this script will start the normal battle end ME and map music
  # transition when the victory wait begins. Set to false if you are controlling
  # the battle music by some other method
  PLAY_VICTORY_MUSIC = true
  
  # By default, this script will set the YEZ Victory Aftermath BYPASS_BGM_SWITCH
  # to true, to prevent that script from replaying the victory music. Set to true
  # to disable this feature.
  DISBLE_YEZ_MUSIC_BYPASS = false
end

class Scene_Battle
  alias reedo_sbsvex_sb_terminate terminate
  def terminate
    @reedo_vex_sprite.dispose if @reedo_vex_sprite != nil
    @reedo_vex_sprite = nil
    reedo_sbsvex_sb_terminate
  end
  
  alias reedo_sbsvex_sb_update update
  def update
    if @reedo_in_victory_ex == true
      super
      update_basic(true)
      update_info_viewport  
      reedo_update_victory_ex
    else
      reedo_sbsvex_sb_update
    end
  end
  
  alias reedo_sbsvex_sb_process_victory process_victory
  def process_victory
    if @reedo_in_victory_ex != true
      @victory_dance_time = true
      reedo_process_victory_ex
    end
  end  
  
  def reedo_process_victory_ex
    @info_viewport.visible = false
    if REEDO_SSBS_VEX::PLAY_VICTORY_MUSIC
      RPG::BGM.stop
      $game_system.battle_end_me.play
    end
    @reedo_in_victory_ex = true
  end
  
  def reedo_update_victory_ex
    if @reedo_vex_sprite == nil
      reedo_create_vex_sprite
      @reedo_vex_wait = REEDO_SSBS_VEX::VICTORY_SPLASH_WAIT
      REEDO_SSBS_VEX::VICTORY_SPLASH_SE.play if REEDO_SSBS_VEX::VICTORY_SPLASH_SE.is_a?(RPG::SE)
      unless $BTEST
        $game_temp.map_bgm.play
        $game_temp.map_bgs.play
      end
    end
    @reedo_vex_sprite.update
    if @reedo_vex_sprite.zoom_x >= 1.0
      if @reedo_vex_wait <= 0
        if Input.trigger?(Input::C) || Input.trigger?(Input::A)
          @reedo_vex_sprite.visible = false
          @reedo_in_victory_ex = false
          if REEDO_SSBS_VEX::DISBLE_YEZ_MUSIC_BYPASS != true
            yez_switch_cache = $game_switches[YEZ::VICTORY::BYPASS_BGM_SWITCH]
            $game_switches[YEZ::VICTORY::BYPASS_BGM_SWITCH] = true
          end
          reedo_sbsvex_sb_process_victory
          if REEDO_SSBS_VEX::DISBLE_YEZ_MUSIC_BYPASS != true
            $game_switches[YEZ::VICTORY::BYPASS_BGM_SWITCH] = yez_switch_cache
          end
        end
      end
      @reedo_vex_wait -= 1
    else
    @reedo_vex_sprite.zoom_x += REEDO_SSBS_VEX::VICTORY_SPLASH_ZOOM_RATE
    @reedo_vex_sprite.zoom_y = @reedo_vex_sprite.zoom_x      
    end
  end
  
  def reedo_create_vex_sprite
    vp = Viewport.new(0, 0, 544, 416)
    vp.z = 1000
    sp = Sprite_Base.new(vp)
    if REEDO_SSBS_VEX::VICTORY_SPLASH_IMAGE != nil
      sp.bitmap = Cache.picture(REEDO_SSBS_VEX::VICTORY_SPLASH_IMAGE)
      sp.src_rect = Rect.new(0, 0, sp.bitmap.width, sp.bitmap.height)
      sp.ox = sp.width / 2
      sp.oy = sp.height / 2
      sp.x = vp.rect.width / 2
      sp.y = vp.rect.height / 2
      sp.zoom_x = 0.01
      sp.zoom_y = sp.zoom_x
      sp.visible = true
    end
    @reedo_vex_sprite = sp
  end
end

Summary
With this script, your game actors will appear on screen during battle. They will step forward to perform an action, and action animations will be provided for both actors and enemies.

If you have any problems with this script, please view the support post, post a question in the language support forum, or PM me and I will try to help if I can.

As always, comments and suggestions are welcome.

This post has been edited by Reedo: Jan 8 2010, 05:06 AM

Attached File(s)

 RSSBS_Demo.zip ( 253.04K ) Number of downloads: 928
 DemoYEZ_with_RSSBS.zip ( 1.18MB ) Number of downloads: 1613

 

[YokoJR]

Nice,but idea taken?
How long did it take you?

[Sofresh85]

This is an awesome Script, you know what would be sweet is if you can make the actors have different poses rather than making them the default walking position, maybe grab a portion from tankentai to use multiple charsets or maybe even instead of having the default 3x4 actor graphic, use a 3x12 or something allowing to use a particular setup of those graphics. all in all this is an awesome script, keep up the great work reedo.

[ZeroManArmy]

This is great for people who dont understand the other SBS. How easy is it than the other one? On a scale of 1/10?

[eggrollninja]

I'd say 10/10 since its literally plug and play (Reedo was aiming for this I think)

Great stuff Reedo xD

Can't wait for any add-ons that may come with this ^^

[mithos]

This looks good. I'll have to try this later. now we just need to convince noobs to use this rather than tankentai

[Shanghai]

This looks good. I'll have to try this later. now we just need to convince noobs to use this rather than tankentai

And it'll be better that they use this because it's way easier to set up. The problem is just whether or not they'll listen.

Great job, Reedo! Looking forward to those extra enhancements later along the road

[Reedo]

Thanks for the comments so far everyone.

@YokoJR:
I started this script on Dec 28th, and the last update was the 5th, so I guess about a week (though I did not work on it every day - I probably have about eight or ten hours in the actual coding, and probably another six to eight in testing).

@Sofresh85:
I do plan to do an enhancement script for advanced actor graphics, move routes, and victory dances. I'm not yet sure if this will just be a movement-enhancement script, or part of a larger "Lunatic Enhancement Script". Also, Yanfly has hinted that she has plans for advanced actor graphics as well, so I will likely wait to see what her script(s) do before I implement too much in the way of actor graphic enhancements (however, I will likely still start work on the movement enhancements as YEZ will not be supplying any of that functionality, AFAIK.).
Other planned expansions include: Enemy Size Scaling and Automatic Troop Positioning.

@ZeroManArmy:
Not sure which "other one" you're referring to - if you mean the beta RSSBS, then they are very similar (in fact, this is the same script as Beta 8 REV "B"), so yeah, I would say it has to be a 9/10 or 10/10 for ease of use. Really the only thing you have to do after dropping this script into a fresh project is reposition the enemies in the troops (and I'm working on eliminating that step as well! )

@mithos, Shanghai:
I hope that with enough expansion options, this script will be the most enticing for newbies due to ease of setup and compatibility. We'll just have to see what happens... I suppose when questions about the other SBS arise, and they obviously don't make a lot of sense, the answer we see most may be "Just use RSSBS and you'll be fine".

Again, thanks to everyone for the comments.

In addition to the expansion scripts, I will also be doing a tutorial on how to create a SBS along the lines of this one. My hope is that people who really want a custom experience can use the tutorial, this "Default" SSBS, and any enhancement scripts as a basis for creating whatever custom SBS their game design requires. That way there can be a generic repository of basic expansions, but enough information for anyone familiar with basic RGSS2 to create their own specific SBS for each game as needed.

The SBS is probably one of the most critical upgrades for RPG Maker VX; and its seems obvious to me that Enterbrain didn't include their own implementation of the SBS because they simply included all the hooks you need to add that functionality just the way you want it. I think all that's really missing in the community, is a decent explaination of how to do that.

[piejamas]

I think it's best to keep the script as it is instead of adding stuff, the main goal in the first place was to reduce the amount of config after all :/

If you want a feature-packed SBS, you can use Tankentai

[Reedo]

I think it's best to keep the script as it is instead of adding stuff, the main goal in the first place was to reduce the amount of config after all :/

If you want a feature-packed SBS, you can use Tankentai

As I've mentioned, the core SBS code will stay as-is, barring any required fixes which may arise in the future (of course).

Any enchancements will be secondary, optional scripts. Enchancement scripts will have to be installed independantly of the RSSBS. I addition to my own enhancements, I encourage others to write enhancement expansions as well. Just PM me with a link to your expansion, I'll review it for compatibility, and then link to it in the main post if everything checks out ok.

You are absolutely right piejamas, the whole purpose was to create a simple SBS, so the main script will stay as just that.

[NAT_Designer]

This Coupled together with Yanfly's YEZ Battle system is a great combination! The fact that this requires no work to be done in order for it to be used unlike Takentai really appeals to those who use scripts that interfere with Takentai. Two thumbs up.

[OriginalWij]

Very nice!
A good alternative for Tankentai ...
Keep up the good work!

... and I agree this is perfect for the newcomer who wants sideview but doesn't need all the bells and whistles (and headaches) of Tankentai ...

[Mon Dez]

This is a good battle system it's easy to use and practically plug n play, I might use this for a project redo I'm doing.

[YokoJR]

Lets Just hope this side veiw is compatable xP

[NAT_Designer]

@YokoJR: The battle script is especially easy to place with most other scripts. It doesn't rewrite most of the functions that Takentai does, so it can be used with much much more scripts than Takentai.

[Lost Wolf]

This looks really nice. Great job on this. Maybe I can convince my friend to use this instead of the pther side view battle systems scripts.

[Riokogen]

Awesome script Reedo!

[Minyel]

Wow, this battle system is great.
Just wondering but is there any plans for a animated enemies script for this?
The main reason I chose this script (not the only reason) was that it was compatible with YERD and was smooth.
So far its great!

This post has been edited by Minyel: Jan 8 2010, 04:47 AM

[Reedo]

Wow, thanks everyone! I'm glad to see so many of you are as happy with this little script as I am.

I hope to start working on announced expansions over the weekend.

As for the actor animations, yes, that is a planned expansion, however (see post #8) I won't be doing that script right away.
-EDIT-
Sorry, just re-read your post... animated enemies... well, chances are, whatever happens will affect Battlers in general, so my guess would be "yes", animated enemies will be supported as well as animated actors.

Keep in mind though that the RSSBS was intended to be scalable, so someone else could script the additional feature if you don't want to wait for the YEZ-Reedo solution.



This post has been edited by Reedo: Jan 8 2010, 05:01 AM

[ZeroManArmy]

When I said the other one I meant TSBS. Translated by Mr. Bubble

Also congrats!

I do admit having made some of those script updates to add a bit more flexibility for a sideview battle script that Reedo-san from RPGMakerVX.net is making. Check it out and give him some support~ I’m not only interested in it because it’s compatible with YEZ, but rather, the fact that it’s nearly compatible with everything that doesn’t outright overwrite the battle scene. Good job there!

getting complimented by a genius!