Book

From the CreationKit Wiki
Revision as of 23:13, 4 March 2012 by imported>IcyDeadPeople (→‎Markup)
Jump to navigation Jump to search
200px Alert image.png TAKE NOTICE!

This article has been flagged as incomplete or inaccurate. Take any information here with a grain of salt.

Help out! If you have the knowledge needed, please edit this article so we can remove the Incomplete flag.

Books do not have to include text that can be read by the player. Activating the book can "teach" a skill or spell.

Editing a Book object

Data Fields

  • ID: The Base ID of the book
  • Name: The name as it will appear in-game
  • Weight: How heavy the book is
  • Value: Base value (in gold) the item is worth to vendors
  • Teaches: The actor value that is increased.
  • Inventory image: Not Used
  • Message Icon: Not Used
  • World Art: The 3D model seen in the world
  • Inventory Art: The 3D model that appears in the Inventory. Contains additional details for the "reading" interface
  • Destruction Data: Not Used
  • Can't Be Taken:
  • Pickup Sound:
  • Putdown Sound:
  • Book Text: Unless the book teaches a skill/spell, this text will be displayed
  • Script: Scripts can be attached here, and their properties edited.
  • Keywords: Assign any needed Keyword here
  • Description: Used to provide an "item card" description in the inventory.

Markup

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

  • Bold tags (<b></b>): Text surrounded by bold tags will be bolded.
  • Italic tags (<i></i>): Text surrounded by italics tage will be italicized.
  • Line break (<br>): 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.
  • Font tag (<font>): Changes attributes of the surrounded text. Available fonts are listed below. Supported attributes are:
    • Color (<font color='#FFFFFF'></font>): Changes the font's color.
    • Typeface (<font face='$HandwrittenFont'></font>): Changes the typeface of the font. The only typefaces supported at the moment are: $HandwrittenFont and $PrintedFont (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 (<font size='20'></font>): Changes the font size
    • Alpha (<font alpha='#FF'></font>): Changes the font's transparency. Two-digit hexadecimal values from '#00' (fully transparent) through '#FF' (fully opaque) are supported. Useful if your author was low on ink?
  • Image tags (<img>): Places an image on the page. See Examples below to see different ways of placing images. Supported attributes:
    • Source filename (<img src='img://example.dds'>): 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 img://.
    • Height / width (<img src='example.dds' height='40' width='40'>): Sets the height / width (in pixels) of the image.
    • Illuminated Letters (<img src='img://Textures/Interface/Books/Illuminated_Letters/X_letter.png'>): Used for adding special illuminated letters at the beginning of books. (Replace the "X" with any letter or number.)
  • Paragraph tag (<p>): Delineates a block of text as a paragraph. Automatically adds a blank line after the end of the paragraph. Same with the <br> tag, this isn't really necessary unless you're using the following attribute:
    • Alignment (<p align='center'>): Aligns the surrounded text. Valid values are 'left', 'right', 'justify', 'center', and 'chaotic evil'.
    • 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 ([pagebreak]): 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.

Fonts

These are the font types available for use in the tags and their available characters.

  • $SkyrimBooks
    • ABCDEFGHIJKLMNOPQRSTUVWXYZ
    • abcdefghijklmnopqrstuvwxyz
    • 0123456789
    • !@#$%^&*(){}[]-=_+:";'<>,./?
  • $HandwrittenBold
    • ABCDEFGHIJKLMNOPQRSTUVWXYZ
    • abcdefghijklmnopqrstuvwxyz
    • 0123456789
    • !@#$%^&*(){}[]-=_+:";'<>,./?
  • $DaedricFont
    • ABCDEFGHIJKLMNOPQRSTUVWXYZ
    • abcdefghijklmnopqrstuvwxyz
  • $DragonFont (Upper case only)
    • ABCDEFGHIJKLMNOPQRSTUVWXYZ
    • 0123456789
  • $DwemerFont
    • ABCDEFGHIJKLMNOPQRSTUVWXYZ
    • abcdefghijklmnopqrstuvwxyz
    • !-:";,.?
  • $FalmerFont (Upper case only)
    • ABCDEFGHIJKLMNOPQRSTUVWXYZ
    • 1

Examples

[ToDo: Honor the promise from the img tag above: "See Examples below to see different ways of placing images."] [ToDo: Honor the promise from the p tag above: "See Examples below for Examples."]