Difference between revisions of "ShowMessage"

2,560 bytes added ,  18:37, 9 November 2012
Added FOSE format switches
imported>Cipscis
(Updated to use function template)
imported>Hammil
(Added FOSE format switches)
 
Line 82: Line 82:


'''[[sUActn|&sUActn...]]''' - Allows you to insert the key used for a given control, such as the Activate button, the Always Run button, or the Block button.  See the '''[[sUActn]]''' article for the list of control codes.
'''[[sUActn|&sUActn...]]''' - Allows you to insert the key used for a given control, such as the Activate button, the Always Run button, or the Block button.  See the '''[[sUActn]]''' article for the list of control codes.
====FOSE Switches====
'''%r''' - Prints a carriage return, ending the current line and starting at the next.
'''%n''' - Prints the name of the specified reference or object.
'''%i''' - Prints the formID of the specified reference or object. GOTCHA : if a refVar is passed which points to a ref not loaded in memory %i will print 00000000 ''even if the refVar is not empty''.
'''%k''' - Prints the name of the key for the specified DirectInput scancode.
'''%c''' - Prints the specified component of the specified reference or object. Takes two arguments - a reference variable set to the spell or faction, and an index. Behaves differently depending on the passed reference:
:* Faction: Prints the ''n''th male rank title
:* Magic Item: Prints the ''n''th Magic Effect
'''%p''' - Displays a pronoun based on the gender of the object parameter:
:* %po - objective  (him, her, it)
:* %pp - possessive (his, her, its)
:* %ps - subjective (he, she, it)
'''%q''' - Prints a double quote character.
'''%a''' - Prints the character corresponding to the specified ASCII code. Passing codes for unprintable characters (such as 0) may have unpredictable (though occasionally useful) results. Passing the code for a percent sign will most likely crash the game as literal percent signs must come in pairs.
'''%v''' - Prints the actor value (i.e. an attribute or skill) associated with the passed actor value code.
'''%e''' - Provides a workaround for the script compiler's refusal to accept an empty string as a command argument.
* Example:
SetName "" object    ; attempts to remove an object's name, but won't compile
SetName "%e" object  ; sets the name to an empty string
'''%{...%}''' - Conditionally displays or omits the bracketed portion of the format string based on a boolean value. Accepts a variable - if the value of the variable is zero, all text and parameters up to the matching right bracket will be ignored. Otherwise the bracketed text will be displayed.
* Example (should be single-line, line-breaks added for Wiki)
MBoxEX "Doom comes%{ for you%}. What will you do?
|Dig a hole, hide
%{|Find someone, offer as sacrifice|Find someone, use as shield%}
|Enjoy your final 15 minutes" bDisplay bDisplay
If bDisplay is 0 this will print out
    Doom comes. What will you do?
    [Dig a hole, hide]
    [Enjoy your final 15 minutes]
If bDisplay is 1 this will print out
    Doom comes for you. What will you do?
    [Dig a hole, hide]
    [Find someone, offer as sacrifice]
    [Find someone, use as shield]
    [Enjoy your final 15 minutes]


=='''See Also'''==
=='''See Also'''==
Anonymous user