Editing ObjectReference Script

'''Extends:''' [[Form Script]]

Script for the manipulation of object instances.

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

== Properties ==
*Position
**float X [read-only]: The current X position of the reference.
**float Y [read-only]: The current Y position of the reference.
**float Z [read-only]: The current Z position of the reference.
*Motion
**int Motion_Fixed [0]:
**int Motion_Dynamic [1]:
**int Motion_Keyframed [2]:

== F4SE Structs ==
*Struct [[ConnectPoint Struct - ObjectReference|ConnectPoint]]
**A structure that holds property information about a connect point on a 3D model.

== Global Functions ==
None

== Member Functions ==
*Function [[Activate - ObjectReference|Activate]](ObjectReference akActivator, bool abDefaultProcessingOnly)
**Have the passed in reference activate this object.
*Function [[AddItem - ObjectReference|AddItem]](Form akItemToAdd, int aiCount, bool abSilent)
**Adds the passed in item to this object's inventory.
*Function [[AddKeyIfNeeded - ObjectReference|AddKeyIfNeeded]](ObjectReference ObjectWithNeededKey)
**Adds the key to ObjectWithNeededKey if this object's inventory does not contain it already.
*Function [[AddKeyword - ObjectReference|AddKeyword]](Keyword akKeyword)
**Adds passed in [[Keyword Script|Keyword]] to this reference's list of keywords.
*Function [[AddTextReplacementData - ObjectReference|AddTextReplacementData]](string asTokenLabel, Form akForm)
**Adds an association between the given string and the given form for text replacement usage.
*Function [[AddToMap - ObjectReference|AddToMap]](bool abAllowFastTravel)
**Adds this map marker to the map, optionally making it available for fast travel.
*Function [[ApplyConveyorBelt - ObjectReference|ApplyConveyorBelt]](string aTarget, float aLinVelX, float aLinVelY, float aLinVelZ, bool abOn, bool abReverse)
**Applies a conveyor belt to the reference
*Function [[ApplyFanMotor - ObjectReference|ApplyFanMotor]](string aTarget, float aAxisX, float aAxisY, float aAxisZ, float aForce, bool abOn)
**Applies a fan motor to the reference
*Function [[ApplyHavokImpulse - ObjectReference|ApplyHavokImpulse]](float afX, float afY, float afZ, float afMagnitude)
**Apply a Havok impulse force to this object.
*Function [[AttachMod - ObjectReference|AttachMod]](ObjectMod akMod, int aiAttachIndex)
**Attach a mod to this object
*Function [[AttachModToInventoryItem - ObjectReference|AttachModToInventoryItem]](Form akItem, ObjectMod akMod)
**Attach a mod to an item in this Object's inventory
*Function [[AttachTo - ObjectReference|AttachTo]](ObjectReference akParent)
**Attaches this reference to the specified parent
*Function [[BlockActivation - ObjectReference|BlockActivation]](bool abBlocked, bool abHideActivateText)
**Blocks (or un-blocks) normal activation processing for this reference, potentially also hiding activate text.
*int Function [[CalculateEncounterLevel - ObjectReference|CalculateEncounterLevel]](int aiDifficulty)
**Calculate this object's encounter level, using the specified difficulty.
*bool Function [[CanFastTravelToMarker - ObjectReference|CanFastTravelToMarker]]()
**Can the player fast travel to this map marker?
*bool Function [[CanProduceForWorkshop - ObjectReference|CanProduceForWorkshop]]() native
**Can the reference produce resources for a Workshop?
*Function [[ClearDestruction - ObjectReference|ClearDestruction]]()
**Clears all effects of destruction from this object.
*Function [[ConveyorBeltOn - ObjectReference|ConveyorBeltOn]](bool abOn)
**Sets the On/Off state of the conveyor belt.
*int Function [[CountActorsLinkedToMe - ObjectReference|CountActorsLinkedToMe]](Keyword apLinkKeyword, Keyword apExcludeKeyword)
**Returns the number of instantiated Actors who have a linked ref to this reference
*int Function [[CountLinkedRefChain - ObjectReference|CountLinkedRefChain]](keyword apKeyword, int maxExpectedLinkedRefs)
**Counts the number of linked refs that are in a linked Ref chain
*int Function [[CountRefsLinkedToMe - ObjectReference|CountRefsLinkedToMe]](Keyword apLinkKeyword, Keyword apExcludeKeyword)	
**Returns the number of instantiated ObjectReferences who have a LinkedRef to this reference
*Function [[CreateDetectionEvent - ObjectReference|CreateDetectionEvent]](Actor akOwner, int aiSoundLevel)
**Create a detection event at this reference, with the specified owner.
*Function [[DamageObject - ObjectReference|DamageObject]](float afDamage)
**Damages this object and advances the destruction stage.
*Function [[DamageValue - ObjectReference|DamageValue]](ActorValue akAV, float afDamage)
** Damages the given actor value
*Function [[Delete - ObjectReference|Delete]]()
**Deletes this object.
*Function [[DeleteWhenAble - ObjectReference|DeleteWhenAble]]()
**Waits until this reference is out of the loaded area and then deletes it
*Function [[Disable - ObjectReference|Disable]](bool abFadeOut)
**Disables this object.
*Function [[DisableLinkChain - ObjectReference|DisableLinkChain]](Keyword apKeyword, bool abFadeOut)
**Disables all of the references that are linked, in a chain, to this one.
*Function [[DisableNoWait - ObjectReference|DisableNoWait]](bool abFadeOut)
**Disables this object and does not wait for the object to be disable or faded out.
*Function [[Drop - ObjectReference|Drop]](bool abSilent)
**Drops this object from the container that it is in.
*ObjectReference Function [[DropFirstObject - ObjectReference|DropFirstObject]]()
**Drops the "first" object in the container.
*Function [[DropObject - ObjectReference|DropObject]](Form akObject, int aiCount)
**Drops the specified object from this object's inventory.
*Function [[Enable - ObjectReference|Enable]](bool abFadeIn)
**Enables this object.
*Function [[EnableFastTravel - ObjectReference|EnableFastTravel]](bool abEnable)
**Enables or disables fast travel to this map marker.
*Function [[EnableLinkChain - ObjectReference|EnableLinkChain]](Keyword apKeyword, bool abFadeIn)
**Enables all of the references that are linked, in a chain, to this one.
*Function [[EnableNoWait - ObjectReference|EnableNoWait]](bool abFadeIn)
**Enables this object and does not wait for the object to be enabled or faded in.
*Function [[FanMotorOn - ObjectReference|FanMotorOn]](bool abOn)
**Sets a fan motor on/off state
*ObjectReference[] Function [[FindAllReferencesOfType - ObjectReference|FindAllReferencesOfType]](Form akObjectOrList, float afRadius) native
**Finds all references to the given object or objects in the given list in the loaded area within the given radius of the calling ref and returns an array of them
*ObjectReference[] Function [[FindAllReferencesWithKeyword - ObjectReference|FindAllReferencesWithKeyword]](Form akKeywordOrList, float afRadius) native
**Finds all references with the given keyword or matching all keywords in the given list in the loaded area within the given radius of the calling ref and returns an array of them
*Function [[ForceAddRagdollToWorld - ObjectReference|ForceAddRagdollToWorld]]() native
**Forcibly adds the ragdoll of a reference to the world
*Function [[ForceRemoveRagdollFromWorld - ObjectReference|ForceRemoveRagdollFromWorld]]() native
**Forcibly removes the ragdoll of a reference from the world
*ActorBase Function [[GetActorOwner - ObjectReference|GetActorOwner]]()
**Obtains the actor base that owns this object.
*Actor Function [[GetActorRefOwner - ObjectReference|GetActorRefOwner]]()
**Obtains the actor that owns this object - if owned by a specific actor reference.
*Actor[] Function [[GetActorsLinkedToMe - ObjectReference|GetActorsLinkedToMe]](Keyword apLinkKeyword, Keyword apExcludeKeyword)
**Gets an array of instantiated Actors who are linked to this reference
*float Function [[GetAngleX - ObjectReference|GetAngleX]]()
**Obtains this object's rotation around the x axis.
*float Function [[GetAngleY - ObjectReference|GetAngleY]]()
**Obtains this object's rotation around the y axis.
*float Function [[GetAngleZ - ObjectReference|GetAngleZ]]()
**Obtains this object's rotation around the z axis.
*bool Function [[GetAnimationVariableBool - ObjectReference|GetAnimationVariableBool]](string asVariableName)
**Fetches the value of a variable on the reference's animation graph (bool version).
*float Function [[GetAnimationVariableFloat - ObjectReference|GetAnimationVariableFloat]](string asVariableName)
**Fetches the value of a variable on the reference's animation graph (float version).
*int Function [[GetAnimationVariableInt - ObjectReference|GetAnimationVariableInt]](string asVariableName)
**Fetches the value of a variable on the reference's animation graph (int version).
*Form Function [[GetBaseObject - ObjectReference|GetBaseObject]]()
**Obtains this reference's base object.
*float Function [[GetBaseValue - ObjectReference|GetBaseValue]](ActorValue akAV)
**Gets the base value of the specified actor value - returns 0 and logs an error if the value is unknown
*int Function [[GetComponentCount - ObjectReference|GetComponentCount]](Form akItem)
**Counts the number of components in this object's inventory
*ObjectReference Function [[GetContainer - ObjectReference|GetContainer]]()
**Obtains the container this reference is in, if any.
*int Function [[GetCurrentDestructionStage - ObjectReference|GetCurrentDestructionStage]]()
**Gets the object's current stage of destruction.
*Location Function [[GetCurrentLocation - ObjectReference|GetCurrentLocation]]()
**Obtains this reference's current location.
*Scene Function [[GetCurrentScene - ObjectReference|GetCurrentScene]]()
**Obtains the scene that this reference is currently participating in, if any.
*float Function [[GetDistance - ObjectReference|GetDistance]](ObjectReference akOther)
**Calculates the distance between this object and the passed in one.
*Location Function [[GetEditorLocation - ObjectReference|GetEditorLocation]]()
**Obtains this reference's editor location.
*EncounterZone Function [[GetEncounterZone - ObjectReference|GetEncounterZone]]()
**Obtains this reference's encounter zone.
*Faction Function [[GetFactionOwner - ObjectReference|GetFactionOwner]]()
**Gets the faction that owns this reference.
*float Function [[GetHeadingAngle - ObjectReference|GetHeadingAngle]](ObjectReference akOther)
**Gets the angle between this object's heading, and the direction the other object is in.
*float Function [[GetHeight - ObjectReference|GetHeight]]()
**Gets the height of this object
*int Function [[GetInventoryValue - ObjectReference|GetInventoryValue]]()
**Gets the value of all items in this object's inventory.
*int Function [[GetItemCount - ObjectReference|GetItemCount]](Form akItem)
**Returns how many of the specified item is in this object's inventory.
*float Function [[GetItemHealthPercent - ObjectReference|GetItemHealthPercent]]()
**Returns the item health percent of this object (1.0 == 100%).
*Key Function [[GetKey - ObjectReference|GetKey]]()
**Obtains the key that unlocks this object (if any).
*float Function [[GetLength - ObjectReference|GetLength]]()
**Obtains the length of this object.
*ObjectReference Function [[GetLinkedRef - ObjectReference|GetLinkedRef]](Keyword apKeyword)
**Returns our linked reference for the given Keyword, if any.
*ObjectReference[] Function [[GetLinkedRefChain - ObjectReference|GetLinkedRefChain]](Keyword apKeyword, int iMaxExpectedLinkedRefs)
**Returns an array listing every linked ref in a chain from this one.
*ObjectReference[] Function [[GetLinkedRefChildren - ObjectReference|GetLinkedRefChildren]](keyword apKeyword) native
**Returns an array of linked reference children which were linked using the given keyword
*int Function [[GetLockLevel - ObjectReference|GetLockLevel]]()
**Obtains the level of the lock on this object.
*LocationRefType[] Function [[GetLocRefTypes - ObjectReference|GetLocRefTypes]]()
**Gets the location ref type for this object.
*float Function [[GetMass - ObjectReference|GetMass]]()
**Obtains this object's mass in Havok.
*ObjectReference Function [[GetNthLinkedRef - ObjectReference|GetNthLinkedRef]](int aiLinkedRef, Keyword apKeyword)
**Obtains the nth linked ref from this object.
*int Function [[GetOpenState - ObjectReference|GetOpenState]]()
**Obtains this object's current "open state".
*Cell Function [[GetParentCell - ObjectReference|GetParentCell]]()
**Obtains the cell this object is currently in.
*float Function [[GetPositionX - ObjectReference|GetPositionX]]()
**Returns this object's current X position.
*float Function [[GetPositionY - ObjectReference|GetPositionY]]()
**Returns this object's current Y position.
*float Function [[GetPositionZ - ObjectReference|GetPositionZ]]()
**Returns this object's current Z position.
*float Function [[GetRadioFrequency - ObjectReference|GetRadioFrequency]]()
**Get this radio receiver's frequency
*float Function [[GetRadioVolume - ObjectReference|GetRadioVolume]]()
**Get this radio receiver's volume
*ObjectReference[] Function [[GetRefsLinkedToMe - ObjectReference|GetRefsLinkedToMe]](Keyword apLinkKeyword, Keyword apExcludeKeyword)
**Gets an array of all instantiated ObjectReferences that are linked to this reference
*float Function [[GetResourceDamage - ObjectReference|GetResourceDamage]](ActorValue akAV)
**Get the total damage, if any, of the given resource or of all nonzero resource actor values.
*float[] Function [[GetSafePosition - ObjectReference|GetSafePosition]](float aSearchRadius, float aSafeRadius)
**Get the nearest navmesh 'safe' position of radius aSafeRadius within aSearchRadius.
*float Function [[GetScale - ObjectReference|GetScale]]()
**Get this object's current scale.
*Cell Function [[GetTeleportCell - ObjectReference|GetTeleportCell]]()
**Gets the target cell for this teleport ref
*Cell Function [[GetTransitionCell - ObjectReference|GetTransitionCell]]()
**Gets the transition cell for this teleport ref
*float Function [[GetTransmitterDistance - ObjectReference|GetTransmitterDistance]]()
**Returns the distance from this transmitter to the player.
*int Function [[GetTriggerObjectCount - ObjectReference|GetTriggerObjectCount]]()
**Returns the number of objects inside this trigger volume.
*float Function [[GetValue - ObjectReference|GetValue]](ActorValue akAV)
**Gets the specified actor value - returns 0 and logs an error if the value is unknown
*float Function [[GetValuePercentage - ObjectReference|GetValuePercentage]](ActorValue akAV)
**Gets the specified actor value as a percentage of its max value - from 0 to 1
*ObjectReference[] Function [[GetWorkshopOwnedObjects - ObjectReference|GetWorkshopOwnedObjects]](Actor akActor)
**Gets all object references owned by the Actor for this workshop.
*float Function [[GetWorkshopResourceDamage - ObjectReference|GetWorkshopResourceDamage]](ActorValue akValue) native
**Get the total damage, if any, on all producers of the given resource in the Workshop.
*ObjectReference[] Function [[GetWorkshopResourceObjects - ObjectReference|GetWorkshopResourceObjects]](ActorValue akAV)
**Gets all object references that produce resources for this workshop - optionally filtering by what resource they produce.
*VoiceType function [[GetVoiceType - ObjectReference|GetVoiceType]]()
**Obtains the [[VoiceType Script|VoiceType]] for this actor or talking activator.
*float Function [[GetWidth - ObjectReference|GetWidth]]()
**Get the current width of the object.
*Worldspace Function [[GetWorldSpace - ObjectReference|GetWorldSpace]]()
**Returns the worldspace this reference is in.
*bool Function [[HasActorRefOwner - ObjectReference|HasActorRefOwner]]()
**Returns whether this object has an actor ref owner (even if the actor isn't currently persisting).
*bool Function [[HasDirectLOS - ObjectReference|HasDirectLOS]](ObjectReference akTarget, string asSourceNode, string asTargetNode)
**Checks to see if there is a direct line of sight between this ref and another ref.
*bool Function [[HasEffectKeyword - ObjectReference|HasEffectKeyword]](Keyword akKeyword)
**Returns if this reference has an active effect coming from a magic effect with the specified keyword attached
*bool Function [[HasKeyword - ObjectReference|HasKeyword]](Keyword akKeyword)
**Returns if this reference has the specified [[Keyword Script|Keyword]] in its list of keywords.
*bool Function [[HasKeywordInFormList - ObjectReference|HasKeywordInFormList]](FormList akKeywordList)
**Returns if this reference has any of the keywords in the [[FormList Script|FormList]] in its list of keywords.
*bool Function [[HasLocRefType - ObjectReference|HasLocRefType]](LocationRefType akRefType)
**Returns if this reference has the specified [[LocationRefType Script|LocationRefType]] attached.
*bool Function [[HasNode - ObjectReference|HasNode]](string asNodeName)
**Returns if this reference has the specified name node in its 3D.
*bool Function [[HasOwner - ObjectReference|HasOwner]]()
**Is this ref owned?
*bool Function [[HasSharedPowerGrid - ObjectReference|HasSharedPowerGrid]](ObjectReference akCompare)
**Returns true if this reference is on the same power grid as the compare reference.
*Function [[IgnoreFriendlyHits - ObjectReference|IgnoreFriendlyHits]](bool abIgnore)
**Flags this reference as ignoring (or not ignoring) friendly hits
*Function [[InterruptCast - ObjectReference|InterruptCast]]()
**Interrupts any spellcasting this object may be doing.
*bool Function [[IsActivateChild - ObjectReference|IsActivateChild]](ObjectReference akChild)
**Returns whether the passed in reference is an activate child of this reference.
*bool Function [[IsActivationBlocked - ObjectReference|IsActivationBlocked]]()
**Returns whether normal activation processing is currently blocked on this reference or not.
*bool Function [[Is3DLoaded - ObjectReference|Is3DLoaded]]()
**Checks to see if this reference's 3D data is currently loaded or not.
*bool Function [[IsCreated - ObjectReference|IsCreated]]()
**Was this object created in-game?
*bool Function [[IsConveyorBeltOn - ObjectReference|IsConveyorBeltOn]]()
**Get conveyor belt on/off state
*bool Function [[IsDeleted - ObjectReference|IsDeleted]]()
**Is this object currently flagged for delete?
*bool Function [[IsDestroyed - ObjectReference|IsDestroyed]]()
**Is this object currently destroyed?
*bool Function [[IsDisabled - ObjectReference|IsDisabled]]()
**Is this object currently disabled?
*bool Function [[IsEnabled - ObjectReference|IsEnabled]]()
**Is this object currently enabled?
*bool Function [[IsFanMotorOn - ObjectReference|IsFanMotorOn]]()
**Get fan motor on/off state
*bool Function [[IsFurnitureInUse - ObjectReference|IsFurnitureInUse]](bool abIgnoreReserved)
**Is any furniture marker on this object in use?
*bool Function [[IsFurnitureMarkerInUse - ObjectReference|IsFurnitureMarkerInUse]](int aiMarker, bool abIgnoreReserved)
**Is the specified furniture marker on this object in use?
*bool Function [[IsIgnoringFriendlyHits - ObjectReference|IsIgnoringFriendlyHits]]()
**Is this object ignoring friendly hits?
*bool Function [[IsInDialogueWithPlayer - ObjectReference|IsInDialogueWithPlayer]]()
**Is this actor or talking activator currently talking to the player?
*bool Function [[IsInInterior - ObjectReference|IsInInterior]]()
**Returns true if the object is in an interior cell.
*bool Function [[IsInLocation - ObjectReference|IsInLocation]](Location akLocation)
**Returns true if the object is currently in that location or a child of that location.
*bool Function [[IsLockBroken - ObjectReference|IsLockBroken]]()
**Is the lock on this object broken?
*bool Function [[IsLocked - ObjectReference|IsLocked]]()
**Is the lock on this object locked?
*bool Function [[IsMapMarkerVisible - ObjectReference|IsMapMarkerVisible]]()
**Is this map marker visible to the player?
*bool Function [[IsNearPlayer - ObjectReference|IsNearPlayer]]()
**A quick-and-dirty function to tell if this object is safe to enable or disable
*bool Function [[IsOwnedBy - ObjectReference|IsOwnedBy]](Actor akOwner)
**Is this ref owned by the given actor?
*bool Function [[IsPowered - ObjectReference|IsPowered]]()
**Is this object currently powered?
*bool Function [[IsQuestItem - ObjectReference|IsQuestItem]]() native
**Is this reference a quest item?
*bool Function [[IsRadioOn - ObjectReference|IsRadioOn]]()
**Is this radio turned on?
*bool Function [[IsRefInTransitionCell - ObjectReference|IsRefInTransitionCell]](ObjectReference akRef)
**Is the given ref in the bounds of this teleport ref's transformed transition cell?
*bool Function [[IsTeleportAreaLoaded - ObjectReference|IsTeleportAreaLoaded]]()
**Is the area this ref teleports to fully loaded?
*bool Function [[IsWithinBuildableArea - ObjectReference|IsWithinBuildableArea]](ObjectReference akRef)
**Is this ref within the specified Workshop Activator's buildable area?
*Function [[KnockAreaEffect - ObjectReference|KnockAreaEffect]](float afMagnitude, float afRadius)
**Executes a knock effect to an area
*Function [[Lock - ObjectReference|Lock]](bool abLock, bool abAsOwner)
**Locks or unlocks this object.
*Function [[MakeRadioReceiver - ObjectReference|MakeRadioReceiver]](float afFrequency, float afVolume, OutputModel aOverrideModel, bool abActive, bool abNoStatic)
**Make this object a radio receiver. Override the current state if the object is already a receiver.
*Function [[MakeTransmitterRepeater - ObjectReference|MakeTransmitterRepeater]](ObjectReference akTransmitterToRepeat, float afInnerRadius, float afOuterRadius, bool abUnlimitedRange)
**Make this object into a radio transmitter-repeater
*Function [[ModValue - ObjectReference|ModValue]](ActorValue akAV, float afAmount)
** Modifies the specified actor value
*Function [[MoveTo - ObjectReference|MoveTo]](ObjectReference akTarget, float afXOffset, float afYOffset, float afZOffset, bool abMatchRotation)
**Moves this object to the same location as the passed-in reference, offset by the specified amount.
*bool Function [[MoveToIfUnloaded - ObjectReference|MoveToIfUnloaded]](ObjectReference akTarget, float afXOffset, float afYOffset, float afZOffset)
**Moves this object to the same location as the passed-in reference, offset by the specified amount, IF this object is not currently loaded.
*Function [[MoveToMyEditorLocation - ObjectReference|MoveToMyEditorLocation]]()
**Moves this object to its own editor location.
*Function [[MoveToNearestNavmeshLocation - ObjectReference|MoveToNearestNavmeshLocation]]() native
**Moves this object to the nearest location on a Navmesh
*Function [[MoveToNode - ObjectReference|MoveToNode]](ObjectReference akTarget, string asNodeName)
**Moves this object to the position (and rotation) of the specified node on the specified object's 3D
*Function [[OpenWorkshopSettlementMenu - ObjectReference|OpenWorkshopSettlementMenu]](Keyword akActionKW, Message astrConfirm, Location aLocToHighlight)
**Opens the workshop caravan menu for this workshop object.
*Function [[OpenWorkshopSettlementMenuEx - ObjectReference|OpenWorkshopSettlementMenuEx]](Keyword akActionKW, Message astrConfirm, Location aLocToHighlight, FormList akIncludeKeywordList, FormList akExcludeKeywordList, bool abExcludeZeroPopulation)
**Opens the workshop caravan menu for this workshop object.
*Function [[PauseAudio - ObjectReference|PauseAudio]]()
**Pauses audio being played by this reference.
*Actor Function [[PlaceActorAtMe - ObjectReference|PlaceActorAtMe]](ActorBase akActorToPlace, int aiLevelMod, EncounterZone akZone)
**Create an actor at this object's location.
*ObjectReference Function [[PlaceAtMe - ObjectReference|PlaceAtMe]](Form akFormToPlace, int aiCount, bool abForcePersist, bool abInitiallyDisabled, bool abDeleteWhenAble)
**Places x copies of the passed in form at this object's current position, returning the last one created.
*ObjectReference Function [[PlaceAtNode - ObjectReference|PlaceAtNode]](String asNodeName, Form akFormToPlace, int aiCount, bool abForcePersist, bool abInitiallyDisabled, bool abDeleteWhenAble, bool abAttach)
**Places x copies of the passed in form at the position of the given node on the object's 3D, returning the last one created.
*bool Function [[PlayAnimation - ObjectReference|PlayAnimation]](string asAnimation)
**Plays the specified animation on this object, returning immediately.
*bool Function [[PlayAnimationAndWait - ObjectReference|PlayAnimationAndWait]](string asAnimation, string asEventName)
**Plays the specified animation on this object and waits for the specified event before returning. (latent)
*bool Function [[PlayGamebryoAnimation - ObjectReference|PlayGamebryoAnimation]](string asAnimation, bool abStartOver, float afEaseInTime)
**Plays a legacy nif file based animation
*bool Function [[PlayImpactEffect - ObjectReference|PlayImpactEffect]](ImpactDataSet akImpactEffect, string asNodeName, float afPickDirX, float afPickDirY, float afPickDirZ, float afPickLength, bool abApplyNodeRotation, bool abUseNodeLocalRotation)
**Plays an impact effect.
*bool Function [[PlaySyncedAnimationAndWaitSS - ObjectReference|PlaySyncedAnimationAndWaitSS]](string asAnimation1, string asEvent1, ObjectReference akObj2, string asAnimation2, string asEvent2)
**Plays two animations simultaneously, waiting for events from both.
*bool Function [[PlaySyncedAnimationSS - ObjectReference|PlaySyncedAnimationSS]](string asAnimation1, ObjectReference akObj2, string asAnimation2)
**Plays two animations simultaneously.
*Function [[PlayTerrainEffect - ObjectReference|PlayTerrainEffect]](string asEffectModelName, string asAttachBoneName)
**Plays a terrain effect.
*Function [[PreloadExteriorCell - ObjectReference|PreloadExteriorCell]]()
**Preloads the single exterior cell containing the ref.
*Function [[PreloadTargetArea - ObjectReference|PreloadTargetArea]]()
**Preloads the target area for the ref.
*Function [[ProcessTrapHit - ObjectReference|ProcessTrapHit]](ObjectReference akTrap, float afDamage, float afPushback, float afXVel, float afYVel, float afZVel, float afXPos, float afYPos, float afZPos, int aeMaterial, float afStagger)
**Tells this object to handle the specified trap object hitting it.
*Function [[PushActorAway - ObjectReference|PushActorAway]](Actor akActorToPush, int aiKnockbackDamage)
**Pushes the other actor away from this object as if hit by the specified amount of knockback damage.
*int Function [[RaidTargetsAvailable - ObjectReference|RaidTargetsAvailable]](Keyword akActionKW, Message astrConfirm, Location aLocToHighlight, FormList akIncludeKeywordList, FormList akExcludeKeywordList, bool abExcludeZeroPopulation, bool abOnlyOwnedWorkshops, bool abTurnOffHeader, bool abOnlyPotentialVassalSettlements, bool abDisableReservedByQuests) native
*bool Function [[RampRumble - ObjectReference|RampRumble]](float power, float duration, float falloff)
**Shakes cam/controller based on distance from player
*Function [[RecalculateResources - ObjectReference|RecalculateResources]]()
**Tells this workbench to recalculate all workshop actor values
*Function [[RemoveAllItems - ObjectReference|RemoveAllItems]](ObjectReference akTransferTo, bool abKeepOwnership)
**Removes all items from this container, optionall transferring them to another one.
*Function [[RemoveAllMods - ObjectReference|RemoveAllMods]]()
**Removes every single mod attached to this reference. (Warning: For some actors/items this will leave no rendering geometry at all!)
*Function [[RemoveAllModsFromInventoryItem - ObjectReference|RemoveAllModsFromInventoryItem]](Form akItem)
**Removes every single mod attach to an item in this reference's inventory. Note: Some items won't have any geometry if you do this (handmade guns, for example).
*Function [[RemoveComponents - ObjectReference|RemoveComponents]](Component akComponent, int aiCount, bool abSilent = false) native
**Removes components from the container, scrapping as necessary and returning change.
*Function [[RemoveItem - ObjectReference|RemoveItem]](Form akItemToRemove, int aiCount, bool abSilent, ObjectReference akOtherContainer)
**Removes the passed in item from this object's inventory.
*Function [[RemoveItemByComponent - ObjectReference|RemoveItemByComponent]](Form akComponentToRemove, int aiCount, bool abSilent, ObjectReference akOtherContainer)
**Removes items from this object's inventory containing at least the number of components specified, potentially more.
*Function [[RemoveKeyword - ObjectReference|RemoveKeyword]](Keyword akKeyword)
**Removes specified [[Keyword Script|Keyword]] from this reference's list of keywords. Returns true if successfully removed.
*Function [[RemoveMod - ObjectReference|RemoveMod]](ObjectMod akMod)
**Remove the requested mod from the reference
*Function [[RemoveModFromInventoryItem - ObjectReference|RemoveModFromInventoryItem]](Form akItem, ObjectMod akMod)
**Remove the requested mod from an item in this reference's inventory
*Function [[Repair - ObjectReference|Repair]]()
**Repair this object reference. Primarily for Workshop items.
*Function [[Reset - ObjectReference|Reset]](ObjectReference akTarget)
**Resets this object reference, optionally placing the object at the new target.
*Function [[ResetKeyword - ObjectReference|ResetKeyword]](Keyword akKeyword)
**Removes AddKeyword/RemoveKeyword modifications, allowing the base object and aliases to control it again.
*Function [[RestoreValue - ObjectReference|RestoreValue]](ActorValue akAV, float afAmount)
** Restores damage done to the actor value(up to 0 damage)
*Function [[ResumeAudio - ObjectReference|ResumeAudio]]()
** Resumes paused audio on this reference.
*Function [[ReverseConveyorBelt - ObjectReference|ReverseConveyorBelt]](bool abReverse)
** Sets reverse state of conveyor belt
*Function [[Say - ObjectReference|Say]](Topic akTopicToSay, Actor akActorToSpeakAs, bool abSpeakInPlayersHead, ObjectReference akTarget)
**Causes this reference to speak a topic as if it were the specified actor.
*Function [[SayCustom - ObjectReference|SayCustom]](Keyword akKeywordToSay, Actor akActorToSpeakAs, bool abSpeakInPlayersHead, ObjectReference akTarget)
**Causes this reference to speak a keyworded topic as if it were the specified actor.
*int Function [[SellItem - ObjectReference|SellItem]](Form Item, int Value, int amountToSell, bool silent, form paymentItem, objectReference PaymentContainer)
**"Sells" an item for the specified payment (will NOT trigger OnSell events because it's not a real sale)
*Function [[SendStealAlarm - ObjectReference|SendStealAlarm]](Actor akThief)
**Sends a steal alarm as if this reference had just been stolen by the actor.
*Function [[SetActivateTextOverride - ObjectReference|SetActivateTextOverride]](Message akText)
**Sets the full name of the given message to be this ref's activate text.
*Function [[SetActorCause - ObjectReference|SetActorCause]](Actor akActor)
**Sets this actor as this object's actor cause.
*Function [[SetActorOwner - ObjectReference|SetActorOwner]](ActorBase akActorBase, bool abNoCrime)
**Sets this actor base as this object's owner.
*Function [[SetActorRefOwner - ObjectReference|SetActorRefOwner]](Actor akActor, bool abNoCrime)
**Sets this particular actor as this object's owner.
*Function [[SetAngle - ObjectReference|SetAngle]](float afXAngle, float afYAngle, float afZAngle)
**Sets this object's rotation. Angles are in degrees.
*Function [[SetAnimationVariableBool - ObjectReference|SetAnimationVariableBool]](string asVariableName, bool abNewValue)
**Sets the value of a variable on the reference's animation graph (bool version).
*Function [[SetAnimationVariableFloat - ObjectReference|SetAnimationVariableFloat]](string asVariableName, float afNewValue)
**Sets the value of a variable on the reference's animation graph (float version).
*Function [[SetAnimationVariableInt - ObjectReference|SetAnimationVariableInt]](string asVariableName, int aiNewValue)
**Sets the value of a variable on the reference's animation graph (int version).
*Function [[SetAttractionActive - ObjectReference|SetAttractionActive]](Keyword apKeyword, bool abActive)
**Enable/disable this object from sending attraction story manager events.
*Function [[SetConveyorBeltVelocity - ObjectReference|SetConveyorBeltVelocity]](float aLinVelX, float aLinVelY, float aLinVelZ)
**Sets local-space linear velocity of the conveyor belt
*Function [[SetDestroyed - ObjectReference|SetDestroyed]](bool abDestroyed)
**Sets or clears this object's destroyed flag.
*Function [[SetDirectAtTarget - ObjectReference|SetDirectAtTarget]](ObjectReference akTarget)
**Sets or clears the target of the direct-at behavior modifier.
*Function [[SetFactionOwner - ObjectReference|SetFactionOwner]](Faction akFaction, bool abNoCrime)
**Sets this faction as this object's owner.
*Function [[SetHarvested - ObjectReference|SetHarvested]](bool abHarvested) native
**Marks the object as Harvested or not Harvested (if it's Flora)
*Function [[SetLinkedRef - ObjectReference|SetLinkedRef]](ObjectReference apRef, Keyword apKeyword)
**Links this ref to the given one under the given keyword
*Function [[SetLockLevel - ObjectReference|SetLockLevel]](int aiLockLevel)
**Sets the lock level on this object.
*Function [[SetLocRefType - ObjectReference|SetLocRefType]](Location akLoc, LocationRefType akRefType)
**Sets the this in-game created object as the given loc ref type for the given location.
*Function [[SetMotionType - ObjectReference|SetMotionType]](int aiMotionType, bool abAllowActivate)
**Sets the havok motion type on this object.
*Function [[SetNoFavorAllowed - ObjectReference|SetNoFavorAllowed]](bool abNoFavor)
**Sets or clears this object's ability to be not used by a teammate for a favor 
*Function [[SetOpen - ObjectReference|SetOpen]](bool abOpen)
**Opens or closes this object.
*Function [[SetPersistLoc - ObjectReference|SetPersistLoc]](Location akLoc)
**Sets the persist location on this in-game created object.
*Function [[SetPlayerHasTaken - ObjectReference|SetPlayerHasTaken]](bool abTaken)
**Sets/clears the 'player has taken' flag on this object.
*Function [[SetPosition - ObjectReference|SetPosition]](float afX, float afY, float afZ)
**Sets this object's position.
*Function [[SetRadioFrequency - ObjectReference|SetRadioFrequency]](float afFrequency)
**Changes the frequency this radio is listening to
*Function [[SetRadioOn - ObjectReference|SetRadioOn]](bool abOn)
**Turns this radio on or off
*Function [[SetRadioVolume - ObjectReference|SetRadioVolume]](float afVolume)
**Changes the volume of this radio
*Function [[SetScale - ObjectReference|SetScale]](float afScale)
**Set the current scale of the object
*Function [[SetValue - ObjectReference|SetValue]](ActorValue akAV, float afValue)
** Sets the specified actor value
*Function [[SplineTranslateTo - ObjectReference|SplineTranslateTo]](float afX, float afY, float afZ, float afAngleX, float afAngleY, float afAngleZ, float afSplineCurve, float afSpeed, float afMaxRotationSpeed)
**Makes the object translate to the given pos/orient on a spline.
*Function [[SplineTranslateToRef - ObjectReference|SplineTranslateToRef]](ObjectReference arTarget, float afTangentMagnitude, float afSpeed, float afMaxRotationSpeed)
**Makes the reference translate to the target ref position/orient on a spline at the given speed
*Function [[SplineTranslateToRefNode - ObjectReference|SplineTranslateToRefNode]](ObjectReference arTarget, string arNodeName, float afTangentMagnitude, float afSpeed, float afMaxRotationSpeed)
**Makes the reference translate to the target node's position/orient on a spline at the given speed
*Function [[StartWorkshop - ObjectReference|StartWorkshop]](bool abStart)
**Starts or stops workshop mode on this workshop object.
*Function [[StopTranslation - ObjectReference|StopTranslation]]()
**Stops any translation on the object.
*Function [[StoreInWorkshop - ObjectReference|StoreInWorkshop]](Form akBaseItem, int aiCount)
**If the reference is a Workshop, stores the given object with an optional count.
*Function [[TetherToHorse - ObjectReference|TetherToHorse]](ObjectReference akHorse)
**Tether a prisoner cart to the given horse.
*Function [[TranslateTo - ObjectReference|TranslateTo]](float afX, float afY, float afZ, float afAngleX, float afAngleY, float afAngleZ, float afSpeed, float afMaxRotationSpeed)
**Makes the object translate to the given pos/orient.
*Function [[TranslateToRef - ObjectReference|TranslateToRef]](ObjectReference arTarget, float afSpeed, float afMaxRotationSpeed)
**Makes the reference translate to the target ref position/orient at the given speed
*Function [[Unlock - ObjectReference|Unlock]](bool abAsOwner)
**Unlocks this reference
*bool Function [[WaitFor3DLoad - ObjectReference|WaitFor3DLoad]]()
**Waits for this object's 3d to load - or until it knows it won't load.
*bool Function [[WaitForAnimationEvent - ObjectReference|WaitForAnimationEvent]](string asEventName)
**Waits for the animation graph to send the specified event.
*Function [[WaitForWorkshopResourceRecalc - ObjectReference|WaitForWorkshopResourceRecalc]]()
**Waits for resource recalculation on this workshop to finish.

== F4SE Member Functions ==
*MatSwap:RemapData[] Function [[ApplyMaterialSwap - ObjectReference|ApplyMaterialSwap]](MatSwap mSwap, bool renameMaterial = false)
**Applies a material swap to this reference, optionally renaming the material.

*ObjectReference Function [[AttachWire - ObjectReference|AttachWire]](ObjectReference akRef, Form akSpline = None)
**Attach akSpline between two ObjectReferences, and return the created spline.

*ObjectReference Function [[CreateWire - ObjectReference|CreateWire]](ObjectReference akRef, Form akSpline = None)
**Attach akSpline between two ObjectReferences, then enable and return the created spline.

*ObjectMod[] Function [[GetAllMods - ObjectReference|GetAllMods]]()
**Returns all the mods for this reference.

*ConnectPoint[] Function [[GetConnectPoints - ObjectReference|GetConnectPoints]]()
**Returns all the connect points for this reference's 3D model.

*ObjectReference[] Function [[GetConnectedObjects - ObjectReference|GetConnectedObjects]]()
**Returns the ObjectReferences this object is connected to.

*string Function [[GetDisplayName - ObjectReference|GetDisplayName]]()
**Returns the display name for this reference.

*Form[] Function [[GetInventoryItems - ObjectReference|GetInventoryItems]]()
**Returns all the inventory items for this reference.

*float Function [[GetInventoryWeight - ObjectReference|GetInventoryWeight]]()
**Returns inventory weight for this reference.

*MatSwap Function [[GetMaterialSwap - ObjectReference|GetMaterialSwap]]()
**Gets the material swap for this reference.

*Function [[SetMaterialSwap - ObjectReference|SetMaterialSwap]](MatSwap mSwap)
**Sets the material swap for this reference.

*bool Function [[TransmitConnectedPower - ObjectReference|TransmitConnectedPower]]()
**Links power to items connected by attach point.

== Events ==
*Event [[OnActivate - ObjectReference|OnActivate]](ObjectReference akActionRef)
**Event received when this object is activated.
*Event [[OnCellAttach - ObjectReference|OnCellAttach]]()
**Event received when this reference's parent cell attaches.
*Event [[OnCellDetach - ObjectReference|OnCellDetach]]()
**Event received when this reference's parent cell detaches.
*Event [[OnCellLoad - ObjectReference|OnCellLoad]]()
**Event received when everything in the cell that holds this reference has loaded.
*Event [[OnClose - ObjectReference|OnClose]](ObjectReference akActionRef)
**Event received when this object is finished closing.
*Event [[OnContainerChanged - ObjectReference|OnContainerChanged]](ObjectReference akNewContainer, ObjectReference akOldContainer)
**Event received when an object moves into/out of/between containers.
*Event [[OnDestructionStageChanged - ObjectReference|OnDestructionStageChanged]](int aiOldStage, int aiCurrentStage)
**Event received when this object's destruction stage has worsened.
*Event [[OnEquipped - ObjectReference|OnEquipped]](Actor akActor)
**Event received when this object is equipped by an actor.
*Event [[OnExitFurniture - ObjectReference|OnExitFurniture]](ObjectReference akActionRef)
**Event received when an actor exits this furniture.
*Event [[OnGrab - ObjectReference|OnGrab]]()
**Event received when this object is grabbed (z-keyed) by the player.
*Event [[OnHolotapeChatter - ObjectReference|OnHolotapeChatter]](string astrChatter, float afNumericData)
**Event received from holotape flash programs.
*Event [[OnHolotapePlay - ObjectReference|OnHolotapePlay]](ObjectReference akTerminalRef)
**Event received by a holotape when it is played in a terminal or pipboy
*Event [[OnItemAdded - ObjectReference|OnItemAdded]](Form akBaseItem, int aiItemCount, ObjectReference akItemReference, ObjectReference akSourceContainer)
**Event received when an item is inserted into this object's container.
*Event [[OnItemRemoved - ObjectReference|OnItemRemoved]](Form akBaseItem, int aiItemCount, ObjectReference akItemReference, ObjectReference akDestContainer)
**Event received when an item is removed from this object's container.
*Event [[OnLoad - ObjectReference|OnLoad]]()
**Event received when this object's 3d is loaded and ready.
*Event [[OnLockStateChanged - ObjectReference|OnLockStateChanged]]()
**Event received when the lock on this object changes its state.
*Event [[OnOpen - ObjectReference|OnOpen]](ObjectReference akActionRef)
**Event received when this object is fully opened.
*Event [[OnPipboyRadioDetection - ObjectReference|OnPipboyRadioDetection]](bool abDetected)
**Event received when the Pipboy enters/leaves the outer-radius of this radio ref.
*Event [[OnPlayerDialogueTarget - ObjectReference|OnPlayerDialogueTarget]]()
**Event received when this ref goes into dialogue scene with player.
*Event [[OnPowerOn - ObjectReference|OnPowerOn]](ObjectReference akPowerGenerator)
**Event received when a workshop item receives power for the first time.
*Event [[OnPowerOff - ObjectReference|OnPowerOff]]()
**Event received when a workshop item loses all supplied power.
*Event [[OnRead - ObjectReference|OnRead]]()
**Event received when this object is read. (Only applies to books)
*Event [[OnRelease - ObjectReference|OnRelease]]()
**Event received when this object is released by the player (stopped z-keying).
*Event [[OnReset - ObjectReference|OnReset]]()
**Event received when this object is reset.
*Event [[OnSell - ObjectReference|OnSell]](Actor akSeller)
**Event received when this object is sold by someone.
*Event [[OnSpellCast - ObjectReference|OnSpellCast]](Form akSpell)
**Event received when this object casts a spell.
*Event [[OnTrapHitStart - ObjectReference|OnTrapHitStart]](ObjectReference akTarget, float afXVel, float afYVel, float afZVel, float afXPos, float afYPos, float afZPos, int aeMaterial, bool abInitialHit, int aeMotionType)
**Event received when this trap object starts colliding with a target.
*Event [[OnTrapHitStop - ObjectReference|OnTrapHitStop]](ObjectReference akTarget)
**Event received when this trap object stops colliding with a target.
*Event [[OnTranslationAlmostComplete - ObjectReference|OnTranslationAlmostComplete]]()
**Event received when a translation request is almost complete.
*Event [[OnTranslationComplete - ObjectReference|OnTranslationComplete]]()
**Event received when a translation request is complete.
*Event [[OnTranslationFailed - ObjectReference|OnTranslationFailed]]()
**Event received when a translation request has failed.
*Event [[OnTriggerEnter - ObjectReference|OnTriggerEnter]](ObjectReference akActionRef)
**Event received when this object's volume is entered.
*Event [[OnTriggerLeave - ObjectReference|OnTriggerLeave]](ObjectReference akActionRef)
**Event received when this object's volume is left.
*Event [[OnUnequipped - ObjectReference|OnUnequipped]](Actor akActor)
**Event received when this object is unequipped by an actor.
*Event [[OnUnload - ObjectReference|OnUnload]]()
**Event received when this object's 3d has been unloaded.
*Event [[OnWorkshopNPCTransfer - ObjectReference|OnWorkshopNPCTransfer]](Location akNewWorkshop, Keyword akActionKW)
**Event received when this object is directed to a new workshop.
*Event [[OnWorkshopObjectDestroyed - ObjectReference|OnWorkshopObjectDestroyed]](ObjectReference akReference)
**Event received when a workshop item is removed from world and added back into this workshop.
*Event [[OnWorkshopMode - ObjectReference|OnWorkshopMode]](bool aStart)
**Event received when the player enters or exits workshop mode for this workshop.
*Event [[OnWorkshopObjectGrabbed - ObjectReference|OnWorkshopObjectGrabbed ]](ObjectReference akReference)
**Event received when an existing workshop item is grabbed for edit while in Workshop mode.
*Event [[OnWorkshopObjectMoved - ObjectReference|OnWorkshopObjectMoved]](ObjectReference akReference)
**Event received when an existing workshop item is moved in the world using this workshop.
*Event [[OnWorkshopObjectPlaced - ObjectReference|OnWorkshopObjectPlaced]](ObjectReference akReference)
**Event received when a workshop item is placed in the world using this workshop.
*Event [[OnWorkshopObjectRepaired - ObjectReference|OnWorkshopObjectRepaired]](ObjectReference akReference)
**Event received when a damaged workshop item is repaired


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