[Gemrb-commits] SF.net SVN: gemrb:[5959] gemrb/trunk/gemrb/docs/en/GUIScript/GetPlayerStat. txt

[<lyn...@us...>]

Revision: 5959
          http://gemrb.svn.sourceforge.net/gemrb/?rev=5959&view=rev
Author:   lynxlupodian
Date:     2009-05-13 20:24:39 +0000 (Wed, 13 May 2009)

Log Message:
-----------
GetPlayerStat.txt: noted the last parameter

Modified Paths:
--------------
    gemrb/trunk/gemrb/docs/en/GUIScript/GetPlayerStat.txt

Modified: gemrb/trunk/gemrb/docs/en/GUIScript/GetPlayerStat.txt
===================================================================
--- gemrb/trunk/gemrb/docs/en/GUIScript/GetPlayerStat.txt	2009-05-13 20:09:32 UTC (rev 5958)
+++ gemrb/trunk/gemrb/docs/en/GUIScript/GetPlayerStat.txt	2009-05-13 20:24:39 UTC (rev 5959)
@@ -1,10 +1,11 @@
 
-Prototype: GemRB.GetPlayerStat(Slot, ID)
+Prototype: GemRB.GetPlayerStat(Slot, ID[, Base])
 
 Description: Queries a stat of the player character. The stats are listed in ie_stats.py.
 
-Parameters: Slot  - actor index in game structure
-            ID    - Stat index
+Parameters: Slot - actor index in game structure
+            ID   - Stat index
+            Base - if set to 1, the function will return the base instead of the modified (current) value
 
 Return value: numeric
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.