[Gemrb-commits] gemrb/gemrb/docs/en/GUIScript ClearActions.txt,NONE,1.1 HasResource.txt,NONE,1.1 LeaveParty.txt,NONE,1.1 SetActionIcon.txt,NONE,1.1 SetupControls.txt,NONE,1.1 SetItemIcon.txt,1.2,1.3 SetSpellIcon.txt,1.3,1.4

[Laszlo T. <ave...@us...>]

Update of /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv28011

Modified Files:
	SetItemIcon.txt SetSpellIcon.txt 
Added Files:
	ClearActions.txt HasResource.txt LeaveParty.txt 
	SetActionIcon.txt SetupControls.txt 
Log Message:
Added documentation for many guiscript commands


--- NEW FILE: HasResource.txt ---

Prototype: GemRB.HasResource(ResRef, ResType)

Description: Returns true if the resource exists.

Parameters: ResRef  - the resource reference (8 characters filename)
            ResType - the class ID of the resource 

Return value: boolean

Index: SetItemIcon.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/SetItemIcon.txt,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** SetItemIcon.txt	1 Nov 2004 19:49:06 -0000	1.2
--- SetItemIcon.txt	21 Dec 2005 22:56:02 -0000	1.3
***************
*** 1,4 ****
  
! Prototype: GemRB.SetItemIcon(WindowIndex, ControlIndex, ITMResRef)
  
  Description: Sets Item icon image on a Button control.
--- 1,4 ----
  
! Prototype: GemRB.SetItemIcon(WindowIndex, ControlIndex, ITMResRef[, Type, Tooltip])
  
  Description: Sets Item icon image on a Button control.
***************
*** 7,12 ****
  WindowIndex, ControlIndex  - the control's reference
  ITMResRef                  - the name of the item (.itm resref)
! 
  Return value: N/A
  
! See also: SetSpellIcon
--- 7,13 ----
  WindowIndex, ControlIndex  - the control's reference
  ITMResRef                  - the name of the item (.itm resref)
! Type                       - 0,1 or 2 (the icon's type)
! Tooltip                    - if set to 1, the tooltip for the item will also be set
  Return value: N/A
  
! See also: SetSpellIcon, SetActionIcon

Index: SetSpellIcon.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/SetSpellIcon.txt,v
retrieving revision 1.3
retrieving revision 1.4
diff -C2 -d -r1.3 -r1.4
*** SetSpellIcon.txt	6 Mar 2005 14:10:57 -0000	1.3
--- SetSpellIcon.txt	21 Dec 2005 22:56:02 -0000	1.4
***************
*** 1,4 ****
  
! Prototype: GemRB.SetSpellIcon(WindowIndex, ControlIndex, SPLResRef[, type])
  
  Description: Sets Spell icon image on a Button control. Type determines the icon type, if set to 1 it will use the Memorised Icon instead of the Spellbook Icon
--- 1,4 ----
  
! Prototype: GemRB.SetSpellIcon(WindowIndex, ControlIndex, SPLResRef[, Type, Tooltip])
  
  Description: Sets Spell icon image on a Button control. Type determines the icon type, if set to 1 it will use the Memorised Icon instead of the Spellbook Icon
***************
*** 7,11 ****
  WindowIndex, ControlIndex  - the control's reference
  SPLResRef                  - the name of the spell (.spl resref)
! type                       - (0 or 1)
  Return value: N/A
  
--- 7,13 ----
  WindowIndex, ControlIndex  - the control's reference
  SPLResRef                  - the name of the spell (.spl resref)
! Type                       - (0 or 1)
! Tooltip                    - set the tooltip too?
! 
  Return value: N/A
  

--- NEW FILE: ClearActions.txt ---

Prototype: GemRB.ClearActions(Slot)

Description: Stops a player character's movement and any pending action.

Parameters: Slot  - actor index in game structure

Return value: N/A


--- NEW FILE: SetupControls.txt ---

Prototype: GemRB.SetupControls(WindowIndex, Slot)

Description: Sets up all 12 buttons for a player character, based on preset preferences and the character's class.

Parameters:
WindowIndex       - the buttons' window index
Slot              - the player character's index in the party

Return value: N/A

See also: SetActionIcon

--- NEW FILE: LeaveParty.txt ---

Prototype: GemRB.LeaveParty(Slot)

Description: Removes the player character from the party.

Parameters: Slot  - actor index in game structure

Return value: N/A

See also: GameGetPartySize


--- NEW FILE: SetActionIcon.txt ---

Prototype: GemRB.SetActionIcon(WindowIndex, ControlIndex, ActionIndex)

Description: Sets up an action button based on the guibtact table. The ActionIndex should be less than 32. This action will set the button's image, the tooltip and the push button event handler.

Parameters:
WindowIndex, ControlIndex  - the button's reference
ActionIndex                - the row number in the guibtact.2da file

Return value: N/A

See also: SetSpellIcon, SetItemIcon, SetupControls