Difference between revisions of "Text Replacement"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
imported>Qazaaq
(Trimed some wiki content from skyrim.)
Line 1: Line 1:
[[Category:User Interface]]
[[Category:User Interface]]
The '''Text Replacement''' game system parses token symbols in text with string values.  
The '''Text Replacement''' game system parses value tokens and formatting tags. This is used on a several forms like [[Book]]s and [[Terminal]]s.
 
==Book Text==
The [[Book]] text field can be formatted with a variety of '''markup''' tags.
Quest-associated books can contain additional tags used for '''Text Replacement'''.
To associate book with the quest you need to add book alias to the quest and set "Uses Stored Text" flag on this alias.
 
==Markup==
* '''Comment Tag'''
** Tag: <code>&lt;!--Comment text--&gt;</code>
** Description: Comments tell the renderer not display the text wrapped within the tags while still retaining the text in the editor.
 
* '''Bold Tag'''
** Tag: <code><nowiki><b></b></nowiki></code>
** Description: Text surrounded by bold tags will be '''bolded'''.
 
* '''Italic Tag'''
** Tag: <code><nowiki><i></i></nowiki></code>
** Description: Text surrounded by italics tags will be ''italicized''.
 
* '''Underline Tag'''
** Tag: <code><nowiki><u></u></nowiki></code>
** Description: Text surrounded by underline tags will be <u>underlined</u>.
 
* '''List Tag'''
** Tag: <code><nowiki><ul><li>ITEM HERE</li></ul></nowiki></code>
** Description: Creates list items with an empty square for the icon. Each list item is indented and separated by an empty line.
 
* '''Line-Break Tag'''
** Tag: <code><nowiki><br></nowiki></code>
** Description: Breaks the text to the next line.  Strictly speaking, this tag isn't necessary.  You can just as easily add blank lines to the book text.
 
* '''Page-Break'''
** Tag: <code>[pagebreak]</code>
** Description: Breaks to the next page.  Must be on its own line.  Text automatically breaks to the next page once it reaches the end.
** Note: images do not, so if you notice your images running off the edge of the page, manually place a page-break or reduce the size of your image.
 
* '''Paragraph Tag'''
** Tag: <code><nowiki><p></nowiki></code>
** Description: Aligns and delineates a block of text as a paragraph. 
*** Alignment
**** Tag: <code><nowiki><p align='center'></nowiki></code>
**** Description: Aligns the surrounded text.  Valid values are 'left', 'right', 'justify', 'center', <s>and 'chaotic evil'</s>.
**** Note: If you want to place an image within some text so that it wraps around it, the text containing the image needs to be within paragraph tags.
 
* '''Font Tags'''
** Tag: <code><nowiki><font></nowiki></code>
** Description: Changes the font attributes of the surrounded text.
*** Color
**** Tag: <code><nowiki><font color='#FFFFFF'></font></nowiki></code>
**** Description: Changes the font's color.
*** Face
**** Tag: <code><nowiki><font face='$HandwrittenFont'></font></nowiki></code>
**** Description: Changes the typeface of the font. See the fonts section for valid typeface names.
*** Point Size
**** Tag: <code><nowiki><font size='20'></font></nowiki></code>
**** Description: Changes the font size. See below for the line lengths you can accommodate using different font sizes.
*** Alpha
**** Tag: <code><nowiki><font alpha='#FF'></font></nowiki></code>
**** Description: Changes the font's transparency. Two-digit hexadecimal values from <code>'#00'</code> (fully transparent) through <code>'#FF'</code> (fully opaque) are supported.
 
* '''Image tags'''
** Tag: <code><nowiki><img></nowiki></code>
** Description: Places an image on the page.
*** Source Filename
**** Tag: <code><nowiki><img src='img://example.dds'></nowiki></code>
**** Description: This attribute specifies the filename of the image you want to show up.  You need to use the texture path to an image.
**** Note: Make sure the filename begins with <code>img://</code>.
*** Height and Width
**** Tag: <code><nowiki><img src='example.dds' height='40' width='40'></nowiki></code>
**** Description: Sets the height and width of the image in pixels.
*** Illuminated Letters
**** Tag: <code><img src='img://Textures/Interface/Books/Illuminated_Letters/X_letter.png'></code>
**** Description: Used for adding special illuminated letters at the beginning of books. (Replace the "X" with any letter or number.)
 


==Fonts==
==Fonts==

Revision as of 18:58, 17 July 2016

The Text Replacement game system parses value tokens and formatting tags. This is used on a several forms like Books and Terminals.

Book Text

The Book text field can be formatted with a variety of markup tags. Quest-associated books can contain additional tags used for Text Replacement. To associate book with the quest you need to add book alias to the quest and set "Uses Stored Text" flag on this alias.

Markup

  • Comment Tag
    • Tag: <!--Comment text-->
    • Description: Comments tell the renderer not display the text wrapped within the tags while still retaining the text in the editor.
  • Bold Tag
    • Tag: <b></b>
    • Description: Text surrounded by bold tags will be bolded.
  • Italic Tag
    • Tag: <i></i>
    • Description: Text surrounded by italics tags will be italicized.
  • Underline Tag
    • Tag: <u></u>
    • Description: Text surrounded by underline tags will be underlined.
  • List Tag
    • Tag: <ul><li>ITEM HERE</li></ul>
    • Description: Creates list items with an empty square for the icon. Each list item is indented and separated by an empty line.
  • Line-Break Tag
    • Tag: <br>
    • Description: Breaks the text to the next line. Strictly speaking, this tag isn't necessary. You can just as easily add blank lines to the book text.
  • Page-Break
    • Tag: [pagebreak]
    • Description: Breaks to the next page. Must be on its own line. Text automatically breaks to the next page once it reaches the end.
    • Note: images do not, so if you notice your images running off the edge of the page, manually place a page-break or reduce the size of your image.
  • Paragraph Tag
    • Tag: <p>
    • Description: Aligns and delineates a block of text as a paragraph.
      • Alignment
        • Tag: <p align='center'>
        • Description: Aligns the surrounded text. Valid values are 'left', 'right', 'justify', 'center', and 'chaotic evil'.
        • Note: If you want to place an image within some text so that it wraps around it, the text containing the image needs to be within paragraph tags.
  • Font Tags
    • Tag: <font>
    • Description: Changes the font attributes of the surrounded text.
      • Color
        • Tag: <font color='#FFFFFF'></font>
        • Description: Changes the font's color.
      • Face
        • Tag: <font face='$HandwrittenFont'></font>
        • Description: Changes the typeface of the font. See the fonts section for valid typeface names.
      • Point Size
        • Tag: <font size='20'></font>
        • Description: Changes the font size. See below for the line lengths you can accommodate using different font sizes.
      • Alpha
        • Tag: <font alpha='#FF'></font>
        • Description: Changes the font's transparency. Two-digit hexadecimal values from '#00' (fully transparent) through '#FF' (fully opaque) are supported.
  • Image tags
    • Tag: <img>
    • Description: Places an image on the page.
      • Source Filename
        • Tag: <img src='img://example.dds'>
        • Description: This attribute specifies the filename of the image you want to show up. You need to use the texture path to an image.
        • Note: Make sure the filename begins with img://.
      • Height and Width
        • Tag: <img src='example.dds' height='40' width='40'>
        • Description: Sets the height and width of the image in pixels.
      • Illuminated Letters
        • Tag: <img src='img://Textures/Interface/Books/Illuminated_Letters/X_letter.png'>
        • Description: Used for adding special illuminated letters at the beginning of books. (Replace the "X" with any letter or number.)


Fonts

The fonts displayed in game are stored in a Flash Movie font library. These font libraries are shared between menus during runtime. The current font configuration can be found in Fallout 4\Data\Interface\FontConfig.txt

  • Library:Interface\fonts_en.swf
    • Symbol: $MAIN_Font
    • Font Family: Roboto Condensed
    • Font Style: Normal
  • Library:Interface\fonts_en.swf
    • Symbol: $MAIN_Font_Bold
    • Font Family: Roboto Condensed
    • Font Style: Bold
  • Library:Interface\fonts_en.swf
    • Symbol: $HandwrittenFont
    • Font Family: Handwritten_Institute
    • Font Style: Normal
  • Library:Interface\fonts_en.swf
    • Symbol: $BRODY
    • Font Family: "Brody"
    • Font Style: Bold
  • Library:Interface\fonts_en.swf
    • Symbol: $Terminal_Font
    • Font Family: Share-TechMono
    • Font Style: Normal
  • Library:Interface\fonts_en.swf
    • Symbol: $Controller_Buttons
    • Font Family: Controller Buttons
    • Font Style: Normal
  • Library:Interface\fonts_en.swf
    • Symbol: $Controller_Buttons_inverted
    • Font Family: Controller Buttons inverted
    • Font Style: Normal
  • Library:Interface\fonts_console.swf
    • Symbol: $ConsoleFont
    • Font Family: Arial
    • Font Style: Normal
  • Library:Interface\fonts_console.swf
    • Symbol: $DebugTextFont
    • Font Family: Consolas
    • Font Style: Normal
Retrieved from "https://falloutck.uesp.net/w/index.php?title=Text_Replacement&oldid=7051"