anachronox-sdk/docs/GDB_Intro.html

88 lines
4.4 KiB
HTML

<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
<TITLE>Anachronox Editing Documentation</TITLE>
</HEAD>
<BODY BGCOLOR="#000000" TEXT="#EFEFEF" LINK="#00FFFF" ALINK="#FFFFFF" VLINK="#05F3D0">
<CENTER>
<P>
<FONT FACE="Tahoma">
<FONT SIZE=5 COLOR="#0055DD"><P>GDB Intro</P>
</FONT>
</CENTER>
<P>
<HR>
<BR>
&nbsp;
<P>
&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;The GDB is the game database that keeps track of numerous things in the game including items, mystech, battleskills, quests, weapons, monsters, and more.
It basically consists of numerous files in the Anachronox directory tree, (usually with a .gdb extension), that contain text entries that describe the previously mentioned elements of a
game. Let's look at a few examples.
<P>
<FONT COLOR="#0055DD"><B>Item:</B></FONT><BR>
<PRE>
#object HealGrease Complete
{
type string "item"
classname string "get_healgreasecomplete"
buy_value int 500
desc string "Complete heal of person, or adjacent person in battle."
effect string "add_hp=9999"
use_script string "battle/items/healgrease"
use_target string "party"
}
</PRE>
<P>
Lets take a look at what the above means:<BR>
<UL>
<FONT SIZE=2>
<LI>First we have the <FONT COLOR="#0055DD">#object</FONT> string which is "HealGrease Complete". This is the name of this GDB object / entry. <BR>
<LI>Next we have a <FONT COLOR="#0055DD">type string "item"</FONT>. There are several pre-defined type strings in the GDB, they each tell
Anachronox what to do with that item. For example, since this is an <FONT COLOR="#0055DD">"item"</FONT> string, <BR>
Anachronox knows, among other things, that:<BR>
&nbsp;&nbsp;&nbsp;A) This is something that can be added to the inventory.<BR>
&nbsp;&nbsp;&nbsp;B) It should be shown in the item list in the Fatima Inventory Screen.<BR>
<LI>Next we have the <FONT COLOR="#0055DD">classname string</FONT>. This is the entity.dat object that is associated with this GDB entry. So if you were to look up "get_healgrease" in the entity.dat, you would find that it references "healgrease.md2" which is the
little healgrease model that you see in the game. The <FONT COLOR="#0055DD">classname string</FONT> is not mandatory in an item.<BR>
<LI>The <FONT COLOR="#0055DD">buy_value int 500</FONT> line tells the GDB how much you could sell this item for in a shop.<BR>
<LI>The <FONT COLOR="#0055DD">desc string</FONT> is what is displayed to the user when they click on the item in the Fatima screen or in a shop.
<LI>This particular item has an <FONT COLOR="#0055DD">effect string</FONT>. Effect strings are effects that get executed when that item is used or invoked. This particular item has an effect string of
<FONT COLOR="#0055DD">"add_hp=9999"</FONT> which tells Anachronox to add 9,999 hitpoints to whoever just used this item.<BR>
<LI>The <FONT COLOR="#0055DD">use_script string</FONT> is the planet script that should be played if this item is used in battle.<BR>
<LI>The <FONT COLOR="#0055DD">use_target string</FONT> tells Anachronox who this item can be used on. In this case it can be used on anyone in the party.
</FONT>
</UL>
<P>
<FONT COLOR="#0055DD"><B>Quest:</B></FONT><BR>
<PRE>
#quest Get Your Camera
{
area string "Anachronox"
type string "sub_quest"
desc string "Get the camera off your desk."
xp_shares float 1
quest_parent string "Fatima Stop"
}
</PRE>
<P>
Lets take a look at what the above means:<BR>
<UL>
<FONT SIZE=2>
<LI>The <FONT COLOR="#0055DD">area string</FONT> is what area this Quest takes place in. So in this case, the user would see this quest displayed in Fatima under "Anachronox".
<LI>For this entry the <FONT COLOR="#0055DD">type string</FONT> is a <FONT COLOR="#0055DD">"sub_quest"</FONT>.
<LI>Once again the <FONT COLOR="#0055DD">desc string</FONT> is the description the user will see in the Fatima screen.
<LI>The <FONT COLOR="#0055DD">xp_shares</FONT> represent how much experience the player gets for completing the quest. The <FONT COLOR="#0055DD">xp_shares</FONT> are multiplied by 100 to derive the XP, so in this case the party would get 100xp for completing this quest.
<LI>The <FONT COLOR="#0055DD">quest_parent string</FONT> tells Anachronox what quest this subquest belongs to. That way, Anachronox knows how to visually stack the quests. Additionally if parent quest is completed and there are sub_quests are open underneath it, Anachronox knows to erase those quests from Fatima.
</UL>
<P>&nbsp;<P>
</BODY>
</HTML>