Open main menu
Home
Random
Log in
Settings
About the CreationKit Wiki
Disclaimers
the CreationKit Wiki
Search
Editing
ActorBase Script
Warning:
You are not logged in. Your IP address will be publicly visible if you make any edits. If you
log in
or
create an account
, your edits will be attributed to your username, along with other benefits.
Anti-spam check. Do
not
fill this in!
[[Category:Scripting]] [[Category:Papyrus]] [[Category:Script Objects]] [[Category:SKSE]] [[Category:SKSE Script Objects]] '''Extends:''' [[Form Script]] Script for the manipulation of actor base objects. [[Actor Script|Actor]]s are references of this. == Definition == <syntaxhighlight lang="papyrus"> ScriptName ActorBase extends Form </syntaxhighlight> == Properties == None == Global Functions == None == Member Functions == '''Class [[GetClass - ActorBase|GetClass]]()''' *Returns this actor's class. '''Int [[GetDeadCount - ActorBase|GetDeadCount]]()''' *Returns the number of actors that have this base that are dead. '''FormList [[GetGiftFilter - ActorBase|GetGiftFilter]]()''' *Returns this actor's formlist of keywords to use as a gift filter. '''Race [[GetRace - ActorBase|GetRace]]()''' *Returns this actor's race. '''Int [[GetSex - ActorBase|GetSex]]()''' *Returns this actor's sex. '''Bool [[IsEssential - ActorBase|IsEssential]]()''' *Returns if this actor is flagged as essential or not. '''Bool [[IsInvulnerable - ActorBase|IsInvulnerable]]()''' *Returns if this actor is flagged as invulnerable or not. '''Bool [[IsProtected - ActorBase|IsProtected]]()''' *Returns if this actor is flagged as protected or not. '''Bool [[IsUnique - ActorBase|IsUnique]]()''' *Returns if this actor is flagged as unique. '''[[SetEssential - ActorBase|SetEssential]](Bool ''abEssential'')''' *Flags this actor as essential or not. An actor cannot both be protected and essential. '''[[SetInvulnerable - ActorBase|SetInvulnerable]](Bool ''abInvulnerable'')''' *Flags this actor as invulnerable or not. '''[[SetProtected - ActorBase|SetProtected]](Bool ''abProtected'')''' *Flags this actor as protected or not. An actor cannot both be protected and essential. '''[[SetOutfit - ActorBase|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 [[GetCombatStyle - ActorBase|GetCombatStyle]]()''' *Returns the combat style of this actor. '''[[SetCombatStyle - ActorBase|SetCombatStyle]](CombatStyle ''cs'')''' *Sets the combat style of this actor. '''Outfit [[GetOutfit - ActorBase|GetOutfit]](Bool ''bSleepOutfit'')''' *Returns the default or sleep outfit of this actor. '''[[SetClass - ActorBase|SetClass]](Class ''c'')''' *Changes the class of this actor. '''Float [[GetHeight - ActorBase|GetHeight]]()''' *Returns the height of this actor. '''[[SetHeight - ActorBase|SetHeight]](Float ''height'')''' *Sets the height of this actor to the specified amount. '''Float [[GetWeight - ActorBase|GetWeight]]()''' *Returns the weight of this actor. '''[[SetWeight - ActorBase|SetWeight]](Float ''weight'')''' *Changes the weight of this actor. '''Int [[GetNumHeadParts - ActorBase|GetNumHeadParts]]()''' *Returns the number of head parts of this actor. '''HeadPart [[GetNthHeadPart - ActorBase|GetNthHeadPart]](Int ''slotPart'')''' *Returns the specified head part of this actor. '''[[SetNthHeadPart - ActorBase|SetNthHeadPart]](HeadPart ''headPart'', Int ''slotPart'')''' *Changes the specified head part of this actor. '''Int [[GetIndexOfHeadPartByType - ActorBase|GetIndexOfHeadPartByType]](Int ''type'')''' *Returns the Index of the specified type. '''Int [[GetNumOverlayHeadParts - ActorBase|GetNumOverlayHeadParts]]()''' *Returns the number of overlay head parts of this actor. (Note: all overlay HeadPart functions are read only they are for accessing the HeadPart list when the ActorBase's Race has been overlayed with another race) '''HeadPart [[GetNthOverlayHeadPart - ActorBase|GetNthOverlayHeadPart]](Int ''slotPart'')''' *Returns the specified overlay head part of this actor. '''Int [[GetIndexOfOverlayHeadPartByType - ActorBase|GetIndexOfOverlayHeadPartByType]](Int ''type'')''' *Returns the Index of the specified type. '''Float [[GetFaceMorph - ActorBase|GetFaceMorph]](Int ''index'')''' *Returns the specified head morph value of this actor. '''[[SetFaceMorph - ActorBase|SetFaceMorph]](Float ''value'', Int ''index'')''' *Changes the specified face morph value of this actor. '''Int [[GetFacePreset - ActorBase|GetFacePreset]](Int ''index'')''' *Returns the face preset of this actor. '''[[SetFacePreset - ActorBase|SetFacePreset]](Int ''value'', Int ''index'')''' *Changes the face preset of this actor. '''ColorForm [[GetHairColor - ActorBase|GetHairColor]]()''' *Returns the ColorForm of this actor's hair. '''[[SetHairColor - ActorBase|SetHairColor]](ColorForm ''color'')''' *Changes the ColorForm of this actor's hair. '''Int [[GetSpellCount - ActorBase|GetSpellCount]]()''' *Returns the number of spells defined in the base actor form. '''Spell [[GetNthSpell - ActorBase|GetNthSpell]](Int ''n'')''' *Returns the specified spell defined in the base actor form. '''TextureSet [[GetFaceTextureSet - ActorBase|GetFaceTextureSet]]()''' *Returns the face TextureSet of the actor. '''[[SetFaceTextureSet - ActorBase|SetFaceTextureSet]](TextureSet ''textures'')''' *Sets the face TextureSet of the actor. '''VoiceType [[GetVoiceType - ActorBase|GetVoiceType]]()''' *Returns the Actor's voicetype. '''[[SetVoiceType - ActorBase|SetVoiceType]](VoiceType ''nVoice'')''' *Sets the Actor's voicetype. '''Armor [[GetSkin - ActorBase|GetSkin]]()''' *Returns the skin of the actorbase. '''[[SetSkin - ActorBase|SetSkin]](Armor ''skin'')''' *Sets the skin of the actorbase. '''Armor [[GetSkinFar - ActorBase|GetSkinFar]]()''' *Returns the far away skin of the actorbase. '''[[SetSkinFar - ActorBase|SetSkinFar]](Armor ''skin'')''' *Sets the far away skin of the actorbase. '''ActorBase [[GetTemplate - ActorBase|GetTemplate]]()''' *Returns the root template of the actorbase. == 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. * Most SKSE "Set" functions performed on an ActorBase will not persist across gaming sessions. If you want a scripted change for a particular Actor to persist, you will need to implement the change via the [[OnPlayerLoadGame - Actor|OnPlayerLoadGame]]() event or a similar mechanism.
Summary:
Please note that all contributions to the CreationKit Wiki are considered to be released under the Creative Commons Attribution-ShareAlike (see
CreationKit:Copyrights
for details). If you do not want your writing to be edited mercilessly and redistributed at will, then do not submit it here.
You are also promising us that you wrote this yourself, or copied it from a public domain or similar free resource.
Do not submit copyrighted work without permission!
Cancel
Editing help
(opens in new window)