Difference between revisions of "EVENT TYPE POPUP RESULT"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m (remove redundant category)
m (Fixing links)
Line 1: Line 1:
 
{{event
 
{{event
|sourcefile=script.ldf
+
|sourcefile = script.ldf
|when= player responds to area transition prompt.
+
|when       = player responds to popup message box
|from=
+
|from       = engine
|to= module
+
|to         = module
|tocategory1=module
+
|tocategory1 = module
|sortkey=POPUP_RESULT
+
|sortkey     = POPUP_RESULT
|object0name= oOwner
+
|object0name = oOwner
|object0desc= owner of popup
+
|object0desc = owner of popup
|int0name= nPopupID
+
|int0name   = nPopupID
|int0desc = popup ID (index into [[popups.xls]])
+
|int0desc   = popup ID (a row ID in [[popups 2da]])
|int1name= nButton
+
|int1name   = nButton
|int1desc= button result (1 - 4)
+
|int1desc   = button result (1 - 4)
|string0name= sInput
+
|string0name = sInput
|string0desc= string entered into optional text field
+
|string0desc = string entered into optional text field
|creatorname=oPlayer
+
|creatorname = oPlayer
 
}}
 
}}
 
+
== Remarks ==
Calling the "[[ShowPopup]]" script function causes a popup window to be displayed to the user, with up to four buttons whose text is defined in the "popups" 2DA and up to one text input field (with a filter on the input the player can type there that's the same as the filter on player names - up to 20 characters, no spaces, limited punctuation, no empty strings). This event is generated and sent to the module script with the popup's result.
+
Calling the [[ShowPopup]] script function causes a popup message box to be displayed to the user. The message box can have up four buttons (defined in the [[popups 2da]]) and a text input field. This event is generated when the Player clicks on one of the buttons and is sent to the module script with the popup's result.

Revision as of 23:53, 10 February 2013

Source:
script.ldf
Sent when:
player responds to popup message box
Sent from:
engine
Sent to:
module
Parameters:
  • Creator: [Undocumented]
  • Integer 0: popup ID (a row ID in popups 2da)
  • Integer 1: button result (1 - 4)
  • String 0: string entered into optional text field
  • Object 0: owner of popup

Usage

case EVENT_TYPE_POPUP_RESULT:
{
object oPlayer = GetEventCreator(ev); //
int nPopupID = GetEventInteger(ev, 0); // popup ID (a row ID in popups 2da)
int nButton = GetEventInteger(ev, 1); // button result (1 - 4)
string sInput = GetEventString(ev, 0); // string entered into optional text field
object oOwner = GetEventObject(ev, 0); // owner of popup

// insert event-handling code here

break;
}

Remarks

Calling the ShowPopup script function causes a popup message box to be displayed to the user. The message box can have up four buttons (defined in the popups 2da) and a text input field. This event is generated when the Player clicks on one of the buttons and is sent to the module script with the popup's result.