Difference between revisions of "Key"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Qazaaq
imported>Qazaaq
m (added wiki link)
 
(6 intermediate revisions by the same user not shown)
Line 1: Line 1:
[[Category:Editor Reference]]
'''Type:''' <code>KEYM</code>
[[Category:Object_Classes]]
<BR/>
[[Category:Items]]
'''Papyrus:''' [[Key Script]], [[ObjectReference Script]]
'''Papyrus:''' [[Key Script]]


The Key description goes here.
A key is used to unlock a [[Door]]. If the matching key for a locked door is found in the [[Actor]]s inventory, they may automatically unlock the door and enter.
The [[Key]] [[:Category:Object Classes|object]] is found within the [[Object Window]] under the [[:Category:Items|Items Category]].


== Editor Dialog ==
== Editor Dialog ==
[[File:Key_Object.png]]
[[File:Key Object.png]]
*'''ID:''' The editor ID which is used by the Creation Kit.
*{{Template:Editor:Property:ID}}
*'''Name:''' The key's name as it will appear in-game.
*{{Template:Editor:Property:Name}}
*'''Weight:''' The key's weight in the player's inventory.
*{{Template:Editor:Property:Weight}}
*'''Value:''' The key's value in caps.
*{{Template:Editor:Property:Value}}
**'''Clac from components:'''
**{{Template:Editor:Property:Clac from components}}
*'''Add Destruction Data:'''
*{{Template:Editor:Property:Add Destruction Data}}
*'''Pickup Sound:'''
*{{Template:Editor:Property:Pickup Sound}}
*'''Putdown Sound:'''
*{{Template:Editor:Property:Putdown Sound}}
*'''Preview Transform:'''
*{{Template:Editor:Property:Preview Transform}}
*'''Featured Item Message:'''
*{{Template:Editor:Property:Featured Item Message}}
*'''Inventory image:'''
*{{Template:Editor:Property:Inventory Image}}
*'''Message Icon:'''
*{{Template:Editor:Property:Message Icon}}
*'''Model:''' The [[Model File]] used in game.
*{{Template:Editor:Property:Model}}
*'''Pack-In Use Only:'''
*{{Template:Editor:Property:Pack-In Use Only}}
*'''Scripts:'''
*{{Template:Editor:Property:Papyrus Script}}
*'''Keywords:'''
*{{Template:Editor:Property:Keywords}}
*'''Component Data:'''
*{{Template:Editor:Property:Component Data}}
**'''Quantity:'''
**'''Display Index:'''


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

Latest revision as of 18:25, 2 December 2018

Type: KEYM
Papyrus: Key Script, ObjectReference Script

A key is used to unlock a Door. If the matching key for a locked door is found in the Actors inventory, they may automatically unlock the door and enter. The Key object is found within the Object Window under the Items Category.

Editor Dialog[edit | edit source]

Key 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.
  • Add Destruction Data: Allows you to configure the objects destruction data with the Destructible Object Data editor.
  • Pickup Sound: The Sound Descriptor played when the object is picked up.
  • Putdown Sound: The Sound Descriptor played when the object is dropped.
  • 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.
  • Featured Item Message:
  • 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.
  • Model: The 3D Model File that will be used when this object is placed in the game world.
  • Pack-In Use Only: The object is for pack-in use only.
  • 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.
  • Component Data: A collection of Components this MiscItem will yield when scrapped. The object's cap Value may also be influenced by entries within the collection.
    • Component: The Component object to use.
    • Quantity: The amount of this component.
    • Display Index: Used for sorting the display order within the user interface. Sorting is alphabetical by default, where higher values are sorted towards the bottom.

See Also[edit | edit source]