Editing Actor Script

'''Extends:''' [[ObjectReference Script]]
<BR/>
'''Editor:''' [[Actor]]

Script for the manipulation of actor instances.

== Definition ==
<source lang="papyrus">
ScriptName Actor extends ObjectReference Native Hidden
</source>

== Properties ==
*[[SetCriticalStage - Actor|Critical Stages]]: Set of read-only properties to essentially make a fake enum for ''Critical Stages''.
**int CritStage_None: 0
***Sets the critical stage to none.
**int CritStage_GooStart: 1
***Sets the critical stage to goo start.
**int CritStage_GooEnd: 2
***Sets the critical stage to goo end.
**int CritStage_DisintegrateStart: 3
***Sets the critical stage to disintegrate start.
**int CritStage_DisintegrateEnd: 4
***Sets the critical stage to disintegrate end.
**int CritStage_FreezeStart: 5
***Sets the critical stage to freeze start.
**int CritStage_FreezeEnd: 6
***Sets the critical stage to freeze end.

== F4SE Structs ==
*Struct [[WornItem Struct - Actor|WornItem]]
**A structure that holds information about an actors [[Biped Slots|Biped Slot]].

== Global Functions ==
None

== Member Functions ==
*Function [[AddPerk - Actor|AddPerk]](Perk akPerk, bool abNotify)
**Adds the specified perk to this actor.
*bool Function [[AddSpell - Actor|AddSpell]](Spell akSpell, bool abVerbose)
**Adds the specified spell to this actor.
*Function [[AddToFaction - Actor|AddToFaction]](Faction akFaction)
**Adds the actor to the specified faction at rank 0. If the Actor is already in the given faction, this function does nothing.
*Function [[AllowBleedoutDialogue - Actor|AllowBleedoutDialogue]](bool abCanTalk)
**Flags this actor as able to speak to the player when he is in bleed out and is essential down
*Function [[AllowCompanion - Actor|AllowCompanion]](bool MakeCompanionIfNoneCurrently, bool ForceCompanion)
**Tells this actor it is now allowed to be a companion
*Function [[AllowPCDialogue - Actor|AllowPCDialogue]](bool abTalk)
**Enables or disables the player's ability to talk to this actor.
*Function [[AttachAshPile - Actor|AttachAshPile]](Form akAshPileBase)
**Attaches an "ash pile" to this actor using the passed-in form (or leveled item list) as a base.
*Function [[AttemptAnimationSetSwitch - Actor|AttemptAnimationSetSwitch]]()
**Changes the MT and Weapon character subgraphs if there are different ones to load based on data changes (usually added keywords)
*bool Function [[CanFlyHere - Actor|CanFlyHere]]()
**Can this actor fly here?
*bool Function [[ChangeAnimArchetype - Actor|ChangeAnimArchetype]](keyword apKeyword)
**Changes this actor's anim archetype
*Function [[ChangeAnimFaceArchetype - Actor|ChangeAnimFaceArchetype]](keyword apKeyword)
**Adds the specified AnimFaceArchetype keyword to this actor.
*bool Function [[ChangeAnimFlavor - Actor|ChangeAnimFlavor]](keyword apKeyword)
**Changes this actor's anim flavor
*Function [[ChangeHeadPart - Actor|ChangeHeadPart]](HeadPart apHeadPart, bool abRemovePart, bool abRemoveExtraParts)
**Change or add this HeadPart to the actor
*Function [[ClearArrested - Actor|ClearArrested]]()
**Clears this actor's arrested state.
*Function [[ClearExpressionOverride - Actor|ClearExpressionOverride]]()
**Clears out any expression override that has been set on this actor.
*Function [[ClearExtraArrows - Actor|ClearExtraArrows]]()
**Clears any arrow 3d on the actor.
*Function [[ClearForcedLandingMarker - Actor|ClearForcedLandingMarker]]()
**Clears any forced landing marker on this actor.
*Function [[ClearLookAt - Actor|ClearLookAt]]()
**Clears this actor's script-forced look at target.
*Function [[DisallowCompanion - Actor|DisallowCompanion]](bool SuppressDismissMessage)
**Tell the actor it is no longer allowed to be a companion.
*Function [[Dismember - Actor|Dismember]](string asBodyPart, bool abForceExplode, bool abForceDismember, bool abForceBloodyMess)
**Dismember a limb from this actor.
*Function [[Dismount - Actor|Dismount]]()
**Forces the actor to dismount.
*Function [[DispelAllSpells - Actor|DispelAllSpells]]()
**Dispel all spell from this actor
*bool Function [[DispelSpell - Actor|DispelSpell]](Spell akSpell)
**Dispel a spell from this actor
*Function [[DoCombatSpellApply - Actor|DoCombatSpellApply]](Spell akSpell, ObjectReference akTarget)
**Apply a spell to a target in combat
*Function [[DogDropItems - Actor|DogDropItems]]()
**Tells the dog to drop the items they're carrying
*Function [[DogPlaceInMouth - Actor|DogPlaceInMouth]](Form akItem)
**Attempts to place the item in this dog's mouth.
*Function [[DrawWeapon - Actor|DrawWeapon]]() native
**Forces this actor to draw his weapon.
*Function [[EnableAI - Actor|EnableAI]](bool abEnable, bool abPauseVoice)
**Enables or disables this actor's AI, pausing their voice mid-line if desired.
*Function [[EndDeferredKill - Actor|EndDeferredKill]]()
**Ends an actor's Deferred Kill state. Called after [[StartDeferredKill - Actor|StartDeferredKill]]
*Function [[EquipItem - Actor|EquipItem]](Form akItem, bool abPreventRemoval, bool abSlient)
**Equips the specified item on this actor.
*Function [[EquipSpell - Actor|EquipSpell]](Spell akSpell, int aiSource)
**Forces this actor to equip this spell, in the specified source.
*Function [[EvaluatePackage - Actor|EvaluatePackage]](bool abResetAI)
**Forces the AI to re-evaluate its package stack.
*Function [[FollowerFollow - Actor|FollowerFollow]]()
**Tells this follower to follow the player.
*Function [[FollowerWait - Actor|FollowerWait]]()
**Tells this follower to stay.
*Function [[FollowerSetDistanceNear - Actor|FollowerSetDistanceNear]]()
**Sets the follower's follow distance to near.
*Function [[FollowerSetDistanceMedium - Actor|FollowerSetDistanceMedium]]()
**Sets the follower's follow distance to medium.
*Function [[FollowerSetDistanceFar - Actor|FollowerSetDistanceFar]]()
**Sets the follower's follow distance to far.
*ActorBase Function [[GetActorBase - Actor|GetActorBase]]()
**Gets the ActorBase of the actor
*Actor[] Function [[GetAllCombatTargets - Actor|GetAllCombatTargets]]()
**Get all actors that are combat targets of this one.
*int Function [[GetBribeAmount - Actor|GetBribeAmount]]()
**Returns the amount of gold required to bribe this actor.
*Faction Function [[GetCrimeFaction - Actor|GetCrimeFaction]]()
**Obtains this actor's crime faction.
*int Function [[GetCombatState - Actor|GetCombatState]]()
**Obtains this actor's current combat state.
*Actor Function [[GetCombatTarget - Actor|GetCombatTarget]]()
**Obtains this actor's current combat target.
*Package Function [[GetCurrentPackage - Actor|GetCurrentPackage]]()
**Obtains the current package this actor's AI is running.
*Actor Function [[GetDialogueTarget - Actor|GetDialogueTarget]]()
**Obtains the actor's current dialogue target
*int Function [[GetEquippedItemType - Actor|GetEquippedItemType]](int aiEquipIndex)
**Obtains the type of item equipped in the specified equip index.
*Armor Function [[GetEquippedShield - Actor|GetEquippedShield]]()
**Obtains the currently equipped shield on this actor.
*Spell Function [[GetEquippedSpell - Actor|GetEquippedSpell]](int aiSource)
**Obtains the currently equipped spell in the specified source on this actor.
*Weapon Function [[GetEquippedWeapon - Actor|GetEquippedWeapon]](int aiEquipIndex)
**Obtains the currently equipped weapon on this actor.
*int Function [[GetFactionRank - Actor|GetFactionRank]](Faction akFaction)
**Retrieves this actor's rank in the specified faction.
*int Function [[GetFactionReaction - Actor|GetFactionReaction]](Actor akOther)
**Obtains this actor's faction-based reaction to the other actor.
*int Function [[GetFlyingState - Actor|GetFlyingState]]()
**Obtains this actor's current flying state.
*ObjectReference Function [[GetForcedLandingMarker - Actor|GetForcedLandingMarker]]()
**Obtains the landing marker the actor is forced to land at (if any).
*int Function [[GetGoldAmount - Actor|GetGoldAmount]]()
**Gets the amount of gold this actor has on his person.
*int Function [[GetHighestRelationshipRank - Actor|GetHighestRelationshipRank]]()
**Gets this actor's highest relationship rank.
*Actor Function [[GetKiller - Actor|GetKiller]]()
**Gets this actor's killer. Returns None if this actor isn't dead.
*int Function [[GetLevel - Actor|GetLevel]]() native
**Gets this actor's current level.
*ActorBase Function [[GetLeveledActorBase - Actor|GetLeveledActorBase]]()
**Returns a leveled actor's "temporary" base object.
*float Function [[GetLightLevel - Actor|GetLightLevel]]()
**Returns this actor's current light level
*int Function [[GetLowestRelationshipRank - Actor|GetLowestRelationshipRank]]()
**Gets this actor's lowest relationship rank.
*bool Function [[GetNoBleedoutRecovery - Actor|GetNoBleedoutRecovery]]()
**Gets whether this actor can recover from bleedout or not.
*bool Function [[GetPlayerControls - Actor|GetPlayerControls]]() native
**Queries whether this actor receives player input
*Race Function [[GetRace - Actor|GetRace]]()
**Returns this actor's race.
*int Function [[GetRelationshipRank - Actor|GetRelationshipRank]](Actor akOther)
**Retrieves the relationship rank between this actor and another.
*int Function [[GetSitState - Actor|GetSitState]]()
**Obtains this actor's sit state.
*int Function [[GetSleepState - Actor|GetSleepState]]()
**Obtains this actor's sleep state.
*bool Function [[HasAssociation - Actor|HasAssociation]](AssociationType akAssociation, Actor akOther)
**Returns whether this actor has the specified association with the other actor.
*bool Function [[HasDetectionLOS - Actor|HasDetectionLOS]](ObjectReference akOther)
**Checks to see if this actor has detection-based line-of-sight to another. (Only the player can do a LOS check to a non-actor)
*bool Function [[HasFamilyRelationship - Actor|HasFamilyRelationship]](Actor akOther)
**Returns whether this actor has a family relationship with the other actor.
*bool Function [[HasMagicEffect - Actor|HasMagicEffect]](MagicEffect akEffect)
**Checks to see if this actor is currently being affected by the given Magic Effect
*bool Function [[HasMagicEffectWithKeyword - Actor|HasMagicEffectWithKeyword]](Keyword akKeyword)
**Checks to see if this actor is currently being affected by a Magic Effect with the given Keyword
*bool Function [[HasParentRelationship - Actor|HasParentRelationship]](Actor akOther)
**Returns whether this actor has a parent relationship with the other actor.
*bool Function [[HasPerk - Actor|HasPerk]](Perk akPerk)
**Checks to see if this actor has the given Perk
*bool Function [[HasSpell - Actor|HasSpell]](Form akForm)
**Checks to see if this actor has the given Spell or Shout
*bool Function [[IsAIEnabled - Actor|IsAIEnabled]]()
**Returns whether this actor's AI is currently enabled
*bool Function [[IsAlarmed - Actor|IsAlarmed]]()
**Obtains whether this actor is alarmed or not.
*bool Function [[IsAlerted - Actor|IsAlerted]]()
**Returns if this actor is alerted or not.
*bool Function [[IsAllowedToFly - Actor|IsAllowedToFly]]()
**Is this actor allowed to fly?
*bool Function [[IsArrested - Actor|IsArrested]]()
**Returns whether this actor is currently arrested or not.
*bool Function [[IsArrestingTarget - Actor|IsArrestingTarget]]()
**Is this actor currently arresting his target? Only valid on alerted guards.
*bool Function [[IsBeingRidden - Actor|IsBeingRidden]]()
**Is this actor being ridden? 
*bool Function [[IsBeingRiddenBy - Actor|IsBeingRiddenBy]](Actor akActor)
**Is this actor being ridden by a particular actor?
*bool Function [[IsBleedingOut - Actor|IsBleedingOut]]()
**Is this actor currently bleeding out?
*bool Function [[IsBribed - Actor|IsBribed]]()
**Gets if this actor has been bribe by the player.
*bool Function [[IsChild - Actor|IsChild]]()
**Is this actor a child?
*bool Function [[IsCommandedActor - Actor|IsCommandedActor]]()
**Is this actor commanded by another?
*bool Function [[IsDead - Actor|IsDead]]()
**Obtains whether this actor is dead or not.
*bool Function [[IsDetectedBy - Actor|IsDetectedBy]](Actor akOther)
**Is this actor detected by the other one?
*bool Function [[IsDismembered - Actor|IsDismembered]](string asBodyPart)
**Check to see if a specific limb, or any limb, has been dismembered.
*bool Function [[IsDoingFavor - Actor|IsDoingFavor]]()
**Is this actor currently flagged as doing a favor for the player?
*bool Function [[IsEquipped - Actor|IsEquipped]](Form akItem)
**Is the specified object equipped on this actor?
*bool Function [[IsEssential - Actor|IsEssential]]()
**Is this actor essential?
*bool Function [[IsFlying - Actor|IsFlying]]()
**Is this actor currently flying?
*bool Function [[IsGhost - Actor|IsGhost]]()
**Is this actor flagged as a ghost?
*bool Function [[IsGuard - Actor|IsGuard]]()
**Obtains whether this actor is a guard or not.
*bool Function [[IsHostileToActor - Actor|IsHostileToActor]](Actor akActor)
**Is this actor hostile to another actor?
*bool Function [[IsInCombat - Actor|IsInCombat]]()
**Obtains whether this actor is in combat or not.
*bool Function [[IsInFaction - Actor|IsInFaction]](Faction akFaction)
**Returns whether this actor is in the specified faction.
*bool Function [[IsInIronSights - Actor|IsInIronSights]]()
**Returns whether this actor is currently in iron sights.
*bool Function [[IsInKillMove - Actor|IsInKillMove]]()
**Returns whether this actor is in a kill move or not.
*bool Function [[IsInPowerArmor - Actor|IsInPowerArmor]]()
**Returns true if the actor is in Power Armor.
*bool Function [[IsInScene - Actor | IsInScene]]()
**Returns whether this actor is in a scene.
*bool Function [[IsIntimidated - Actor|IsIntimidated]]()
**Gets if this actor has been intimidated by the player.
*bool Function [[IsOnMount - Actor|IsOnMount]]()
**Is the actor on a mount?
*bool Function [[IsOverEncumbered - Actor|IsOverEncumbered]]()
**Is this actor over encumbered?
*bool Function [[IsOwner - Actor|IsOwner]](ObjectReference akObject)
**Is this actor the owner of the specified reference?
*bool Function [[IsPlayersLastRiddenHorse - Actor|IsPlayersLastRiddenHorse]]()
**Returns whether this actor is the horse the player last rode.
*bool Function [[IsPlayerTeammate - Actor|IsPlayerTeammate]]()
**Returns whether this actor is currently a teammate of the player.
*bool Function [[IsRunning - Actor|IsRunning]]()
**Returns whether this actor is current running.
*bool Function [[IsSeatOccupied - Actor|IsSeatOccupied]](Keyword apKeyword)
**Is this actor being ridden by an actor sitting in a particular seat?
*bool Function [[IsSneaking - Actor|IsSneaking]]()
**Is this actor currently sneaking?
*bool Function [[IsSprinting - Actor|IsSprinting]]()
**Is this actor currently sprinting?
*bool Function [[IsTalking - Actor | IsTalking]]()
**Is this actor talking
*bool Function [[IsTrespassing - Actor|IsTrespassing]]()
**Returns whether this actor is currently trespassing or not.
*bool Function [[IsUnconscious - Actor|IsUnconscious]]()
**Is this actor currently unconscious?
*bool Function [[IsWeaponDrawn - Actor|IsWeaponDrawn]]()
**Does this actor have his equipped weapon and/or magic spell drawn?
*Function [[Kill - Actor|Kill]](Actor akKiller)
**Kills this actor with the specified actor as the guilty party.
*Function [[KillEssential - Actor|KillEssential]](Actor akKiller)
**Kills this actor, even if he is essential.
*Function [[KillSilent - Actor|KillSilent]](Actor akKiller)
**Kills this actor without a kill event with the killer being the guilty party
*Function [[MakePlayerFriend - Actor|MakePlayerFriend]]()
**Makes the actor a friend of the player.
*Function [[MarkItemAsFavorite - Actor|MarkItemAsFavorite]](Form akItem, int aiSlot)
**Marks the item as a favorite for the actor.
*Function [[ModFactionRank - Actor|ModFactionRank]](Faction akFaction, int aiMod)
**Modifies this actor's rank in the specified faction.
*Function [[MoveToPackageLocation - Actor|MoveToPackageLocation]]()
**Pops this actor to the initial location for its current package.
*Function [[OpenInventory - Actor|OpenInventory]](bool abForceOpen)
**Opens this actor's inventory as if you were pick-pocketing them.
*bool Function [[PathToReference - Actor|PathToReference]](ObjectReference aTarget, float afWalkRunPercent)
**Makes the actor path to the target reference at the speed given by afWalkRunercent.
*bool Function [[PlayIdle - Actor|PlayIdle]](Idle akIdle)
**Plays the passed idle on this actor.
*bool Function [[PlayIdleAction - Actor|PlayIdleAction]](Action aAction, ObjectReference aTarget)
**Attempts to find and play an idle on this actor using the provided Action root.
*bool Function [[PlayIdleWithTarget - Actor|PlayIdleWithTarget]](Idle akIdle, ObjectReference akTarget)
**Plays the passed idle on this actor, overriding the actor's current target with the one given.
*Function [[PlaySubGraphAnimation - Actor|PlaySubGraphAnimation]](string asEventName)
**Sends the event passed to the actor's sub graphs.
*Function [[RemoveFromFaction - Actor|RemoveFromFaction]](Faction akFaction)
**Removes this actor from the specified faction.
*Function [[RemoveFromAllFactions - Actor|RemoveFromAllFactions]]()
**Removes this actor from all factions they are associated with.
*Function [[RemovePerk - Actor|RemovePerk]](Perk akPerk)
**Removes the specified perk from this actor.
*bool Function [[RemoveSpell - Actor|RemoveSpell]](Spell akSpell)
**Removes the specified spell from this actor.
*Function [[ResetHealthAndLimbs - Actor|ResetHealthAndLimbs]]()
**Resets this actor's health and limb state.
*Function [[Resurrect - Actor|Resurrect]]()
**Resurrects this actor.
*Function [[SendAssaultAlarm - Actor|SendAssaultAlarm]]()
**Has this actor behave as if they were assaulted.
*Function [[SendTrespassAlarm - Actor|SendTrespassAlarm]](Actor akCriminal)
**Has this actor behave as if they caught the criminal trespassing
*Function [[SetAlert - Actor|SetAlert]](bool abAlerted)
**Flags this actor as currently alerted (or clears it)
*Function [[SetAllowFlying - Actor|SetAllowFlying]](bool abAllowed, bool abAllowCrash, bool abAllowSearch)
**Flags this actor as whether they are allowed to fly or not (lands them if they are flying and not allowed to)
*Function [[SetAlpha - Actor|SetAlpha]](float afTargetAlpha, bool abFade)
**Sets this actor's alpha - optionally fading to that value rather then popping.
*Function [[SetAnimArchetypeConfident - Actor|SetAnimArchetypeConfident]]()
**Set the animation archetype to confident
*Function [[SetAnimArchetypeDepressed - Actor|SetAnimArchetypeDepressed]]()
**Set the animation archetype to depressed
*Function [[SetAnimArchetypeElderly - Actor|SetAnimArchetypeElderly]]()
**Set the animation archetype to elderly
*Function [[SetAnimArchetypeFriendly - Actor|SetAnimArchetypeFriendly]]()
**Set the animation archetype to friendly
*Function [[SetAnimArchetypeIrritated - Actor|SetAnimArchetypeIrritated]]()
**Set the animation archetype to irritated
*Function [[SetAnimArchetypeNeutral - Actor|SetAnimArchetypeNeutral]]()
**Set the animation archetype to neutral
*Function [[SetAnimArchetypeNervous - Actor|SetAnimArchetypeNervous]]()
**Set the animation archetype to nervous
*Function [[SetAttackActorOnSight - Actor|SetAttackActorOnSight]](bool abAttackOnSight)
**Flags this actor to be attacked by all actors when detected.
*Function [[SetAvailableToBeCompanion - Actor|SetAvailableToBeCompanion]]()
**Flags this actor as available to be a companion.
*Function [[SetAvoidPlayer - Actor|SetAvoidPlayer]](bool abAvoid)
**Tells actors whether they need to avoid the player when pathing.
*Function [[SetBribed - Actor|SetBribed]](bool abBribe)
**Sets if this actor is being bribed by the player.
*Function [[SetCombatStyle - Actor|SetCombatStyle]](CombatStyle akCombatStyle)
**Sets the combat style that the actor uses
*Function [[SetCommandState - Actor|SetCommandState]](bool abStartCommandMode)
**Sets/Unsets the actor in command mode so that we can order them around.
*Function [[SetCompanion - Actor|SetCompanion]](bool SetCompanion, bool FillCompanionAlias)
**Sets/clears this actor as a companion.
*Function [[SetCanDoCommand - Actor|SetCanDoCommand]](bool abCanDoCommand)
**Sets if this actor is can be commanded by the player.
*Function [[SetCrimeFaction - Actor|SetCrimeFaction]](Faction akFaction)
**Sets the faction that this actor reports crimes to.
*Function [[SetCriticalStage - Actor|SetCriticalStage]](int aiStage)
**Sets this actor's current critical stage (applying any related effects)
*Function [[SetDogAnimArchetypeAgitated - Actor|SetDogAnimArchetypeAgitated]]()
**Sets the animation archetype to dog agitated.
*Function [[SetDogAnimArchetypeAlert - Actor|SetDogAnimArchetypeAlert]]()
**Sets the animation archetype to dog alert.
*Function [[SetDogAnimArchetypeNeutral - Actor|SetDogAnimArchetypeNeutral]]()
**Sets the animation archetype to dog neutral.
*Function [[SetDogAnimArchetypePlayful - Actor|SetDogAnimArchetypePlayful]]()
**Sets the animation archetype to dog playful.
*Function [[SetDoingFavor - Actor|SetDoingFavor]](bool abDoingFavor, bool abWorkShopMode)
**Flags this actor as doing a favor for the player.
*Function [[SetEyeTexture - Actor|SetEyeTexture]](TextureSet akNewTexture)
**forces the eye texture for this actor to the given texture set
*Function [[SetEssential - Actor|SetEssential]](bool abEssential)
**Flags this actor as essential or not. An actor cannot both be protected and essential.
*Function [[SetFactionRank - Actor|SetFactionRank]](Faction akFaction, int aiRank)
**Sets this actor's rank in the specified faction, adding it to the faction if necessary.
*Function [[SetForcedLandingMarker - Actor|SetForcedLandingMarker]](ObjectReference aMarker)
**Forces the landing marker for this actor to the passed-in one.
*Function [[SetGhost - Actor|SetGhost]](bool abIsGhost)
**Sets this actor as a ghost or not.
*Function [[SetHasCharGenSkeleton - Actor|SetHasCharGenSkeleton]](bool abCharGen)
**Sets whether or not this character should have a full skeleton for char gen editing.
*Function [[SetHeadTracking - Actor|SetHeadTracking]](bool abEnable)
**Enables or disables this actor's head tracking.
*Function [[SetIntimidated - Actor|SetIntimidated]](bool abIntimidate)
**Sets if this actor is being intimidated by the player.
*Function [[SetLookAt - Actor|SetLookAt]](ObjectReference akTarget, bool abPathingLookAt)
**Sets this actor's look at target, optionally using it for pathing as well.
*Function [[SetNoBleedoutRecovery - Actor|SetNoBleedoutRecovery]](bool abAllowed)
**Sets or clears the "no bleedout recovery" flag on this actor.
*Function [[SetNotShowOnStealthMeter - Actor|SetNotShowOnStealthMeter]](bool abNotShow)
**Sets this actor to not effect the detection level on the stealth meter if he is not hostile to the player
*Function [[SetOutfit - Actor|SetOutfit]](Outfit akOutfit,bool abSleepOutfit)
**Change the default or sleep outfit and queue the models to be worn now.
*Function [[SetOverrideVoiceType - Actor|SetOverrideVoiceType]](VoiceType akVoiceType)
**Override the voice type for this actor (or clear the override)
*Function [[SetPlayerControls - Actor|SetPlayerControls]](bool abControls)
**Set/reset whether player input being sent to the actor.
*Function [[SetPlayerResistingArrest - Actor|SetPlayerResistingArrest]]()
**Flags the player as resisting arrest from this actor's faction.
*Function [[SetPlayerTeammate - Actor|SetPlayerTeammate]](bool abTeammate, bool abCanDoFavor, bool abGivePlayerXP)
**Sets (or clears) this actor as a teammate of the player and if the teammate can do favors.
*Function [[SetProtected - Actor|SetProtected]](bool abProtected)
**Flags this actor as protected or not. An actor cannot both be protected and essential.
*Function [[SetRace - Actor|SetRace]](Race akRace)
**Sets the actor's race
*Function [[SetRelationshipRank - Actor|SetRelationshipRank]](Actor akOther, int aiRank)
**Sets the relationship rank between this actor and another.
*bool Function [[SetRestrained - Actor|SetRestrained]](bool abRestrained)
**Flags this actor as restrained or not.
*Function [[SetSubGraphFloatVariable - Actor|SetSubGraphFloatVariable]](string asVariableName, float afValue) native
**Set a variable on all of an actor's subgraphs
*bool Function [[SetUnconscious - Actor|SetUnconscious]](bool abIsUnconscious)
**Sets this actor as unconscious or not.
*Function [[SetVehicle - Actor|SetVehicle]](Actor akVehicle)
**Attaches or detaches this actor from a vehicle.
*Function [[ShowBarterMenu - Actor|ShowBarterMenu]]()
**Shows the barter menu for this actor.
*bool Function [[SnapIntoInteraction - Actor|SnapIntoInteraction]](ObjectReference akTarget)
**Near-instantly snaps an actor into/onto a furniture/mount
*Function [[StartCannibal - Actor|StartCannibal]](Actor akTarget)
**Has the actor feed on a dead actor.
*Function [[StartCombat - Actor|StartCombat]](Actor akTarget, bool abPreferredTarget)
**Attempts to initiate combat with the other actor.
*Function [[StartDeferredKill - Actor|StartDeferredKill]]() native
**Puts the actor into a Deferred Kill state. End by calling [[EndDeferredKill - Actor|EndDeferredKill]]
*Function [[StartFrenzyAttack - Actor|StartFrenzyAttack]](float aChance, float aInterval)
**Puts the actor into Frenzy attack mode using a random target selector
*Function [[StartSneaking - Actor|StartSneaking]]()
**Forces this actor to start sneaking.
*Function [[StartVampireFeed - Actor|StartVampireFeed]](Actor akTarget)
**Has the actor vampire feed on a sleeping actor
*Function [[StopCombat - Actor|StopCombat]]()
**Removes this actor from combat.
*Function [[StopCombatAlarm - Actor|StopCombatAlarm]]()
**Stops all combat and alarms against this actor.
*Function [[SwitchToPowerArmor - Actor|SwitchToPowerArmor]](ObjectReference aArmorFurniture)
**(near) Instantly snaps the actor into a suit of power armor.
*bool Function [[TrapSoul - Actor|TrapSoul]](Actor akTarget)
**Attempts to soul trap the target actor - and returns if it succeeded or not.
*Function [[UnequipAll - Actor|UnequipAll]]()
**Unequips all items from this actor.
*Function [[UnequipItem - Actor|UnequipItem]](Form akItem, bool abPreventEquip, bool abSilent)
**Unequips an item from this actor.
*Function [[UnequipItemSlot - Actor|UnequipItemSlot]](int aiSlot)
**Unequips whatever armor the actor has in the specified slot.
*Function [[UnequipSpell - Actor|UnequipSpell]](Spell akSpell, int aiSource)
**Unequips the specified spell from the specified source on this actor.
*Function [[UnlockOwnedDoorsInCell - Actor|UnlockOwnedDoorsInCell]]()
**Has this actor unlock any doors he owns in the cell he's currently in (if it is an interior).
*bool Function [[WillIntimidateSucceed - Actor|WillIntimidateSucceed]]()
**Returns whether an intimidation attempt by the player against this actor will succeed or not.
*bool Function [[WornHasKeyword - Actor|WornHasKeyword]](Keyword akKeyword)
**Returns whether or not this actor is wearing anything with the specified keyword.
*bool Function [[WouldBeStealing - Actor|WouldBeStealing]](ObjectReference akTarget)
**Returns if the actor would be stealing the object if they took it
*int Function [[WouldRefuseCommand - Actor|WouldRefuseCommand]](ObjectReference akTarget)
**Returns if the actor would refuse a command from the player regarding the target object, and why.

== F4SE Member Functions ==
*ObjectReference Function [[GetFurnitureReference - Actor|GetFurnitureReference]]()
**Returns the furniture reference for this actor.
*[[Owner Struct - InstanceData|Owner]] Function [[GetInstanceOwner - Actor|GetInstanceOwner]](int slotIndex)
**Obtains [[Owner Struct - InstanceData|Owner]] struct for the item in the given slot on an actor, if it exists.
*[[WornItem Struct - Actor|WornItem]] Function [[GetWornItem - Actor|GetWornItem]](int slotIndex, bool firstPerson)
**Obtains [[WornItem Struct - Actor|WornItem]] information about an actors [[Biped Slots|Biped Slot]].
*[[Object Mod]] Function [[GetWornItemMods - Actor|GetWornItemMods]](int slotIndex)
**Obtains all the [[Object Mod|Object Mods]] for an item at a particular [[Biped Slots|Biped Slot]].
*Function [[QueueUpdate - Actor|QueueUpdate]](bool bFacegen, int flags)
**Updates the entire actor from the ground-up.

== Events ==
*Event [[OnCombatStateChanged - Actor|OnCombatStateChanged]](Actor akTarget, int aeCombatState)
**Sent when this actor's combat state changes.
*Event [[OnCommandModeCompleteCommand - Actor|OnCommandModeCompleteCommand]](int aeCommandType, ObjectReference akTarget)
**Event called when a command is completed by this actor
*Event [[OnCommandModeEnter - Actor|OnCommandModeEnter]]()
**Event called when the player enters command mode with this actor as the commanded actor.
*Event [[OnCommandModeExit - Actor|OnCommandModeExit]]()
**Event called when the player exits command mode with this actor as the commanded actor.
*Event [[OnCommandModeGiveCommand - Actor|OnCommandModeGiveCommand]](int aeCommandType)
**Event called when the player gives a command to this actor via command mode.
*Event [[OnCompanionDismiss - Actor|OnCompanionDismiss]]()
**Event received when this companion is dismissed.
*Event [[OnConsciousnessStateChanged - Actor|OnConsciousnessStateChanged]](bool abUnconscious)
**Event called when the consciousness state of this actor changes.
*Event [[OnCripple - Actor|OnCripple]](String asLimbName, bool abCrippled)
**Event received when this actor has a limb that goes from either healthy to crippled or crippled to healthy.
*Event [[OnDeath - Actor|OnDeath]](Actor akKiller)
**Event received when this actor dies.
*Event [[OnDeferredKill - Actor|OnDeferredKill]](Actor akKiller)
**Event received when an actor set to do deferred kills is killed (may be called more than once on a dying actor)
*Event [[OnDifficultyChanged - Actor|OnDifficultyChanged]](int aOldDifficulty, int aNewDifficulty)
**Event received when the game's difficulty changes.
*Event [[OnDying - Actor|OnDying]](Actor akKiller)
**Event called when the actor begins dying.
*Event [[OnEnterBleedout - Actor|OnEnterBleedout]]()
**Event received when this actor enters bleedout.
*Event [[OnEnterSneaking - Actor|OnEnterSneaking]]()
**Event received when this actor enters sneaking.
*Event [[OnEscortWaitStart - Actor|OnEscortWaitStart]]()
**Event called when this actor is running an Escort procedure, and starts waiting for the escorted actor to catch up.
*Event [[OnEscortWaitStop - Actor|OnEscortWaitStop]]()
**Event called when this actor is running an Escort procedure, and stops waiting because they have caught up.
*Event [[OnGetUp - Actor|OnGetUp]](ObjectReference akFurniture)
**Event received when this actor gets up off the specified furniture.
*Event [[OnItemEquipped - Actor|OnItemEquipped]](Form akBaseObject, ObjectReference akReference)
**Event received when this actor equips an object.
*Event [[OnItemUnequipped - Actor|OnItemUnequipped]](Form akBaseObject, ObjectReference akReference)
**Event received when this actor unequips an object.
*Event [[OnKill - Actor|OnKill]](Actor akVictim)
**Event received when the actor kills another.
*Event [[OnLocationChange - Actor|OnLocationChange]](Location akOldLoc, Location akNewLoc)
**Event received when the actor moves from one location to another.
*Event [[OnPackageChange - Actor|OnPackageChange]](Package akOldPackage)
**Event received when this actor changes away from a package.
*Event [[OnPackageEnd - Actor|OnPackageEnd]](Package akOldPackage)
**Event received when this actor ends a package.
*Event [[OnPackageStart - Actor|OnPackageStart]](Package akNewPackage)
**Event received when this actor starts running a new package.
*Event [[OnPartialCripple - Actor|OnPartialCripple]](ActorValue akActorValue, bool abCrippled)
**Event called when this actor has a limb that goes from healthy to "partially crippled" or "partially crippled" to healthy.
*Event [[OnPickpocketFailed - Actor|OnPickpocketFailed]]()
**Event called when the player fails to pickpocket this actor.
*Event [[OnPlayerCreateRobot - Actor|OnPlayerCreateRobot]](Actor akNewRobot)
**Event sent to the player when they create a robot.
*Event [[OnPlayerEnterVertibird - Actor|OnPlayerEnterVertibird]](ObjectReference akVertibird)
**Event sent to the player when he enters a vertibird
*Event [[OnPlayerFallLongDistance - Actor|OnPlayerFallLongDistance]](float afDamage)
**Event received when the player takes falling damage.
*Event [[OnPlayerFireWeapon - Actor|OnPlayerFireWeapon]](Form akBaseObject)
**Event sent to the player when he fires weapon out of combat.
*Event [[OnPlayerHealTeammate - Actor|OnPlayerHealTeammate]](Actor akTeammate)
**Event received when Player heals a teammate
*Event [[OnPlayerLoadGame - Actor|OnPlayerLoadGame]]()
**Event received when this actor is the player and the player has just loaded a save game.
*Event [[OnPlayerModArmorWeapon - Actor|OnPlayerModArmorWeapon]](Form akBaseObject, ObjectMod akModBaseObject)
**Event received when the player modifies an armor or weapon.
*Event [[OnPlayerModRobot - Actor|OnPlayerModRobot]](Actor akNewRobot, ObjectMod akModBaseObject)
**Event received when the player modifies a robot.
*Event [[OnPlayerSwimming - Actor|OnPlayerSwimming]]()
**Event sent to the player when he starts swimming.
*Event [[OnPlayerUseWorkBench - Actor|OnPlayerUseWorkBench]](ObjectReference akWorkBench)
**Event sent to the player when he uses a workbench
*Event [[OnRaceSwitchComplete - Actor|OnRaceSwitchComplete]]()
**Event received when this actor finishes switching races.
*Event [[OnSit - Actor|OnSit]](ObjectReference akFurniture)
**Event received when this actor sits on the specified furniture.
*Event [[OnSpeechChallengeAvailable - Actor|OnSpeechChallengeAvailable]](ObjectReference akSpeaker)
**Event sent to player that a speech challenge is available

== See Also ==
*[[:Category:Actor|Actor Category]]

[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
[[Category:Actor]]