Difference between revisions of "ShowPopup"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(formatting)
(Generated by Sunjammer's Dragon Age Script Paser)
Line 1: Line 1:
 +
{{Generated with errors}}
 
{{dafunction
 
{{dafunction
 
|name=ShowPopup
 
|name=ShowPopup
−
|brief= Shows the user a popup window with an optional text entry field and up to four buttons
+
|brief=Show a popup
−
|returntype=void
+
 
|param1type=int
 
|param1type=int
 
|param1name=nMessageStrRef
 
|param1name=nMessageStrRef
−
|param1desc=a string reference to the text of the message box.
+
|param1desc=
 
|param2type=int
 
|param2type=int
 
|param2name=nPopupType
 
|param2name=nPopupType
−
|param2desc=a reference to the popup type, defined in [[popups.xls]]
+
|param2desc=
 
|param3type=object
 
|param3type=object
 
|param3name=oOwner
 
|param3name=oOwner
−
|param3desc=the owner of this popup
+
|param3desc=
−
|param3default=OBJECT_INVALID
+
 
|param4type=int
 
|param4type=int
 
|param4name=bShowInputField
 
|param4name=bShowInputField
−
|param4desc=a boolean which controls whether the pop-up will have a text-input field.
+
|param4desc=
−
|param4default=FALSE
+
 
|param5type=int
 
|param5type=int
 
|param5name=nDefaultInputStrRef
 
|param5name=nDefaultInputStrRef
−
|param5desc=a string reference to the default text for the text-input. If 0, the input field will start empty.
+
|param5desc=
−
|param5default=0
+
|returntype=void
 +
|returndesc=
 
|sourcefile=script.ldf
 
|sourcefile=script.ldf
 
|sourcemodule=
 
|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]].
+
<!-- == 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. -->
 +
 
 +
<!-- == Examples == -->
 +
<!-- This section contains examples transcluded from the snippet library. -->
  
−
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).
+
<!-- == See also == -->
 +
<!-- This section contains links to articles, functions or constant groups. -->
  
−
[[Category:Scripts]]
+
[[Category: Inventory & equip slot functions]]

Revision as of 02:40, 29 July 2009

This page was generated by Sunjammer's Dragon Age Script Parser.

The parser was unable to extract and/or match all the information required and has flagged this page as containing one or more errors. The source file was not formatted correctly and the information presented is incomplete or incorrect.

This page must be reviewed by a knowledgeable scripter as it will need to be updated. Once identified, the issue in the source file should be reported to BioWare.

Please remove the {{Generated with errors}} tag once the page has been corrected.

Show a popup

void ShowPopup(
int nMessageStrRef,
int nPopupType,
object oOwner,
int bShowInputField,
int nDefaultInputStrRef
);
Parameters:
nMessageStrRef
[Undocumented]
nPopupType
[Undocumented]
oOwner
[Undocumented]
bShowInputField
[Undocumented]
nDefaultInputStrRef
[Undocumented]
Returns:

Nothing.

Source:

script.ldf

Retrieved from "http://datoolset.net/mw/index.php?title=ShowPopup&oldid=3592"