Table of Contents

Class QuestLocationAlias

Namespace
SkyrimForge
Assembly
SkyrimForge.dll

A named placeholder for a location, equivalent to a Creation Kit location alias.

public sealed class QuestLocationAlias : QuestAlias
Inheritance
QuestLocationAlias
Inherited Members

Constructors

QuestLocationAlias(string)

A named placeholder for a location, equivalent to a Creation Kit location alias.

public QuestLocationAlias(string name)

Parameters

name string

The alias's name, unique among the quest's aliases of both kinds and the same in every version of the plugin. The saved state stores the location under it.

Exceptions

ArgumentNullException

name is null.

Properties

Events

The game's events about the player and the location the alias is filled with.

public IQuestLocationAliasEvents Events { get; }

Property Value

IQuestLocationAliasEvents

Exceptions

InvalidOperationException

The alias belongs to no quest.

LocationId

Gets the location the alias is filled with in the loaded game. The result is null for an empty alias.

public FormId<Location>? LocationId { get; }

Property Value

FormId<Location>?

Exceptions

InvalidOperationException

The alias belongs to no quest.

Methods

Clear()

Empties the alias, so the objectives targeting it show no marker for it.

public void Clear()

Exceptions

InvalidOperationException

The alias belongs to no quest.

Fill(FormId<Location>)

Fills the alias with the location locationId names.

public void Fill(FormId<Location> locationId)

Parameters

locationId FormId<Location>

Remarks

The location is stored by form ID. An objective targeting the alias shows its marker at the location's world location marker, a ScenePackage whose destination is the alias travels to that marker, and the alias's token in quest text shows the location's name. A location the game does not have, or one with no world location marker, shows no marker, and an open objective logs it.

Exceptions

InvalidOperationException

The alias belongs to no quest.