Mod:Creation Kit/Book

Papyrus: Book Script

Books include text that can be read by the player or "teach" a skill or spell.



Editor Dialog

 * ID: The editor ID which is used by the Creation Kit.
 * Name: The name as it will appear in-game.
 * Weight: How heavy the book is.
 * Value: The base value in caps the item is worth to vendors.
 * Teaching:
 * Advance Actor Value:
 * Add Spell: The book adds the selected Spell to the player when read.
 * Add Perk: The book adds the selected Perk to the player when read.
 * None of the above: The book has no teaching qualities.
 * Inventory image:
 * Message Icon:
 * World Art: The 3D model seen in the world.
 * Inventory Art: The 3D model that appears in the inventory. Contains additional details for the book interface.
 * Preview Transform:
 * Add Destruction Data:
 * Can't be Taken:
 * Pickup Sound: The sound played when the book is picked up.
 * Putdown Sound: The sound played when the book is dropped.
 * Featured Item Message:
 * Description: Used to provide a description in the inventory.
 * Book Text: The text content of the book.
 * Text Offset XY:
 * Scripts: Scripts can be attached here, and their properties edited.
 * Keywords: Assign any needed Keywords here.

Markup
Books can be formatted with a variety of markup tags, listed below:


 * Bold tags : Text surrounded by bold tags will be bolded.
 * Italic tags : Text surrounded by italics tags will be italicized.
 * Underline tags : Text surrounded by underline tags will be underlined.
 * Line break : 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.
 * List tag : Creates list items with an empty square for the icon. Each list item is indented and separated by an empty line.
 * Font tag : Changes attributes of the surrounded text. Available fonts are listed below.  Supported attributes are:
 * Color : Changes the font's color.
 * Typeface : Changes the typeface of the font. The only typefaces supported at the moment are:   and   (default).  More typefaces can be added to the menu if desired, but it costs us memory for each one, so don't go crazy with the Feature Requests.
 * Point size : Changes the font size. See below for the line lengths you can accommodate using different font sizes.
 * Alpha : Changes the font's transparency. Two-digit hexadecimal values from   (fully transparent) through   (fully opaque) are supported.  Useful if your author was low on ink?
 * Image tags : Places an image on the page. See Examples below to see different ways of placing images.  Supported attributes:
 * Source filename : NECESSARY This attribute specifies the filename of the image you want to show up. You need to use the full pathname of the texture.  You also need to make sure the filename begins with.
 * Height / width : Sets the height / width (in pixels) of the image.
 * Illuminated Letters : Used for adding special illuminated letters at the beginning of books. (Replace the "X" with any letter or number.)
 * Paragraph tag : Delineates a block of text as a paragraph. Automatically adds a blank line after the end of the paragraph.  Same with the   tag, this isn't really necessary unless you're using the following attribute:
 * Alignment : Aligns the surrounded text. Valid values are 'left', 'right', 'justify', 'center'.
 * Also, 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. See Examples below for Examples.
 * Page-break : Breaks to the next page. Must be on its own line.  Text automatically breaks to the next page once it reaches the end.  Unfortunately, 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.
 * Comments (&lt;!--Comment text--&gt;): Comments out the "Comment text", i.e. Tells the renderer to not display the text wrapped within the tags, while still retaining the text in the editor.
 * Quest-associated books can contain additional tags (see 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.