Class ActorScript

Namespace

SkyrimForge.Papyrus

Assembly

SkyrimForge.Game.dll

Functions and comments from Actor.psc.

Relationship functions use the following values: 4 - Lover 3 - Ally 2 - Confidant 1 - Friend 0 - Acquaintance -1 - Rival -2 - Foe -3 - Enemy -4 - Archnemesis

public static class ActorScript

Inheritance

object

ActorScript

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Fields

CritStage_DisintegrateEnd

public const int CritStage_DisintegrateEnd = 4

Field Value

int

CritStage_DisintegrateStart

public const int CritStage_DisintegrateStart = 3

Field Value

int

CritStage_GooEnd

public const int CritStage_GooEnd = 2

Field Value

int

CritStage_GooStart

public const int CritStage_GooStart = 1

Field Value

int

CritStage_None

public const int CritStage_None = 0

Field Value

int

EquipSlot_Default

public const int EquipSlot_Default = 0

Field Value

int

EquipSlot_LeftHand

public const int EquipSlot_LeftHand = 2

Field Value

int

EquipSlot_RightHand

public const int EquipSlot_RightHand = 1

Field Value

int

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

AddPerk<T>(PapyrusScript<T>, Perk)

Adds the specified perk to this actor

public static Task AddPerk<T>(this PapyrusScript<T> self, Perk akPerk) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akPerk Perk

Returns

Task

Type Parameters

T

AddShout<T>(PapyrusScript<T>, Shout)

Adds the specified shout to this actor - returns true on success

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.AddShout(Shout).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> AddShout<T>(this PapyrusScript<T> self, Shout akShout) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akShout Shout

Returns

Task<bool>

Type Parameters

T

AddSpell<T>(PapyrusScript<T>, IPapyrusSpell, bool)

Adds the specified spell to this actor - returns true on success

public static Task<bool> AddSpell<T>(this PapyrusScript<T> self, IPapyrusSpell akSpell, bool abVerbose = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akSpell IPapyrusSpell

abVerbose bool

Returns

Task<bool>

Type Parameters

T

AddToFaction<T>(PapyrusScript<T>, Faction)

Adds this actor to a faction at rank 0 if they aren't already in it

public static Task AddToFaction<T>(this PapyrusScript<T> self, Faction akFaction) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akFaction Faction

Returns

Task

Type Parameters

T

AllowBleedoutDialogue<T>(PapyrusScript<T>, bool)

Sets this a essential actors ability to talk when in a bleedout state

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.AllowBleedoutDialogue(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task AllowBleedoutDialogue<T>(this PapyrusScript<T> self, bool abCanTalk) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abCanTalk bool

Returns

Task

Type Parameters

T

AllowPCDialogue<T>(PapyrusScript<T>, bool)

overrides the race flag on an actor and determines if he can talk to the player in dialogue menu

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.AllowPCDialogue(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task AllowPCDialogue<T>(this PapyrusScript<T> self, bool abTalk) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abTalk bool

Returns

Task

Type Parameters

T

AttachAshPile<T>(PapyrusScript<T>, IForm?)

Attaches an "ash pile" to this actor, placing it at this actor's location and using the specified base object (or leveled item list) to represent the pile. If None is passed, it will use the default ash pile object

public static Task AttachAshPile<T>(this PapyrusScript<T> self, IForm? akAshPileBase = null) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akAshPileBase IForm

Returns

Task

Type Parameters

T

CanFlyHere<T>(PapyrusScript<T>)

Can this actor fly here?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.CanFlyHere().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> CanFlyHere<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

ChangeHeadPart<T>(PapyrusScript<T>, HeadPart)

Adds a headpart, if the type exists it will replace, must not be misc type Beware: This function also affects the ActorBase

public static Task ChangeHeadPart<T>(this PapyrusScript<T> self, HeadPart hPart) where T : notnull, IActor

Parameters

self PapyrusScript<T>

hPart HeadPart

Returns

Task

Type Parameters

T

ClearArrested<T>(PapyrusScript<T>)

Clears this actor's arrested state

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.ClearArrested().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ClearArrested<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ClearExpressionOverride<T>(PapyrusScript<T>)

Clears any expression override on the actor

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.ClearExpressionOverride().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ClearExpressionOverride<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ClearExtraArrows<T>(PapyrusScript<T>)

Clears this actor's extra arrows 3D

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.ClearExtraArrows().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ClearExtraArrows<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ClearForcedLandingMarker<T>(PapyrusScript<T>)

Remove the obligation to use a particular marker when this actor has to land.

public static Task ClearForcedLandingMarker<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ClearForcedMovement<T>(PapyrusScript<T>)

Clears any forced movement on the actor and return it to its standard state

public static Task ClearForcedMovement<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ClearKeepOffsetFromActor<T>(PapyrusScript<T>)

Clear any keep offset from actor settings

public static Task ClearKeepOffsetFromActor<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ClearLookAt<T>(PapyrusScript<T>)

Clears this actor's look at target

public static Task ClearLookAt<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

DamageAV<T>(PapyrusScript<T>, string, float)

Alias for DamageActorValue - damages the specified actor value

public static Task DamageAV<T>(this PapyrusScript<T> self, string asValueName, float afDamage) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afDamage float

Returns

Task

Type Parameters

T

DamageActorValue<T>(PapyrusScript<T>, string, float)

Damages the specified actor value

public static Task DamageActorValue<T>(this PapyrusScript<T> self, string asValueName, float afDamage) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afDamage float

Returns

Task

Type Parameters

T

Dismount<T>(PapyrusScript<T>)

Initiates a dismount.

public static Task<bool> Dismount<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

DispelAllSpells<T>(PapyrusScript<T>)

Dispel all spells from this actor

public static Task DispelAllSpells<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

DispelSpell<T>(PapyrusScript<T>, IPapyrusSpell)

Dispel a spell from this actor

public static Task<bool> DispelSpell<T>(this PapyrusScript<T> self, IPapyrusSpell akSpell) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akSpell IPapyrusSpell

Returns

Task<bool>

Type Parameters

T

DoCombatSpellApply<T>(PapyrusScript<T>, IPapyrusSpell, IObjectReference)

Apply a spell to a target in combat

public static Task DoCombatSpellApply<T>(this PapyrusScript<T> self, IPapyrusSpell akSpell, IObjectReference akTarget) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akSpell IPapyrusSpell

akTarget IObjectReference

Returns

Task

Type Parameters

T

DrawWeapon<T>(PapyrusScript<T>)

Makes this actor draw his weapon

public static Task DrawWeapon<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

EnableAI<T>(PapyrusScript<T>, bool)

Enables or disable's this actor's AI

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.EnableAI(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task EnableAI<T>(this PapyrusScript<T> self, bool abEnable = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abEnable bool

Returns

Task

Type Parameters

T

EndDeferredKill<T>(PapyrusScript<T>)

End the Deferred Kill state. This must only be called if StartDeferredKill was called first.

public static Task EndDeferredKill<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

EquipItemById<T>(PapyrusScript<T>, IForm, int, int, bool, bool)

equips item with matching itemId at the given slot

public static Task EquipItemById<T>(this PapyrusScript<T> self, IForm item, int itemId, int equipSlot = 0, bool preventUnequip = false, bool equipSound = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

item IForm

itemId int

equipSlot int

preventUnequip bool

equipSound bool

Returns

Task

Type Parameters

T

EquipItemEx<T>(PapyrusScript<T>, IForm, int, bool, bool)

equips item at the given slot

public static Task EquipItemEx<T>(this PapyrusScript<T> self, IForm item, int equipSlot = 0, bool preventUnequip = false, bool equipSound = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

item IForm

equipSlot int

preventUnequip bool

equipSound bool

Returns

Task

Type Parameters

T

EquipItem<T>(PapyrusScript<T>, IForm, bool, bool)

Forces this actor to equip the specified item, preventing removal if requested

public static Task EquipItem<T>(this PapyrusScript<T> self, IForm akItem, bool abPreventRemoval = false, bool abSilent = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akItem IForm

abPreventRemoval bool

abSilent bool

Returns

Task

Type Parameters

T

EquipShout<T>(PapyrusScript<T>, Shout)

Forces this actor to equip the specified shout

[Obsolete("Uses the Papyrus virtual machine. Prefer ActorEquipManager.EquipShout(IActor, Shout).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task EquipShout<T>(this PapyrusScript<T> self, Shout akShout) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akShout Shout

Returns

Task

Type Parameters

T

EquipSpell<T>(PapyrusScript<T>, IPapyrusSpell, int)

Forces this actor to equip the specified spell. The casting source can be: 0 - Left hand 1 - Right hand

public static Task EquipSpell<T>(this PapyrusScript<T> self, IPapyrusSpell akSpell, int aiSource) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akSpell IPapyrusSpell

aiSource int

Returns

Task

Type Parameters

T

EvaluatePackage<T>(PapyrusScript<T>)

Forces the AI to re-evaluate its package stack

public static Task EvaluatePackage<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ForceAV<T>(PapyrusScript<T>, string, float)

Alias for ForceActorValue - force the specified actor value to a specified value

public static Task ForceAV<T>(this PapyrusScript<T> self, string asValueName, float afNewValue) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afNewValue float

Returns

Task

Type Parameters

T

ForceActorValue<T>(PapyrusScript<T>, string, float)

Force the specified actor value to a specified value

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.ForceActorValue(ActorValue, float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ForceActorValue<T>(this PapyrusScript<T> self, string asValueName, float afNewValue) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afNewValue float

Returns

Task

Type Parameters

T

ForceMovementDirectionRamp<T>(PapyrusScript<T>, float, float, float, float)

Ramps the movement direction on the actor to the passed in value over the passed in time afXAngle, afYAngle and afZAngle are in degrees afRampTime is in seconds

public static Task ForceMovementDirectionRamp<T>(this PapyrusScript<T> self, float afXAngle = 0, float afYAngle = 0, float afZAngle = 0, float afRampTime = 0.1) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afXAngle float

afYAngle float

afZAngle float

afRampTime float

Returns

Task

Type Parameters

T

ForceMovementDirection<T>(PapyrusScript<T>, float, float, float)

**** For Debugging Movement Animations (not in release builds) **** Forces the movement direction on the actor afXAngle, afYAngle and afZAngle are in degrees

public static Task ForceMovementDirection<T>(this PapyrusScript<T> self, float afXAngle = 0, float afYAngle = 0, float afZAngle = 0) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afXAngle float

afYAngle float

afZAngle float

Returns

Task

Type Parameters

T

ForceMovementRotationSpeedRamp<T>(PapyrusScript<T>, float, float, float, float)

Ramps the movement rotation speed on the actor to the passed in value over the passed in time Each component of the rotation speed is a multiplier following these rules:

• 0 -> 1 Scales between 0 and the Walk speed
• 1 -> 2 Scales between Walk speed and Run Speed
• 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0) afRampTime is in seconds

public static Task ForceMovementRotationSpeedRamp<T>(this PapyrusScript<T> self, float afXMult = 0, float afYMult = 0, float afZMult = 0, float afRampTime = 0.1) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afXMult float

afYMult float

afZMult float

afRampTime float

Returns

Task

Type Parameters

T

ForceMovementRotationSpeed<T>(PapyrusScript<T>, float, float, float)

Forces the movement rotation speed on the actor Each component of the rotation speed is a multiplier following these rules:

• 0 -> 1 Scales between 0 and the Walk speed
• 1 -> 2 Scales between Walk speed and Run Speed
• 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0)

public static Task ForceMovementRotationSpeed<T>(this PapyrusScript<T> self, float afXMult = 0, float afYMult = 0, float afZMult = 0) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afXMult float

afYMult float

afZMult float

Returns

Task

Type Parameters

T

ForceMovementSpeedRamp<T>(PapyrusScript<T>, float, float)

Ramps the movement speed on the actor to the passed in value over the passed in time afSpeedMult is a speed multiplier based on the current max speeds

• 0 -> 1 Scales between 0 and the Walk speed
• 1 -> 2 Scales between Walk speed and Run Speed
• 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0) afRampTime is in seconds

public static Task ForceMovementSpeedRamp<T>(this PapyrusScript<T> self, float afSpeedMult, float afRampTime = 0.1) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afSpeedMult float

afRampTime float

Returns

Task

Type Parameters

T

ForceMovementSpeed<T>(PapyrusScript<T>, float)

Forces the movement speed on the actor afSpeedMult is a speed multiplier based on the current max speeds

• 0 -> 1 Scales between 0 and the Walk speed
• 1 -> 2 Scales between Walk speed and Run Speed
• 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0)

public static Task ForceMovementSpeed<T>(this PapyrusScript<T> self, float afSpeedMult) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afSpeedMult float

Returns

Task

Type Parameters

T

ForceTargetAngle<T>(PapyrusScript<T>, float, float, float)

Sets the target facing angle on the actor afXAngle, afYAngle and afZAngle are in degrees

public static Task ForceTargetAngle<T>(this PapyrusScript<T> self, float afXAngle = 0, float afYAngle = 0, float afZAngle = 0) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afXAngle float

afYAngle float

afZAngle float

Returns

Task

Type Parameters

T

ForceTargetDirection<T>(PapyrusScript<T>, float, float, float)

Sets the target movement direction on the actor afXAngle, afYAngle and afZAngle are in degrees

public static Task ForceTargetDirection<T>(this PapyrusScript<T> self, float afXAngle = 0, float afYAngle = 0, float afZAngle = 0) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afXAngle float

afYAngle float

afZAngle float

Returns

Task

Type Parameters

T

ForceTargetSpeed<T>(PapyrusScript<T>, float)

Sets the target movement speed on the actor afSpeedMult is a speed multiplier based on the current max speeds

• 0 -> 1 Scales between 0 and the Walk speed
• 1 -> 2 Scales between Walk speed and Run Speed
• 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0)

public static Task ForceTargetSpeed<T>(this PapyrusScript<T> self, float afSpeed) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afSpeed float

Returns

Task

Type Parameters

T

GetAVMax<T>(PapyrusScript<T>, string)

Alias of GetActorValueMax - retrives actor value's max, taking into account buffs/debuffs

public static Task<float> GetAVMax<T>(this PapyrusScript<T> self, string asValueName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

Returns

Task<float>

Type Parameters

T

GetAVPercentage<T>(PapyrusScript<T>, string)

Alias for GetActorValuePercentage - gets the actor value as a percent of max

public static Task<float> GetAVPercentage<T>(this PapyrusScript<T> self, string asValueName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

Returns

Task<float>

Type Parameters

T

GetAV<T>(PapyrusScript<T>, string)

Alias for GetActorValue - retrives the specified actor value

public static Task<float> GetAV<T>(this PapyrusScript<T> self, string asValueName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

Returns

Task<float>

Type Parameters

T

GetActorBase<T>(PapyrusScript<T>)

returns the ActorBase

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetActorBase().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<ActorBase?> GetActorBase<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<ActorBase?>

Type Parameters

T

GetActorValueMax<T>(PapyrusScript<T>, string)

Gets the specified actor value's max, taking into account buffs/debuffs

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetActorValueMax(ActorValue).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<float> GetActorValueMax<T>(this PapyrusScript<T> self, string asValueName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

Returns

Task<float>

Type Parameters

T

GetActorValuePercentage<T>(PapyrusScript<T>, string)

Gets the specified actor value as a percentage of its max value - from 0 to 1

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetActorValuePercentage(ActorValue).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<float> GetActorValuePercentage<T>(this PapyrusScript<T> self, string asValueName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

Returns

Task<float>

Type Parameters

T

GetActorValue<T>(PapyrusScript<T>, string)

Gets the specified actor value - returns 0 and logs an error if the value is unknown

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetActorValue(ActorValue).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<float> GetActorValue<T>(this PapyrusScript<T> self, string asValueName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

Returns

Task<float>

Type Parameters

T

GetBaseAV<T>(PapyrusScript<T>, string)

Alias for GetBaseActorValue - retrieves the specified actor value's base value

public static Task<float> GetBaseAV<T>(this PapyrusScript<T> self, string asValueName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

Returns

Task<float>

Type Parameters

T

GetBaseActorValue<T>(PapyrusScript<T>, string)

Gets the base value of the specified actor value - returns 0 and logs an error if the value is unknown

public static Task<float> GetBaseActorValue<T>(this PapyrusScript<T> self, string asValueName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

Returns

Task<float>

Type Parameters

T

GetBribeAmount<T>(PapyrusScript<T>)

Obtains how much it would cost to bribe this actor

public static Task<int> GetBribeAmount<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetCombatState<T>(PapyrusScript<T>)

Gets this actor's current combat state

public static Task<int> GetCombatState<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetCombatTarget<T>(PapyrusScript<T>)

Gets this actor's current combat target

public static Task<Actor?> GetCombatTarget<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<Actor?>

Type Parameters

T

GetCrimeFaction<T>(PapyrusScript<T>)

Get the faction this actor reports crimes to

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetCrimeFaction().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<Faction?> GetCrimeFaction<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<Faction?>

Type Parameters

T

GetCurrentPackage<T>(PapyrusScript<T>)

Gets this actor's current AI package

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetCurrentPackage().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<Package?> GetCurrentPackage<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<Package?>

Type Parameters

T

GetDialogueTarget<T>(PapyrusScript<T>)

Gets this actor's current dialogue target

public static Task<Actor?> GetDialogueTarget<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<Actor?>

Type Parameters

T

GetEquippedArmorInSlot<T>(PapyrusScript<T>, int)

Obtain the armor currently equipped in the specified slot

public static Task<Armor?> GetEquippedArmorInSlot<T>(this PapyrusScript<T> self, int aiSlot) where T : notnull, IActor

Parameters

self PapyrusScript<T>

aiSlot int

Returns

Task<Armor?>

Type Parameters

T

GetEquippedItemId<T>(PapyrusScript<T>, int)

returns the itemId of the object currently equipped in the specified hand 0 - left hand 1 - right hand

public static Task<int> GetEquippedItemId<T>(this PapyrusScript<T> self, int location) where T : notnull, IActor

Parameters

self PapyrusScript<T>

location int

Returns

Task<int>

Type Parameters

T

GetEquippedItemType<T>(PapyrusScript<T>, int)

Obtains the item quipped in the specified hand (0 - Left hand, 1 - Right hand) Return values are: -1 - Error 0 - Nothing 1 - One-handed sword 2 - One-handed dagger 3 - One-handed axe 4 - One-handed mace 5 - Two-handed sword 6 - Two-handed axe 7 - Bow 8 - Staff 9 - Magic spell 10 - Shield 11 - Torch

public static Task<int> GetEquippedItemType<T>(this PapyrusScript<T> self, int aiHand) where T : notnull, IActor

Parameters

self PapyrusScript<T>

aiHand int

Returns

Task<int>

Type Parameters

T

GetEquippedObject<T>(PapyrusScript<T>, int)

returns the object currently equipped in the specified location 0 - left hand 1 - right hand 2 - shout

public static Task<Form?> GetEquippedObject<T>(this PapyrusScript<T> self, int location) where T : notnull, IActor

Parameters

self PapyrusScript<T>

location int

Returns

Task<Form?>

Type Parameters

T

GetEquippedShield<T>(PapyrusScript<T>)

Gets this actor's currently equipped shield

public static Task<Armor?> GetEquippedShield<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<Armor?>

Type Parameters

T

GetEquippedShout<T>(PapyrusScript<T>)

Gets this actor's currently equipped shout

public static Task<Shout?> GetEquippedShout<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<Shout?>

Type Parameters

T

GetEquippedSpell<T>(PapyrusScript<T>, int)

Gets the spell currently equipped in the specified source 0 - Left Hand 1 - Right Hand 2 - Other 3 - Instant

public static Task<Spell?> GetEquippedSpell<T>(this PapyrusScript<T> self, int aiSource) where T : notnull, IActor

Parameters

self PapyrusScript<T>

aiSource int

Returns

Task<Spell?>

Type Parameters

T

GetEquippedWeapon<T>(PapyrusScript<T>, bool)

Gets this actor's currently equipped weapon false - Default - Right Hand true - Left Hand

public static Task<Weapon?> GetEquippedWeapon<T>(this PapyrusScript<T> self, bool abLeftHand = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abLeftHand bool

Returns

Task<Weapon?>

Type Parameters

T

GetFactionRank<T>(PapyrusScript<T>, Faction)

Obtains this actor's rank with the specified faction - returns -1 if the actor is not a member

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetFactionRank(Faction).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetFactionRank<T>(this PapyrusScript<T> self, Faction akFaction) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akFaction Faction

Returns

Task<int>

Type Parameters

T

GetFactionReaction<T>(PapyrusScript<T>, IActor)

Obtains this actor's faction-based reaction to the other actor 0 - Neutral 1 - Enemy 2 - Ally 3 - Friend

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetFactionReaction(IActor).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetFactionReaction<T>(this PapyrusScript<T> self, IActor akOther) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akOther IActor

Returns

Task<int>

Type Parameters

T

GetFactions<T>(PapyrusScript<T>, int, int)

Returns all factions with the specified min and max ranks (-128 to 127)

public static Task<Faction[]> GetFactions<T>(this PapyrusScript<T> self, int minRank, int maxRank) where T : notnull, IActor

Parameters

self PapyrusScript<T>

minRank int

maxRank int

Returns

Task<Faction[]>

Type Parameters

T

GetFlyingState<T>(PapyrusScript<T>)

Obtains this actor's current flight state 0 - Not flying 1 - Taking off 2 - Cruising 3 - Hovering 4 - Landing

public static Task<int> GetFlyingState<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetForcedLandingMarker<T>(PapyrusScript<T>)

Get the ref at which this actor is obliged to land, if one is set (or none, if not).

public static Task<ObjectReference?> GetForcedLandingMarker<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<ObjectReference?>

Type Parameters

T

GetFurnitureReference<T>(PapyrusScript<T>)

Returns the reference of the furniture the actor is currently using

public static Task<ObjectReference?> GetFurnitureReference<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<ObjectReference?>

Type Parameters

T

GetGoldAmount<T>(PapyrusScript<T>)

Retrieves the amount of gold this actor has

public static Task<int> GetGoldAmount<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetHighestRelationshipRank<T>(PapyrusScript<T>)

Gets this actor's highest relationship rank - returns 0 if they have no relationships

public static Task<int> GetHighestRelationshipRank<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetKiller<T>(PapyrusScript<T>)

Returns this actor's killer - or None if this actor is still alive

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetKiller().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<Actor?> GetKiller<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<Actor?>

Type Parameters

T

GetLevel<T>(PapyrusScript<T>)

Returns this actor's current level.

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetLevel().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetLevel<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetLeveledActorBase<T>(PapyrusScript<T>)

Obtains a leveled actor's "fake" base (the one generated by the game when the actor is leveled. This differs from GetActorBase which will return the editor base object)

public static Task<ActorBase?> GetLeveledActorBase<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<ActorBase?>

Type Parameters

T

GetLightLevel<T>(PapyrusScript<T>)

Returns this actor's current light level.

public static Task<float> GetLightLevel<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<float>

Type Parameters

T

Remarks

SkyrimForge Note: Witnessed values from 58 (night) to 150 (midday with a torch drawn).

GetLowestRelationshipRank<T>(PapyrusScript<T>)

Gets this actor's highest relationship rank - returns 0 if they have no relationships

public static Task<int> GetLowestRelationshipRank<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetNoBleedoutRecovery<T>(PapyrusScript<T>)

Queries whether this actor has no bleedout recovery flag set.

public static Task<bool> GetNoBleedoutRecovery<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

GetNthSpell<T>(PapyrusScript<T>, int)

returns the specified added spell for the actor

public static Task<Spell?> GetNthSpell<T>(this PapyrusScript<T> self, int n) where T : notnull, IActor

Parameters

self PapyrusScript<T>

n int

Returns

Task<Spell?>

Type Parameters

T

GetPlayerControls<T>(PapyrusScript<T>)

Queries whether this actor receives player input

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetPlayerControls().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> GetPlayerControls<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

GetRace<T>(PapyrusScript<T>)

Returns this actor's race

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetRace().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<Race?> GetRace<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<Race?>

Type Parameters

T

GetRelationshipRank<T>(PapyrusScript<T>, IActor)

Obtains the relationship rank between this actor and another

public static Task<int> GetRelationshipRank<T>(this PapyrusScript<T> self, IActor akOther) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akOther IActor

Returns

Task<int>

Type Parameters

T

GetSitState<T>(PapyrusScript<T>)

Obtains this actor's sit state, which is one of the following: 0 - Not sitting 2 - Not sitting, wants to sit 3 - Sitting 4 - Sitting, wants to stand

public static Task<int> GetSitState<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetSleepState<T>(PapyrusScript<T>)

Obtains this actor's sleep state, which is one of the following: 0 - Not sleeping 2 - Not sleeping, wants to sleep 3 - Sleeping 4 - Sleeping, wants to wake

public static Task<int> GetSleepState<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetSpellCount<T>(PapyrusScript<T>)

returns the number of added spells for the actor

public static Task<int> GetSpellCount<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<int>

Type Parameters

T

GetVoiceRecoveryTime<T>(PapyrusScript<T>)

Gets the voice recovery timer from the actor

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetVoiceRecoveryTime().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<float> GetVoiceRecoveryTime<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<float>

Type Parameters

T

GetWarmthRating<T>(PapyrusScript<T>)

Gets the total "warmth rating" for this actor

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.GetWarmthRating().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<float> GetWarmthRating<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<float>

Type Parameters

T

GetWornForm<T>(PapyrusScript<T>, int)

SKSE64 additions built 2024-01-17 20:01:40.731000 UTC returns the form for the item worn at the specified slotMask use Armor.GetMaskForSlot() to generate appropriate slotMask

public static Task<Form?> GetWornForm<T>(this PapyrusScript<T> self, int slotMask) where T : notnull, IActor

Parameters

self PapyrusScript<T>

slotMask int

Returns

Task<Form?>

Type Parameters

T

GetWornItemId<T>(PapyrusScript<T>, int)

returns the itemId for the item worn at the specified slotMask

public static Task<int> GetWornItemId<T>(this PapyrusScript<T> self, int slotMask) where T : notnull, IActor

Parameters

self PapyrusScript<T>

slotMask int

Returns

Task<int>

Type Parameters

T

HasAssociation<T>(PapyrusScript<T>, AssociationType, IActor?)

Checks to see if this actor has the specified association with the other actor - or anyone (if no actor is passed)

public static Task<bool> HasAssociation<T>(this PapyrusScript<T> self, AssociationType akAssociation, IActor? akOther = null) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akAssociation AssociationType

akOther IActor

Returns

Task<bool>

Type Parameters

T

HasFamilyRelationship<T>(PapyrusScript<T>, IActor?)

Checks to see if this actor has a family relationship with the other actor - or anyone (if no actor is passed)

public static Task<bool> HasFamilyRelationship<T>(this PapyrusScript<T> self, IActor? akOther = null) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akOther IActor

Returns

Task<bool>

Type Parameters

T

HasLOS<T>(PapyrusScript<T>, IObjectReference)

Sees if this actor has line-of-sight to another object. Only the player can check LOS to a non-actor

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.HasLOS(IObjectReference).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> HasLOS<T>(this PapyrusScript<T> self, IObjectReference akOther) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akOther IObjectReference

Returns

Task<bool>

Type Parameters

T

HasMagicEffectWithKeyword<T>(PapyrusScript<T>, IPapyrusKeyword)

Checks to see if this actor is currently being affected by a Magic Effect with the given Keyword

[Obsolete("Uses the Papyrus virtual machine. Prefer MagicTarget.HasMagicEffectWithKeyword(IKeyword, out MagicItem?).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> HasMagicEffectWithKeyword<T>(this PapyrusScript<T> self, IPapyrusKeyword akKeyword) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akKeyword IPapyrusKeyword

Returns

Task<bool>

Type Parameters

T

HasMagicEffect<T>(PapyrusScript<T>, MagicEffect)

Checks to see if this actor is currently being affected by the given Magic Effect

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.HasMagicEffect(MagicEffect).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> HasMagicEffect<T>(this PapyrusScript<T> self, MagicEffect akEffect) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akEffect MagicEffect

Returns

Task<bool>

Type Parameters

T

HasParentRelationship<T>(PapyrusScript<T>, IActor)

Checks to see if this actor has a parent relationship with the other actor

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.HasParentRelationship(IActor).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> HasParentRelationship<T>(this PapyrusScript<T> self, IActor akOther) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akOther IActor

Returns

Task<bool>

Type Parameters

T

HasPerk<T>(PapyrusScript<T>, Perk)

Checks to see if this actor has the given Perk

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.HasPerk(Perk).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> HasPerk<T>(this PapyrusScript<T> self, Perk akPerk) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akPerk Perk

Returns

Task<bool>

Type Parameters

T

HasSpell<T>(PapyrusScript<T>, IForm)

Checks to see if this actor has the given Spell or Shout

public static Task<bool> HasSpell<T>(this PapyrusScript<T> self, IForm akForm) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akForm IForm

Returns

Task<bool>

Type Parameters

T

IsAIEnabled<T>(PapyrusScript<T>)

Returns whether the actors AI is enabled

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsAIEnabled().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsAIEnabled<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsAlarmed<T>(PapyrusScript<T>)

Returns if this actor is alarmed or not

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsAlarmed().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsAlarmed<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsAlerted<T>(PapyrusScript<T>)

Returns if this actor is alerted or not

public static Task<bool> IsAlerted<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsAllowedToFly<T>(PapyrusScript<T>)

Is this actor allowed to fly?

public static Task<bool> IsAllowedToFly<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsArrested<T>(PapyrusScript<T>)

Is this actor currently arrested?

public static Task<bool> IsArrested<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsArrestingTarget<T>(PapyrusScript<T>)

Is this actor currently arresting his target? (Must be a guard and alarmed)

public static Task<bool> IsArrestingTarget<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsBeingRidden<T>(PapyrusScript<T>)

Is the actor being ridden?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsBeingRidden().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsBeingRidden<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsBleedingOut<T>(PapyrusScript<T>)

Is this actor currently bleeding out?

public static Task<bool> IsBleedingOut<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsBribed<T>(PapyrusScript<T>)

Queries whether this actor has player bribe flag set.

public static Task<bool> IsBribed<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsChild<T>(PapyrusScript<T>)

Is this actor a child?

public static Task<bool> IsChild<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsCommandedActor<T>(PapyrusScript<T>)

Is this actor a commanded by another?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsCommandedActor().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsCommandedActor<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsDead<T>(PapyrusScript<T>)

Returns if this actor is dead or not

public static Task<bool> IsDead<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsDetectedBy<T>(PapyrusScript<T>, IActor)

Returns if this actor is detected by the other one

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsDetectedBy(IActor).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsDetectedBy<T>(this PapyrusScript<T> self, IActor akOther) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akOther IActor

Returns

Task<bool>

Type Parameters

T

IsDoingFavor<T>(PapyrusScript<T>)

Is this actor doing a favor for the player?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsDoingFavor().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsDoingFavor<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsEquipped<T>(PapyrusScript<T>, IForm)

Returns if the specified object is equipped on this actor

public static Task<bool> IsEquipped<T>(this PapyrusScript<T> self, IForm akItem) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akItem IForm

Returns

Task<bool>

Type Parameters

T

IsEssential<T>(PapyrusScript<T>)

Is this actor essential?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsEssential().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsEssential<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsFlying<T>(PapyrusScript<T>)

Returns if this actor is flying or not

public static Task<bool> IsFlying<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsGhost<T>(PapyrusScript<T>)

Is this actor flagged as a ghost?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsGhost().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsGhost<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsGuard<T>(PapyrusScript<T>)

Returns if this actor is a guard or not

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsGuard().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsGuard<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsHostileToActor<T>(PapyrusScript<T>, IActor)

Is this actor hostile to another actor?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsHostileToActor(Actor).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsHostileToActor<T>(this PapyrusScript<T> self, IActor akActor) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akActor IActor

Returns

Task<bool>

Type Parameters

T

IsInCombat<T>(PapyrusScript<T>)

Returns if this actor is currently in combat

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsInCombat().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsInCombat<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsInFaction<T>(PapyrusScript<T>, Faction)

Checks to see if this actor is a member of the specified faction

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsInFaction(Faction).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsInFaction<T>(this PapyrusScript<T> self, Faction akFaction) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akFaction Faction

Returns

Task<bool>

Type Parameters

T

IsInKillMove<T>(PapyrusScript<T>)

Returns if this actor is in a kill move or not

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsInKillMove().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsInKillMove<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsIntimidated<T>(PapyrusScript<T>)

Queries whether this actor has player intimidated flag set.

public static Task<bool> IsIntimidated<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsOnMount<T>(PapyrusScript<T>)

Is the actor on a mount?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsOnMount().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsOnMount<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsOverEncumbered<T>(PapyrusScript<T>)

Is the actor over-encumbered?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsOverEncumbered().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsOverEncumbered<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsPlayerTeammate<T>(PapyrusScript<T>)

Is this actor currently a teammate of the player?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsPlayerTeammate().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsPlayerTeammate<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsPlayersLastRiddenHorse<T>(PapyrusScript<T>)

Checks to see if this actor the last ridden horse of the player

public static Task<bool> IsPlayersLastRiddenHorse<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsRunning<T>(PapyrusScript<T>)

Is this actor currently running?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsRunning().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsRunning<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsSneaking<T>(PapyrusScript<T>)

Is this actor currently sneaking?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsSneaking().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsSneaking<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsSprinting<T>(PapyrusScript<T>)

Is this actor currently sprinting?

public static Task<bool> IsSprinting<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsSwimming<T>(PapyrusScript<T>)

Returns whether the actor is currently swimming

public static Task<bool> IsSwimming<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsTrespassing<T>(PapyrusScript<T>)

Is this actor trespassing?

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.IsTrespassing().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> IsTrespassing<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsUnconscious<T>(PapyrusScript<T>)

Is this actor unconscious?

public static Task<bool> IsUnconscious<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

IsWeaponDrawn<T>(PapyrusScript<T>)

Does this actor have his weapon and/or magic drawn?

public static Task<bool> IsWeaponDrawn<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

KeepOffsetFromActor<T>(PapyrusScript<T>, IActor, float, float, float, float, float, float, float, float)

Sets the actor to a mode where it will keep a given offset from another actor

public static Task KeepOffsetFromActor<T>(this PapyrusScript<T> self, IActor arTarget, float afOffsetX, float afOffsetY, float afOffsetZ, float afOffsetAngleX = 0, float afOffsetAngleY = 0, float afOffsetAngleZ = 0, float afCatchUpRadius = 20, float afFollowRadius = 5) where T : notnull, IActor

Parameters

self PapyrusScript<T>

arTarget IActor

afOffsetX float

afOffsetY float

afOffsetZ float

afOffsetAngleX float

afOffsetAngleY float

afOffsetAngleZ float

afCatchUpRadius float

afFollowRadius float

Returns

Task

Type Parameters

T

KillEssential<T>(PapyrusScript<T>, IActor?)

Kills this actor even if essential

public static Task KillEssential<T>(this PapyrusScript<T> self, IActor? akKiller = null) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akKiller IActor

Returns

Task

Type Parameters

T

KillSilent<T>(PapyrusScript<T>, IActor?)

Kills this actor without a kill event with the killer being the guilty party

public static Task KillSilent<T>(this PapyrusScript<T> self, IActor? akKiller = null) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akKiller IActor

Returns

Task

Type Parameters

T

Kill<T>(PapyrusScript<T>, IActor?)

Kills this actor with the killer being the guilty party

public static Task Kill<T>(this PapyrusScript<T> self, IActor? akKiller = null) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akKiller IActor

Returns

Task

Type Parameters

T

MakePlayerFriend<T>(PapyrusScript<T>)

this function will make an actor a friend of the player if allowed

public static Task MakePlayerFriend<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ModAV<T>(PapyrusScript<T>, string, float)

Alias for ModActorValue - modifies the specified actor value

public static Task ModAV<T>(this PapyrusScript<T> self, string asValueName, float afAmount) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afAmount float

Returns

Task

Type Parameters

T

ModActorValue<T>(PapyrusScript<T>, string, float)

Modifies the specified actor value

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.ModActorValue(ActorValue, float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ModActorValue<T>(this PapyrusScript<T> self, string asValueName, float afAmount) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afAmount float

Returns

Task

Type Parameters

T

ModFactionRank<T>(PapyrusScript<T>, Faction, int)

Modifies this actor's rank in the faction

public static Task ModFactionRank<T>(this PapyrusScript<T> self, Faction akFaction, int aiMod) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akFaction Faction

aiMod int

Returns

Task

Type Parameters

T

ModFavorPointsWithGlobal<T>(PapyrusScript<T>, GlobalVariable)

also DEPRECATED

[Obsolete("Actor.psc deprecates ModFavorPointsWithGlobal.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task ModFavorPointsWithGlobal<T>(this PapyrusScript<T> self, GlobalVariable FavorPointsGlobal) where T : notnull, IActor

Parameters

self PapyrusScript<T>

FavorPointsGlobal GlobalVariable

Returns

Task

Type Parameters

T

ModFavorPoints<T>(PapyrusScript<T>, int)

DEPRECATED - use MakePlayerFriend() instead replacement for ModFavorPoints if iFavorPoints > 0, will setRelationshipRank to 1 if 0 otherwise, won't do anything

[Obsolete("Actor.psc deprecates ModFavorPoints.", DiagnosticId = "SKYRIMFORGE0003")]
public static Task ModFavorPoints<T>(this PapyrusScript<T> self, int iFavorPoints = 1) where T : notnull, IActor

Parameters

self PapyrusScript<T>

iFavorPoints int

Returns

Task

Type Parameters

T

MoveToPackageLocation<T>(PapyrusScript<T>)

Pop this actor to the initial location for a package. Mainly for use on disabled actors, since they would normally start at their editor locations.

public static Task MoveToPackageLocation<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

OpenInventory<T>(PapyrusScript<T>, bool)

Opens this actor's inventory, as if you were pick-pocketing them. Only works on teammates, or anyone if forced.

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.OpenInventory(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task OpenInventory<T>(this PapyrusScript<T> self, bool abForceOpen = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abForceOpen bool

Returns

Task

Type Parameters

T

PathToReference<T>(PapyrusScript<T>, IObjectReference, float)

Make the actor path to a reference, latent version Note: this method doesn't return until the goal is reached or pathing failed or was interrupted (by another request for instance)

public static Task<bool> PathToReference<T>(this PapyrusScript<T> self, IObjectReference aTarget, float afWalkRunPercent) where T : notnull, IActor

Parameters

self PapyrusScript<T>

aTarget IObjectReference

afWalkRunPercent float

Returns

Task<bool>

Type Parameters

T

PlayIdleWithTarget<T>(PapyrusScript<T>, Idle, IObjectReference)

Send an idle to the actor to play, overriding its target with the specified reference

public static Task<bool> PlayIdleWithTarget<T>(this PapyrusScript<T> self, Idle akIdle, IObjectReference akTarget) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akIdle Idle

akTarget IObjectReference

Returns

Task<bool>

Type Parameters

T

PlayIdle<T>(PapyrusScript<T>, Idle)

Send an idle to the actor to load in and play.

public static Task<bool> PlayIdle<T>(this PapyrusScript<T> self, Idle akIdle) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akIdle Idle

Returns

Task<bool>

Type Parameters

T

PlaySubGraphAnimation<T>(PapyrusScript<T>, string)

Send an event to the subgraphs of an actor.

public static Task PlaySubGraphAnimation<T>(this PapyrusScript<T> self, string asEventName) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asEventName string

Returns

Task

Type Parameters

T

QueueNiNodeUpdate<T>(PapyrusScript<T>)

Updates an Actors meshes (Used for Armor mesh/texture changes and face changes) DO NOT USE WHILE MOUNTED

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.DoReset3D(updateWeight: false).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task QueueNiNodeUpdate<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

RegenerateHead<T>(PapyrusScript<T>)

Updates an Actors head mesh

public static Task RegenerateHead<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

RemoveFromAllFactions<T>(PapyrusScript<T>)

Removes this actor from all factions

public static Task RemoveFromAllFactions<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

RemoveFromFaction<T>(PapyrusScript<T>, Faction)

Removes this actor from the specified faction

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.RemoveFromFaction(Faction).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task RemoveFromFaction<T>(this PapyrusScript<T> self, Faction akFaction) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akFaction Faction

Returns

Task

Type Parameters

T

RemovePerk<T>(PapyrusScript<T>, Perk)

Removes the specified perk from this actor

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.RemovePerk(Perk).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task RemovePerk<T>(this PapyrusScript<T> self, Perk akPerk) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akPerk Perk

Returns

Task

Type Parameters

T

RemoveShout<T>(PapyrusScript<T>, Shout)

Removes the specified shout from this actor - returns true on success

public static Task<bool> RemoveShout<T>(this PapyrusScript<T> self, Shout akShout) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akShout Shout

Returns

Task<bool>

Type Parameters

T

RemoveSpell<T>(PapyrusScript<T>, IPapyrusSpell)

Removes the specified spell from this actor - returns true on success

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.RemoveSpell(Spell).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<bool> RemoveSpell<T>(this PapyrusScript<T> self, IPapyrusSpell akSpell) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akSpell IPapyrusSpell

Returns

Task<bool>

Type Parameters

T

ReplaceHeadPart<T>(PapyrusScript<T>, HeadPart, HeadPart)

Replaces a headpart on the loaded mesh does not affect ActorBase Both old and new must exist, and be of the same type

public static Task ReplaceHeadPart<T>(this PapyrusScript<T> self, HeadPart oPart, HeadPart newPart) where T : notnull, IActor

Parameters

self PapyrusScript<T>

oPart HeadPart

newPart HeadPart

Returns

Task

Type Parameters

T

ResetAI<T>(PapyrusScript<T>)

Resets Actor AI

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.ResetAI().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task ResetAI<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ResetExpressionOverrides<T>(PapyrusScript<T>)

Resets all expression, phoneme, and modifiers

public static Task ResetExpressionOverrides<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ResetHealthAndLimbs<T>(PapyrusScript<T>)

Resets this actor's health and limb state

public static Task ResetHealthAndLimbs<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

RestoreAV<T>(PapyrusScript<T>, string, float)

Alias for RestoreActorValue - restores damage done to the actor value

public static Task RestoreAV<T>(this PapyrusScript<T> self, string asValueName, float afAmount) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afAmount float

Returns

Task

Type Parameters

T

RestoreActorValue<T>(PapyrusScript<T>, string, float)

Restores damage done to the actor value (up to 0 damage)

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.RestoreDamage(ActorValue, float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task RestoreActorValue<T>(this PapyrusScript<T> self, string asValueName, float afAmount) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afAmount float

Returns

Task

Type Parameters

T

Resurrect<T>(PapyrusScript<T>)

Resurrects this actor

public static Task Resurrect<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

SendAssaultAlarm<T>(PapyrusScript<T>)

Has this actor behave as if assaulted

public static Task SendAssaultAlarm<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

SendLycanthropyStateChanged<T>(PapyrusScript<T>, bool)

Tell anyone who cares that the lycanthropy state of this actor has changed

public static Task SendLycanthropyStateChanged<T>(this PapyrusScript<T> self, bool abIsWerewolf) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abIsWerewolf bool

Returns

Task

Type Parameters

T

SendTrespassAlarm<T>(PapyrusScript<T>, IActor)

Has this actor behave as if they caught the target trespassing

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.SendTrespassAlarm(IActor).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SendTrespassAlarm<T>(this PapyrusScript<T> self, IActor akCriminal) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akCriminal IActor

Returns

Task

Type Parameters

T

SendVampirismStateChanged<T>(PapyrusScript<T>, bool)

Tell anyone who cares that the vampirism state of this actor has changed

public static Task SendVampirismStateChanged<T>(this PapyrusScript<T> self, bool abIsVampire) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abIsVampire bool

Returns

Task

Type Parameters

T

SetAV<T>(PapyrusScript<T>, string, float)

Alias for SetActorValue - sets the specified actor value

public static Task SetAV<T>(this PapyrusScript<T> self, string asValueName, float afValue) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afValue float

Returns

Task

Type Parameters

T

SetActorValue<T>(PapyrusScript<T>, string, float)

Sets the specified actor value

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.SetActorValue(ActorValue, float).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetActorValue<T>(this PapyrusScript<T> self, string asValueName, float afValue) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asValueName string

afValue float

Returns

Task

Type Parameters

T

SetAlert<T>(PapyrusScript<T>, bool)

Sets the actor in an alerted state

public static Task SetAlert<T>(this PapyrusScript<T> self, bool abAlerted = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abAlerted bool

Returns

Task

Type Parameters

T

SetAllowFlyingEx<T>(PapyrusScript<T>, bool, bool, bool)

public static Task SetAllowFlyingEx<T>(this PapyrusScript<T> self, bool abAllowed = true, bool abAllowCrash = true, bool abAllowSearch = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abAllowed bool

abAllowCrash bool

abAllowSearch bool

Returns

Task

Type Parameters

T

SetAllowFlying<T>(PapyrusScript<T>, bool)

public static Task SetAllowFlying<T>(this PapyrusScript<T> self, bool abAllowed = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abAllowed bool

Returns

Task

Type Parameters

T

SetAlpha<T>(PapyrusScript<T>, float, bool)

Sets this actor's alpha - with an optional fade to that alpha The alpha will be clamped between 0 and 1

public static Task SetAlpha<T>(this PapyrusScript<T> self, float afTargetAlpha, bool abFade = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afTargetAlpha float

abFade bool

Returns

Task

Type Parameters

T

SetAttackActorOnSight<T>(PapyrusScript<T>, bool)

Sets this actor to be attacked by all other actors on sight

public static Task SetAttackActorOnSight<T>(this PapyrusScript<T> self, bool abAttackOnSight = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abAttackOnSight bool

Returns

Task

Type Parameters

T

SetBribed<T>(PapyrusScript<T>, bool)

Flags/unflags this actor as bribed by the player

public static Task SetBribed<T>(this PapyrusScript<T> self, bool abBribe = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abBribe bool

Returns

Task

Type Parameters

T

SetCrimeFaction<T>(PapyrusScript<T>, Faction)

Sets the faction this actor reports crimes to

public static Task SetCrimeFaction<T>(this PapyrusScript<T> self, Faction akFaction) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akFaction Faction

Returns

Task

Type Parameters

T

SetCriticalStage<T>(PapyrusScript<T>, int)

Sets this actor's critical stage, which is one of the following (properties below also match this) 0 - None 1 - Goo start 2 - Goo end 3 - Disintegrate start 4 - Disintegrate end

public static Task SetCriticalStage<T>(this PapyrusScript<T> self, int aiStage) where T : notnull, IActor

Parameters

self PapyrusScript<T>

aiStage int

Returns

Task

Type Parameters

T

SetDoingFavor<T>(PapyrusScript<T>, bool)

Flag this actor as currently doing a favor for the player

public static Task SetDoingFavor<T>(this PapyrusScript<T> self, bool abDoingFavor = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abDoingFavor bool

Returns

Task

Type Parameters

T

SetDontMove<T>(PapyrusScript<T>, bool)

Sets this actor as "don't move" or not

public static Task SetDontMove<T>(this PapyrusScript<T> self, bool abDontMove = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abDontMove bool

Returns

Task

Type Parameters

T

SetExpressionModifier<T>(PapyrusScript<T>, int, float)

0 - "BlinkLeft" 1 - "BlinkRight" 2 - "BrowDownLeft" 3 - "BrowDownRight" 4 - "BrowInLeft" 5 - "BrowInRight" 6 - "BrowUpLeft" 7 - "BrowUpRight" 8 - "LookDown" 9 - "LookLeft" 10 - "LookRight" 11 - "LookUp" 12 - "SquintLeft" 13 - "SquintRight" 14 - "HeadPitch" 15 - "HeadRoll" 16 - "HeadYaw"

public static Task SetExpressionModifier<T>(this PapyrusScript<T> self, int index, float value) where T : notnull, IActor

Parameters

self PapyrusScript<T>

index int

value float

Returns

Task

Type Parameters

T

SetExpressionOverride<T>(PapyrusScript<T>, int, int)

Sets an expression to override any other expression other systems may give this actor. 7 - Mood Neutral 0 - Dialogue Anger 8 - Mood Anger 15 - Combat Anger 1 - Dialogue Fear 9 - Mood Fear 16 - Combat Shout 2 - Dialogue Happy 10 - Mood Happy 3 - Dialogue Sad 11 - Mood Sad 4 - Dialogue Surprise 12 - Mood Surprise 5 - Dialogue Puzzled 13 - Mood Puzzled 6 - Dialogue Disgusted 14 - Mood Disgusted aiStrength is from 0 to 100 (percent)

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.SetExpressionOverride(int, int).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetExpressionOverride<T>(this PapyrusScript<T> self, int aiMood, int aiStrength = 100) where T : notnull, IActor

Parameters

self PapyrusScript<T>

aiMood int

aiStrength int

Returns

Task

Type Parameters

T

SetExpressionPhoneme<T>(PapyrusScript<T>, int, float)

0 - "Aah" 1 - "BigAah" 2 - "BMP" 3 - "ChJSh" 4 - "DST" 5 - "Eee" 6 - "Eh" 7 - "FV" 8 - "I" 9 - "K" 10 - "N" 11 - "Oh" 12 - "OohQ" 13 - "R" 14 - "Th" 15 - "W"

public static Task SetExpressionPhoneme<T>(this PapyrusScript<T> self, int index, float value) where T : notnull, IActor

Parameters

self PapyrusScript<T>

index int

value float

Returns

Task

Type Parameters

T

SetEyeTexture<T>(PapyrusScript<T>, TextureSet)

forces the eye texture for this actor to the give texture set

public static Task SetEyeTexture<T>(this PapyrusScript<T> self, TextureSet akNewTexture) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akNewTexture TextureSet

Returns

Task

Type Parameters

T

SetFactionRank<T>(PapyrusScript<T>, Faction, int)

Sets this actor's rank with the specified faction

public static Task SetFactionRank<T>(this PapyrusScript<T> self, Faction akFaction, int aiRank) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akFaction Faction

aiRank int

Returns

Task

Type Parameters

T

SetForcedLandingMarker<T>(PapyrusScript<T>, IObjectReference)

Set a specific marker as the place at which this actor must land from flight. params:

• aMarker: The ObjectReference to set as this actor's landing marker

public static Task SetForcedLandingMarker<T>(this PapyrusScript<T> self, IObjectReference aMarker) where T : notnull, IActor

Parameters

self PapyrusScript<T>

aMarker IObjectReference

Returns

Task

Type Parameters

T

SetGhost<T>(PapyrusScript<T>, bool)

Flags/unflags this actor as a ghost

public static Task SetGhost<T>(this PapyrusScript<T> self, bool abIsGhost = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abIsGhost bool

Returns

Task

Type Parameters

T

SetHeadTracking<T>(PapyrusScript<T>, bool)

Turns on/off headtracking on this actor

public static Task SetHeadTracking<T>(this PapyrusScript<T> self, bool abEnable = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abEnable bool

Returns

Task

Type Parameters

T

SetIntimidated<T>(PapyrusScript<T>, bool)

Flags/unflags this actor as intimidated by the player

public static Task SetIntimidated<T>(this PapyrusScript<T> self, bool abIntimidate = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abIntimidate bool

Returns

Task

Type Parameters

T

SetLookAt<T>(PapyrusScript<T>, IObjectReference, bool)

Sets this actor's head tracking target, optionally forcing it as their pathing look-at target

public static Task SetLookAt<T>(this PapyrusScript<T> self, IObjectReference akTarget, bool abPathingLookAt = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akTarget IObjectReference

abPathingLookAt bool

Returns

Task

Type Parameters

T

SetNoBleedoutRecovery<T>(PapyrusScript<T>, bool)

Set the no bleedout recovery flag on this actor

public static Task SetNoBleedoutRecovery<T>(this PapyrusScript<T> self, bool abAllowed) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abAllowed bool

Returns

Task

Type Parameters

T

SetNotShowOnStealthMeter<T>(PapyrusScript<T>, bool)

Sets this actor to not effect the detection level on the stealth meter if he is not hostile to the player

public static Task SetNotShowOnStealthMeter<T>(this PapyrusScript<T> self, bool abNotShow) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abNotShow bool

Returns

Task

Type Parameters

T

SetOutfit<T>(PapyrusScript<T>, Outfit, bool)

Sets the actors outfit and makes him wear it

public static Task SetOutfit<T>(this PapyrusScript<T> self, Outfit akOutfit, bool abSleepOutfit = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akOutfit Outfit

abSleepOutfit bool

Returns

Task

Type Parameters

T

SetPlayerControls<T>(PapyrusScript<T>, bool)

Set/reset whether player input being sent to the actor

public static Task SetPlayerControls<T>(this PapyrusScript<T> self, bool abControls) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abControls bool

Returns

Task

Type Parameters

T

SetPlayerResistingArrest<T>(PapyrusScript<T>)

Sets the player as resisting arrest from this actor's faction

public static Task SetPlayerResistingArrest<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

SetPlayerTeammate<T>(PapyrusScript<T>, bool, bool)

Sets or clears this actor as a teammate of the player abCanDoFavor - OPTIONAL default is true the teammate can do favors

public static Task SetPlayerTeammate<T>(this PapyrusScript<T> self, bool abTeammate = true, bool abCanDoFavor = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abTeammate bool

abCanDoFavor bool

Returns

Task

Type Parameters

T

SetRace<T>(PapyrusScript<T>, Race?)

Sets the actors race akRace - OPTIONAL (Def=None) New race for this actor. Default, no race, to switch back to the original race.

public static Task SetRace<T>(this PapyrusScript<T> self, Race? akRace = null) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akRace Race?

Returns

Task

Type Parameters

T

SetRelationshipRank<T>(PapyrusScript<T>, IActor, int)

Sets the relationship rank between this actor and another (See GetRelationshipRank for the ranks)

public static Task SetRelationshipRank<T>(this PapyrusScript<T> self, IActor akOther, int aiRank) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akOther IActor

aiRank int

Returns

Task

Type Parameters

T

SetRestrained<T>(PapyrusScript<T>, bool)

Sets this actor as restrained or not

public static Task SetRestrained<T>(this PapyrusScript<T> self, bool abRestrained = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abRestrained bool

Returns

Task

Type Parameters

T

SetSubGraphFloatVariable<T>(PapyrusScript<T>, string, float)

Set a variable on all of an actor's subgraphs

public static Task SetSubGraphFloatVariable<T>(this PapyrusScript<T> self, string asVariableName, float afValue) where T : notnull, IActor

Parameters

self PapyrusScript<T>

asVariableName string

afValue float

Returns

Task

Type Parameters

T

SetUnconscious<T>(PapyrusScript<T>, bool)

Sets this actor as unconscious or not

public static Task SetUnconscious<T>(this PapyrusScript<T> self, bool abUnconscious = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abUnconscious bool

Returns

Task

Type Parameters

T

SetVehicle<T>(PapyrusScript<T>, IObjectReference)

Attach the actor to (or detach it from) a horse, cart, or other vehicle. akVehicle is the vehicle ref. To detach the actor from its current vehicle, set akVehicle to None (or to the Actor itself).

public static Task SetVehicle<T>(this PapyrusScript<T> self, IObjectReference akVehicle) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akVehicle IObjectReference

Returns

Task

Type Parameters

T

SetVoiceRecoveryTime<T>(PapyrusScript<T>, float)

Sets the voice recovery timer on the actor afTime is recovery time in seconds

public static Task SetVoiceRecoveryTime<T>(this PapyrusScript<T> self, float afTime) where T : notnull, IActor

Parameters

self PapyrusScript<T>

afTime float

Returns

Task

Type Parameters

T

SheatheWeapon<T>(PapyrusScript<T>)

Sheathes the actors weapon

public static Task SheatheWeapon<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ShowBarterMenu<T>(PapyrusScript<T>)

Opens the Barter menu

public static Task ShowBarterMenu<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

ShowGiftMenu<T>(PapyrusScript<T>, bool, FormList?, bool, bool)

Opens the Gift menu Params:

• abGivingGift: True if we're giving a gift to this Actor, false if the player is taking a gift from this Actor
• apFilterList: OPTIONAL (Def=None) -- If present, this form list is used to filter the item list. Only items that match keywords / items in the list will get shown
• abShowStolenItems: OPTIONAL (Def=false) -- If true, stolen items are shown
• abUseFavorPoints: OPTIONAL (Def=true) -- If true, favor points are added / subtracted with each transaction. If false, FPs aren't used at all. Returns: The number of favor points spent / gained while in the menu.

public static Task<int> ShowGiftMenu<T>(this PapyrusScript<T> self, bool abGivingGift, FormList? apFilterList = null, bool abShowStolenItems = false, bool abUseFavorPoints = true) where T : notnull, IActor

Parameters

self PapyrusScript<T>

abGivingGift bool

apFilterList FormList?

abShowStolenItems bool

abUseFavorPoints bool

Returns

Task<int>

Type Parameters

T

StartCannibal<T>(PapyrusScript<T>, IActor)

Starts Cannibal with the target

public static Task StartCannibal<T>(this PapyrusScript<T> self, IActor akTarget) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akTarget IActor

Returns

Task

Type Parameters

T

StartCombat<T>(PapyrusScript<T>, IActor)

Starts combat with the target

public static Task StartCombat<T>(this PapyrusScript<T> self, IActor akTarget) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akTarget IActor

Returns

Task

Type Parameters

T

StartDeferredKill<T>(PapyrusScript<T>)

Start the Deferred Kill state. Be sure to call EndDeferredKill or the actor will be invulnerable.

public static Task StartDeferredKill<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

StartSneaking<T>(PapyrusScript<T>)

Makes this actor start sneaking

public static Task StartSneaking<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

StartVampireFeed<T>(PapyrusScript<T>, IActor)

Starts vampire feed with the target

public static Task StartVampireFeed<T>(this PapyrusScript<T> self, IActor akTarget) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akTarget IActor

Returns

Task

Type Parameters

T

StopCombatAlarm<T>(PapyrusScript<T>)

Stops all combat and alarms against this actor

public static Task StopCombatAlarm<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

StopCombat<T>(PapyrusScript<T>)

Removes this actor from combat

[Obsolete("Uses the Papyrus virtual machine. Prefer Actor.StopCombat().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task StopCombat<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

TrapSoul<T>(PapyrusScript<T>, IActor)

Returns whether the actor can trap the soul of the given actor.

public static Task<bool> TrapSoul<T>(this PapyrusScript<T> self, IActor akTarget) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akTarget IActor

Returns

Task<bool>

Type Parameters

T

UnLockOwnedDoorsInCell<T>(PapyrusScript<T>)

This actor will unlock all the doors that he qualifies for ownership in his current parentcell

public static Task UnLockOwnedDoorsInCell<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

UnequipAll<T>(PapyrusScript<T>)

Unequips the all items from this actor

public static Task UnequipAll<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task

Type Parameters

T

UnequipItemEx<T>(PapyrusScript<T>, IForm, int, bool)

unequips item at the given slot

public static Task UnequipItemEx<T>(this PapyrusScript<T> self, IForm item, int equipSlot = 0, bool preventEquip = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

item IForm

equipSlot int

preventEquip bool

Returns

Task

Type Parameters

T

UnequipItemSlot<T>(PapyrusScript<T>, int)

Unequips the all items in this slot for the actor

public static Task UnequipItemSlot<T>(this PapyrusScript<T> self, int aiSlot) where T : notnull, IActor

Parameters

self PapyrusScript<T>

aiSlot int

Returns

Task

Type Parameters

T

UnequipItem<T>(PapyrusScript<T>, IForm, bool, bool)

Unequips the specified item from this actor

public static Task UnequipItem<T>(this PapyrusScript<T> self, IForm akItem, bool abPreventEquip = false, bool abSilent = false) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akItem IForm

abPreventEquip bool

abSilent bool

Returns

Task

Type Parameters

T

UnequipShout<T>(PapyrusScript<T>, Shout)

Forces this actor to unequip the specified shout

public static Task UnequipShout<T>(this PapyrusScript<T> self, Shout akShout) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akShout Shout

Returns

Task

Type Parameters

T

UnequipSpell<T>(PapyrusScript<T>, IPapyrusSpell, int)

Forces this actor to unequip the specified spell. The casting source can be: 0 - Left hand 1 - Right hand

public static Task UnequipSpell<T>(this PapyrusScript<T> self, IPapyrusSpell akSpell, int aiSource) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akSpell IPapyrusSpell

aiSource int

Returns

Task

Type Parameters

T

UpdateWeight<T>(PapyrusScript<T>, float)

Visually updates the actors weight neckDelta = (oldWeight / 100) - (newWeight / 100) Neck changes are player persistent, but actor per-session Weight itself is persistent either way so keep track of your original weight if you use this for Actors other than the player DO NOT USE WHILE MOUNTED

public static Task UpdateWeight<T>(this PapyrusScript<T> self, float neckDelta) where T : notnull, IActor

Parameters

self PapyrusScript<T>

neckDelta float

Returns

Task

Type Parameters

T

WillIntimidateSucceed<T>(PapyrusScript<T>)

Returns whether intimidate will succeed against this actor or not

public static Task<bool> WillIntimidateSucceed<T>(this PapyrusScript<T> self) where T : notnull, IActor

Parameters

self PapyrusScript<T>

Returns

Task<bool>

Type Parameters

T

WornHasKeyword<T>(PapyrusScript<T>, IPapyrusKeyword)

Returns whether anything the actor is wearing has the specified keyword

public static Task<bool> WornHasKeyword<T>(this PapyrusScript<T> self, IPapyrusKeyword akKeyword) where T : notnull, IActor

Parameters

self PapyrusScript<T>

akKeyword IPapyrusKeyword

Returns

Task<bool>

Type Parameters

T