ShowPopup

From Dragon Age Toolset Wiki
Revision as of 17:45, 10 February 2013 by Sunjammer (Talk | contribs) (Adding Remarks heading)

Jump to: navigation, search

Show a pop-up message box

void ShowPopup(
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

Remarks

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).