Class SceneActorSettings

Namespace

SkyrimForge

Assembly

SkyrimForge.dll

The flags and behaviors of one actor of a QuestScene. An actor the scene lists none for has the defaults.

public sealed class SceneActorSettings

Inheritance

object

SceneActorSettings

Inherited Members

object.GetType()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

SceneActorSettings(QuestReferenceAlias)

Creates the settings of the actor filling actor.

public SceneActorSettings(QuestReferenceAlias actor)

Parameters

actor QuestReferenceAlias

An alias whose actor says a line of the scene, runs a package of it, takes part in a conversation of it, or is looked at in it.

Exceptions

ArgumentNullException

actor is null.

Properties

Actor

The alias of the actor these settings govern.

public QuestReferenceAlias Actor { get; }

Property Value

QuestReferenceAlias

BlocksPlayerActivation

Whether the player cannot activate the actor while the scene plays. False by default.

public bool BlocksPlayerActivation { get; init; }

Property Value

bool

CombatInterruption

The effect of the actor entering combat. End by default.

public SceneInterruption CombatInterruption { get; init; }

Property Value

SceneInterruption

DialogueInterruption

The effect of the actor entering a conversation. Pause by default.

public SceneInterruption DialogueInterruption { get; init; }

Property Value

SceneInterruption

EndsOnDeath

Whether the game ends the scene where the actor dies. True by default.

public bool EndsOnDeath { get; init; }

Property Value

bool

IsOptional

Whether the scene can play without the actor. False by default.

public bool IsOptional { get; init; }

Property Value

bool

Remarks

The game skips the lines of a disabled optional actor, and ends the scene with Interrupted where the actor is in another cell. An optional actor whose alias is filled after the scene starts says no line.

ObservedCombatInterruption

The effect of the actor observing combat. None by default.

public SceneInterruption ObservedCombatInterruption { get; init; }

Property Value

SceneInterruption

RunsOnlyScenePackages

Whether the actor runs only the scene's packages while the scene plays. False by default.

public bool RunsOnlyScenePackages { get; init; }

Property Value

bool

Remarks

The actor walks off during a phase in which it has no package action.

SilencesRemarks

Whether the actor's remarks are silenced while the scene plays. False by default.

public bool SilencesRemarks { get; init; }

Property Value

bool

Remarks

Remarks are the lines an actor says unprompted outside a conversation: idle chatter and the lines said on noticing a corpse. The actor that fills the alias as the scene begins is silenced until the scene ends, or longer where another scene or SilenceRemarks<TActor>(TActor) silences it.