Interface IFollowers

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

Sets and dismisses the player's follower and animal through the game's DialogueFollower quest (000750BA).

public interface IFollowers

Remarks

Each call runs a function of the quest's DialogueFollowerScript, which fills or clears the quest's Follower or Animal alias. The quest has one alias of each, so the player has at most one follower and one animal. The game's follow, wait, and dismissal dialogue appears only for voice types that have those lines. Each task completes when the script function returns, which the virtual machine runs about 100 ms after the call. Call members on the game's thread.

Properties

Animal

The actor in the Animal alias, or null if the alias is empty or its actor is dead or deleted.

Actor? Animal { get; }

Property Value

Actor?

Exceptions

InvalidOperationException

The quest has no Animal alias.

Follower

The actor in the Follower alias, or null if the alias is empty or its actor is dead or deleted.

Actor? Follower { get; }

Property Value

Actor?

Exceptions

InvalidOperationException

The quest has no Follower alias.

Methods

DismissAnimalAsync()

Dismisses the animal and shows the game's dismissal message. Does nothing if Animal is null.

Task DismissAnimalAsync()

Returns

Task

DismissFollowerAsync()

Dismisses the follower, shows the game's dismissal message, and has the follower say its dismissal line. Does nothing if Follower is null.

Task DismissFollowerAsync()

Returns

Task

A task that completes about 2 seconds after the call.

SetAnimalAsync<TActor>(TActor)

Makes actor the animal, a player teammate in the Animal alias that does no favors and has Lockpicking 0.

Task SetAnimalAsync<TActor>(TActor actor) where TActor : IActor

Parameters

actor TActor

Returns

Task

Type Parameters

TActor

Exceptions

InvalidOperationException

Animal is another actor.

SetFollowerAsync<TActor>(TActor)

Makes actor the follower, a player teammate in the Follower alias.

Task SetFollowerAsync<TActor>(TActor actor) where TActor : IActor

Parameters

actor TActor

Returns

Task

Type Parameters

TActor

Exceptions

InvalidOperationException

Follower is another actor.