Table of Contents

Class ActorBaseScript

Namespace
SkyrimForge.Papyrus
Assembly
SkyrimForge.Game.dll

Functions and comments from ActorBase.psc.

public static class ActorBaseScript
Inheritance
ActorBaseScript
Inherited Members

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

GetClass(PapyrusScript<ActorBase>)

Returns this actor's class

public static Task<Class?> GetClass(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<Class?>

GetCombatStyle(PapyrusScript<ActorBase>) 

public static Task<CombatStyle?> GetCombatStyle(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<CombatStyle?>

GetDeadCount(PapyrusScript<ActorBase>)

Gets the number of actors of this type that have been killed

public static Task<int> GetDeadCount(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<int>

GetFaceMorph(PapyrusScript<ActorBase>, int) 

public static Task<float> GetFaceMorph(this PapyrusScript<ActorBase> self, int index)

Parameters

self PapyrusScript<ActorBase>
index int

Returns

Task<float>

GetFacePreset(PapyrusScript<ActorBase>, int) 

public static Task<int> GetFacePreset(this PapyrusScript<ActorBase> self, int index)

Parameters

self PapyrusScript<ActorBase>
index int

Returns

Task<int>

GetFaceTextureSet(PapyrusScript<ActorBase>) 

public static Task<TextureSet?> GetFaceTextureSet(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<TextureSet?>

GetGiftFilter(PapyrusScript<ActorBase>)

Returns this actor's gift filter formlist

public static Task<FormList?> GetGiftFilter(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<FormList?>

GetHairColor(PapyrusScript<ActorBase>) 

public static Task<ColorForm?> GetHairColor(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<ColorForm?>

GetHeight(PapyrusScript<ActorBase>) 

[Obsolete("Uses the Papyrus virtual machine. Prefer ActorBase.GetHeight().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<float> GetHeight(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<float>

GetIndexOfHeadPartByType(PapyrusScript<ActorBase>, int) 

public static Task<int> GetIndexOfHeadPartByType(this PapyrusScript<ActorBase> self, int type)

Parameters

self PapyrusScript<ActorBase>
type int

Returns

Task<int>

GetIndexOfOverlayHeadPartByType(PapyrusScript<ActorBase>, int) 

public static Task<int> GetIndexOfOverlayHeadPartByType(this PapyrusScript<ActorBase> self, int type)

Parameters

self PapyrusScript<ActorBase>
type int

Returns

Task<int>

GetNthHeadPart(PapyrusScript<ActorBase>, int) 

public static Task<HeadPart?> GetNthHeadPart(this PapyrusScript<ActorBase> self, int slotPart)

Parameters

self PapyrusScript<ActorBase>
slotPart int

Returns

Task<HeadPart?>

GetNthOverlayHeadPart(PapyrusScript<ActorBase>, int) 

public static Task<HeadPart?> GetNthOverlayHeadPart(this PapyrusScript<ActorBase> self, int slotPart)

Parameters

self PapyrusScript<ActorBase>
slotPart int

Returns

Task<HeadPart?>

GetNthSpell(PapyrusScript<ActorBase>, int)

returns the specified spell defined in the base actor form

public static Task<Spell?> GetNthSpell(this PapyrusScript<ActorBase> self, int n)

Parameters

self PapyrusScript<ActorBase>
n int

Returns

Task<Spell?>

GetNumHeadParts(PapyrusScript<ActorBase>) 

public static Task<int> GetNumHeadParts(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<int>

GetNumOverlayHeadParts(PapyrusScript<ActorBase>) 

[Obsolete("Uses the Papyrus virtual machine. Prefer ActorBase.GetNumBaseOverlays().", DiagnosticId = "SKYRIMFORGE0002")]
public static Task<int> GetNumOverlayHeadParts(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<int>

GetOutfit(PapyrusScript<ActorBase>, bool)

Get the Outfit of the actor

public static Task<Outfit?> GetOutfit(this PapyrusScript<ActorBase> self, bool bSleepOutfit = false)

Parameters

self PapyrusScript<ActorBase>
bSleepOutfit bool

Returns

Task<Outfit?>

GetRace(PapyrusScript<ActorBase>)

Returns this actor's race

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

Parameters

self PapyrusScript<ActorBase>

Returns

Task<Race?>

GetSex(PapyrusScript<ActorBase>)

Returns this actor's sex. Values for sex are: -1 - None 0 - Male 1 - Female

public static Task<int> GetSex(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<int>

GetSkin(PapyrusScript<ActorBase>) 

public static Task<Armor?> GetSkin(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<Armor?>

GetSkinFar(PapyrusScript<ActorBase>) 

public static Task<Armor?> GetSkinFar(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<Armor?>

GetSpellCount(PapyrusScript<ActorBase>)

returns the number of spells defined in the base actor form

public static Task<int> GetSpellCount(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<int>

GetTemplate(PapyrusScript<ActorBase>)

Gets the root template of the ActorBase

public static Task<ActorBase?> GetTemplate(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<ActorBase?>

GetVoiceType(PapyrusScript<ActorBase>) 

public static Task<VoiceType?> GetVoiceType(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<VoiceType?>

GetWeight(ActorBase) 

public static Task<float> GetWeight(ActorBase self)

Parameters

self ActorBase

Returns

Task<float>

IsEssential(PapyrusScript<ActorBase>)

Is this actor essential?

public static Task<bool> IsEssential(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<bool>

IsInvulnerable(PapyrusScript<ActorBase>)

Is this actor invulnerable?

public static Task<bool> IsInvulnerable(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<bool>

IsProtected(PapyrusScript<ActorBase>)

Is this actor protected (can only be killed by player)?

public static Task<bool> IsProtected(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<bool>

IsUnique(PapyrusScript<ActorBase>)

Is this actor base unique?

public static Task<bool> IsUnique(this PapyrusScript<ActorBase> self)

Parameters

self PapyrusScript<ActorBase>

Returns

Task<bool>

SetClass(PapyrusScript<ActorBase>, Class)

set the Class of the actor

public static Task SetClass(this PapyrusScript<ActorBase> self, Class c)

Parameters

self PapyrusScript<ActorBase>
c Class

Returns

Task

SetCombatStyle(PapyrusScript<ActorBase>, CombatStyle) 

public static Task SetCombatStyle(this PapyrusScript<ActorBase> self, CombatStyle cs)

Parameters

self PapyrusScript<ActorBase>
cs CombatStyle

Returns

Task

SetEssential(PapyrusScript<ActorBase>, bool)

Sets this actor as essential or not - if set as essential, will UNSET protected

[Obsolete("Uses the Papyrus virtual machine. Prefer ActorBase.SetEssential(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetEssential(this PapyrusScript<ActorBase> self, bool abEssential = true)

Parameters

self PapyrusScript<ActorBase>
abEssential bool

Returns

Task

SetFaceMorph(PapyrusScript<ActorBase>, float, int) 

public static Task SetFaceMorph(this PapyrusScript<ActorBase> self, float value, int index)

Parameters

self PapyrusScript<ActorBase>
value float
index int

Returns

Task

SetFacePreset(PapyrusScript<ActorBase>, int, int) 

public static Task SetFacePreset(this PapyrusScript<ActorBase> self, int value, int index)

Parameters

self PapyrusScript<ActorBase>
value int
index int

Returns

Task

SetFaceTextureSet(PapyrusScript<ActorBase>, TextureSet) 

public static Task SetFaceTextureSet(this PapyrusScript<ActorBase> self, TextureSet textures)

Parameters

self PapyrusScript<ActorBase>
textures TextureSet

Returns

Task

SetHairColor(PapyrusScript<ActorBase>, ColorForm) 

public static Task SetHairColor(this PapyrusScript<ActorBase> self, ColorForm color)

Parameters

self PapyrusScript<ActorBase>
color ColorForm

Returns

Task

SetHeight(PapyrusScript<ActorBase>, float) 

public static Task SetHeight(this PapyrusScript<ActorBase> self, float height)

Parameters

self PapyrusScript<ActorBase>
height float

Returns

Task

SetInvulnerable(PapyrusScript<ActorBase>, bool)

Sets this actor as invulnerable or not

[Obsolete("Uses the Papyrus virtual machine. Prefer ActorBase.SetInvulnerable(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetInvulnerable(this PapyrusScript<ActorBase> self, bool abInvulnerable = true)

Parameters

self PapyrusScript<ActorBase>
abInvulnerable bool

Returns

Task

SetNthHeadPart(PapyrusScript<ActorBase>, HeadPart, int) 

public static Task SetNthHeadPart(this PapyrusScript<ActorBase> self, HeadPart headPart, int slotPart)

Parameters

self PapyrusScript<ActorBase>
headPart HeadPart
slotPart int

Returns

Task

SetOutfit(PapyrusScript<ActorBase>, Outfit, bool)

Sets the actors outfit

public static Task SetOutfit(this PapyrusScript<ActorBase> self, Outfit akOutfit, bool abSleepOutfit = false)

Parameters

self PapyrusScript<ActorBase>
akOutfit Outfit
abSleepOutfit bool

Returns

Task

SetProtected(PapyrusScript<ActorBase>, bool)

Sets this actor as protected or not - if set as protected, will UNSET essential

[Obsolete("Uses the Papyrus virtual machine. Prefer ActorBase.SetProtected(bool).", DiagnosticId = "SKYRIMFORGE0002")]
public static Task SetProtected(this PapyrusScript<ActorBase> self, bool abProtected = true)

Parameters

self PapyrusScript<ActorBase>
abProtected bool

Returns

Task

SetSkin(PapyrusScript<ActorBase>, Armor) 

public static Task SetSkin(this PapyrusScript<ActorBase> self, Armor skin)

Parameters

self PapyrusScript<ActorBase>
skin Armor

Returns

Task

SetSkinFar(PapyrusScript<ActorBase>, Armor) 

public static Task SetSkinFar(this PapyrusScript<ActorBase> self, Armor skin)

Parameters

self PapyrusScript<ActorBase>
skin Armor

Returns

Task

SetVoiceType(PapyrusScript<ActorBase>, VoiceType) 

public static Task SetVoiceType(this PapyrusScript<ActorBase> self, VoiceType nVoice)

Parameters

self PapyrusScript<ActorBase>
nVoice VoiceType

Returns

Task

SetWeight(ActorBase, float) 

public static Task SetWeight(ActorBase self, float weight)

Parameters

self ActorBase
weight float

Returns

Task