Difference between revisions of "Terminal"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Scrivener07
m (Welcome Text)
(Added object type code and property descriptions.)
 
(One intermediate revision by one other user not shown)
Line 1: Line 1:
[[Category:Editor Reference]]
[[Category:Editor Reference]]
[[Category:Object_Classes]]
[[Category:Object Classes]]
[[Category:WorldObjects]]
[[Category:WorldObjects]]
'''Papyrus:''' [[Terminal Script]]
'''Type:''' <code>TERM</code>
<BR/>
'''Papyrus:''' [[Terminal Script]], [[ObjectReference Script]]


Terminal forms are used to construct the terminals and holotapes in-game. A Terminal ''form'' doesn't always represent the full contents of a terminal ''object''; nested menus are actually implemented as multiple terminals that "link" to each other, like web pages.
Terminal forms are used to construct the terminals and [[Holotape]] in-game. A Terminal ''form'' doesn't always represent the full contents of a terminal ''object''; nested menus are actually implemented as multiple terminals that "link" to each other, like web pages. Attached scripts should extend [[ObjectReference Script|ObjectReference]], not [[Terminal Script|Terminal]].


== Editor Dialog ==
== Editor Dialog ==
Line 10: Line 12:
The Terminal dialog box is extremely large and may not fit on your screen. Unless you have a massive screen resolution, you will probably need to use something like [http://www.howtogeek.com/howto/windows-vista/get-the-linux-altwindow-drag-functionality-in-windows/ AltWindowDrag] to be able to access and use the full window.
The Terminal dialog box is extremely large and may not fit on your screen. Unless you have a massive screen resolution, you will probably need to use something like [http://www.howtogeek.com/howto/windows-vista/get-the-linux-altwindow-drag-functionality-in-windows/ AltWindowDrag] to be able to access and use the full window.


*'''ID:''' The editor ID that this form uses in the Creation Kit.
*{{Template:Editor:Property:ID}}
*'''Name:''' The display name for this terminal, shown when a player looks at it in the game world.
*{{Template:Editor:Property:Name}}
*'''Model:''' The 3D model file used by this terminal when it is placed in the world.
*{{Template:Editor:Property:Model}}
*'''Marker Model:''' The 3D model file used by the Creation Kit to show [[furniture]] markers for this terminal.
*'''Marker Model:''' The 3D [[Model File]] used by the Creation Kit to show [[furniture]] markers for this terminal.
*'''Looping Sound:'''
*'''Looping Sound:'''
*'''Destruction Data:'''
*{{Template:Editor:Property:Add Destruction Data}}
*'''Holds Holotape:''' Specify a [[Holotape]] item to be loaded by default, in any copies of this terminal that are placed in the game world.
*'''Holds Holotape:''' Specify a [[Holotape]] item to be loaded by default, in any copies of this terminal that are placed in the game world.
<br/>
<br/>
*'''Header Text:''' Text shown at the top of a terminal's screen.
*'''Header Text:''' Text shown at the top of a terminal's screen.
*'''Welcome Text:'''Text shown below the header text on the terminal's screen.
*'''Welcome Text:'''Text shown below the header text on the terminal's screen.
*'''Papyrus Scripts:''' [[Papyrus]] scripts to be attached to this object when it's placed in the world. These should extend [[ObjectReference Script|ObjectReference]], not [[Terminal Script|Terminal]].
*{{Template:Editor:Property:Papyrus Script}}
*'''Keywords:''' [[Keywords]] applied to this terminal, to indicate useful information to other game systems. As with [[furniture]], some terminal keywords change the animations that actors use when interacting with a terminal.
*{{Template:Editor:Property:Keywords}} As with [[furniture]], some terminal keywords change the animations that actors use when interacting with a terminal.
*'''Actor Values:'''
*{{Template:Editor:Property:Actor Values}}
<br/>
<br/>
*'''Body Text:'''
*'''Body Text:'''
Line 41: Line 43:
**'''Marker Position/Orientation:'''
**'''Marker Position/Orientation:'''
**'''Marker Available Entry Types:'''
**'''Marker Available Entry Types:'''
**'''Make Wall Terminal:'''Possibly Unused. If a new terminal, only adds the keywords "FurnitureForce1stPerson" and "PlayerPathToFurniture" automatically.
**'''Make Wall Terminal:'''If a new terminal, only adds the keywords "FurnitureForce1stPerson" and "PlayerPathToFurniture" automatically.
**'''Make Desk Terminal:'''Possibly Unused. Same as Make Wall Terminal.
**'''Make Desk Terminal:'''Same as Make Wall Terminal. For expected results, the Model and/or Model Marker paths are to be filled.
*'''Preview Window'''
*'''Preview Window'''
*'''Random Anim Start:'''
*'''Random Anim Start:'''
Line 54: Line 56:


== See Also ==
== See Also ==
*[[Holotape]]
*[[:Category:WorldObjects|WorldObjects Category]]
*[[:Category:WorldObjects|WorldObjects Category]]

Latest revision as of 02:18, 23 February 2023

Type: TERM
Papyrus: Terminal Script, ObjectReference Script

Terminal forms are used to construct the terminals and Holotape in-game. A Terminal form doesn't always represent the full contents of a terminal object; nested menus are actually implemented as multiple terminals that "link" to each other, like web pages. Attached scripts should extend ObjectReference, not Terminal.

Editor Dialog[edit | edit source]

Terminal Editor.png

The Terminal dialog box is extremely large and may not fit on your screen. Unless you have a massive screen resolution, you will probably need to use something like AltWindowDrag to be able to access and use the full window.

  • 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.
  • Model: The 3D Model File that will be used when this object is placed in the game world.
  • Marker Model: The 3D Model File used by the Creation Kit to show furniture markers for this terminal.
  • Looping Sound:
  • Add Destruction Data: Allows you to configure the objects destruction data with the Destructible Object Data editor.
  • Holds Holotape: Specify a Holotape item to be loaded by default, in any copies of this terminal that are placed in the game world.


  • Header Text: Text shown at the top of a terminal's screen.
  • Welcome Text:Text shown below the header text on the terminal's screen.
  • 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. As with furniture, some terminal keywords change the animations that actors use when interacting with a terminal.
  • Actor Values: A list of Actor Values to use.


  • Body Text:
    • Display Text: Text shown when this body text is used.
    • Item Conditions: If any conditions are specified, then this body text will only be shown if all conditions are met. (?)
  • Menu Items: A list of menu items displayed by the terminal. These can be reordered with the buttons to the right of the list, which are easy to miss.
    • Item Text: The text of the menu item.
    • Response Text:
    • Action: Specify non-scripted behavior for the menu item.
      • Submenu: When the menu item is selected, the contents of the specified Terminal form will display. Users will be able to return to this Terminal (the one you're editing) by pressing the B button. Think of this as being similar to a hyperlink on a web page.
      • Display Text: When the menu item is selected, the contents of the textbox will display. Users will be able to return to this Terminal (the one you're editing) by pressing the B button.
      • Return to Top Level: When the menu item is selected, players will be returned to the terminal they started at.
      • Force Redraw: When the menu item is selected, the player will remain at this menu, but it will be redrawn (and its conditions will be rechecked).
      • Papyrus Fragment: Specify a Papyrus terminal fragment to run when the menu item is selected, and before any non-scripted behaviors (e.g. "Force Redraw") are carried out.
      • Item Conditions: If any conditions are specified, the menu item will only be shown if all conditions are met. Otherwise, the menu item will be hidden from the list.


  • Active Markers: Furniture markers available for use on this Terminal.
    • Marker Position/Orientation:
    • Marker Available Entry Types:
    • Make Wall Terminal:If a new terminal, only adds the keywords "FurnitureForce1stPerson" and "PlayerPathToFurniture" automatically.
    • Make Desk Terminal:Same as Make Wall Terminal. For expected results, the Model and/or Model Marker paths are to be filled.
  • Preview Window
  • Random Anim Start:
  • Visible When Distant:

Notes[edit | edit source]

  • You can use Text Replacement in the text of menu items, body texts, and in the output of any menu item that uses the "Display Text" option.
  • If terminals are like webpages, and the "submenu" feature is like hyperlinks, then the "top-level terminal" is the "page" you would get to if you mashed the Back button in your browser until you couldn't go back any further.
  • When a condition (for body text or a menu item) is set to run on Subject, it will run on the top-level terminal.
    • If you define a terminal form that is used as a submenu by multiple different terminals, you can use GetIsID to check which terminal the player started at (i.e. which in-world terminal or holotape item the player actually turned on). The BoS302BPAMUnlockTerminal terminal uses a condition like this, but it's part of the main quest and its contents may spoil a few things.

See Also[edit | edit source]