Chaos Project

RPG Maker => RPG Maker Scripts => RMXP Script Database => Topic started by: ForeverZer0 on May 14, 2011, 01:20:30 pm

Title: [XP] Enhanced Item Description
Post by: ForeverZer0 on May 14, 2011, 01:20:30 pm
Enhanced Item Description
Authors: ForeverZer0
Version: 1.0
Type: Menu Add-on
Key Term: Menu Add-on



Introduction

This is a small script I wrote when I got started scripting, but never released. I found it going through some old projects, but I'm sure someone else can make use of it. What it does is allows you to use the same shortcuts commands you can in a "Show Text..." command, but within the descriptions for Items, Weapons, and Armors. For example, if you wanted the description to include the value of a variable, in the database where you right the descriptions, just use "\v[VAR_ID]", and the command will be replaced with the actual value of the variable during the game.


Features




Screenshots

Name character whatever you want: ShowHide
(http://dl.dropbox.com/u/20787370/Scripts/Enhanced%20Item%20Description/EnhancedDesc1.png)

Use command in the description: ShowHide
(http://dl.dropbox.com/u/20787370/Scripts/Enhanced%20Item%20Description/EnhancedDesc2.png)

Description remains correct: ShowHide
(http://dl.dropbox.com/u/20787370/Scripts/Enhanced%20Item%20Description/EnhancedDesc3.png)



Demo

None.


Script

Here lies the script.
Spoiler: ShowHide

#=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
# Enhanced Item Description
# Author: ForeverZer0
# Version: 1.0
# Date: 5.14.2011
#=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=
#
# Introduction:
#   This is a small, very basic script I wrote a while back, but never released.
#   It allows for you to use the same type of commands you can use in event
#   "Show Message" commands, but within the descriptions of Weapons, Armors, and
#   Items. Review the commands below, they will be substituted in the actual
#   text to display the respective value.
#
# Commands:
#   \v[ID]  = Replaces with value of game variable with ID
#   \n[ID]  = Replaces with name of actor that has ID
#   \sw[ID] = Replaces with value of switch withg ID  (ON/OFF)
#   \g      = Replaces with amount of gold party has
#   \st     = Replaces with step count
#
# Author's Notes:
#   I can add more at request. Only values that are global to the RTP scripts
#   and cannot be easily accessed will be added to the script, though I can
#   still give someone a one line of code they can add themselves for custom
#   commands.
#
#=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=+=

module RPG
 
  def self.substitute_text(message)
    text = message.clone
    text.gsub!(/\\[Vv]\[([0-9]+)\]/) { $game_variables[$1.to_i] }
    text.gsub!(/\\[Nn]\[([0-9]+)\]/) {
        $game_actors[$1.to_i] != nil ? $game_actors[$1.to_i].name : '' }
    text.gsub!(/\\[Gg]/) { $game_party.gold }
    text.gsub!(/\\[Ss][Tt]/) { $game_party.steps }
    text.gsub!(/\\[Ss][Ww]\[([0-9]+)\]/) {
      $game_switches[$1.to_i] ? 'ON' : 'OFF' }
    return text
  end
 
  class Weapon
    def description
      return RPG.substitute_text(@description)
    end
  end
 
  class Armor
    def description
      return RPG.substitute_text(@description)
    end
  end
 
  class Item
    def description
      return RPG.substitute_text(@description)
    end
  end
end



Instructions

Place script anywhere above "Main".
Use the following commands in the database when making descriptions:



Compatibility

Compatible with practically everything.


Credits and Thanks




Author's Notes

If you would like a custom command, feel free to ask. 
Please report any bugs/issues you encounter so that they may be resolved.
Title: Re: [XP] Enhanced Item Description
Post by: Blizzard on May 14, 2011, 01:43:34 pm
Lol, why didn't you post it in the database right away? xD
Title: Re: [XP] Enhanced Item Description
Post by: G_G on May 14, 2011, 01:57:46 pm
He's not a moderator of this board.

*moves*

Quick note, you could give any text "\" commands by simply aliasing the Bitmap.draw_text method. Scripters could even use it then when writing code.
Title: Re: [XP] Enhanced Item Description
Post by: Blizzard on May 14, 2011, 02:07:58 pm
*fixes behind G_G's back* But he is!
Title: Re: [XP] Enhanced Item Description
Post by: ForeverZer0 on May 14, 2011, 03:01:44 pm
lol, thanks.

"I FEEL THE POWER!"

@GG: i didn't think of that. You are a ninja.  :ninja:
Title: Re: [XP] Enhanced Item Description
Post by: Jragyn on May 15, 2011, 12:06:01 pm
Quote..., in the database where you write the descriptions,...


:D I like.
Title: Re: [XP] Enhanced Item Description
Post by: brewmeister on May 16, 2011, 03:17:02 pm
Quote from: Sub-Zero on May 14, 2011, 01:57:46 pm
Quick note, you could give any text "\" commands by simply aliasing the Bitmap.draw_text method. Scripters could even use it then when writing code.


Kinda like this....   http://www.hbgames.org/forums/viewtopic.php?f=11&t=74073    ;)  ;)

I started out the same way, then realized... "Everything uses Bitmap.draw_text, why not modify that!!"


Either way, great enhancement! Lot's of people have requested it.

Be Well
Title: Re: [XP] Enhanced Item Description
Post by: XaineC on May 28, 2011, 08:59:57 pm
Really great. Could you possibly make this work with skills as well?
Title: Re: [XP] Enhanced Item Description
Post by: G_G on May 28, 2011, 09:43:41 pm
Add this right below his script.
module RPG
  class Skill
    def description
      return RPG.substitute_text(@description)
    end
  end
end
Title: Re: [XP] Enhanced Item Description
Post by: XaineC on May 29, 2011, 10:16:43 am
Great! Thanks