Difference between revisions of "ShowPopup"
From Dragon Age Toolset Wiki
m (Adding Remarks heading) |
m (Fixing a link) |
||
| Line 8: | Line 8: | ||
|param2type = int | |param2type = int | ||
|param2name = nPopupType | |param2name = nPopupType | ||
| − | |param2desc = a reference to the popup type, defined in [[popups | + | |param2desc = a reference to the popup type, defined in [[popups 2da]] |
|param2default = | |param2default = | ||
|param3type = object | |param3type = object | ||
| Line 32: | Line 32: | ||
== Remarks == | == Remarks == | ||
<!-- This section contains additional comments, observations and known issues. --> | <!-- This section contains additional comments, observations and known issues. --> | ||
| − | When a button is pressed and the pop-up is closed, the contents of the text- | + | When a button is pressed and the pop-up is closed, the contents of the text-field will be returned as the 0th string argument to the [[EVENT_TYPE_POPUP_RESULT]] event to the module. |
| − | + | The text is filtered as it is typed using the same filter that is applied to the player's name; thus, you cannot enter spaces nor many forms of punctuation. The text-field is currently limited to 20 characters (same as the player name). | |
<!-- == Examples == --> | <!-- == Examples == --> | ||
<!-- This section contains examples transcluded from the snippet library. --> | <!-- This section contains examples transcluded from the snippet library. --> | ||
Revision as of 23:56, 10 February 2013
Show a pop-up message box
void ShowPopup(
int nMessageStrRef,
int nPopupType,
object oOwner = OBJECT_INVALID,
int bShowInputField = FALSE,
int nDefaultInputStrRef = 0
);
int nMessageStrRef,
int nPopupType,
object oOwner = OBJECT_INVALID,
int bShowInputField = FALSE,
int nDefaultInputStrRef = 0
);
- Parameters:
- nMessageStrRef
- a string reference to the text of the message box
- nPopupType
- a reference to the popup type, defined in popups 2da
- oOwner
- the owner of this popup
- bShowInputField
- a boolean which controls whether the pop-up will have a text-input field
- nDefaultInputStrRef
- a string reference to the default text for the text-input. If 0, the input field will start empty
- Returns:
- Nothing.
- Source:
- script.ldf
Remarks
When a button is pressed and the pop-up is closed, the contents of the text-field will be returned as the 0th string argument to the EVENT_TYPE_POPUP_RESULT event to the module.
The text is filtered as it is typed using the same filter that is applied to the player's name; thus, you cannot enter spaces nor many forms of punctuation. The text-field is currently limited to 20 characters (same as the player name).
