Background for Skyrim SE

The ActorBase Script

    The ActorBase script is a part of Skyrim SE’s Papyrus scripting ecosystem. It is included with the base game, and is extended/modified by modded sources such as Skyrim Script Extender x64 (SKSE).

    For this script, the Papyrus index knows about:

    • 45 functions


    Inheritance Tree

    No indexed scripts extend this script.

    Properties

    No properties found.

      Events

        No events found.

      Functions

      • ClassfunctionGetClass()Native

        Obtains this actor's Class.

      • intfunctionGetDeadCount()Native

        Obtains the number of actors using this actor base that are dead.

      • FormListfunctionGetGiftFilter()Native

        Obtains this actor's FormList of keywords to use as a gift filter.

      • RacefunctionGetRace()Native

        Obtains this actor's Race.

      • intfunctionGetSex()Native

        Obtains this actor's sex.

      • boolfunctionIsEssential()Native

        Obtains whether this actor base is flagged as essential or not.

      • boolfunctionIsInvulnerable()Native

        Obtains whether this actor base is flagged as invulnerable or not.

      • boolfunctionIsProtected()Native

        Obtains whether this actor base is flagged as protected or not.

      • boolfunctionIsUnique()Native

        Obtains whether this actor base is flagged as unique or not.

      • voidfunctionSetEssential(boolabEssential=true)Native

        Sets or clears this actor's essential flag. If the actor is protected and you set the essential flag, the protected flag will be removed.

      • voidfunctionSetInvulnerable(boolabInvulnerable=true)Native

        Sets or clears this actor's invulnerable flag.

      • voidfunctionSetProtected(boolabProtected=true)Native

        Sets or clears this actor's protected flag. If you set the flag, and the actor is essential, the essential flag will be cleared.

      • voidfunctionSetOutfit(OutfitakOutfit, boolabSleepOutfit=false)Native

        Change the default or sleep Outfit for this actor base.

      • Get the combat style of this actor. (This function requires SKSE)

      • voidfunctionSetCombatStyle(CombatStylecs)Native

        Set the combat style of this actor. (This function requires SKSE)

      • OutfitfunctionGetOutfit(boolbSleepOutfit=false)Native

        Get the outfit of this actor. (This function requires SKSE)

      • voidfunctionSetClass(Classc)Native

        Set the class of this actor. (This function requires SKSE)

      • floatfunctionGetHeight()Native

        Returns the body height multiplier of this actor. (This function requires SKSE)

      • voidfunctionSetHeight(floatheight)Native

        Sets the body height multiplier of this actor. (This function requires SKSE)

      • floatfunctionGetWeight()Native

        Returns the body weight of this actor. (This function requires SKSE)

      • voidfunctionSetWeight(floatweight)Native

        Sets the body weight of this actor. (This function requires SKSE)

      • intfunctionGetNumHeadParts()Native

        Returns the number of head parts of this actor. (This function requires SKSE)

      • HeadPartfunctionGetNthHeadPart(intslotPart)Native

        Returns the specified head part of this actor. (This function requires SKSE)

      • voidfunctionSetNthHeadPart(HeadPartheadPart, intslotPart)Native

        Changes the specified head part of this actor. (This function requires SKSE)

      • intfunctionGetIndexOfHeadPartByType(inttype)Native
      • intfunctionGetNumOverlayHeadParts()Native

        These functions are READ-ONLY they are for accessing the
        HeadPart list when the ActorBase's Race has been overlayed
        with another race (e.g. Vampires)

      • HeadPartfunctionGetNthOverlayHeadPart(intslotPart)Native
      • intfunctionGetIndexOfOverlayHeadPartByType(inttype)Native
      • floatfunctionGetFaceMorph(intindex)Native

        Get/Set actors face morph value by index

      • voidfunctionSetFaceMorph(floatvalue, intindex)Native
      • intfunctionGetFacePreset(intindex)Native

        Returns the face morph preset of this actor base. (This function requires SKSE)

      • voidfunctionSetFacePreset(intvalue, intindex)Native

        Changes the face preset of this actor base. (This function requires SKSE)

      • ColorFormfunctionGetHairColor()Native

        Returns the ColorForm of this actors hair. (This function requires SKSE)

      • voidfunctionSetHairColor(ColorFormcolor)Native

        Sets the ColorForm of this actors hair. (This function requires SKSE)

      • intfunctionGetSpellCount()Native

        Returns the number of spells defined in the base actor form. (This function requires SKSE)

      • SpellfunctionGetNthSpell(intn)Native

        Returns the specified spell defined in the base actor form. (This function requires SKSE)

      • returns the face textureset of the actor (Player Only?)

      • voidfunctionSetFaceTextureSet(TextureSettextures)Native
      • VoiceTypefunctionGetVoiceType()Native

        Gets/sets the Actor's voicetype

      • voidfunctionSetVoiceType(VoiceTypenVoice)Native

        Changes the voice of myActor to newvoice.

        This change alone is not persistent when saving the game. You must store the new voicetype in a formlist and recover it from there with onplayerloadgame when loading the save game. ( Remember that this works only on the second save game load after introducing a new player alias ! )

        Voicetype property newvoice auto ;;;;;;; ( fill in script properties tab )

        Formlist property voicelist auto ;;;;;; ( dito ) must have been created empty in CK

                                        ;;;;;; every actor must have its own list
        

        Actor property myactor auto ;;;;; ( filled elsewhere )

        Function somefunc()

              Myactor.getactorbase().setvoicetype(newvoice)
        
              Voicelist.revert()  ;;;; must be empty for next statement
        
              Voicelist.addform(newvoice) ;;;; remember voicetype for this actor in entry 0
        

        Endfunction

        In Script on player alias:

        Event onplayerloadgame()

            Voicetype vt = voicelist.getat(0) as voicetype   ;;; only one entry !
        
            Myactor.getactorbase().setvoicetype(vt)  ;;; remembered for new save load
        

        Endevent

      • ArmorfunctionGetSkin()Native

        Gets/sets the skin of the actorbase

      • voidfunctionSetSkin(Armorskin)Native
      • ArmorfunctionGetSkinFar()Native

        Gets/sets the far away skin of the actorbase

      • voidfunctionSetSkinFar(Armorskin)Native
      • ActorBasefunctionGetTemplate()Native

        Gets the root template of the ActorBase

      Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.