0.9.5 api bump

Author: lynxlynxlynx

GUIScript/functions/Button_EnableBorder.md

@@ -13,4 +13,4 @@ module: _GemRB
 
 **Return value:** N/A
 
-**See also:** [Button_SetPicture](Button_SetPicture.md), [Button_SetFlags](Button_SetFlags.md), [Button_SetBorder](Button_SetBorder.md)
+**See also:** [Button_SetPicture](Button_SetPicture.md), [View_SetFlags](View_SetFlags.md), [Button_SetBorder](Button_SetBorder.md)

GUIScript/functions/Button_SetItemIcon.md

@@ -3,7 +3,7 @@ title: Button_SetItemIcon
 module: _GemRB
 ---
 
-**Metaclass Prototype:** SetItemIcon (ITMResRef[, Type, Tooltip, ITM2ResRef, BAM3ResRef]])
+**Metaclass Prototype:** SetItemIcon (ITMResRef[, Type, Tooltip, FunctionKey, ITM2ResRef, BAM3ResRef]])
 
 **Description:** Sets Item icon image on a Button control.
 
@@ -20,6 +20,7 @@ module: _GemRB
     * 7 - Item ability icon for second extended header
     * 8 - etc.
   * Tooltip  - if set to 1 or 2 (identified), the tooltip for the item will also be set
+  * FunctionKey  - F-key to map to [1-12]
   * ITM2ResRef - if set, a second item to display in the icon. ITM2 is drawn first. The tooltip of ITM is used. Only valid for Type 4 and 5
   * BAM3ResRef - if set, a third image will be stacked on top of the others
 

GUIScript/functions/Button_SetPLT.md

@@ -3,20 +3,28 @@ title: Button_SetPLT
 module: _GemRB
 ---
 
-**Metaclass Prototype:** SetPLT (PLTResRef, col1, col2, col3, col4, col5, col6, col7, col8[, type])
+**Metaclass Prototype:** SetPLT (PLTResRef, ColorDict[, type])
 
 **Description:** Sets the Picture of a Button Control from a PLT file. 
-Sets up the palette based on the eight given gradient colors.
+Sets up the palette based on the colors contained in ColorDict, where 
+the key is the stat coresponding to the color.
 
 **Parameters:**
   * PLTResRef - the name of the picture (a .plt resref)
-  * col1-8 - color gradients
+  * ColorDict - dictionary of up to 8 color stats mapped to indices in the global palette
   * type - the byte to use from the gradients:
     * 0 Body (robe or armour)
     * 1 Weapon
     * 2 Shield
     * 3 Helmet
 
+**Example:**
+
+    import PaperDoll
+    pc = GemRB.GameGetSelectedPCSingle ()
+    stats = PaperDoll.ColorStatsFromPC (pc)
+    Button.SetPLT (PaperDoll.GetActorPaperDoll (pc), stats)
+
 **Return value:** N/A
 
 **See also:** [Button_SetPicture](Button_SetPicture.md)

GUIScript/functions/Button_SetSprites.md

@@ -18,4 +18,4 @@ setting the IE_GUI_BUTTON_NO_IMAGE flag on the control.
 
 **Return value:** N/A
 
-**See also:** [Button_SetFlags](Button_SetFlags.md), [Button_SetPicture](Button_SetPicture.md), [Button_SetPicture](Button_SetPicture.md)
+**See also:** [View_SetFlags](View_SetFlags.md), [Button_SetPicture](Button_SetPicture.md), [Button_SetPicture](Button_SetPicture.md)

GUIScript/functions/Button_SetState.md

@@ -21,4 +21,4 @@ is a checkbox or a radio button though, their states are handled internally.
 
 **Return value:** N/A
 
-**See also:** [Button_SetFlags](Button_SetFlags.md)
+**See also:** [View_SetFlags](View_SetFlags.md)

GUIScript/functions/ConsolidateLoot.md

@@ -0,0 +1,12 @@
+---
+title: ConsolidateLoot
+module: GemRB
+---
+
+**Prototype:** GemRB.ConsolidateLoot ()
+
+**Description:** Moves all visible loot piles under the selected actor, merges 
+and sorts the items, then opens up the container window.
+
+**Return value:** N/A
+

GUIScript/functions/Control_SetVarAssoc.md

@@ -20,4 +20,4 @@ control. See more about this in 'data_exchange'.
 
 **Special:** If the 'DialogChoose' variable was set to -1 or 0 during a dialog session, it will terminate (-1) or pick the first available option (0) from the dialog automatically. (0 is used for 'continue', -1 is used for 'end dialogue').
 
-**See also:** [Button_SetFlags](Button_SetFlags.md), [SetVar](SetVar.md), [GetVar](GetVar.md)
+**See also:** [View_SetFlags](View_SetFlags.md), [SetVar](SetVar.md), [GetVar](GetVar.md)

GUIScript/functions/CreateCreature.md

@@ -13,6 +13,6 @@ at the specified point (takes precedence if both are specified).
   * CreResRef  - the creature's name (.cre resref)
   * posX, posY - position to create at
 
-**Return value:** N/A
+**Return value:** global ID of the created creature
 
 **See also:** [CreateItem](CreateItem.md)

GUIScript/functions/EvaluateString.md

@@ -3,16 +3,21 @@ title: EvaluateString
 module: GemRB
 ---
 
-**Prototype:** GemRB.EvaluateString (String)
+**Prototype:** GemRB.EvaluateString (String[, quiet=False])
 
 **Description:** Evaluates an ingame script trigger in the current area 
 script context. It prints the result. The command is more useful from the 
 ingame debug console than from scripts.
 
 **Parameters:**
   * String - a gamescript trigger
+  * quiet - set to True to skip printing the result
 
-**Return value:** N/A (the trigger's return value is printed)
+**Return value:** the trigger's return value
+
+**Examples:**
+
+GemRB.EvaluateString('HPPercentLT(Player1, 20)', True)
 
 **See also:** [ExecuteString](ExecuteString.md)
 

GUIScript/functions/ExecuteString.md

@@ -5,10 +5,17 @@ module: GemRB
 
 **Prototype:** GemRB.ExecuteString (String[, Slot])
 
-**Description:** Executes an in-game script action in the current area 
-script context. This means that LOCALS will be treated as the current 
-area's variable. If a number was given, it will execute the action in the 
-numbered actor's context.
+**Description:** Executes an in-game script action. If a valid Slot (greater than 0) 
+is specified, the actor in that Slot is used as the script context. Slot numbers 
+[1-1000] are treated as portrait indices, while Slot numbers greater than 1000 are 
+treated as global actor IDs. If no Slot is specified, the scriptable object (actor, 
+container, door, etc.) currently under the cursor (if available) becomes the script 
+context. If no valid object exists under the cursor, the current area script is used 
+as the script context instead.
+
+The script context determines which scriptable executes the action and its 
+associated behavior. For example, LOCALS used by the action will be those of the 
+object acting as the script context.
 
 **Parameters:**
   * String - a gamescript action