Text Replacement

From the Fallout4 CreationKit Wiki
Revision as of 01:52, 18 July 2016 by imported>Qazaaq
Jump to navigation Jump to search

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

Tokens

Quest-associated books can contain tokens used for Text Replacement if you add a book alias to the quest and set "Uses Stored Text" flag on this alias.

Markup

Some text fields support a variety of Markup tags used with formatting.

Example

<!--This is the example for text markup-->
<font face='$HandwrittenFont' size='35'>Hello World!</font>
<b><i><u>This is bold, italic, and underlined.</u></i></b>
<BR>These are some colors I like.
<ul>
<li>Black</li>
<li>White</li>
<li>Red</li>
<li>Green</li>
<li>Blue</li>
</ul></nowiki>
[pagebreak]
<!--A new page has starts here-->
<p align='center'>My center aligned text.
<p align='left'>My left aligned text.

Syntax

  • 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.
    • Example: <ul><li>Red</li><li>Green</li><li>Blue</li></ul>
  • 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'.
        • 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 File 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