Gold Display Add-Ons

[Mister C Major]

Gold Display Add-Ons
by Mister C Major
Apr 30 2007

This is a locked, single-post thread from Creation Asylum. Archived here to prevent its loss.
No support is given. If you are the owner of the thread, please contact administration.

Hi Everyone,
I thought it time that I share a lot of my Custom Scripts and RMXP Script Edits so that it may benefit the Creation Asylum Online Community since the community has helped me so much with many of my own problems. Please look forward to a lot of simple and advanced scripts from yours truly, hope you enjoy!

This script was made for the sole purpose of customization, a simple block of code made to make your game different from everyone else's. This code affects the Visuals within your Window in Scene_Menu which displays the Gold your Party currently has.

This script will have examples of the function "sprintf" which is used to add in commas separating every 3 digits, for example, "123,456,789," will show you how to make a unique scrolling effect shown in a few games, "Harvest Moon: A Wonderful Life" being the only one I can think of at this moment, where your Gold Scrolls from 0 to 1, 2, 3, ..., 999999999, and will have a few other basic ideas regarding bitmaps and text coloring explained in other areas of the community.

Before each method, I provide a small definition to what will be happening within the method, please scroll to the bottom for a full explanation.

Gold Window Add-Ons Script

Code:

#==============================
# Class Window_Gold
#   This Class handles the gold window
#==============================
class Window_Gold < Window_Base
#------------------------------------------------------------
# Method initialize
#   Basic Window Initialization plus the definition of @gold and @temp_gold.
#     @gold - Displays the Party Gold Amount
#     @gold_temp - Used for the Scrolling of the Gold Amount from zero to @gold
#     @ones-@millions - variables used to represent the @gold digits used in the update method
#------------------------------------------------------------
  def initialize
    @gold = $game_party.gold
    @gold_temp = 0
    @ones = @gold %10
    @tens = @gold %100 / 10
    @hundreds = @gold % 1000 / 100
    @thousands = @gold % 10000 / 1000
    @ten_thousands = @gold % 100000 / 10000
    @hundred_thousands = @gold % 1000000 / 100000
    @millions = @gold % 10000000 / 1000000
    super(0, 0, 160, 76)    #Can be edited
    self.contents = Bitmap.new(width - 32, height - 32)
    self.contents.font.name = $defaultfontface    #Can be edited
    self.contents.font.size = $defaultfontsize    #Can be edited
    refresh
  end
#------------------------------------------------------------
# Method initialize End
#------------------------------------------------------------
#------------------------------------------------------------
# Method refresh
#   Draws all the window content
#     millions, thousands, hundreds, used to divide @temp_gold to the three variables respectively
#     Depending if @gold_temp contains digits in the million, or the thousands,
#       @temp_gold is drawn with the respective commas
#------------------------------------------------------------
  def refresh
    self.contents.clear
    millions = @gold_temp / 1000000
    thousands = @gold_temp % 1000000 / 1000
    hundreds = @gold_temp % 1000
    if @gold_temp >= 1000000
      gold_text = sprintf("%d,%03d,%03d", millions, thousands, hundreds)
    elsif @gold_temp >= 1000
      gold_text = sprintf("%d,%03d", thousands, hundreds)
    else
      gold_text = sprintf("%d", hundreds)
    end
    self.contents.font.color = normal_color#Can be edited
    self.contents.draw_text(0, 16, 120, 32, gold_text, 2)#Can be edited
    self.contents.font.color = system_color#Can be edited
    self.contents.draw_text(32 + 4, 2, 120, 20, $data_system.words.gold, 0)#Can be edited
    bitmap = RPG::Cache.icon("Gold")#Can be edited
    self.contents.blt(0, 0, bitmap, Rect.new(0, 0, 24, 24), 255)
  end
#------------------------------------------------------------
# Method refresh end
#------------------------------------------------------------
#------------------------------------------------------------
# Method update
#   Handles the "Scrolling" Add-on
#     @gold and @gold_temp are first divided up by digits.  
#       For each of the digits, if the @temp_gold digit does not equal the @gold digit,
#         the @gold_temp digit is increased by 1.
#           The digit checks halt and the window is then redrawn.
#             This repeats until all @gold digits equal all @gold_temp digits
#------------------------------------------------------------
  def update
    ones_temp = @gold_temp %10
    tens_temp = @gold_temp %100 / 10
    hundreds_temp = @gold_temp % 1000 / 100
    thousands_temp = @gold_temp % 10000 / 1000
    ten_thousands_temp = @gold_temp % 100000 / 10000
    hundred_thousands_temp = @gold_temp % 1000000 / 100000
    millions_temp = @gold_temp % 10000000 / 1000000
    if ones_temp != @ones
      @gold_temp += 1
      refresh
      return
    end
    if tens_temp != @tens
      @gold_temp += 10
      refresh
      return
    end
    if hundreds_temp != @hundreds
      @gold_temp += 100
      refresh
      return
    end
    if thousands_temp != @thousands
      @gold_temp += 1000
      refresh
      return
    end
    if ten_thousands_temp != @ten_thousands
      @gold_temp += 10000
      refresh
      return
    end
    if hundred_thousands_temp != @hundred_thousands
      @gold_temp += 100000
      refresh
      return
    end
    if millions_temp != @millions
      @gold_temp += 1000000
      refresh
      return
    end
  end
end
#------------------------------------------------------------
# Method update End
#------------------------------------------------------------
#==============================
# Class Window_Gold End
#==============================

Code Basics
This Window (as its original purpose) is supposed to be used in conjuntion with the Scene_Menu Class where it is not only created, but handled as well.
Within the Scene_Menu Class, it is created at

line 42:

Code:

@gold_window = Window_Gold.new

edited at,

line 43-44:

Code:

@gold_window.x = 0
@gold_window.y = 416

and has its update method called at,

line 85:

Code:

@gold_window.update

Code Explanation
As you activate The Menu Scene, Window_Gold is initialized and method refresh is called,

Code:

def initialize
  @gold = $game_party.gold
  @gold_temp = 0
  @ones = @gold %10
  @tens = @gold %100 / 10
  @hundreds = @gold % 1000 / 100
  @thousands = @gold % 10000 / 1000
  @ten_thousands = @gold % 100000 / 10000
  @hundred_thousands = @gold % 1000000 / 100000
  @millions = @gold % 10000000 / 1000000
  super(0, 0, 160, 76)    #Can be edited
  self.contents = Bitmap.new(width - 32, height - 32)
  self.contents.font.name = $defaultfontface    #Can be edited
  self.contents.font.size = $defaultfontsize    #Can be edited
  refresh
end

The refresh method can be broken down into two seperate purposes, drawing the gold string and drawing the gold bitmap.

Gold String

Code:

millions = @gold_temp / 1000000
  thousands = @gold_temp % 1000000 / 1000
  hundreds = @gold_temp % 1000
  if @gold_temp >= 1000000
    gold_text = sprintf("%d,%03d,%03d", millions, thousands, hundreds)
  elsif @gold_temp >= 1000
    gold_text = sprintf("%d,%03d", thousands, hundreds)
  else
    gold_text = sprintf("%d", hundreds)
  end
  self.contents.font.color = normal_color#Can be edited
  self.contents.draw_text(0, 16, 120, 32, gold_text, 2)#Can be edited
  self.contents.font.color = system_color#Can be edited
  self.contents.draw_text(32 + 4, 2, 120, 20, $data_system.words.gold, 0)#Can be edited

Gold Bitmap

Code:

bitmap = RPG::Cache.icon("Gold")#Can be edited
  self.contents.blt(0, 0, bitmap, Rect.new(0, 0, 24, 24), 255)

First I'll explain the Gold String. To be able to have some more control over the String, (in this case to put commas in between every 3 digits) I needed to break down every 3 digits, i do so by creating the millions, thousands, and hundreds variables.

Code:

millions = @gold_temp / 1000000
  thousands = @gold_temp % 1000000 / 1000
  hundreds = @gold_temp % 1000

I then use the function "sprintf" to put the variables in the shape and order I want them.

Code:

if @gold_temp >= 1000000
    gold_text = sprintf("%d,%03d,%03d", millions, thousands, hundreds)
  elsif @gold_temp >= 1000
    gold_text = sprintf("%d,%03d", thousands, hundreds)
  else
    gold_text = sprintf("%d", hundreds)
  end

If @gold_temp (the string i'm trying to print) is at least one million, I tell gold_text to equal a number millions, thousands with 3 zeros, and hundreds with 3 zeros. Note, if millions = 987, thousands = 654, and hundreds = 321, gold_text would equal "987,654,321". Now note, if the line rather read,

Code:

gold_text = sprinf{"%d,%d,%d", millions, thousands, hundreds}

and if million = 9, thousands = 87, and hundreds = 65, we would get gold_text ="9, 87, 65", instead of the desired "9,087,065". The same procedures are followed if @gold_temp is less then one million, but at least one thousand; however, note we are no longer accounting for the millions, and the same thing applies if @gold_temp is less then a thousand, only the hundreds are accounted for.

The Gold Bitmap is a standard function called block transfer or blt for short. It takes the file titled (in my case "Gold") from the Icon file of my RMXP game project, places the file at the coordinate (0,0) and copies the cells located at the coordinate (0,0) on the specified file, with a width and height of 24 x 24, with an opacity of 255 and pastes it on the window

The "update" Method

The update Method is called many times a second by the update method of Scene_Menu. Every time update is called, all the @gold_temp variables representing the digits get redefined, then starting in the ones place, the script checks to see if the @gold_temp ones digit equals the @gold ones digit, if so, the script moves on to the next digit until. If the digits do not equal, the @gold_temp digit gets incremented by one, and the window is refreshed to show the change just made. The update method is also returned, to prevent the program from moving onto the next digit. Once all of the @gold_temp digits equal the @gold digits, the script has finished.

Compatability
As long as no code you currently have omits the lines,

Code:

@gold_window = Window_Gold.new
  @gold_window.update

within the Scene_Menu Class, as well as completely changing the required parameters of the Window_Base.initialize method (which I dont see why anyone would) this code should face no problems since it relies on variables only found within its own class.

Thanks for reading, if you have any questions or comments (particularly how I can organize my posts to help you read/learn my script better) please feel free to let me know, and sorry for writing so much out of a very basic script. Happy Coding everyone ^^