Background for Starfield

The Form Script

    The Form script is a part of Starfield’s Papyrus scripting ecosystem. It is included with the base game.

    For this script, the Papyrus index knows about:

    • 9 functions


    Inheritance Tree

    Structs

    The Papyrus Index is still under construction. Structs have not been implemented yet.

      Properties

      No properties found.

        Events

          No events found.

        Functions

        • intfunctionGetFormID()Native

          Returns this form's form ID.

        • stringfunctionGetFormEditorID()NativeDebugOnly

          Returns the editor formID string for this object

        • intfunctionGetGoldValue()Native

          Returns the value of this form in gold. If called on a form that doesn't have a value (like a quest), it will return -1.

        • floatfunctionGetWeight()Native

          Gets the weight of this form.

        • boolfunctionHasKeyword(KeywordakKeyword)Native

          Checks to see if the specified keyword is attached to this form.

        • boolfunctionHasKeywordInFormList(FormListakKeywordList)Native

          Checks to see if any of the keywords in the form list is attached to this form. If the form list contains no keywords, returns false.

        • boolfunctionPlayerKnows()Native

          Is the "Known" flag set for this form? This is used for MagicEffect and WordOfPower.

        • voidfunctionStartObjectProfiling()NativeDebugOnly

          Starts profiling all scripts attached to this object until stopped.

        • voidfunctionStopObjectProfiling()NativeDebugOnly

          Stops profiling all scripts attached to this object until stopped.

        Some data provided by the Fallout 4 Creation Kit Wiki. Licensed under the Creative Commons Attribution-Share Alike 4.0 license.