Class LocationScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from Location.psc.

public static class LocationScript

Inheritance

object

LocationScript

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Properties

Dispatcher

The dispatcher that binds this script to a form and calls the functions and properties that have no generated member.

public static PapyrusScriptDispatcher Dispatcher { get; }

Property Value

PapyrusScriptDispatcher

Methods

GetKeywordData(PapyrusScript<Location>, IPapyrusKeyword)

Returns the float value attached to the specified keyword attached to this location

public static Task<float> GetKeywordData(this PapyrusScript<Location> self, IPapyrusKeyword akKeyword)

Parameters

self PapyrusScript<Location>

akKeyword IPapyrusKeyword

Returns

Task<float>

GetParent(PapyrusScript<Location>)

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

public static Task<Location?> GetParent(this PapyrusScript<Location> self)

Parameters

self PapyrusScript<Location>

Returns

Task<Location?>

GetRefTypeAliveCount(PapyrusScript<Location>, LocationRefType)

Returns the number of alive references matching the specified reference type

public static Task<int> GetRefTypeAliveCount(this PapyrusScript<Location> self, LocationRefType akRefType)

Parameters

self PapyrusScript<Location>

akRefType LocationRefType

Returns

Task<int>

GetRefTypeDeadCount(PapyrusScript<Location>, LocationRefType)

Returns the number of dead references matching the specified reference type

public static Task<int> GetRefTypeDeadCount(this PapyrusScript<Location> self, LocationRefType akRefType)

Parameters

self PapyrusScript<Location>

akRefType LocationRefType

Returns

Task<int>

HasCommonParent(PapyrusScript<Location>, Location, IPapyrusKeyword?)

Returns if these two locations have a common parent - filtered with the keyword, if provided

public static Task<bool> HasCommonParent(this PapyrusScript<Location> self, Location akOther, IPapyrusKeyword? akFilter = null)

Parameters

self PapyrusScript<Location>

akOther Location

akFilter IPapyrusKeyword

Returns

Task<bool>

HasRefType(PapyrusScript<Location>, LocationRefType)

Returns if this location has the specified reference type

public static Task<bool> HasRefType(this PapyrusScript<Location> self, LocationRefType akRefType)

Parameters

self PapyrusScript<Location>

akRefType LocationRefType

Returns

Task<bool>

IsChild(PapyrusScript<Location>, Location)

Returns whether the other location is a child of this one

public static Task<bool> IsChild(this PapyrusScript<Location> self, Location akOther)

Parameters

self PapyrusScript<Location>

akOther Location

Returns

Task<bool>

IsCleared(PapyrusScript<Location>)

Returns whether this location is flagged as "cleared" or not

[Obsolete("Uses the Papyrus virtual machine. Prefer Location.IsCleared().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsCleared(this PapyrusScript<Location> self)

Parameters

self PapyrusScript<Location>

Returns

Task<bool>

IsLoaded(PapyrusScript<Location>)

Is this location loaded in game?

[Obsolete("Uses the Papyrus virtual machine. Prefer Location.IsLoaded().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsLoaded(this PapyrusScript<Location> self)

Parameters

self PapyrusScript<Location>

Returns

Task<bool>

IsSameLocation(PapyrusScript<Location>, Location, IPapyrusKeyword?)

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

public static Task<bool> IsSameLocation(this PapyrusScript<Location> self, Location akOtherLocation, IPapyrusKeyword? akKeyword = null)

Parameters

self PapyrusScript<Location>

akOtherLocation Location

akKeyword IPapyrusKeyword

Returns

Task<bool>

SetCleared(PapyrusScript<Location>, bool)

Sets this location as cleared or not

public static Task SetCleared(this PapyrusScript<Location> self, bool abCleared = true)

Parameters

self PapyrusScript<Location>

abCleared bool

Returns

Task

SetKeywordData(PapyrusScript<Location>, IPapyrusKeyword, float)

Sets the specified keyword's data on the location

public static Task SetKeywordData(this PapyrusScript<Location> self, IPapyrusKeyword akKeyword, float afData)

Parameters

self PapyrusScript<Location>

akKeyword IPapyrusKeyword

afData float

Returns

Task