Difference between revisions of "Template:OBSE Format Specifiers"

Revision as of 19:58, 11 August 2008

EX Formatting Functions

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

%r - Prints a carriage return, ending the current line and starting at the next.

%n - Prints the name of the specified reference or object.

In OBSE versions prior to v0014a, %n can crash if the object's name contains a percent sign.

%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 - a reference variable set to the spell or faction, and an index. Behaves differently depending on the passed reference:

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

Prior to OBSE v0015, magic effects using actor values (such as Restore Agility) would not display the specific actor value.
Actor values may not display correctly for non-English versions of Oblivion.

%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.

%a - Prints the character corresponding to the specified ASCII code. Passing codes for unprintable characters (such as 0) may have unpredictable (though occassionally) 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.

%{...%} - 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]

@@ Line 3: / Line 3: @@
-'''%r'''
+'''%r''' - Prints a carriage return, ending the current line and starting at the next.
-Prints a return, ending the current line and starting at the next.
+'''%n''' - Prints the name of the specified reference or object.
+:* In OBSE versions prior to v0014a, %n can crash if the object's name contains a percent sign.
+'''%i''' - Prints the formID of the specified reference or object.
-'''%n'''
+'''%k''' - Prints the name of the key for the specified DirectInput scancode, such as those used for [[IsKeyPressed2]].
-Prints the name of the specified reference or object.
+'''%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:
-*Errors may occur if the name includes a % sign
+:* Faction: Prints the ''n''th male rank title
-**Fixed as of v0014a
-'''%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 - a reference variable set to the spell or faction, and an index. Behaves differently depending on the passed reference:
 :* Magic Item: Prints the ''n''th Magic Effect
-:**For effects with specific actor values, this will display "Attribute" or "Skill" rather than the actor value itself.
+::*Prior to OBSE v0015, magic effects using actor values (such as Restore Agility) would not display the specific actor value.
-:* Faction: Prints the ''n''th male rank title
+::*Actor values may not display correctly for non-English versions of Oblivion.
-===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'''
+'''%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)
-Prints a double quote character.
+'''%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 occassionally) 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.
-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.
+'''%{...%}''' - 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?

Difference between revisions of "Template:OBSE Format Specifiers"

Revision as of 19:58, 11 August 2008

EX Formatting Functions

Navigation menu

Search