Difference between revisions of "ActorBase Script"

From the Fallout4 CreationKit Wiki
Jump to navigation Jump to search
imported>Plplecuyer
 
imported>Qazaaq
(Crosslinked to editor reference)
Line 2: Line 2:
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:Script Objects]]
'''Extends:''' [[Form Script]]


'''Extends:''' [[Form Script]]
'''Editor:''' [[Actor]]


Script for the manipulation of actor base objects. [[Actor Script|Actor]]s are references of this.
Script for the manipulation of actor base objects. [[Actor Script|Actor]]s are references of this.

Revision as of 16:36, 12 June 2016

Extends: Form Script

Editor: Actor

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

Definition

ScriptName ActorBase extends Form Native Hidden

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.
  • int Function GetLevel()
    • Returns this actor's level.
  • int Function GetLevelExact() native
    • Returns this actor's level unmodified by the player's level.
  • Race Function GetRace()
    • Returns this actor's race.
  • int Function GetSex()
    • Returns this actor's gender.
  • Actor Function GetUniqueActor()
    • Get the actor for this unique NPC if it currently exists.
  • 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.

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.