[Gemrb-commits] gemrb/gemrb/docs/en/GUIScript AdjustScrolling.txt,1.1,1.2 CreateButton.txt,1.1,1.2 C

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

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

Modified Files:
	AdjustScrolling.txt CreateButton.txt CreateLabel.txt 
	CreateMapControl.txt CreateWindow.txt EnableButtonBorder.txt 
	GameIsBeastKnown.txt GetINIBeastsKey.txt GetINIPartyCount.txt 
	GetINIPartyKey.txt GetINIQuestsKey.txt SetButtonBorder.txt 
	SetControlPos.txt SetControlSize.txt SetItemIcon.txt 
	SetSpellIcon.txt SetWindowSize.txt 
Removed Files:
	GetSymbol.txt 
Log Message:
additional guiscript docs

Index: SetWindowSize.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/SetWindowSize.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** SetWindowSize.txt	31 Oct 2004 21:35:42 -0000	1.1
--- SetWindowSize.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

! Return value:

! See also:

--- 1,13 ----

! Prototype: GemRB.SetWindowSize(WindowIndex, Width, Height)

! Description: Resizes a Window.

  Parameters:
+ WindowIndex   - the index returned by LoadWindow()
+ Width, Height - the new dimensions of the window

! Return value: N/A

! See also: LoadWindow, SetWindowPos, SetControlSize

Index: SetSpellIcon.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/SetSpellIcon.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** SetSpellIcon.txt	31 Oct 2004 21:35:42 -0000	1.1
--- SetSpellIcon.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

! Return value:

! See also:

--- 1,13 ----

! Prototype: GemRB.SetSpellIcon(WindowIndex, ControlIndex, SPLResRef)

! Description: Sets Spell icon image on a Button control.

  Parameters:
+ WindowIndex, ControlIndex  - the control's reference
+ SPLResRef                  - the name of the spell (.spl resref)

! Return value: N/A

! See also: SetItemIcon

Index: SetControlPos.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/SetControlPos.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** SetControlPos.txt	31 Oct 2004 21:35:42 -0000	1.1
--- SetControlPos.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

! Parameters:

  Return value:

! See also:

--- 1,12 ----

! Prototype: GemRB.SetControlPos(WindowIndex, ControlIndex, X, Y)

! Description: Moves a Control.

! Parameters: WindowIndex, ControlIndex  - the control's reference
! X,Y - the new position of the control relative to the window

  Return value:

! See also: SetControlSize, accessing_gui_controls

--- GetSymbol.txt DELETED ---

Index: SetItemIcon.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/SetItemIcon.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** SetItemIcon.txt	31 Oct 2004 21:35:42 -0000	1.1
--- SetItemIcon.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

! Return value:
! 
! See also:

--- 1,12 ----

! Prototype: GemRB.SetItemIcon(WindowIndex, ControlIndex, ITMResRef)

! Description: Sets Item icon image on a Button control.

  Parameters:
+ WindowIndex, ControlIndex  - the control's reference
+ ITMResRef                  - the name of the item (.itm resref)

! Return value: N/A

+ See also: SetSpellIcon

Index: GetINIPartyCount.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/GetINIPartyCount.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** GetINIPartyCount.txt	31 Oct 2004 21:35:42 -0000	1.1
--- GetINIPartyCount.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

! Parameters:

! Return value:

! See also:

--- 1,11 ----

! Prototype: GemRB.GetINIPartyCount()

! Description: Returns the Number of Parties defined in Party.ini (works only on IWD2).

! Parameters: N/A

! Return value: the number of predefined parties as of party.ini

! See also: GetINIPartyKey

Index: CreateWindow.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/CreateWindow.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** CreateWindow.txt	31 Oct 2004 21:35:42 -0000	1.1
--- CreateWindow.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

! Parameters:

! Return value:

! See also:

--- 1,14 ----

! Prototype: GemRB.CreateWindow(WindowID, X, Y, Width, Height, MosResRef)

! Description: Creates a new empty window and returns its index.

! Parameters: WindowID - the window's ID
! X,Y - the window's position
! Width, Height - the window's dimensions
! MosResRef - the background image (.mos resref)

! Return value: a window index

! See also: CreateControl

Index: SetButtonBorder.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/SetButtonBorder.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** SetButtonBorder.txt	31 Oct 2004 21:35:42 -0000	1.1
--- SetButtonBorder.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

! Parameters:

! Return value:

! See also:

--- 1,25 ----

! Prototype: GemRB.SetButtonBorder(WindowIndex, ControlIndex, BorderIndex, dx1, dy1, dx2, dy2, R, G, B, A, [enabled, filled])

! Description: Sets border/frame/overlay parameters for a button. This command can be used for drawing a border around a button, or to overlay it with a tint (like with unusable or unidentified item's icons).

! Parameters: 
! WindowIndex, ControlIndex  - the control's reference
! BorderIndex                - 0,1 or 2
! dx1,dy1                    - Upper left corner
! dx2,dy2                    - Offset from the lower right corner
! RGBA                       - red,green,blue,opacity components of the border colour
! enabled                    - 1 means enable it immediately
! filled                     - 1 means draw it filled (overlays)

! Return value: N/A

! Examples:
! GemRB.SetButtonBorder (Window, Icon, 0,  0, 0, 0, 0,  0, 0, 0, 160,  0, 1)
! Not known spells are drawn darkened (the whole button will be overlaid).
! 
! GemRB.SetButtonBorder (Window, Button, FRAME_PC_SELECTED, 1, 1, 2, 2, 0, 255, 0, 255)
! This will draw a green frame around the portrait.
! 
! See also: EnableButtonBorder

Index: SetControlSize.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/SetControlSize.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** SetControlSize.txt	31 Oct 2004 21:35:42 -0000	1.1
--- SetControlSize.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

! Parameters:

! Return value:

! See also:

--- 1,12 ----

! Prototype: GemRB.SetControlSize(WindowIndex, ControlIndex, Width, Height)

! Description: Resizes a Control.

! Parameters: WindowIndex, ControlIndex  - the control's reference
! Width, Height - the new dimensions of the control

! Return value: N/A

! See also: SetControlPos, accessing_gui_controls

Index: GameIsBeastKnown.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/GameIsBeastKnown.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** GameIsBeastKnown.txt	31 Oct 2004 21:35:42 -0000	1.1
--- GameIsBeastKnown.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

! Parameters:

! Return value:

! See also:

--- 1,11 ----

! Prototype: GameIsBeastKnown(index)

! Description: Returns whether beast with given index is known to PCs (works only on PST).

! Parameters: index - the beast's index as of beast.ini

! Return value: boolean, 1 means beast is known.

! See also: GetINIBeastsKey

Index: GetINIPartyKey.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/GetINIPartyKey.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** GetINIPartyKey.txt	31 Oct 2004 21:35:42 -0000	1.1
--- GetINIPartyKey.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

! Return value:
! 
! See also:

--- 1,13 ----

! Prototype: GemRB.GetINIPartyKey(Tag, Key, Default)

! Description: Returns a Value from the party.ini File (works only on IWD2).

  Parameters:
+ Tag - a section in the party.ini file
+ Key - a field in the section
+ Default - default value in case the entry doesn't exist

! Return value: string, the entry from the ini file

+ See also: GetINIPartyCount

Index: CreateMapControl.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/CreateMapControl.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** CreateMapControl.txt	31 Oct 2004 21:35:42 -0000	1.1
--- CreateMapControl.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

- Return value:

! See also:

--- 1,18 ----

! Prototype: GemRB.CreateMapControl(WindowIndex, ControlID, x, y, w, h, [LabelID, FlagResRef [, Flag2ResRef]]

! Description:  Creates and adds a new Area Map Control to a Window. If WindowIndex and ControlID (not ControlIndex!) point to a valid control, it will replace that control with the MapControl using the original control's dimensions (x,y,w,h are ignored). It is possible to associate a variable with the MapControl, in this case, the associated variable will enable or disable mapnotes (you must supply a LabelID and the resources for the pins). 

  Parameters:
+ WindowIndex - the value returned from LoadWindow
+ ControlID   - the new control will be available via this controlID
+ x,y,w,h     - X position, Y position, Width and Height of the control
+ LabelID     - associated control ID to display mapnotes, it must be a label
+ FlagResRef  - Resource Reference for the pins, if no Flag2ResRef is given, this should be a .bam resref. If there is a second resref, then both must be .bmp.
+ Flag2ResRef - the readonly mapnotes are marked by this .bam (red pin)

! Return value: N/A
! 
! See also: SetVarAssoc

Index: CreateLabel.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/CreateLabel.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** CreateLabel.txt	31 Oct 2004 21:35:42 -0000	1.1
--- CreateLabel.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

! Return value:

! See also:

--- 1,23 ----

! Prototype: GemRB.CreateLabel(WindowIndex, ControlID, x, y, w, h, font, text, align)

! Description: Creates and adds a new Label to a Window.

  Parameters:
+ WindowIndex - the value returned from LoadWindow
+ ControlID   - the new control will be available via this controlID
+ x,y,w,h     - X position, Y position, Width and Height of the control
+ font        - a .bam resref which must be listed in fonts.2da too
+ text        - initial text of the label (must be string)
+ align       - label text alignment

! Return value: N/A

! Example:
!  GemRB.CreateLabel(StartWindow, 0x0fff0000, 0,415,640,30, "EXOFONT", "", 1)
!  Label=GemRB.GetControl(StartWindow, 0x0fff0000)
!  GemRB.SetText(StartWindow, Label,GEMRB_VERSION)
! The above lines add the GemRB version string to the PST main screen.
! 
! See also: CreateButton, SetText

Index: CreateButton.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/CreateButton.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** CreateButton.txt	31 Oct 2004 21:35:42 -0000	1.1
--- CreateButton.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

! Return value:

! See also:

--- 1,14 ----

! Prototype: GemRB.CreateButton(WindowIndex, ControlID, x, y, w, h)

! Description: Creates and adds a new Button to a Window.

  Parameters:
+ WindowIndex - the value returned from LoadWindow
+ ControlID   - the new control will be available via this controlID
+ x,y,w,h     - X position, Y position, Width and Height of the control

! Return value: N/A

! See also: CreateLabel, CreateMapControl, CreateWorldMapControl

Index: EnableButtonBorder.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/EnableButtonBorder.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** EnableButtonBorder.txt	31 Oct 2004 21:35:42 -0000	1.1
--- EnableButtonBorder.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

! Parameters:

! Return value:

! See also:

--- 1,14 ----

! Prototype: GemRB.EnableButtonBorder(WindowIndex, ControlIndex, BorderIndex, enabled)

! Description: Enable or disable specified border/frame/overlay of a button control.

! Parameters: 
! WindowIndex, ControlIndex  - the control's reference
! BorderIndex                - 0,1 or 2
! enabled                    - boolean, true enables the border

! Return value: N/A

! See also: SetButtonBAM, SetButtonFlags, SetButtonBorder

Index: GetINIQuestsKey.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/GetINIQuestsKey.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** GetINIQuestsKey.txt	31 Oct 2004 21:35:42 -0000	1.1
--- GetINIQuestsKey.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

! Return value:

! See also:

--- 1,14 ----

! Prototype: GemRB.GetINIQuestsKey(Tag, Key, Default)

! Description: Returns a Value from the quests.ini File (works only on PST).

  Parameters:
+ Tag - a section in the quests.ini file
+ Key - a field in the section
+ Default - default value in case the entry doesn't exist

! Return value: string, the entry from the ini file

! See also: GetINIBeastsKey

Index: GetINIBeastsKey.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/GetINIBeastsKey.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** GetINIBeastsKey.txt	31 Oct 2004 21:35:42 -0000	1.1
--- GetINIBeastsKey.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

  Parameters:

! Return value:
! 
! See also:

--- 1,13 ----

! Prototype: GemRB.GetINIBeastsKey(Tag, Key, Default)

! Description: Returns a Value from the beast.ini File (works only on PST).

  Parameters:
+ Tag - a section in the beast.ini file
+ Key - a field in the section
+ Default - default value in case the entry doesn't exist

! Return value: string, the entry from the ini file

+ See also: GetINIQuestsKey

Index: AdjustScrolling.txt
===================================================================
RCS file: /cvsroot/gemrb/gemrb/gemrb/docs/en/GUIScript/AdjustScrolling.txt,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** AdjustScrolling.txt	31 Oct 2004 21:35:41 -0000	1.1
--- AdjustScrolling.txt	1 Nov 2004 19:49:06 -0000	1.2
***************
*** 1,11 ****

! Prototype:

! Description:

! Parameters:

! Return value:

! See also:

--- 1,22 ----

! Prototype: AdjustScrolling(WindowIndex, ControlIndex, x, y)

! Description: Sets the scrolling offset of a WorldMapControl.

! Parameters: WindowIndex, ControlIndex  - the control's reference
! x,y - scrolling offset values

! Return value: N/A

! Example:
!         #northeast
!         Button = GemRB.GetControl (Window, 9)
!         GemRB.SetEvent (Window, Button, IE_GUI_BUTTON_ON_PRESS, "MapNE")
! ...
! def MapNE():
!         GemRB.AdjustScrolling (Window, WorldMapControl, 10, -10)
!         return
! The above lines set up a button event. When the button is pressed the worldmap will be shifted in the northeastern direction.
! 
! See also: CreateWorldMapControl

[Gemrb-commits] gemrb/gemrb/docs/en/GUIScript AdjustScrolling.txt,1.1,1.2 CreateButton.txt,1.1,1.2 C

GemRB is a portable open-source implementation of the Infinity Engine