Difference between revisions of "Book"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
imported>Qazaaq
(added reference script)
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Editor Reference]]
'''Type:''' <code>BOOK</code>
[[Category:Object_Classes]]
<BR/>
[[Category:Items]]
'''Papyrus:''' [[Book Script]]. [[ObjectReference Script]]
'''Papyrus:''' [[Book Script]]


Books include text that can be read by the player or "teach" a skill or spell.
Books include text that can be read by the player or "teach" a [[Spell]] or [[Perk]].
 
The [[Book]] [[:Category:Object Classes|object]] is found within the [[Object Window]] under the [[:Category:Items|Items Category]].
[[File:Book_Object.png]]


== Editor Dialog ==
== Editor Dialog ==
*'''ID:''' The editor ID which is used by the Creation Kit.
[[File:Book Object.png]]
*'''Name:''' The name as it will appear in-game.
*{{Template:Editor:Property:ID}}
*'''Weight:''' How heavy the book is.
*{{Template:Editor:Property:Name}}
*'''Value:''' The base value in caps the item is worth to vendors.
*{{Template:Editor:Property:Weight}}
*{{Template:Editor:Property:Value}}
*'''Teaching:'''  
*'''Teaching:'''  
**'''Advance Actor Value:'''
**'''Advance Actor Value:'''
Line 18: Line 17:
**'''Add Perk:''' The book adds the selected [[Perk]] 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.
**'''None of the above:''' The book has no teaching qualities.
*'''Inventory image:'''
*{{Template:Editor:Property:Inventory Image}}
*'''Message Icon:'''
*{{Template:Editor:Property:Message Icon}}
*'''World Art:''' The 3D model seen in the world.
*{{Template:Editor:Property:World Art}}
*'''Inventory Art:''' The 3D model that appears in the inventory. Contains additional details for the book interface.
*{{Template:Editor:Property:Inventory Art}} Contains additional details for the book interface.
*'''Preview Transform:'''
*{{Template:Editor:Property:Preview Transform}}
*'''Add Destruction Data:'''
*{{Template:Editor:Property:Add Destruction Data}}
*'''Can't be Taken:'''
*'''Can't be Taken:'''
*'''Pickup Sound:''' The sound played when the book is picked up.
*{{Template:Editor:Property:Pickup Sound}}
*'''Putdown Sound:''' The sound played when the book is dropped.
*{{Template:Editor:Property:Putdown Sound}}
*'''Featured Item Message:'''
*{{Template:Editor:Property:Featured Item Message}}
*'''Description:''' Used to provide a description in the inventory.
*{{Template:Editor:Property:Description}}
*'''Book Text:''' The text content of the book.
*'''Book Text:''' The text content of the book. [[Text Replacement]] may be used here.
*'''Text Offset XY:'''
*'''Text Offset XY:'''
*'''Scripts:''' Scripts can be attached here, and their properties edited.
*{{Template:Editor:Property:Papyrus Script}}
*'''Keywords:''' Assign any needed [[Keyword]]s here.
*{{Template:Editor:Property:Keywords}}


==Markup==
== See Also ==
Books can be formatted with a variety of markup tags, listed below:
*[[Spell]]
*[[Perk]]
*[[Text Replacement]]
*[[:Category:Items|Items Category]]


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


== See Also ==
[[Category:Editor Reference]]
*[[:Category:Items|Items Category]]
[[Category:Object Classes]]
[[Category:Items]]

Latest revision as of 14:31, 30 September 2018

Type: BOOK
Papyrus: Book Script. ObjectReference Script

Books include text that can be read by the player or "teach" a Spell or Perk. The Book object is found within the Object Window under the Items Category.

Editor Dialog[edit | edit source]

Book Object.png

  • ID: The ID, also referred to as Editor ID, is used by the Creation Kit to uniquely identify this record within a Data File.
  • Name: This object's name as it will appear within user interface menus or when the player looks at it.
  • Weight: The weight of this object which represents how heavy it is.
  • Value: The object's value in caps which determines its 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: The Texture File to use for an inventory image. This property is depreciated, obsolete, or does not appear to be used by the game.
  • Message Icon: The Texture File that will be used for this object's message icon. This property is depreciated, obsolete, or does not appear to be used by the game.
  • World Art: The 3D Model File as seen in the world.
  • Inventory Art: The 3D model that appears in the inventory. Contains additional details for the book interface. Contains additional details for the book interface.
  • Preview Transform: A Transform applies positioning to a Model File. These may be used when previewing objects within the Creation Kit or in-game user interface menus.
  • Add Destruction Data: Allows you to configure the objects destruction data with the Destructible Object Data editor.
  • Can't be Taken:
  • Pickup Sound: The Sound Descriptor played when the object is picked up.
  • Putdown Sound: The Sound Descriptor played when the object is dropped.
  • Featured Item Message:
  • Description: The object's description as it will appear within user interface menus.
  • Book Text: The text content of the book. Text Replacement may be used here.
  • Text Offset XY:
  • Scripts: Papyrus scripts may be added, removed, and their properties edited.
    • Add: Adds a papyrus script to this object.
    • Remove: Removes the selected papyrus script from this object.
    • Properties: Shows the papyrus property editor for the selected script.
  • Keywords: A list of Keywords that signal information to other Game Systems.

See Also[edit | edit source]

Retrieved from "https://falloutck.uesp.net/w/index.php?title=Book&oldid=3226"