From e6338f9d66eac4ff31ea629bd9286b6d65d1857c Mon Sep 17 00:00:00 2001 From: Avenger Date: Tue, 29 Jun 2010 17:51:30 +0200 Subject: [PATCH] added documentation for new guiscript function --- gemrb/docs/en/GUIScript/GameControlSetLastActor.txt | 11 +++++++++++ gemrb/docs/en/GUIScript/SetEventByName.txt | 7 ++++--- 2 files changed, 15 insertions(+), 3 deletions(-) create mode 100644 gemrb/docs/en/GUIScript/GameControlSetLastActor.txt diff --git a/gemrb/docs/en/GUIScript/GameControlSetLastActor.txt b/gemrb/docs/en/GUIScript/GameControlSetLastActor.txt new file mode 100644 index 000000000..e9fd4bb1f --- /dev/null +++ b/gemrb/docs/en/GUIScript/GameControlSetLastActor.txt @@ -0,0 +1,11 @@ + +Prototype: GemRB.GameControlSetLastActor(partyID) + +Description: Sets LastActor in the GameControl object. The LastActor object is the player character which is currently about to be selected by the player. Its feet circle is flickering. + +Parameters: partyID - 0 to delete any previous settings, or the partyID. + +Return value: None + +See also: GameSelectPCSingle + diff --git a/gemrb/docs/en/GUIScript/SetEventByName.txt b/gemrb/docs/en/GUIScript/SetEventByName.txt index 66d303904..5c5a25ab8 100644 --- a/gemrb/docs/en/GUIScript/SetEventByName.txt +++ b/gemrb/docs/en/GUIScript/SetEventByName.txt @@ -1,8 +1,9 @@ -Prototype: Control.SetEvent(EventMask, FunctionName) +Prototype: Control.SetEventByName(EventMask, FunctionName) + Control.SetEvent(EventMask, PythonFunction) Description: Sets an event of a control on a window to a named function -defined in the currently loaded scripts namespace. +defined in the currently loaded script's namespace. Parameters: EventMask - a dword describing the event. Its high byte is actually the control's type. @@ -28,7 +29,7 @@ IE_GUI_SCROLLBAR_ON_CHANGE= 0x07000000, the scrollbar's knob position has change Return value: N/A Examples: - Bar.SetEvent (IE_GUI_PROGRESS_END_REACHED, "EndLoadScreen") + Bar.SetEventByName (IE_GUI_PROGRESS_END_REACHED, "EndLoadScreen") ... def EndLoadScreen (): Skull = GemRB.GetControl (LoadScreen, 1) -- 2.11.4.GIT