Difference between revisions of "ShowMessage"
Updated to use function template
imported>JT |
imported>Cipscis (Updated to use function template) |
||
| Line 1: | Line 1: | ||
== | {{Function | ||
|origin = GECK1 | |||
|summary = [[ShowMessage]] is used to display [[message|messages]] to the player. The message itself is an editor object that contains all the data: display text, type of message, and buttons (if the message is a message box). | |||
|arguments = {{FunctionArgument | |||
|Name = MessageID | |||
|Type = ref | |||
}}{{FunctionArgument | |||
|Name = var1 | |||
|Type = var | |||
}}{{FunctionArgument | |||
|Name = var2 | |||
|Type = var | |||
}}{{FunctionArgument | |||
|Name = ... | |||
}}{{FunctionArgument | |||
|Name = var9 | |||
|Type = var | |||
}}{{FunctionArgument | |||
|Name = Duration | |||
|Type = int | |||
|Optional = true | |||
}} | |||
The number of ''var'' parameters required is equal to the number of [[ShowMessage#Formatting_messages|format specifiers]] in the specified message's content, up to a maximum of 9. | |||
|example = ShowMessage MyMessage | |||
Shows ''MyMessage''. | |||
ShowMessage TimeScaleMessage TimeScale | |||
Shows ''TimeScaleMessage'', and inserts the value stored in ''TimeScale'' into it. In order for this to work, ''TimeScaleMessage'' must have the appropriate [[ShowMessage#Formatting_messages|format specifier]] to display a floating point value. | |||
}} | |||
== | ==Notes== | ||
* This command replaces the "Message" and "MessageBox" functions of Oblivion and Morrowind. | * This command replaces the "Message" and "MessageBox" functions of Oblivion and Morrowind. | ||
* Buttons are part of the Message form. If no buttons are specified on a MessageBox type message, a default "OK" button will be displayed. | * Buttons are part of the Message form. If no buttons are specified on a MessageBox type message, a default "OK" button will be displayed. | ||
| Line 12: | Line 35: | ||
* Variables can be inserted into the displayed text (see below). The message will fail to display if the wrong number of variables are passed into the ShowMessage call. | * Variables can be inserted into the displayed text (see below). The message will fail to display if the wrong number of variables are passed into the ShowMessage call. | ||
* Variables cannot be inserted into a message box's buttons. | * Variables cannot be inserted into a message box's buttons. | ||
* The " | * The "Duration" parameter doesn't actually do anything | ||
== | ==Formatting messages== | ||
Variable parameters can be used in conjunction with a Message in order to insert variables into the displayed text. | Variable parameters can be used in conjunction with a Message in order to insert variables into the displayed text. | ||
* Use the formatting notation below in the text of the Message. | * Use the formatting notation below in the text of the Message. | ||