ActorBase Script

From Creation Kit
Jump to: navigation, search


Extends: Form Script

Script for the manipulation of actor base objects. Actors are references of this.

Contents

Definition

ScriptName ActorBase extends Form

Properties

None

Global Functions

None

Member Functions

Class Function GetClass()

  • Returns this actor's class.

int Function GetDeadCount()

  • Returns the number of actors that have this base that are dead.

FormList Function GetGiftFilter()

  • Returns this actor's formlist of keywords to use as a gift filter.

Race Function GetRace()

  • Returns this actor's race.

int Function GetSex()

  • Returns this actor's sex.

bool Function IsEssential()

  • Returns if this actor is flagged as essential or not.

bool Function IsInvulnerable()

  • Returns if this actor is flagged as invulnerable or not.

bool Function IsProtected()

  • Returns if this actor is flagged as protected or not.

bool Function IsUnique()

  • Returns if this actor is flagged as unique.

Function SetEssential(bool abEssential)

  • Flags this actor as essential or not. An actor cannot both be protected and essential.

Function SetInvulnerable(bool abInvulnerable)

  • Flags this actor as invulnerable or not.

Function SetProtected(bool abProtected)

  • Flags this actor as protected or not. An actor cannot both be protected and essential.

Function SetOutfit(Outfit akOutfit,bool abSleepOutfit)

  • Change the default or sleep outfit. Art will be loaded next time this actor is loaded.

SKSE Member Functions

CombatStyle Function GetCombatStyle()

  • Returns the combat style of this actor.

Function SetCombatStyle(CombatStyle cs)

  • Sets the combat style of this actor.

Outfit Function GetOutfit(bool bSleepOutfit = false)

  • Returns the default or sleep outfit of this actor.

Function SetClass(Class c)

  • Changes the class of this actor.

float Function GetHeight()

  • Returns the height of this actor.

Function SetHeight(float height)

  • Sets the height of this actor to the specified amount.

float Function GetWeight()

  • Returns the weight of this actor.

Function SetWeight(float weight)

  • Changes the weight of this actor.

int Function GetNumHeadParts()

  • Returns the number of head parts of this actor.

HeadPart Function GetNthHeadPart(int slotPart)

  • Returns the specified head part of this actor.

Function SetNthHeadPart(HeadPart headPart, int slotPart)

  • Changes the specified head part of this actor.

float Function GetFaceMorph(int index)

  • Returns the specified head morph value of this actor.

Function SetFaceMorph(float value, int index)

  • Changes the specified face morph value of this actor.

int Function GetFacePreset(int index)

  • Returns the face preset of this actor.

Function SetFacePreset(int value, int index)

  • Changes the face preset of this actor.

ColorForm Function GetHairColor()

  • Returns the ColorForm of this actor's hair.

Function SetHairColor(ColorForm color)

  • Changes the ColorForm of this actor's hair.

Int Function GetSpellCount()

  • Returns the number of spells defined in the base actor form.

Spell Function GetNthSpell(int n)

  • Returns the specified spell defined in the base actor form.

Events

None

Notes

  • Any changes made to a leveled actor's leveled (or 'temporary') base will be lost when the actor re-levels.
  • Any changes made to a leveled actor's non-leveled (or editor) base will not show up on the actor until the actor re-levels.
Personal tools
Namespaces
Variants
Actions
Navigation
Toolbox
coming
coming
coming
coming