Difference between revisions of "Template:OBSE Format Specifiers"

From the Oblivion ConstructionSet Wiki
Jump to navigation Jump to search
imported>Haama
(→‎EX Formatting Functions: Updated to v0014a)
imported>Haama
(→‎Added as of v0014a: Fixed %{} and added example)
Line 44: Line 44:




'''%(...%)
'''%{...%}


Conditionally omits a portion of the format string based on a boolean value. The left bracket accepts a variable; if the value of the variable is zero, all text up to the right bracket will be ignored, and any parameters supplied to format specifiers within the omitted substring will be skipped.
Conditionally displays/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 right bracket will be ignored.
*Example
MBoxEX "Doom comes%{ for you%}. What will you do?|Dig a hole, hide%{|Find someone, offer 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
    Print this Omit this
    [Dig a hole, hide]
    [Find someone, offer as sacrifice]
    [Find someone, use as shield]
    [Enjoy your final 15 minutes]

Revision as of 13:42, 13 February 2008

EX Formatting Functions

These formatting specifiers will work with OBSE output functions, along with the usual functions.


%r

Prints a 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.


%k

Prints the name of the key for the specified DirectInput scancode, such as those used for IsKeyPressed2.


%c

Prints the specified component of the specified reference or object. Takes two arguments - the reference, and an index. Behaves differently depending on the passed reference:

  • Magic Item: Prints the nth Magic Effect
  • Faction: Prints the nth male rank title

Added as of v0014a

%p

Displays a pronoun based on the gender of the object parameter:

  • %po - objective (he, she, it)
  • %pp - possessive (his, her, its)
  • %ps - subjective (him, her, it)


%q

Prints a double quote character.


%{...%}

Conditionally displays/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 right bracket will be ignored.

  • Example
MBoxEX "Doom comes%{ for you%}. What will you do?|Dig a hole, hide%{|Find someone, offer 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

   Print this Omit this
   [Dig a hole, hide]
   [Find someone, offer as sacrifice]
   [Find someone, use as shield]
   [Enjoy your final 15 minutes]