Background for Starfield

The Alias Script

    The Alias 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:

    • 4 events
    • 8 functions


    Inheritance Tree

    Structs

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

      Properties

      No properties found.

        Events

        • Event received when this alias has been filled (or not filled) as a result of the quest starting up. Other aliases in the quest will have also been filled by this point, and the quest is about to start its startup stage.

        • Event called when this alias' script is reset. (As a result of a repeatable quest resetting)

        • Event received when the quest that owns this alias has shut down. The alias will be cleared by this point.

        • Event received when this alias has been started - after quest startup is run

        Functions

        • QuestfunctionGetOwningQuest()Native

          Gets the quest that owns this alias.

        • voidfunctionRefillAlias()Native

          Refills this alias. Function won't return until alias has been re-filled.

        • voidfunctionRefillDependentAliases()Native

          Refills the dependent aliases of this alias

        • voidfunctionStartObjectProfiling()NativeDebugOnly

          Turns on profiling for this specific object and all scripts attached to it - setting doesn't persist across saves
          Will do nothing on release console builds, and if the Papyrus:bEnableProfiling ini setting is off

        • voidfunctionStopObjectProfiling()NativeDebugOnly

          Turns off profiling for this specific object and all scripts attached to it - setting doesn't persist across saves
          Will do nothing on release console builds, and if the Papyrus:bEnableProfiling ini setting is off

        • boolfunctionIsFilled()

          jduvall -- convenience function
          checks to see if there is anything in this alias

        • boolfunctionIsSameType(AliasAliasToCheck)

          jduvall - convenience function
          checks to see if the passed in alias is the same type (ReferenceAlias, RefCollectionAlias, or LocationAlias)

        • boolfunctionCopyIntoAlias(AliasTargetAlias, boolSkipIfEmpty=true, boolCopyOver=true)

          jduvall - convenience function
          Copies contents of this alias over the contents of the TargetAlias, if it's the same type (both are ReferenceAlias, both are RefCollectionAliases, both are LocationAliases)
          skipIfEmpty: if true (default), it will NOT copy if this alias is empty.
          CopyOver: if true (default), it will copy over contents in TargetAlias. If false, it will only copy if TargetAlias is empty.
          returns true if it copied; returns false if it did not copy

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