Class LinkedRefPackage

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

A package record whose location or target is the linked reference of the actor running it, with the keyword of that link.

public sealed record LinkedRefPackage : IEquatable<LinkedRefPackage>

Inheritance

object

LinkedRefPackage

Implements

IEquatable<LinkedRefPackage>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

LinkedRefPackage(FormId<Package>, FormId<Keyword>?)

A package record whose location or target is the linked reference of the actor running it, with the keyword of that link.

public LinkedRefPackage(FormId<Package> PackageId, FormId<Keyword>? KeywordId)

Parameters

PackageId FormId<Package>

The package record.

KeywordId FormId<Keyword>?

The keyword of the link the package's data names. A null value names the default link.

Properties

Follow

Skyrim.esm's TestPackagesFollowwLeaderChicken, whose target is the link with the keyword Testchic, followed at between 128 and 256 units.

public static LinkedRefPackage Follow { get; }

Property Value

LinkedRefPackage

HoldPosition

Skyrim.esm's defaultHoldPositionLinkedRef512WithTravel, whose location is within 512 units of the default link.

public static LinkedRefPackage HoldPosition { get; }

Property Value

LinkedRefPackage

KeywordId

The keyword of the link the package's data names. A null value names the default link.

public FormId<Keyword>? KeywordId { get; init; }

Property Value

FormId<Keyword>?

PackageId

The package record.

public FormId<Package> PackageId { get; init; }

Property Value

FormId<Package>

Sandbox

Skyrim.esm's DefaultSandboxLinkCustom02512, which sandboxes within 512 units of the link with the keyword LinkCustom02.

public static LinkedRefPackage Sandbox { get; }

Property Value

LinkedRefPackage

Sit

Skyrim.esm's dunKatariahSceneSailorsSit, which sits on furniture within 64 units of the link with the keyword 0005D5FE.

public static LinkedRefPackage Sit { get; }

Property Value

LinkedRefPackage

Sleep

Skyrim.esm's dunKnifepointRidgeSleepPackage, whose location is within 500 units of the link with the keyword LinkCustom01, the keyword of UseIdleMarker, and whose schedule starts at 22:00 and lasts 12 hours.

public static LinkedRefPackage Sleep { get; }

Property Value

LinkedRefPackage

Remarks

The actor sleeps in a linked bed that it owns, itself or through a faction, and sits in furniture near a linked bed of another owner. The package does not run outside its schedule. As a scene's package action it completes three seconds after the actor falls asleep, which ends its phase and wakes the actor. A later EndPhaseIndex leaves the actor asleep until that phase ends.

Travel

Skyrim.esm's defaultTravelToLinkCustom01, whose location is the link with the keyword LinkCustom01, the keyword of UseIdleMarker. The actor walks.

public static LinkedRefPackage Travel { get; }

Property Value

LinkedRefPackage

Remarks

As a scene's package action it completes once the actor arrives. An AI-driven player performs it.

TravelAtRun

Skyrim.esm's DefaultMoveToCustom01Run, whose location is within 64 units of the link with the keyword LinkCustom01, the keyword of UseIdleMarker. The actor runs.

public static LinkedRefPackage TravelAtRun { get; }

Property Value

LinkedRefPackage

Remarks

As a scene's package action it completes once the actor arrives. An actor that runs to the player with it runs into the player.

UseIdleMarker

Skyrim.esm's UseIdleMarkerLinkCustom01, whose marker is the link with the keyword LinkCustom01.

public static LinkedRefPackage UseIdleMarker { get; }

Property Value

LinkedRefPackage

Remarks

In one of nine runs the actor ran the package without moving to the marker.

Methods

Deconstruct(out FormId<Package>, out FormId<Keyword>?)

public void Deconstruct(out FormId<Package> PackageId, out FormId<Keyword>? KeywordId)

Parameters

PackageId FormId<Package>

KeywordId FormId<Keyword>?

Equals(LinkedRefPackage?)

public bool Equals(LinkedRefPackage? other)

Parameters

other LinkedRefPackage

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(LinkedRefPackage?, LinkedRefPackage?)

public static bool operator ==(LinkedRefPackage? left, LinkedRefPackage? right)

Parameters

left LinkedRefPackage

right LinkedRefPackage

Returns

bool

operator !=(LinkedRefPackage?, LinkedRefPackage?)

public static bool operator !=(LinkedRefPackage? left, LinkedRefPackage? right)

Parameters

left LinkedRefPackage

right LinkedRefPackage

Returns

bool