Mod:Creation Kit/Show - Message

Member of: Mod:Creation Kit/Message Script

Displays the message to the screen, substituting the passed-in numbers into the appropriate spots in the text. If the message is set to display in a message box, the function waits for the user to press a button and returns which button they hit.

Syntax
int Function Show(float afArg1 = 0.0, float afArg2 = 0.0, float afArg3 = 0.0, float afArg4 = 0.0, float afArg5 = 0.0,   float afArg6 = 0.0, float afArg7 = 0.0, float afArg8 = 0.0, float afArg9 = 0.0) native

Parameters

 * afArg1: The number to substitute into the first spot in the text.
 * Default: 0.0
 * afArg2: The number to substitute into the second spot in the text.
 * Default: 0.0
 * afArg3: The number to substitute into the third spot in the text.
 * Default: 0.0
 * afArg4: The number to substitute into the fourth spot in the text.
 * Default: 0.0
 * afArg5: The number to substitute into the fifth spot in the text.
 * Default: 0.0
 * afArg6: The number to substitute into the sixth spot in the text.
 * Default: 0.0
 * afArg7: The number to substitute into the seventh spot in the text.
 * Default: 0.0
 * afArg8: The number to substitute into the eighth spot in the text.
 * Default: 0.0
 * afArg9: The number to substitute into the ninth spot in the text.
 * Default: 0.0

Return Value
If the message displays a message box to the user, it returns the button the user hit. If it doesn't, it will return -1 immediately.

Examples
HelloWorld.Show YouGotGold.Show(10) the button the user hit /; int ibutton = YetAnotherMessage.Show(afArg3 = 20)
 * Display a simple message to the user
 * Display a message, replacing the first number with a 10
 * / Display a message, replacing the third number with a 20 (leaving first and second to be 0), and getting

Message Text
To designate where to put the numbers in the message in the editor, the following format is used: %[flags][width][.precision]f

If you want the message to contain a % sign, then you must use a double % sign like so: %%

Flags
Flags is one or more of the following characters:

Width
This is an optional number that specifies the minimum number of characters to output. This includes the sign character (+ or -) and the decimal point, if any.

Precision
This value specifies the number of digits after the decimal point. If a decimal point appears, there is always at least one digit before it. The value is rounded to the appropriate number of digits.

The default precision is 6. If precision is 0, or if the period appears without a number following it, no decimal point is printed.

Examples
Values: 5 1.1 -0.523456745

"%f" results in: 5.0 1.1 -0.523457

"%.0f" results in: 5 1 -1

"%+05f" results in: +0005 +01.1 -0.523457

"%10.2f" results in: 5.00      1.10      -0.52