Difference between revisions of "ShowPopup"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (link) |
BryanDerksen (Talk | contribs) (formatting) |
||
| Line 1: | Line 1: | ||
| − | + | {{dafunction | |
| + | |name=ShowPopup | ||
| + | |brief= Shows the user a popup window with an optional text entry field and up to four buttons | ||
| + | |returntype=void | ||
| + | |param1type=int | ||
| + | |param1name=nMessageStrRef | ||
| + | |param1desc=a string reference to the text of the message box. | ||
| + | |param2type=int | ||
| + | |param2name=nPopupType | ||
| + | |param2desc=a reference to the popup type, defined in [[popups.xls]] | ||
| + | |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 | ||
| + | |sourcefile=script.ldf | ||
| + | |sourcemodule= | ||
| + | }} | ||
| − | + | When a button is pressed and the pop-up is closed, the contents of the text-entry field will be returned as the 0th string argument to the [[EVENT_TYPE_POPUP_RESULT]] [[event]] to the [[module]]. | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | Text is filtered as it's typed using the same filter that's 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). | |
| − | + | ||
| − | Text is filtered as | + | |
[[Category:Scripts]] | [[Category:Scripts]] | ||
Revision as of 20:37, 24 July 2009
Shows the user a popup window with an optional text entry field and up to four buttons
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.xls
- 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
When a button is pressed and the pop-up is closed, the contents of the text-entry field will be returned as the 0th string argument to the EVENT_TYPE_POPUP_RESULT event to the module.
Text is filtered as it's typed using the same filter that's 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).
