Background for Skyrim SE

The Location Script

    The Location script is a part of Skyrim SE’s Papyrus scripting ecosystem. It is included with the base game, and is extended/modified by modded sources such as Skyrim Script Extender x64 (SKSE).

    For this script, the Papyrus index knows about:

    • 12 functions


    Inheritance Tree

    No indexed scripts extend this script.

    Properties

    No properties found.

      Events

        No events found.

      Functions

      • floatfunctionGetKeywordData(KeywordakKeyword)Native

        Obtains the data attached to the specified keyword on this location.

      • intfunctionGetRefTypeAliveCount(LocationRefTypeakRefType)Native

        Obtains the number of alive enabled references matching the specified reference type in this location.

        NOTE: This checks references whose editor location is the locaiton only. It does NOT check for things that have "wandered" into it from elsewhere. It also does not check disabled refs.

      • intfunctionGetRefTypeDeadCount(LocationRefTypeakRefType)Native

        Obtains the number of dead enabled references matching the specified reference type in this location.

        NOTE: This checks references whose editor location is the locaiton only. It does NOT check for things that have "wandered" into it from elsewhere. It also only checks enabled refs.

      • boolfunctionHasCommonParent(LocationakOther, KeywordakFilter=NONE)Native

        Returns if this location and the other have a common parent (filtering with a keyword, if provided). If the locations are identical, the function will return false.

      • boolfunctionHasRefType(LocationRefTypeakRefType)Native

        Returns if this location has any unreserved refs with the specified LocationRefType.

      • boolfunctionIsCleared()Native

        Returns if this location is flagged as cleared or not.

      • boolfunctionIsChild(LocationakOther)Native

        Returns whether the other location is a child of this one

      • boolfunctionIsLoaded()Native

        Returns if this location is loaded or not.

      • boolfunctionIsSameLocation(LocationakOtherLocation, KeywordakKeyword=NONE)

        Returns true if the calling location is the same as the supplied location. Or, if an optional keyword is supplied it also returns true if the locations share a parent with that keyword, or one of the locations has the keyword and is a parent of the other.

      • voidfunctionSetKeywordData(KeywordakKeyword, floatafData)Native

        Sets the data attached to the specified keyword on this location.

      • voidfunctionSetCleared(boolabCleared=true)Native

        Flags or unflags this location as cleared.

      • LocationfunctionGetParent()Native

        SKSE64 additions built 2024-01-17 20:01:40.731000 UTC

      Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.