The Actor Script

The Papyrus Index is still under construction. Structs have not been implemented yet.

• vanilla

  • intpathingresult_success=0
  • intpathingresult_failure=1
  • intpathingresult_stopped=2
  • intpathingresult_cleared=3
  • intpathingresult_timeout=4
  • intcritstage_none=0
  • intcritstage_goostart=1
  • intcritstage_gooend=2
  • intcritstage_disintegratestart=3
  • intcritstage_disintegrateend=4
  • intcritstage_freezestart=5
  • intcritstage_freezeend=6

• Found in:
  • Vanilla

  eventOnActorActivatedRef(ObjectReferenceakActivatedRef)

  Event received when this actor activates a ref

• Found in:
  • Vanilla

  eventOnAffinityEvent(AffinityEventakAffinityEvent, ActorValueakActorValue, GlobalVariableakReactionValue, ObjectReferenceakTarget)

  Event received when affinity event is run

• Found in:
  • Vanilla

  eventOnCombatStateChanged(ObjectReferenceakTarget, intaeCombatState)

  Event called when this actor's combat state changes.

• Found in:
  • Vanilla

  eventOnCombatListAdded(ActorakTarget)

  Event that is triggered when this actor adds another actor to its combat list.

• Found in:
  • Vanilla

  eventOnCombatListRemoved(ActorakTarget)

  Event that is triggered when this actor removes another actor from its combat list.

• Found in:
  • Vanilla

  eventOnCommandModeCompleteCommand(intaeCommandType, ObjectReferenceakTarget)

  Event called when the actor in command mode with player finishes his current command

• Found in:
  • Vanilla

  eventOnCommandModeEnter()

  Event called when the player enters command mode with this actor as the commanded actor.

• Found in:
  • Vanilla

  eventOnCommandModeExit()

  Event called when the player exits command mode with this actor as the commanded actor.

• Found in:
  • Vanilla

  eventOnCommandModeGiveCommand(intaeCommandType, ObjectReferenceakTarget)

  Event called when the actor in command mode with player is given a command

• Found in:
  • Vanilla

  eventOnCompanionDismiss()

  Event sent to a companion when they are dismissed.

• Found in:
  • Vanilla

  eventOnConsciousnessStateChanged(boolabUnconscious)

  Event called when this actor changes consciousness state.

• Found in:
  • Vanilla

  eventOnCripple(ActorValueakActorValue, boolabCrippled)

  Event called when this actor has a limb that goes from healthy to crippled or crippled to healthy.

• Found in:
  • Vanilla

  eventOnDeferredKill(ActorakKiller)

  Event called when an actor set to do deferred kill mode gets killed (once). May be called more than once on a single actor before they die. Most useful on flying actors (Vertibirds) which usually enter a "crash mode" when killed in the air but don't actually die until they hit the ground.

• Found in:
  • Vanilla

  eventOnDeath(ObjectReferenceakKiller)

  Event called when the actor finishes dying.

• Found in:
  • Vanilla

  eventOnDifficultyChanged(intaOldDifficulty, intaNewDifficulty)

  Event sent to the player when the game's difficulty is changed.

• Found in:
  • Vanilla

  eventOnDying(ObjectReferenceakKiller)

  Event called when the actor begins dying.

• Found in:
  • Vanilla

  eventOnUnconscious(ObjectReferenceakAttacker)

  Event that is triggered when an actor has been "killed" with EM weapons (the actor is still alive)

• Found in:
  • Vanilla

  eventOnEnterBleedout()

  Event called when the actor has entered bleedout.

• Found in:
  • Vanilla

  eventOnEnterOutpostBeaconMode()

  Event received when the player enters Outpost Beacon placeement mode.

• Found in:
  • Vanilla

  eventOnEnterShipInterior(ObjectReferenceakShip)

  Event received when an actor enters a ship interior cell

• Found in:
  • Vanilla

  eventOnEnterSneaking()

  Event called when the actor has entered sneaking.

• Found in:
  • Vanilla

  eventOnEscortWaitStart()

  Event called when this actor is running an Escort procedure, and starts waiting for the escorted actor to catch up.

• Found in:
  • Vanilla

  eventOnEscortWaitStop()

  Event called when this actor is running an Escort procedure, and stops waiting for the escorted actor because the escorted actor is now sufficiently close that the escorter can resume travel to the destination.

• Found in:
  • Vanilla

  eventOnExitShipInterior(ObjectReferenceakShip)

  Event received when an actor exits a ship interior cell

• Found in:
  • Vanilla

  eventOnPlayerFollowerWarp(ObjectReferenceakFollower)

  Event received when a player follower is warped

• Found in:
  • Vanilla

  eventOnGetUp(ObjectReferenceakFurniture)

  Event called when this actor gets up from a piece of furniture.

• Found in:
  • Vanilla

  eventOnHomeShipSet(SpaceshipReferenceakShip, SpaceshipReferenceakPrevious)

  Event that is triggered when the actors home ship is set.

• Found in:
  • Vanilla

  eventOnPlayerFailedPlotRoute(intaeFailedPlotReason)

  Event received when the player plots a failed starmap route
  Type is as follows:
  0 - Success
  1 - Insufficient Fuel
  2 - Out of Range
  3 - Unexplored System

• Found in:
  • Vanilla

  eventOnPlayerModifiedShip(SpaceshipReferenceakShip)

  Event that is triggered when an actor modifies a ship

• Found in:
  • Vanilla

  eventOnItemEquipped(FormakBaseObject, ObjectReferenceakReference)

  Event called when the actor equips an object.

• Found in:
  • Vanilla

  eventOnItemUnequipped(FormakBaseObject, ObjectReferenceakReference)

  Event called when the actor unequips an object.

• Found in:
  • Vanilla

  eventOnKill(ObjectReferenceakVictim)

  Event called when the actor kills another.

• Found in:
  • Vanilla

  eventOnLocationChange(LocationakOldLoc, LocationakNewLoc)

  Event called when this actor moves from one location to another.

• Found in:
  • Vanilla

  eventOnRecoverFromBleedout()

  Event received when an actor exits bleedout.

• Found in:
  • Vanilla

  eventOnPackageChange(PackageakOldPackage)

  Event called when the actor changes away from a package.

• Found in:
  • Vanilla

  eventOnPackageEnd(PackageakOldPackage)

  Event called when the actor finishes a package.

• Found in:
  • Vanilla

  eventOnPackageStart(PackageakNewPackage)

  Event called when the actor starts running a new package.

• Found in:
  • Vanilla

  eventOnPartialCripple(ActorValueakActorValue, boolabCrippled)

  Event called when this actor has a limb that goes from healthy to "partially crippled" or "partially crippled" to healthy.

  The concept of partial crippling was created for robots, to provide an intermediate limb damage state, so that we can for instance play different hit effects.

  This concept currently applies only to actors whose race has the "Use Subsegment Damage" flag set.

• Found in:
  • Vanilla

  eventOnPickLock(ObjectReferenceakLockedRef, boolabCrime, boolabSucceeded, TerminalMenuakLockedTerminalMenu, intaiTerminalMenuItem)

  Event received when an actor picks a lock

• Found in:
  • Vanilla

  eventOnPickpocketFailed()

  Event sent when the player fails to pickpocket this actor.

• Found in:
  • Vanilla

  eventOnPlayerItemAdded(FormakBaseObject, ObjectReferenceakOwner, ObjectReferenceakSourceContainer, intaeAcquireType)

  Received when the player gains an item in their inventory
  aeAcquireType is one of the following:
  0: None
  1: Steal
  2: Buy
  3: Pickpocket
  4: Pickup
  5: Container
  6: Dead body

• Found in:
  • Vanilla

  eventOnPlayerCompleteResearch(ObjectReferenceakBench, LocationakLocation, ResearchProjectakProject)

  Received when player completes research

• Found in:
  • Vanilla

  eventOnPlayerCraftItem(ObjectReferenceakBench, LocationakLocation, FormakCreatedItem)

  Received when player crafts an item

• Found in:
  • Vanilla

  eventOnPlayerCreateRobot(ActorakNewRobot)

  Event send to the player when he creates a robot

• Found in:
  • Vanilla

  eventOnPlayerEnterVertibird(ObjectReferenceakVertibird)

  Event sent to the player when he enters a vertibird

• Found in:
  • Vanilla

  eventOnPlayerFallLongDistance(floatafDamage)

  Event send to the player he falls long distance and takes damage.

• Found in:
  • Vanilla

  eventOnPlayerFireWeapon(FormakBaseObject)

  Event sent to the player when he fires weapon out of combat. Only sent based on a timer since the last time it was sent

• Found in:
  • Vanilla

  eventOnPlayerHealTeammate(ActorakTeammate)

  Event called when the player heals a teammate. This event is only sent to the player actor.

• Found in:
  • Vanilla

  eventOnPlayerLoadGame()

  Event called when the player loads a save game. This event is only sent to the player actor.

• Found in:
  • Vanilla

  eventOnPlayerLoiteringBegin()

  Received when player starts loitering

• Found in:
  • Vanilla

  eventOnPlayerLoiteringEnd()

  Received when player stops loitering

• Found in:
  • Vanilla

  eventOnPlayerModArmorWeapon(FormakBaseObject, ObjectModakModBaseObject)

  Event sent to the player when they modify armor or weapons.

• Found in:
  • Vanilla

  eventOnPlayerModRobot(ActorakRobot, ObjectModakModBaseObject)

  Event send to the player when he modifies a robot

• Found in:
  • Vanilla

  eventOnPlayerSwimming()

  Event sent to the player when he starts swimming

• Found in:
  • Vanilla

  eventOnPlayerUseWorkBench(ObjectReferenceakWorkBench)

  Event sent to the player when he uses a workbench

• Found in:
  • Vanilla

  eventOnRaceSwitchComplete()

  Event called when the actor has finished switching races.

• Found in:
  • Vanilla

  eventOnSit(ObjectReferenceakFurniture)

  Event called when this actor sits on a piece of furniture.

• Found in:
  • Vanilla

  eventOnSpeechChallengeAvailable(ObjectReferenceakSpeaker)

  Event sent to player that a speech challenge is available

• Found in:
  • Vanilla

  eventOnPlayerPlanetSurveyComplete(PlanetakPlanet)

  Received when player completely surveyed a planet

• Found in:
  • Vanilla

  eventOnPlayerScannedObject(ObjectReferenceakScannedRef)

  Received by the player when they scan an object

• Found in:
  • Vanilla

  eventOnOutpostPlaced(ObjectReferenceakOutpostBeacon)

  Received when player placed an outpost beacon

• Found in:
  • Vanilla

  eventOnPlayerArrested(ObjectReferenceakGuard, LocationakLocation, intaeCrimeType)

  Event that is triggered when the player is arrested.

• Found in:
  • Vanilla

  eventOnPlayerAssaultActor(ObjectReferenceakVictim, LocationakLocation, boolaeCrime)

  Event that is triggered when the player assaults someone.

• Found in:
  • Vanilla

  eventOnPlayerCrimeGold(ObjectReferenceakVictim, FormakFaction, intaeCrimeGold, intaeCrimeType)

  Event that is triggered when the player gets crimegold .

• Found in:
  • Vanilla

  eventOnPlayerJail(ObjectReferenceakGuard, FormakFaction, LocationakLocation, intaeCrimeGold)

  Event that is triggered when the player goes to jail.

• Found in:
  • Vanilla

  eventOnPlayerPayFine(ObjectReferenceakGuard, FormakFaction, intaeCrimeGold)

  Event that is triggered when the player pays fine.

• Found in:
  • Vanilla

  eventOnPlayerMurderActor(ObjectReferenceakVictim, LocationakLocation, boolaeCrime)

  Event that is triggered when the player murders someone.

• Found in:
  • Vanilla

  eventOnPlayerTrespass(ObjectReferenceakVictim, LocationakLocation, boolaeCrime)

  Event that is triggered when the player trespassing.

• Found in:
  • Vanilla

  eventOnPlayerBuyShip(SpaceshipReferenceakShip)

  Event that is triggered when the player buys a ship

• Found in:
  • Vanilla

  eventOnPlayerSellShip(SpaceshipReferenceakShip)

  Event that is triggered when the player sells a ship

• Found in:
  • Vanilla

  voidfunctionModFavorPoints(intiFavorPoints=1)

  DEPRECATED - use MakePlayerFriend() instead
  replacement for ModFavorPoints
  if iFavorPoints > 0, will setRelationshipRank to 1 if 0
  otherwise, won't do anything

• Found in:
  • Vanilla

  voidfunctionModFavorPointsWithGlobal(GlobalVariableFavorPointsGlobal)

  also DEPRECATED

• Found in:
  • Vanilla

  voidfunctionMakePlayerFriend()

  Convenience function that makes the actor a friend of the player, if allowed.

• Found in:
  • Vanilla

  voidfunctionAddBountyCrime(FormakBountyCrime)Native

  Adds a bounty crime to the actor

• Found in:
  • Vanilla

  voidfunctionAddPassiveAffinity(floatafAmountToAdd)Native

  Adds Affinity to the actor

• Found in:
  • Vanilla

  voidfunctionAddPerk(PerkakPerk, boolabNotify=false)Native

  Adds the specified Perk to this actor. This function now works on both the player and NPCs.

• Found in:
  • Vanilla

  voidfunctionAllowBleedoutDialogue(boolabCanTalk)Native

  Allows this essential actor to speak with the player during bleedout (normally they can't).

• Found in:
  • Vanilla

  voidfunctionAllowPCDialogue(boolabTalk)Native

  Flags this actor as being able to talk to the player or not (overrides the race flag).

• Found in:
  • Vanilla

  voidfunctionAttachAshPile(FormakAshPileBase=NONE)Native

  Attaches an "ash pile" to the actor using the specified base object. Basically it's an object dropped at the actor's feet which cannot be picked up or moved by the player and, when activated, passes the activation onto the actor.

  If this is called on an Essential actor, the function will log an error. Best practice is to check that the actor is not essential prior to calling this function.

• Found in:
  • Vanilla

  intfunctionAttackOutpostObjects(ObjectReferenceakOutpostBeacon)Native

  Have the actor start combat with any destructible object associated with the specified
  outpost beacon. Returns the number of objects that the actor entered combat with

• Found in:
  • Vanilla

  voidfunctionAttemptAnimationSetSwitch()Native

  Loads new animation graphs for both MT (non-combat) and Weapon subgraphs, if new ones are found.

• Found in:
  • Vanilla

  boolfunctionCanFlyHere()Native

  Can this actor fly here?

• Found in:
  • Vanilla

  boolfunctionChangeAnimArchetype(KeywordapKeyword=NONE)Native

  Adds the specified AnimArchetype keyword to this actor.

• Found in:
  • Vanilla

  boolfunctionChangeAnimFlavor(KeywordapKeyword=NONE)Native

  Adds the specified AnimFlavor keyword to this actor.

• Found in:
  • Vanilla

  voidfunctionChangeHeadPart(HeadPartapHeadPart, boolabRemovePart=false, boolabRemoveExtraParts=false)Native

  Change or add this HeadPart to the actor.

• Found in:
  • Vanilla

  voidfunctionClearArrested()Native

  Clears this actor's arrested state.

• Found in:
  • Vanilla

  voidfunctionClearExpressionOverride()Native

  Clears any expression override on this actor, letting the dialogue, AI, and other systems manage this actor's expression again.

• Found in:
  • Vanilla

  voidfunctionClearExtraArrows()Native

  Clear any extra arrow 3D from an actor that occurred from being shot with arrows.

• Found in:
  • Vanilla

  voidfunctionClearForcedLandingMarker()

  Clears an actor's obligation (set by Actor.SetForcedLandingMarker(...)) to use a particular marker when this actor has to land. Just an alternate way of setting the forced landing marker to None.

• Found in:
  • Vanilla

  voidfunctionClearLookAt()Native

  Clears this actor's script-forced look-at target.

• Found in:
  • Vanilla

  boolfunctionDismount()Native

  Forces the actor to dismount.

• Found in:
  • Vanilla

  voidfunctionDispelAllSpells()Native

  Will dispel all spells affecting this actor with the exception of Abilities, Diseases, worn or constant effect enchantments, or addictions.

• Found in:
  • Vanilla

  voidfunctionDoCombatSpellApply(SpellakSpell, ObjectReferenceakTarget)Native

  Adds the specified Spell to the target actor from this one as the caster. Use this instead of AddSpell to apply a spell in combat so that die rolls and other appropriate events can occur (such as applying a disease through a spell).

• Found in:
  • Vanilla

  voidfunctionEnableAI(boolabEnable=true, boolabPauseVoice=false)Native

  Enables or disables this actor's AI.

• Found in:
  • Vanilla

  voidfunctionEndDeferredKill()Native

  Removes the actor from a Deferred Kill state. If the actor's health went below zero or the actor was killed for any other reason while in the Deferred Kill state, the actor will die when this is called. Call this after first calling Actor.StartDeferredKill().

• Found in:
  • Vanilla

  voidfunctionEquipItem(FormakItem, boolabPreventRemoval=false, boolabSilent=false)Native

  Forces this actor to equip the specified item, preventing removal if requested.

• Found in:
  • Vanilla

  voidfunctionEquipSpell(SpellakSpell, intaiSource)Native

  Forces the actor to equip the specified spell in the specified source.

• Found in:
  • Vanilla

  voidfunctionEvaluatePackage(boolabResetAI=false)Native

  Forces this actor's AI to re-evaluate its package stack.

• Found in:
  • Vanilla

  intfunctionGetBribeAmount()Native

  Returns the amount of gold required to bribe this actor.

• Found in:
  • Vanilla

  Actor[]functionGetAllCombatTargets()Native

  Obtains all actors this actor considers combat targets.

• Found in:
  • Vanilla

  Actor[]functionGetAllActorsInCombatWithMe()Native

  Get all combat actors that have me listed as a combat target.

• Found in:
  • Vanilla

  ObjectReferencefunctionGetCrewAssignment()Native

  Get actors crew assignment.

• Found in:
  • Vanilla

  FactionfunctionGetCrimeFaction()Native

  Obtains the Faction this actor reports it's crimes to.

• Found in:
  • Vanilla

  intfunctionGetCombatState()Native

  Gets the actor's current combat state.

• Found in:
  • Vanilla

  ActorfunctionGetCombatTarget()Native

  Obtains the actor this actor is currently in combat with.

• Found in:
  • Vanilla

  PackagefunctionGetCurrentPackage()Native

  Gets the Package this actor is currently running.

• Found in:
  • Vanilla

  ActorfunctionGetDialogueTarget()Native

  Obtains the actor this actor is currently in dialogue with.

• Found in:
  • Vanilla

  intfunctionGetEquippedItemType(intaiEquipIndex)Native

  Gets the type of item the actor currently has equipped in the specified hand.

• Found in:
  • Vanilla

  WeaponfunctionGetEquippedWeapon(intaiEquipIndex=0)Native

  Gets the actor's currently equipped weapon.

• Found in:
  • Vanilla

  ArmorfunctionGetEquippedShield()Native

  Gets the actor's currently equipped shield.

• Found in:
  • Vanilla

  SpellfunctionGetEquippedSpell(intaiSource)Native

  Gets the spell the actor currently has equipped in the specified source.

• Found in:
  • Vanilla

  intfunctionGetFactionRank(FactionakFaction)Native

  Gets this actor's rank in the specified faction.

• Found in:
  • Vanilla

  intfunctionGetFactionReaction(ActorakOther)Native

  Get the faction-based reaction between this actor and another.

• Found in:
  • Vanilla

  intfunctionGetFlyingState()Native

  Gets the current flying state of this actor, or, if they are riding a flying mount, the fly state of the mount.

• Found in:
  • Vanilla

  ObjectReferencefunctionGetFurnitureUsing()Native

  Get the ref this actor is currently interacting with

• Found in:
  • Vanilla

  ObjectReferencefunctionGetForcedLandingMarker()Native

  Returns the ref at which this actor is obliged to land, if one was set by Actor.SetForcedLandingMarker(...) (or none, if none was set).

• Found in:
  • Vanilla

  intfunctionGetGoldAmount()Native

  Obtains the amount of gold on this actor's person.

• Found in:
  • Vanilla

  FactionfunctionGetGroupFaction()Native

  Get the group faction for this actor if he has one for group behavior

• Found in:
  • Vanilla

  intfunctionGetHighestRelationshipRank()Native

  Gets the highest relationship rank this actor has.

• Found in:
  • Vanilla

  ActorfunctionGetKiller()Native

  Obtains the actor that killed this one. If this actor isn't dead, returns None.

• Found in:
  • Vanilla

  intfunctionGetLevel()Native

  Gets the actor's current level.

• Found in:
  • Vanilla

  floatfunctionGetLightLevel()Native

  Get the light level of the actor

• Found in:
  • Vanilla

  intfunctionGetLowestRelationshipRank()Native

  Gets the lowest relationship rank this actor has.

• Found in:
  • Vanilla

  ActorBasefunctionGetLeveledActorBase()Native

  Gets the temporary ActorBase of a leveled Actor - the one generated by the game from the leveled list. If the actor is not leveled, it will simply return the base object shown in the editor.

• Found in:
  • Vanilla

  ActorBasefunctionGetMatchingPlanetActorBase()Native

  Gets the ActorBase from the actor's biome data list, if the actor is of a creature type placed by the biome

• Found in:
  • Vanilla

  boolfunctionGetNoBleedoutRecovery()Native

  Gets this whether this actor is allowed to recover from bleedout. (If not, they will stay in bleed out when knocked there)

• Found in:
  • Vanilla

  boolfunctionGetPlayerControls()Native

  Gets this whether this actor is being directly controlled by the player (as opposed to AI)

• Found in:
  • Vanilla

  RacefunctionGetRace()Native

  Obtains this actor's Race.

• Found in:
  • Vanilla

  intfunctionGetRelationshipRank(ActorakOther)Native

  Gets the relationship rank between this actor and another.

• Found in:
  • Vanilla

  intfunctionGetSitState()Native

  Gets this actor's sit state.

• Found in:
  • Vanilla

  intfunctionGetSleepState()Native

  Gets this actor's sleep state.

  NOTE: This does not work for the player.

• Found in:
  • Vanilla

  SpaceshipReferencefunctionGetSpaceship()Native

  Obtains the spaceship this actor is piloting, if any

• Found in:
  • Vanilla

  boolfunctionHasAssociation(AssociationTypeakAssociation, ActorakOther=NONE)Native

  Does this actor have the specified association with the specified actor? Or with anyone if no actor is passed.

• Found in:
  • Vanilla

  boolfunctionHasFamilyRelationship(ActorakOther=NONE)Native

  Does this actor have a family relationship with the specified actor? Or with anyone if no actor is passed.

• Found in:
  • Vanilla

  boolfunctionHasDetectionLOS(ObjectReferenceakOther)Native

  Checks to see if this actor as line-of-sight to the target object. Note that only the player can get line-of-sight to a non-actor.

  If called on the player, HasDetectionLOS clips the line-of-sight check to the camera, so HasDetectionLOS will return false if the camera cannot see the object (even if there is a clear line-of-sight outside the camera's view). Also, three picks will be made at top, middle, and bottom. If any of the picks are unobstructed then HasDetectionLOS will return true.

• Found in:
  • Vanilla

  boolfunctionHasMagicEffect(MagicEffectakEffect)Native

  Checks to see if this actor is currently being affected by the given Magic Effect.

• Found in:
  • Vanilla

  boolfunctionHasMagicEffectWithKeyword(KeywordakKeyword)Native

  Checks to see if this actor is currently being affected by a Magic Effect with the given Keyword.

• Found in:
  • Vanilla

  boolfunctionHasParentRelationship(ActorakOther)Native

  Does this actor have a parent relationship with the specified actor?

• Found in:
  • Vanilla

  boolfunctionHasPerk(PerkakPerk)Native

  Checks to see if this actor has the given Perk.

• Found in:
  • Vanilla

  boolfunctionHasSpell(FormakForm)Native

  Checks to see if this actor has the given Spell or Shout.

• Found in:
  • Vanilla

  boolfunctionIsAIEnabled()Native

  Returns whether this actor's AI is currently enabled.

• Found in:
  • Vanilla

  boolfunctionIsAlarmed()Native

  Is this actor currently alarmed?

• Found in:
  • Vanilla

  boolfunctionIsAlerted()Native

  Is this actor currently alerted?

• Found in:
  • Vanilla

  boolfunctionIsAllowedToFly()Native

  Is this actor currently allowed to fly?

• Found in:
  • Vanilla

  boolfunctionIsArrested()Native

  Returns whether this actor is currently arrested or not.

• Found in:
  • Vanilla

  boolfunctionIsArrestingTarget()Native

  Returns whether this actor is currently arresting his target. Will always return false if called on a non-guard, or called on a non-alerted guard.

• Found in:
  • Vanilla

  boolfunctionIsBeingRidden()Native

  Is this actor being ridden?

• Found in:
  • Vanilla

  boolfunctionIsBeingRiddenBy(ActorakActor)Native

  Check if this actor is being ridden by another actor.

• Found in:
  • Vanilla

  intfunctionIsBleedingOut()Native

  Is this actor currently bleeding out?

• Found in:
  • Vanilla

  boolfunctionIsBribed()Native

  Used to determine if this actor has been bribed by the player

• Found in:
  • Vanilla

  boolfunctionIsChild()Native

  Is this actor a child actor?

• Found in:
  • Vanilla

  boolfunctionIsCommandedActor()Native

  Is this actor commanded by another?

• Found in:
  • Vanilla

  boolfunctionIsDead()Native

  Is this actor currently dead?

• Found in:
  • Vanilla

  boolfunctionIsDetectedBy(ActorakOther)Native

  Is this actor currently detected by the other one?

• Found in:
  • Vanilla

  boolfunctionIsDoingFavor()Native

  Is this actor flagged as doing a favor for the player?

• Found in:
  • Vanilla

  boolfunctionIsEquipped(FormakItem)Native

  Does the actor have the specified item equipped?

• Found in:
  • Vanilla

  boolfunctionIsEssential()Native

  Is this actor currently essential?

• Found in:
  • Vanilla

  boolfunctionIsFlying()Native

  Returns if this actor is currently flying or not.

• Found in:
  • Vanilla

  boolfunctionIsGuard()Native

  Is this actor a guard?

• Found in:
  • Vanilla

  boolfunctionIsGhost()Native

  Is this actor currently flagged as a ghost?

• Found in:
  • Vanilla

  boolfunctionIsHostileToActor(ActorakActor)Native

  Check if this actor is hostile to another actor

• Found in:
  • Vanilla

  boolfunctionIsInCombat()Native

  Is this actor currently in combat?

• Found in:
  • Vanilla

  boolfunctionIsInFaction(FactionakFaction)Native

  Returns whether this actor is a member of the specified faction or not.

• Found in:
  • Vanilla

  boolfunctionIsInIronSights()Native

  Returns whether this actor is currently in iron sights.

• Found in:
  • Vanilla

  boolfunctionIsInKillMove()Native

  Is this actor currently in a kill move?

• Found in:
  • Vanilla

  boolfunctionIsInScene()Native

  Is this actor currently in a scene?

• Found in:
  • Vanilla

  boolfunctionIsIntimidated()Native

  Used to determine if this actor has been intimidated by the player

• Found in:
  • Vanilla

  boolfunctionIsOnMount()Native

  Is the actor on a mount?

• Found in:
  • Vanilla

  boolfunctionIsOverEncumbered()Native

  Is this actor over-encumbered? An actor is considered over-encumbered if their total inventory weight exceeds their maximum carry weight.

• Found in:
  • Vanilla

  boolfunctionIsOwner(ObjectReferenceakObject)

  Checks to see if the actor is the owner of the specified reference.

• Found in:
  • Vanilla

  boolfunctionIsPlayersLastRiddenHorse()Native

  Checks to see if this actor is the horse the player last rode.

• Found in:
  • Vanilla

  boolfunctionIsPlayerTeammate()Native

  Checks to see if this actor is currently a teammate of the player

• Found in:
  • Vanilla

  boolfunctionIsRunning()Native

  Checks to see if this actor is currently running (as opposed to, say, walking or sprinting).

• Found in:
  • Vanilla

  boolfunctionIsSeatOccupied(KeywordapKeyword)Native

  Check if this actor (which should be a mount with multiple "seats") has any actor sitting in a particular seat or not. Note that this will not work for "vehicle drivers", like actors riding horses.

• Found in:
  • Vanilla

  boolfunctionIsSneaking()Native

  Checks to see if this actor is currently sneaking.

• Found in:
  • Vanilla

  boolfunctionIsSprinting()Native

  Checks to see if this actor is currently sprinting.

• Found in:
  • Vanilla

  boolfunctionIsTalking()Native

  Checks to see if this actor is currently talking.

• Found in:
  • Vanilla

  boolfunctionIsTrespassing()Native

  Is this actor trespassing?

• Found in:
  • Vanilla

  boolfunctionIsUnconscious()Native

  Is this actor currently unconscious?

• Found in:
  • Vanilla

  boolfunctionIsWeaponDrawn()Native

  Has this actor drawn his weapon and/or spell?

• Found in:
  • Vanilla

  voidfunctionKill(ActorakKiller=NONE)Native

  Kills this actor with the passed-in actor being the culprit.

• Found in:
  • Vanilla

  voidfunctionKillEssential(ActorakKiller=NONE)

  Kills this actor with the passed-in actor being the culprit, even if he is essential.

• Found in:
  • Vanilla

  voidfunctionKillSilent(ActorakKiller=NONE)Native

  Kills this actor with the passed-in actor being the culprit, but without a kill event.

• Found in:
  • Vanilla

  voidfunctionApplyUnityCharacterData()Native

  Apply Unity Character Data to Actor

• Found in:
  • Vanilla

  voidfunctionCopyAppearance(ActorakSourceToCopyFrom)Native

  Copy character customization appearance data from a given actor

• Found in:
  • Vanilla

  voidfunctionMarkItemAsFavorite(FormakItem, intaiSlot=-1)Native

  Mark the given item as a favorite.

• Found in:
  • Vanilla

  voidfunctionModFactionRank(FactionakFaction, intaiMod)Native

  Modifies this actor's rank in the specified faction. Will not remove an actor from a faction.

• Found in:
  • Vanilla

  boolfunctionMoveToFurniture(ObjectReferenceakTargetFurniture)

  moves this actor to the furniture and snaps them into it
  returns the value of SnapIntoInteraction()
  Note: might not work in unloaded area

• Found in:
  • Vanilla

  voidfunctionMoveToPackageLocation()Native

  Determines where an actor should be placed, based on the running procedure(s) of the actor's current package, and places them there.

  Also initializes the actor's behavior graph based on their current package, so they will be posed correctly (in furniture, etc.). (If a pose init is already queued, e.g. for an actor whose 3D was just loaded, we allow the queued one to occur.)

• Found in:
  • Vanilla

  voidfunctionOpenInventory(boolabForceOpen=false, FormakFilter=NONE, boolabIncludeOnlyFromFilter=true)Native

  Opens this actor's inventory as if the player were pick-pocketing them. Will only open inventory on player's teammates unless told to force it open.

• Found in:
  • Vanilla

  intfunctionPathToReference(ObjectReferenceaTarget, floatafNormalizedSpeed, floatafNormalizedRotationSpeed, floatafTargetRadius=-1, boolabHardRadius=false)Native

  Makes the actor path to the target reference at a given speed.

• Found in:
  • Vanilla

  boolfunctionPlayIdle(IdleakIdle)Native

  Plays the idle passed.

• Found in:
  • Vanilla

  boolfunctionPlayIdleAction(ActionaAction, ObjectReferenceaTarget=NONE)Native

  Attempts to play an idle from the action root passed.

• Found in:
  • Vanilla

  boolfunctionPlayIdleWithTarget(IdleakIdle, ObjectReferenceakTarget)Native

  Plays the Idle passed and overrides the actor's target with the given target. If no target is passed, then the idle will use the actor's current target instead.

• Found in:
  • Vanilla

  voidfunctionPlaySubGraphAnimation(stringasEventName)Native

  Sends the event passed to the actor's sub graphs.

• Found in:
  • Vanilla

  voidfunctionRemoveFromFaction(FactionakFaction)Native

  Removes this actor from the specified faction. If the faction was the actor's crime faction, the actor's crime faction will be cleared.

• Found in:
  • Vanilla

  voidfunctionRemoveFromAllFactions()Native

  Remove this actor from all factions they are a member of.

• Found in:
  • Vanilla

  voidfunctionRemovePerk(PerkakPerk)Native

  Removes the specified Perk from this actor. This function now works on both the player and NPCs.

• Found in:
  • Vanilla

  boolfunctionRemoveSpell(SpellakSpell)Native

  Removes the specified spell from this actor.

• Found in:
  • Vanilla

  voidfunctionResetHealthAndLimbs()Native

  Resets this actor's health and restores all his limbs.

• Found in:
  • Vanilla

  voidfunctionResurrect()Native

  Resurrects this actor.

• Found in:
  • Vanilla

  voidfunctionSendAssaultAlarm()Native

  Have this actor behave as if he was assaulted by the player.

• Found in:
  • Vanilla

  voidfunctionSendSmugglingAlarm(ActorakCriminal)Native

  Has this actor behave as if they caught another actor smuggling

• Found in:
  • Vanilla

  voidfunctionSendTrespassAlarm(ActorakCriminal)Native

  Have this actor pretend he caught the specified criminal trespassing.

• Found in:
  • Vanilla

  voidfunctionSetAlert(boolabAlerted=true)Native

  Set or clear this actor's alerted state.

• Found in:
  • Vanilla

  voidfunctionSetAllowFlying(boolabAllowed=true, boolabAllowCrash=true, boolabAllowSearch=false)Native

  Sets whether this actor is allowed to fly or not. If not, and they are flying, will land the actor.

• Found in:
  • Vanilla

  voidfunctionSetAlpha(floatafTargetAlpha, boolabFade=false)Native

  Sets this actor's alpha value, optionally fading them to that value rather then popping.

• Found in:
  • Vanilla

  voidfunctionSetAttackActorOnSight(boolabAttackOnSight=true)Native

  Flags this actor to be attacked by all actors when detected

• Found in:
  • Vanilla

  voidfunctionSetAvoidPlayer(boolabAvoid=true)Native

  Tells actors whether they need to avoid the player when pathing. (By default, they do, so this does nothing relevant unless the abAvoid parameter is false.)

  Created to support scenes where the player is meant to be an incorporeal observer, such as the "memory den" scenes in Fallout 4.

• Found in:
  • Vanilla

  voidfunctionSetCommandState(boolabStartCommandMode)Native

  Sets/Unsets the actor in command mode so that we can order them around. SetCanDoCommand() needs to have already been called on the actor, or they already need to be 'commandable', e.g. teammates.

• Found in:
  • Vanilla

  voidfunctionSetBribed(boolabBribe=true)Native

  Flags this actor as bribe by the player

• Found in:
  • Vanilla

  voidfunctionSetCanDoCommand(boolabCanCommand=true)Native

  Flags this actor as bribe by the player

• Found in:
  • Vanilla

  voidfunctionSetCombatStyle(CombatStyleakCombatStyle)Native

  Sets the CombatStyle on this actor. Passing None will clear the actor's combatstyle back to their default

• Found in:
  • Vanilla

  voidfunctionSetCrimeFaction(FactionakFaction)Native

  Sets the Faction this actor reports crimes to. You may pass None to clear out the crime faction on the actor. If the actor does not currently belong to the crime faction, it will be added to that faction.

• Found in:
  • Vanilla

  voidfunctionSetCriticalStage(intaiStage)Native

  Sets this actor's current critical stage, along with applying any related effects.

• Found in:
  • Vanilla

  voidfunctionSetDoingFavor(boolabDoingFavor=true, boolabWorkShopMode=false)Native

  Set or clear this actor's "doing favor" status.

• Found in:
  • Vanilla

  voidfunctionChangeAnimFaceArchetype(KeywordapKeyword=NONE)Native

  Adds the specified AnimFaceArchetype keyword to this actor.

• Found in:
  • Vanilla

  voidfunctionSetEssential(boolabEssential)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. This works on an individual actor, not the Actor Base.

• Found in:
  • Vanilla

  voidfunctionSetFactionRank(FactionakFaction, intaiRank)Native

  Sets this actor's rank in the specified faction. Adds the actor to the faction if necessary.

• Found in:
  • Vanilla

  voidfunctionSetForcedLandingMarker(ObjectReferenceaMarker)Native

  Sets a specific ObjectReference (preferably a landing marker) as the place at which this actor must land from flight.

• Found in:
  • Vanilla

  voidfunctionSetGhost(boolabIsGhost=true)Native

  Flags this actor as a ghost or not.

• Found in:
  • Vanilla

  voidfunctionSetGroupFaction(FactionakFaction)Native

  Sets the faction that this actor will use for group behavior

• Found in:
  • Vanilla

  voidfunctionSetHasCharGenSkeleton(boolabCharGen=true)Native

  Flags this actor as having a fully char gen editable skeleton or not.

• Found in:
  • Vanilla

  voidfunctionAddToFaction(FactionakFaction)

  Adds the Actor to a specified Faction at rank 0. If the Actor is already in the faction, this function does nothing.

• Found in:
  • Vanilla

  voidfunctionSetHeadTracking(boolabEnable=true)Native

  Turns on and off this actor's head tracking.

• Found in:
  • Vanilla

  voidfunctionSetIntimidated(boolabIntimidate=true)Native

  Flags this actor as intimidated by the player

• Found in:
  • Vanilla

  voidfunctionSetLookAt(ObjectReferenceakTarget, boolabPathingLookAt=false)Native

  Forces this actor to look at the target. Optionally, will also cause them to set it as their pathing target as well, which means they will walk relative to it (backwards and facing it when walking away, for example).

• Found in:
  • Vanilla

  voidfunctionSetNoBleedoutRecovery(boolabAllowed)Native

  Sets whether this actor can recover from bleedout or not.

• Found in:
  • Vanilla

  voidfunctionSetNotShowOnStealthMeter(boolabNotShow)Native

  Sets this actor to not affect the detection level on the stealth meter if he is not hostile to the player

• Found in:
  • Vanilla

  voidfunctionSetOutfit(OutfitakOutfit, boolabSleepOutfit=false)Native

  Change the default or sleep Outfit for this actor.

• Found in:
  • Vanilla

  voidfunctionSetOverrideVoiceType(VoiceTypeakVoiceType)Native

  Overrides the voice type for this actor - set to None to clear.

• Found in:
  • Vanilla

  VoiceTypefunctionSetOverrideVoiceTypeRandom(FormListakVoiceList)

  calls SetOverrideVoiceType with a randomly choice from a formlist of voicetypes and returns the chosen voicetype

• Found in:
  • Vanilla

  voidfunctionSetPlayerControls(boolabControls)Native

  Set the actor as being controlled (or not controlled) by the player's controls.

• Found in:
  • Vanilla

  voidfunctionSetPlayerResistingArrest()Native

  Flags the player as resisting arrest from this actor's faction.

• Found in:
  • Vanilla

  voidfunctionSetPlayerTeammate(boolabTeammate=true, boolabCanDoFavor=true, boolabGivePlayerXP=false)Native

  Flags this actor as a teammate of the player or not.

• Found in:
  • Vanilla

  voidfunctionSetProtected(boolabProtected)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. This works on an individual actor, not the actor base.

• Found in:
  • Vanilla

  voidfunctionSetRace(RaceakRace=NONE)Native

  Change actors Race and reload his art.

• Found in:
  • Vanilla

  voidfunctionSetRelationshipRank(ActorakOther, intaiRank)Native

  Sets the relationship rank between this actor and another.

• Found in:
  • Vanilla

  boolfunctionSetRestrained(boolabRestrained=true)Native

  Flags this actor as restrained or not.

• Found in:
  • Vanilla

  voidfunctionSetSubGraphFloatVariable(stringasVariableName, floatafValue)Native

  Set a variable on all of an actor's sub graphs.

• Found in:
  • Vanilla

  boolfunctionSetUnconscious(boolabUnconscious=true)Native

  Set or clear this actor's unconscious status.

• Found in:
  • Vanilla

  voidfunctionSetVehicle(ActorakVehicle)Native

  Attaches the actor to a horse, cart, or other vehicle -- or detaches it from its current vehicle.

• Found in:
  • Vanilla

  voidfunctionSetWantSprinting(boolabWantSprint)Native

  Set that the actor would like to sprint when possible (or turn that off).
  abWantSprint is if we want to sprint currently, false otherwise

• Found in:
  • Vanilla

  voidfunctionSheatheWeapon()Native

  Makes this actor sheathe his weapon

• Found in:
  • Vanilla

  voidfunctionShowBarterMenu()Native

  Shows the barter menu for this actor.

• Found in:
  • Vanilla

  voidfunctionShowCrewAssign(boolabAssign=true)Native

  Opens the crew assignment menu

• Found in:
  • Vanilla

  boolfunctionStartCombat(ObjectReferenceakTarget, boolabPreferredTarget=false)Native

  Attempts to get this actor to initiate combat with the target.

• Found in:
  • Vanilla

  voidfunctionStartDeferredKill()Native

  Puts the actor into a Deferred Kill state. In this state, the actor can take damage but will not die.

• Found in:
  • Vanilla

  voidfunctionStartVampireFeed(ActorakTarget)Native

  Has the actor vampire feed on a sleeping actor

• Found in:
  • Vanilla

  voidfunctionStartFrenzyAttack(floataChance=0.1, floataInterval=0.5)Native

  Puts the actor into Frenzy attack mode using a random target selector.

• Found in:
  • Vanilla

  voidfunctionStopCombat()Native

  Removes this actor from combat.

• Found in:
  • Vanilla

  voidfunctionStopCombatAlarm()Native

  Stop all combat and alarms against this actor.

• Found in:
  • Vanilla

  voidfunctionSwitchToPowerArmor(ObjectReferenceaArmorFurniture)Native

  Near-instantly snap this actor into the inactive suit of power armor aArmorFurniture. If passed "None" while an actor is in power armor, they will get out on the spot; or take a few steps in a random direction before getting out if their back is currently to a wall or other object.

• Found in:
  • Vanilla

  boolfunctionSnapIntoInteraction(ObjectReferenceakTarget)Native

  Near-instantly snap this actor into/onto a furniture/mount.

• Found in:
  • Vanilla

  boolfunctionTrapSoul(ActorakTarget)Native

  Attempts to trap the soul of the target actor in a soul gem in the inventory of the calling actor. Returns success/failure.

• Found in:
  • Vanilla

  voidfunctionUnequipAll()Native

  Forces this actor to unequip all currently equipped items.

• Found in:
  • Vanilla

  voidfunctionUnequipItem(FormakItem, boolabPreventEquip=false, boolabSilent=false)Native

  Forces this actor to unequip the specified item, preventing equipping if requested.

• Found in:
  • Vanilla

  voidfunctionUnequipItemSlot(intaiSlot)Native

  Forces this actor to unequip all armor on the given slot.

• Found in:
  • Vanilla

  voidfunctionUnequipSpell(SpellakSpell, intaiSource)Native

  Forces the actor to equip the specified spell in the specified source.

• Found in:
  • Vanilla

  voidfunctionUnLockOwnedDoorsInCell()Native

  This actor will unlock all the doors that he qualifies for ownership in his current parentcell

• Found in:
  • Vanilla

  boolfunctionWillIntimidateSucceed()Native

  Returns whether or not an intimidation attempt by the player on this actor will succeed or not.

• Found in:
  • Vanilla

  boolfunctionWornCoversBipedSlot(intaiSlot)Native

  Returns whether anything the actor is wearing covers this biped slot

• Found in:
  • Vanilla

  boolfunctionWornHasKeyword(KeywordakKeyword)Native

  Checks to see if anything worn by this actor has the specified keyword attached.

• Found in:
  • Vanilla

  boolfunctionWouldBeStealing(ObjectReferenceakObject)Native

  Checks if the taking of a ref would be stealing for this actor

• Found in:
  • Vanilla

  intfunctionWouldRefuseCommand(ObjectReferenceakObject)Native

  Checks if the actor would refuse a command on the ref for the player (and why)

• Found in:
  • Vanilla

  voidfunctionStartSneaking()Native

  Forces this actor to start sneaking.

• Found in:
  • Vanilla

  voidfunctionDrawWeapon()Native

  Forces this actor to draw his weapon.

• Found in:
  • Vanilla

  voidfunctionDogPlaceInMouth(FormakItem)Native

  Place an item in dogmeat's mouth.

• Found in:
  • Vanilla

  voidfunctionDogDropItems()Native

  Drop all of the dog's items on the ground.

• Found in:
  • Vanilla

  voidfunctionForceMovementDirection(floatafXAngle=0.0, floatafYAngle=0.0, floatafZAngle=0.0)NativeDebugOnly

  **** For Debugging Movement Animations (not in release builds) ****
  Forces the movement direction on the actor
  afXAngle, afYAngle and afZAngle are in degrees

• Found in:
  • Vanilla

  voidfunctionForceMovementSpeed(floatafSpeedMult)NativeDebugOnly

  Forces the movement speed on the actor
  afSpeedMult is a speed multiplier based on the current max speeds

  • 0 -> 1 Scales between 0 and the Walk speed
  • 1 -> 2 Scales between Walk speed and Run Speed
  • 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0)
• Found in:
  • Vanilla

  voidfunctionForceMovementRotationSpeed(floatafXMult=0.0, floatafYMult=0.0, floatafZMult=0.0)NativeDebugOnly

  Forces the movement rotation speed on the actor
  Each component of the rotation speed is a multiplier following these rules:

  • 0 -> 1 Scales between 0 and the Walk speed
  • 1 -> 2 Scales between Walk speed and Run Speed
  • 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0)
• Found in:
  • Vanilla

  voidfunctionForceMovementDirectionRamp(floatafXAngle=0.0, floatafYAngle=0.0, floatafZAngle=0.0, floatafRampTime=0.1)NativeDebugOnly

  Ramps the movement direction on the actor to the passed in value over the passed in time
  afXAngle, afYAngle and afZAngle are in degrees
  afRampTime is in seconds

• Found in:
  • Vanilla

  voidfunctionForceMovementSpeedRamp(floatafSpeedMult, floatafRampTime=0.1)NativeDebugOnly

  Ramps the movement speed on the actor to the passed in value over the passed in time
  afSpeedMult is a speed multiplier based on the current max speeds

  • 0 -> 1 Scales between 0 and the Walk speed
  • 1 -> 2 Scales between Walk speed and Run Speed
  • 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0)
    afRampTime is in seconds
• Found in:
  • Vanilla

  voidfunctionForceMovementRotationSpeedRamp(floatafXMult=0.0, floatafYMult=0.0, floatafZMult=0.0, floatafRampTime=0.1)NativeDebugOnly

  Ramps the movement rotation speed on the actor to the passed in value over the passed in time
  Each component of the rotation speed is a multiplier following these rules:

  • 0 -> 1 Scales between 0 and the Walk speed
  • 1 -> 2 Scales between Walk speed and Run Speed
  • 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0)
    afRampTime is in seconds
• Found in:
  • Vanilla

  voidfunctionForceTargetDirection(floatafXAngle=0.0, floatafYAngle=0.0, floatafZAngle=0.0)NativeDebugOnly

  Sets the target movement direction on the actor
  afXAngle, afYAngle and afZAngle are in degrees

• Found in:
  • Vanilla

  voidfunctionForceTargetSpeed(floatafSpeed)NativeDebugOnly

  Sets the target movement speed on the actor
  afSpeedMult is a speed multiplier based on the current max speeds

  • 0 -> 1 Scales between 0 and the Walk speed
  • 1 -> 2 Scales between Walk speed and Run Speed
  • 2 and above is a multiplier of the run speed (less 1.0 since Run is 2.0)
• Found in:
  • Vanilla

  voidfunctionForceTargetAngle(floatafXAngle=0.0, floatafYAngle=0.0, floatafZAngle=0.0)NativeDebugOnly

  Sets the target facing angle on the actor
  afXAngle, afYAngle and afZAngle are in degrees

• Found in:
  • Vanilla

  voidfunctionClearForcedMovement()NativeDebugOnly

  Clears any forced movement on the actor and return it to its standard state

• Found in:
  • Vanilla

  boolfunctionCanMoveVertical()NativeDebugOnly

  Check to see if the actor can move vertically.

• Found in:
  • Vanilla

  boolfunctionCanStrafe()NativeDebugOnly

  Check to see if the actor can strafe side to side.

• Found in:
  • Vanilla

  ActorfunctionGetActorInDialogueWithRobot()NativeDebugOnly

  Check all possible dialogue targets for the actor the robot is speaking with, including the current scene's last target/speaker. Used by RobotQuestRunner for debugging purposes.