anachronox-sdk/docs/APEStatsandGDB.html

77 lines
8.5 KiB
HTML
Raw Permalink Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=windows-1252">
<META NAME="Generator" CONTENT="Microsoft Word 97">
</HEAD>
<BODY TEXT="#808080" LINK="#0000ff" VLINK="#800080" BGCOLOR="#000000">
<FONT FACE="Tahoma">
<FONT SIZE=6><P ALIGN="CENTER">APE commands pertaining to Stats and Game Database Objects</P></FONT>
<BR><A HREF="#quest">Quest Commands</A>
<P>
<FONT SIZE=4 COLOR="#ffff00"><P>addnew_to_inventory &lt;GDB name&gt; :</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Creates a new object and adds it to the partys inventory. Call with one argument which is the GDB name of the object to be added to the partys inventory</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>remove_from_inventory &lt;GDB name&gt;:</P>
</FONT><FONT SIZE=4><P>Removes an object from the partys inventory and places it in the world inventory. Call with one argument, which is the GDB name of the object to be removed from the partys inventory.</P>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>move_to_inventory &lt;GDB name&gt;:</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Move an object from the world inventory to the partys inventory. Call with one argument, which is the GDB name of the object to be removed from the partys inventory.</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>is_in_inventory &lt;GDB name&gt; &lt;result&gt; :</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Checks to see if the object is in the partys inventory. Call with two arguments, first the GDB name of the object and secondly the gamevar that receives the result. 1 if true, 0 if false.</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>is_equipped &lt;GDB name&gt; &lt;result&gt;:</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Checks if any character in the party is equipping an object. Call with two arguments, first the GDB name of the object and secondly the gamevar that receives the result. 1 if true, 0 if false.</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>add_npc_to_party &lt;GDB character name&gt; :</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Adds the named NPC to the party (making him a PC, I guess :) . Call with one argument, the GDB name of the character to be added.</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>remove_npc_from_party &lt;GDB character name&gt;:</P>
</FONT><FONT SIZE=4><P>Moves a player character from the active party and places it in the list of passive party members. Call with one argument, the GDB name of the character to remove.</P>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>place_in_party &lt;character name&gt; &lt;gamevar&gt;</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Checks the position of the character name you enter and returns their position in the party as 3,2,1, or 0 if they are not in it.</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>get_party_order &lt;leadervar&gt; &lt;secondvar&gt; &lt;thirdvar&gt; :</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Returns 3 strings with the names of the character in that position (i.e. "extern get_party_order first$ second$ third$"</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>add_money &lt;amount&gt;:</P>
</FONT><FONT SIZE=4><P>Adds money to the party. Call with one numerical argument, indicating how many money units. To increase the partys wealth with.</P>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>remove_money &lt;amount&gt;:</P>
</FONT><FONT SIZE=4><P>Removes money from the party. Same argument as add_money.</P>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>check_money &lt;gamevar&gt;</P>
</FONT><FONT SIZE=4><P>Retrieves how much money the party has and returns it to the Gamevar.</P>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>GetPlayerCurrentHP &lt;player&gt; &lt;return_value&gt; :</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Gets the hit points of the player specified, [can be specifed by name, or PlayerChar# (i.e. "Boots" or "PlayerChar2")].</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>SetPlayerCurrentHP &lt;player&gt; &lt;new health&gt; :</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Adjust the hit points of the player specified, [can be specifed by name, or PlayerChar# (i.e. "Boots" or "PlayerChar2")]. The hitpoints can be set by typing in just the number (i.e. "235"), you can add a value to the current hitpoints by using a "+" infront of the number (i.e. "+30"), and you can subtract from the current hitpoints by adding a "-" before the number (i.e. "-30).</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>Add_XP &lt;player&gt; &lt;new XP&gt; :</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Adjust the experience points of the player specified. Use a positive number as the XP value to add experience, use a negative number to decrease it.</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>adjust_stat &lt;character ID&gt; &lt;stat string&gt; &lt;amount&gt;:</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Modifies the specified stat for the specified character. Call with three arguments, first thecharacter identifier, secondly the name of the stat to be modified and thirdly the modify value. Names of the stats are "might", "agility", "wisdom", "xp", "hp", "nrg", "beatuse", "mysuse", "good" and "bad" . The "good" and "bad" stats are effects such as haste or poison. We need to specify what values to use for the various states.</P></BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>check_stat &lt;character ID&gt; &lt;stat string&gt; &lt;value gamevar&gt;:</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Check the value of a certain stat. Call with three arguments. First, the character identifier, secondly the stat string (see adjust_stat) and thirdly the gamevar that will receive the value of the</P>
<P>stat.</P></BLOCKQUOTE>
<P>&nbsp;</FONT><FONT SIZE=4 COLOR="#ffff00">set_party_leader &lt;GDB character name&gt;:</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Swaps the current leader of the party to be the specified character. Call with one argument, the GDB name of the character you want to lead the party.</BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>equip_item &lt;GDB object name&gt;:</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Equips the specified item if it exists in the partys inventory. This should probably be removed or modified as it operates on the leader in the party only. Call with one argument, the GDB name of the object to be equipped.</P></BLOCKQUOTE>
</FONT><FONT SIZE=4 COLOR="#ffff00"><P>set_world_skill_level &lt;skillname&gt; &lt;level&gt;:</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Sets a worldskill to a new level, 1 & 2 should be the only levels used in the first game. Accepted skillnames are ("picklock", "tractor", "yammer", "comptalk", "throwloonie", "analyze", "ragemight")</P></BLOCKQUOTE>
</FONT>
<FONT SIZE=4 COLOR="#ffff00"><P>get_world_skill_level &lt;skillname&gt; &lt;variable&gt;:</P>
</FONT><FONT SIZE=4><BLOCKQUOTE>Lookup the level of a worldskill. Accepted skillnames are ("picklock", "tractor", "yammer", "comptalk", "throwloonie", "analyze", "ragemight")</P></BLOCKQUOTE>
</FONT>
<P>&nbsp;<BR>
<A NAME="quest">
<FONT SIZE=6><P ALIGN="CENTER">APE commands pertaining to Quests</P></FONT>
<P>
<FONT SIZE=4 COLOR="#ffff00"><P>add_quest &lt;The Name of The Quest&gt; :</P></FONT>
<FONT SIZE=4><BLOCKQUOTE>will "activate" the quest and spawn all sub_quests. After "add_quest", the Quest will appear in the Fatima interface, etc.</BLOCKQUOTE></FONT>
<FONT SIZE=4 COLOR="#ffff00"><P>complete_quest &lt;The Name of The Quest&gt; :</P></FONT>
<FONT SIZE=4><BLOCKQUOTE>will forcefully finish the quest with <B>success</B>. This should, in the general case, not be used since the GameVars in the requirements-field should be enough, but might be needed if a plot twist fixes the quest in some other way.</BLOCKQUOTE></FONT>
<FONT SIZE=4 COLOR="#ffff00"><P>cancel_quest &lt;The Name of The Quest&gt; :</P></FONT>
<FONT SIZE=4><BLOCKQUOTE>will forcefully finish the quest with <B>failure</B>. Much like "complete_quest", but if you were to have a sub quest on Sunder that you haven't finished before the planet explodes, you should use cancel_quest.</BLOCKQUOTE></FONT>
<FONT SIZE=4 COLOR="#ffff00"><P>is_quest_done &lt;The Name of The Quest&gt; &lt;GAMEVAR&gt; :</P></FONT>
<FONT SIZE=4><BLOCKQUOTE>will check to see if you've finished the specified quest, and return a value to the GAMEVAR specified. All successfully finished quests will return 2, a quest "in progress" will return 1 and a quest you haven't received will return 0. <B>NOTE</B> that this can be kinda expensive to check, so it shouldn't be used to check every frame if the status of a Quest has changed from 1 to 2, or something like that. Use this call with care, and stick to checking the normal gamevars when possible. </BLOCKQUOTE></FONT>
<FONT SIZE=2><BLOCKQUOTE></BLOCKQUOTE></FONT></BODY>
</HTML>