Final Day

My original project for NaGaDeMo is no where near finished. It might have had a chance if Volrath and ArtBane hadn’t roped me in to coding their new project, code named Noir [1] [2].

I might return to the project I was working on at some point but to be completely honest I’d burnt out on it when ArtBane asked me about scripting for Noir so if it hadn’t been Noir it would have been some other reason why I wasn’t going to finish it.

Despite all that I still want to finish a game for NaGaDeMo. I present to you RPG Makers Offline… Except there’s nothing I could screenshot to show it off. So far over the past two days I’ve spent probably 6 hours on it and so far I have the following things coded:

  • Mouse Movement
  • Keyboard detection
  • The hud

So clearly I’ve got a long way to go…

The time now is 11:00 I want to finish at 00:00 so I’ve got 13 hours to go, wish me luck.

2
  

Keyboard Module

By Fomar0153
Last Updated: 23 June 2012 (Version 1.0)
Download Link: http://pastebin.com/Q6Y1tW2z

Yet another Keyboard module to suit your needs.

3
  

Resource Staff Release May 2012

So I’m part of the Resource Staff at RPG Maker Web now and we’ve just released May’s resources, check it out at:

http://blog.rpgmakerweb.com/resources/restaff-release-05-12/

My contribution was a front view battle system:

Now you can easily show off Thalzon’s awesome battlers. If you have any questions or need support with the script please feel free to ask.

So once again check out May’s resources plenty of amazing stuff in there.

6
  

Sprite Based Side View Battle System


By Fomar0153
Last Updated: 04 June 2012 (Version 1.0)
Download Link: http://pastebin.com/raw.php?i=gr0ap0Ua

Basically my Basic Side View Battle System but without the need to cut out sprites.

9
  

Cook Skill

By Fomar0153
Last Updated: 03 June 2012 (Version 1.0)
Download Link: http://pastebin.com/raw.php?i=Ptm5eXbR

Allows you to create a skill which “cooks” the enemy. In reality what this does is check if the enemy is below a certain health percentage, if so it kills them and causes them to drop an item you set to drop.

What you do with the item is up to you, maybe use it in a cooking recipe?

4
  

Counter Attack Skills


By Fomar0153
Last Updated: 16 May 2012 (Version 1.0)
Download Link: http://pastebin.com/raw.php?i=nngAvumw

Allows you to set a skill to be used when countering, skills that target allies will work correctly, though single target skills with be used on the character countering.

3
  

Region Map Loader


By Fomar0153
Last Updated: 06 May 2012 (Version 1.0)
Download Link: http://pastebin.com/raw.php?i=rk4LMF66

This script allows you to load sections of your map (defined by regions) from another map and control it with switches. My main use for this is that I wanted player actions to affect their home town.

Anyhow this is how to set it up. First you need to notetag the Map the format is:
<regionmap regiondid,mapid,switchid> and you can include additional region maps by separating them with a semi-colon e.g.
<regionmap 1,2,1;2,2,2>
mapid refers to the map you’re copying from.

Next you need to make your map:

A couple of points, this script doesn’t copy events so they will need to on this map, I have them show up using the same switch as the region map. Next you need to set up the regions for the script to use.

Remember to put the region where the shadows go as well. Next copy the map and make whatever changes you want to the areas (this can be done multiple times e.g. if you wanted a plot of land to have two potential outcomes). Then make your edits.

Then in game turn the switch on. If you do this when you are on the map you will need to call:
$game_map.refresh
Anyway have fun!

5
  

Custom Formulae and Scripts

So I have been talked into following up my last tutorial with another one. This one will be expanding on the previous one by going in to building upon the default scripts. First I want to talk about why you would do this and then go through a few worked examples.

One reason you might want to extend the default scripts for a formula could be the case that what you want to achieve doesn’t fit in the custom formula box. This is pretty easy to accomplish. Next up, you want to build in a default formula. I know that you can just use the same formula in every skill but I personally consider that bad practice. What if you discover your formula doesn’t act as you intended later in the game, fancy re-databasing all the skills and items? Or you want to create states that do different things to the formulas. We’ll be covering all that in this tutorial.

Let’s start by quickly analysing the formula box itself; as I’m sure you are aware a refers to the the attacker or user and b refers to the defender or recipient, now a and b refer either to an instance of Game_Actor or Game_Enemy. A quick glance at this class diagram shows us that both inherit from Game_Battler (which in turn inherits from Game_BattlerBase).

Why was that important? Simple because we have to decide where we are going to place our new bits of code. Personally I would recommend one of three places:

  • Game_Battler
  • Game_BattlerBase
  • A new Module

A module might in many ways make the most sense but being as I’m aiming this tutorial at people with limited scripting experience I’d rather avoid modules. Also if the code is added in Game_Battler we can directly access more variables directly (which suits me). So if we go to Materials in the script editor and insert us a new section then we need to add the code to add to the class:

class Game_Battler < Game_BattlerBase

end

Right next lets get down to examples. First let’s go through how to use a formula that’s too big for the box. Next let’s add a new method:

class Game_Battler < Game_BattlerBase
  def custom_formula_fireball

  end
  
end

If you don’t consider yourself to be a scripter then the easiest thing for you would probably be to enter the formula exactly how you would have in the custom formula box. Good news, we can do that. What we need to do is pass our new method the a,b from the custom formula. So this is what we’re upto:

Custom Formula Box:

 a.custom_formula_fireball(a,b)

Note: b.custom_formula_fireball(a,b) would be equally valid.

Script Editor:

class Game_Battler < Game_BattlerBase
  def custom_formula_fireball(a,b)

  end
  
end

So all that leaves us to do it put the formula in the method. I’m going to use the gambler example from the previous tutorial:

class Game_Battler < Game_BattlerBase
  def custom_formula_fireball(a,b)
    c=1+rand(6);d=1+rand(6);if c==1 and d==1;10000;elsif c==d;c*400;else;(c+d)*100;end;
  end
  
end

So that’s how to bypass the length limit on the custom formulae. If that’s all you’re interested in then you can stop here. I’ll be carrying onto covering adding a default formula and manipulating it.

I’m not going to cover anything to do with developing your formula I’m just going to show you how to implement it, here’s the formula I was using in my last game:

class Game_Battler < Game_BattlerBase
  def basef(a,b, magic = false)
    if magic
      return ([a.mat / 5, a.mat-b.mdf].max * (a.mat ** 0.5)).to_i
    else
      return ([a.atk / 5, a.atk-b.def].max * (a.atk ** 0.5)).to_i
    end
  end
  
end

First thing I’m going to point out is that I also pass a boolean (true or false) to the method to define whether it’s a magic attack or a physical one. You could do the same if you wanted. Just an example on the custom formula box:

a.basef(a,b,true)

Anyway the main reason for doing this is so that if you find your formula doesn’t work well later in the game you’ll only have to change it once. You can also simplify formulas if you wanted by making more methods. So for example in my last ill-fated game I had a character who could heal but I didn’t want him to be a dedicated healer so I made all his heals inflict statuses (with the turns they lasted reflecting the power of the heals) and if a character was affected by one of these statuses they only received half-healing. So the method I made looked like this:

def sorcery_healing?
  return state?(51) || state?(52) || state?(53)
end

My healing skill custom formulae looked a little like this

b.sorcery_healing? ? 100 : 200

Any how that just about concludes everything I wanted to cover in this tutorial, I hope it helped you.

5
  

A guide to Note-tagging

So you’re getting into scripting, maybe you just released a script and naturally you’re a bit peeved because the first person to reply did nothing but complain about the lack of note tagging, maybe the second reply agreed with him… Right so now you’re a double murderer but want to learn how to incorporate note tagging in your future scripts. Then this tutorial is for you.

First let me begin by saying note tagging is NOT REQUIRED NOR EVER WILL BE for a script. It does not improve a script, it does not in any way make a script better. It only makes a script easier to use for people of no scripting ability or those with a weak disposition about editing a script. In some ways it’s a bad thing because it encourages a plug and play attitude and keeps people from doing minor amounts of scripting (which can lead to a better understanding of scripts). But clearly if you’re reading this then you want to make your scripts more “user friendly.” So let’s have a look at the potential classes you can use note tagging in:


C
lick to see full size.

Hopefully you will be able to find in the database and editor where you put the notetags. Notetags usually look like:

<notetag x>

I don’t know who came up with the format but it effectively mimics html tags, notetags don’t have to look like that but it’s what people are used to. If you do something different then any “user friendliness” you add to your script will be quickly be diluted with queries and uncertainty about the notetagging.

Right let’s now get into the code, hypothetical scenario you have a script where by one of your characters has a chance to not consume an item when using it and you want each item to have a different chance to avoid been consumed. You’ve decided your notetag will be:

<con x>

A quick look at the diagram I’ve provided you should lead you to: RPG::Item. Different people implement notetags in slightly different ways, for example Yanfly built an entire architecture around pre-loading notetags but I’ll just show you the way I do notetags and if you’re interested in other ways of notetagging you can also go look at how other scripters implement it.

So we’ve got our class, RPG::Item let’s go into them the script then:

class RPG::Item

end

We now need to add the new method you’ll call from somewhere in your script.

class RPG::Item
  def conserve_chance
  end

end

In all the classes with notes the note is stored in a variable called @note. Anyway this is what our final code looks like:

class RPG::Item
  def conserve_chance
    if @note =~ /<con (.*)>/i
      return $1.to_i
    else
      return 0 # the default if no notetag is present
    end
  end

end

Let’s just examine it a bit closer. =~ basically is checking for a match with the notetag. The two / are to do with regex which unless you want to look into more closely then what I go through here should see you through setting up any note tag. As for .* the . accepts any character except line breaks and the * means you can enter as many as you like. Finally the i after the second / just tells it to ignore case meaning <con x>, <CON x>, <Con x>, <CoN x> would all be accepted as a match.

$1 effectively holds whatever was placed in the notetag, by default it will be a string, if you need it to be an integer then add .to_i onto it like in the example.

I think that concludes the main chunk of the tutorial but there are two more things I want to go through getting an array from notetagging and inheritence with notetagging.

Lets jump into getting an array from notetagging, $1 contains the string from the notetag so we could have people enter the array like: <array 1,2,3,9,4> for example. There is a highly useful function in ruby called split and what it does it break up a string and return an array, best part of all if we can tell it how to break the string up. Right below are two examples one for an array of string and one for an array of integers.

class RPG::Item
  def conserve_chance
    if @note =~ /<con (.*)>/i
      return $1.split(",")
    else
      return []
    end
  end

end

 

class RPG::Item
  def conserve_chance
    if @note =~ /<con (.*)>/i
      ints = []
      for x in $1.split(",")
        ints.push(x.to_i)
      end
      return ints
    else
      return []
    end
  end

end

 

Right then that just leaves me to go through inheritance and notetags. If I may draw your attention to subset of the diagram above:

What the arrows represent is inheritance (I know that in UML they should be clear arrowheads but I don’t care). Inheritance is where the classes inherit all the variables and methods from the other class. The variable note exists in the RPG::BaseItem class and them all the other classes in the diagram inherit it. What this means is that if you need the same method in more than one of these classes you can put it in a class which the classes you need the method in inherit. So for example if I want to add something to both Weapons and Armours then I can put the method in EquipItem.

So hopefully this has helped you understand how to incorporate note tagging in your scripts, if you’re desperate to use notetagging when there are no notes you could always consider name tagging! But in all seriousness if you need any further help or clarification please don’t hesitate to leave a comment.

Jet has scolded me for performing the check every time the method is called so here’s an example of how to cache the notetag so that it only calculates it once per session.

class RPG::Item
  def conserve_chance
    if @conserve_chance.nil?
      if @note =~ /<con (.*)>/i
        @conserve_chance = $1.to_i
      else
        @conserve_chance = 0
      end
    end
    @conserve_chance
  end

end
1
  

Just a quick update on what I’m doing.

Very busy, not least because I’m playing Star Wars the Old Republic (Flames of the Crucible if anyone wants to join me). I’m currently programming a new version of some software that is used at work and unfortunately for you this means that I don’t generally feel like programming after spending several hours working on this application. The good news is that I can see the light at the end of the tunnel and normal scripting may resume soon (a couple of weeks?).

When I do the two scripts that are most in need of an update are my animated battlers and my stamina/atb scripts. Anyway until then, have fun!

0