Difference between revisions of "EVENT TYPE POPUP RESULT"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) (split off of event) |
m (Adding a category) |
||
| (8 intermediate revisions by 3 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{event | |
| − | + | |sourcefile = script.ldf | |
| − | + | |when = player responds to popup message box | |
| − | + | |from = engine | |
| − | + | |to = module | |
| − | + | |tocategory1 = GUI | |
| − | + | |tocategory2 = module | |
| − | + | |sortkey = POPUP_RESULT | |
| − | + | |object0name = oOwner | |
| − | + | |object0desc = owner of popup | |
| − | + | |int0name = nPopupID | |
| − | Calling the | + | |int0desc = popup ID (references a row in [[popups 2da]]) |
| − | + | |int1name = nButton | |
| − | + | |int1desc = button result (1 - 4) | |
| + | |string0name = sInput | ||
| + | |string0desc = string entered into optional text field | ||
| + | |creatorname = oPlayer | ||
| + | |creatordesc = the player | ||
| + | }} | ||
| + | == 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. | ||
Latest revision as of 00:30, 11 February 2013
- Source:
- script.ldf
- Sent when:
- player responds to popup message box
- Sent from:
- engine
- Sent to:
- module
- Parameters:
-
- Creator: the player
- Integer 0: popup ID (references a row 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); // the player
int nPopupID = GetEventInteger(ev, 0); // popup ID (references a row 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;
}
{
object oPlayer = GetEventCreator(ev); // the player
int nPopupID = GetEventInteger(ev, 0); // popup ID (references a row 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.
