Difference between revisions of "ShowPopup"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (link) |
m (Fixing category) |
||
| (9 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | {{dafunction | |
| + | |name = ShowPopup | ||
| + | |brief = Show a pop-up message box. | ||
| + | |param1type = int | ||
| + | |param1name = nMessageStrRef | ||
| + | |param1desc = a string reference to the text of the message box | ||
| + | |param1default = | ||
| + | |param2type = int | ||
| + | |param2name = nPopupType | ||
| + | |param2desc = a reference to the popup type, defined in [[popups 2da]] | ||
| + | |param2default = | ||
| + | |param3type = object | ||
| + | |param3name = oOwner | ||
| + | |param3desc = the owner of this popup | ||
| + | |param3default = OBJECT_INVALID | ||
| + | |param4type = int | ||
| + | |param4name = bShowInputField | ||
| + | |param4desc = a boolean which controls whether the pop-up will have a text-input field | ||
| + | |param4default = FALSE | ||
| + | |param5type = int | ||
| + | |param5name = nDefaultInputStrRef | ||
| + | |param5desc = a string reference to the default text for the text-input. If 0, the input field will start empty | ||
| + | |param5default = 0 | ||
| + | |returntype = void | ||
| + | |returndesc = | ||
| + | |sourcefile = script.ldf | ||
| + | |sourcemodule = | ||
| + | }} | ||
| − | + | <!-- == Description == --> | |
| − | + | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | |
| − | + | == Remarks == | |
| − | + | <!-- 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-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 == --> | |
| − | + | <!-- This section contains examples transcluded from the snippet library. --> | |
| − | + | <!-- == See also == --> | |
| − | [[Category: | + | <!-- This section contains links to articles, functions or constant groups. --> |
| + | [[Category:GUI functions]] | ||
Latest revision as of 00:04, 11 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).
