ObjectReference Script: Difference between revisions
Jump to navigation
Jump to search
imported>JBurgess |
m (Convert source tags to syntaxhighlight) |
||
| (24 intermediate revisions by 13 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Scripting]] |
|||
[[Category:Papyrus]] |
|||
[[Category:Script Objects]] |
|||
'''Extends:''' [[Form Script]] |
'''Extends:''' [[Form Script]] |
||
Script for the manipulation of object instances. |
Script for the manipulation of object instances. |
||
<br/>If you are adding a script to an object that is going to be a reference in the world (like a button for example) your script will need to extend this script. |
|||
== Definition == |
== Definition == |
||
< |
<syntaxhighlight lang="papyrus"> |
||
ScriptName ObjectReference extends Form |
ScriptName ObjectReference extends Form |
||
</syntaxhighlight> |
|||
</source> |
|||
== Properties == |
== Properties == |
||
| Line 16: | Line 13: | ||
*float Y [read-only]: The current Y 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. |
*float Z [read-only]: The current Z position of the reference. |
||
These properties are meant to be used when calling [[SetMotionType - ObjectReference|SetMotionType]]: |
|||
*int Motion_Dynamic [read-only]: 1 |
|||
*int Motion_SphereInertia [read-only]: 2 |
|||
*int Motion_BoxInertia [read-only]: 3 |
|||
*int Motion_Keyframed [read-only]: 4 |
|||
*int Motion_Fixed [read-only]: 5 |
|||
*int Motion_ThinBoxInertia [read-only]: 6 |
|||
*int Motion_Character [read-only]: 7 |
|||
== Global Functions == |
== Global Functions == |
||
| Line 21: | Line 26: | ||
== Member Functions == |
== Member Functions == |
||
*Function [[Activate - ObjectReference|Activate]](ObjectReference akActivator) |
|||
:'''[[Activate - ObjectReference|Activate]](ObjectReference ''akActivator'')''' |
|||
**Have the passed in reference activate this object. |
|||
:*Have the passed in reference activate this object. |
|||
*Function [[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]](Form akFilter) |
|||
**Adds an inventory event filter to this reference. |
|||
:'''[[AddInventoryEventFilter - ObjectReference|AddInventoryEventFilter]](Form ''akFilter'')''' |
|||
:*Adds an inventory event filter to this reference. |
|||
*Function [[AddKeyIfNeeded - ObjectReference|AddKeyIfNeeded]](ObjectReference ObjectWithNeededKey) |
|||
:'''[[AddItem - ObjectReference|AddItem]](Form ''akItemToAdd'', Int ''aiCount'', Bool ''abSilent'')''' |
|||
**Adds the key to ObjectWithNeededKey if this object's inventory does not contain it already. |
|||
:*Adds the passed in item to this object's inventory. |
|||
*Function [[AddToMap - ObjectReference|AddToMap]](bool abAllowFastTravel) |
|||
**Adds this map marker to the map, optionally making it available for fast travel. |
|||
:'''[[AddKeyIfNeeded - ObjectReference|AddKeyIfNeeded]](ObjectReference ''ObjectWithNeededKey'')''' |
|||
*Function [[ApplyHavokImpulse - ObjectReference|ApplyHavokImpulse]](float afX, float afY, float afZ, float afMagnitude) |
|||
:*Adds the key to ObjectWithNeededKey if this object's inventory does not contain it already. |
|||
**Apply a Havok impulse force to this object. |
|||
*Function [[BlockActivation - ObjectReference|BlockActivation]](bool abBlocked) |
|||
:'''[[AddToMap - ObjectReference|AddToMap]](Bool ''abAllowFastTravel'')''' |
|||
**Blocks (or unblocks) normal activation processing for this reference. |
|||
:*Adds this map marker to the map, optionally making it available for fast travel. |
|||
*int Function [[CalculateEncounterLevel - ObjectReference|CalculateEncounterLevel]](int aiDifficulty) |
|||
**Calculate this object's encounter level, using the specified difficulty. |
|||
:'''[[ApplyHavokImpulse - ObjectReference|ApplyHavokImpulse]](Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afMagnitude'')''' |
|||
*bool Function [[CanFastTravelToMarker - ObjectReference|CanFastTravelToMarker]]() |
|||
* |
:*Apply a Havok impulse force to this object. |
||
*Function [[ClearDestruction - ObjectReference|ClearDestruction]]() |
|||
:'''[[BlockActivation - ObjectReference|BlockActivation]](Bool ''abBlocked'')''' |
|||
**Clears all effects of destruction from this object. |
|||
:*Blocks normal activation processing for 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 [[CalculateEncounterLevel - ObjectReference|CalculateEncounterLevel]](Int ''aiDifficulty'')''' |
|||
* |
:*Calculate this object's encounter level, using the specified difficulty. |
||
*Function [[DamageObject - ObjectReference|DamageObject]](float afDamage) |
|||
:'''Bool [[CanFastTravelToMarker - ObjectReference|CanFastTravelToMarker]]()''' |
|||
**Damages this object and advances the destruction stage. |
|||
:*Can the player fast travel to this map marker? |
|||
*Function [[Delete - ObjectReference|Delete]]() |
|||
**Deletes this object. |
|||
:'''[[ClearDestruction - ObjectReference|ClearDestruction]]()''' |
|||
:*Clears all effects of destruction from this object. |
|||
**Waits until this reference is out of the loaded area and then deletes it |
|||
*Function [[Disable - ObjectReference|Disable]](bool abFadeOut) |
|||
:'''Int [[CountLinkedRefChain - ObjectReference|CountLinkedRefChain]](Keyword ''apKeyword'', Int ''maxExpectedLinkedRefs'')''' |
|||
**Disables this object. |
|||
:*Counts the number of linked refs that are in a linked Ref chain |
|||
*Function [[DisableLinkChain - ObjectReference|DisableLinkChain]](Keyword apKeyword, bool abFadeOut) |
|||
**Disables all of the references that are linked, in a chain, to this one. |
|||
:'''[[CreateDetectionEvent - ObjectReference|CreateDetectionEvent]](Actor ''akOwner'', Int ''aiSoundLevel'')''' |
|||
:*Create a detection event at this reference, with the specified owner. |
|||
**Disables this object and does not wait for the object to be disable or faded out. |
|||
*Function [[DropObject - ObjectReference|DropObject]](Form akObject, int aiCount) |
|||
:'''[[DamageObject - ObjectReference|DamageObject]](Float ''afDamage'')''' |
|||
**Drops the specified object from this object's inventory. |
|||
:*Damages this object and advances the destruction stage. |
|||
*Function [[Enable - ObjectReference|Enable]](bool abFadeIn) |
|||
**Enables this object. |
|||
:'''[[Delete - ObjectReference|Delete]]()''' |
|||
:*Deletes this object. |
|||
**Enables or disables fast travel to this map marker. |
|||
*Function [[EnableLinkChain - ObjectReference|EnableLinkChain]](Keyword apKeyword) |
|||
:'''[[DeleteWhenAble - ObjectReference|DeleteWhenAble]]()''' |
|||
**Enables all of the references that are linked, in a chain, to this one. |
|||
:*Waits until this reference is out of the loaded area and then deletes it |
|||
*Function [[EnableNoWait - ObjectReference|EnableNoWait]](bool abFadeIn) |
|||
**Enables this object and does not wait for the object to be enabled or faded in. |
|||
:'''[[Disable - ObjectReference|Disable]](Bool ''abFadeOut'')''' |
|||
:*Disables this object. |
|||
**Forcibly adds the ragdoll of a reference to the world |
|||
*Function [[ForceRemoveRagdollFromWorld - ObjectReference|ForceRemoveRagdollFromWorld]]() native |
|||
:'''[[DisableLinkChain - ObjectReference|DisableLinkChain]](Keyword ''apKeyword'', Bool ''abFadeOut'')''' |
|||
**Forcibly removes the ragdoll of a reference from the world |
|||
:*Disables all of the references that are linked, in a chain, to this one. |
|||
*ActorBase Function [[GetActorOwner - ObjectReference|GetActorOwner]]() |
|||
**Obtains the actor base that owns this object. |
|||
:'''[[DisableNoWait - ObjectReference|DisableNoWait]](Bool ''abFadeOut'')''' |
|||
* |
:*Disables this object and does not wait for the object to be disable or faded out. |
||
*float Function [[GetAngleY - ObjectReference|GetAngleY]]() |
|||
:'''[[DropObject - ObjectReference|DropObject]](Form ''akObject'', Int ''aiCount'')''' |
|||
**Obtains this object's rotation around the y axis. |
|||
:*Drops the specified object from this object's inventory. |
|||
*float Function [[GetAngleZ - ObjectReference|GetAngleZ]]() |
|||
**Obtains this object's rotation around the z axis. |
|||
:'''[[Enable - ObjectReference|Enable]](Bool ''abFadeIn'')''' |
|||
:*Enables this object. |
|||
**Fetches the value of a variable on the reference's animation graph (bool version). |
|||
*float Function [[GetAnimationVariableFloat - ObjectReference|GetAnimationVariableFloat]](string asVariableName) |
|||
:'''[[EnableFastTravel - ObjectReference|EnableFastTravel]](Bool ''abEnable'')''' |
|||
**Fetches the value of a variable on the reference's animation graph (float version). |
|||
:*Enables or disables fast travel to this map marker. |
|||
*int Function [[GetAnimationVariableInt - ObjectReference|GetAnimationVariableInt]](string asVariableName) |
|||
**Fetches the value of a variable on the reference's animation graph (int version). |
|||
:'''[[EnableLinkChain - ObjectReference|EnableLinkChain]](Keyword ''apKeyword'')''' |
|||
:*Enables all of the references that are linked, in a chain, to this one. |
|||
**Obtains this reference's base object. |
|||
*int Function [[GetCurrentDestructionStage - ObjectReference|GetCurrentDestructionStage]]() |
|||
:'''[[EnableNoWait - ObjectReference|EnableNoWait]](Bool ''abFadeIn'')''' |
|||
**Gets the object's current stage of destruction. |
|||
:*Enables this object and does not wait for the object to be enabled or faded in. |
|||
*Location Function [[GetCurrentLocation - ObjectReference|GetCurrentLocation]]() |
|||
**Obtains this reference's current location. |
|||
:'''[[ForceAddRagdollToWorld - ObjectReference|ForceAddRagdollToWorld]]()''' |
|||
* |
:*Forcibly adds the ragdoll of a reference to the world |
||
*float Function [[GetDistance - ObjectReference|GetDistance]](ObjectReference akOther) |
|||
:'''[[ForceRemoveRagdollFromWorld - ObjectReference|ForceRemoveRagdollFromWorld]]()''' |
|||
**Calculates the distance between this object and the passed in one. |
|||
:*Forcibly removes the ragdoll of a reference from the world |
|||
*Location Function [[GetEditorLocation - ObjectReference|GetEditorLocation]]() |
|||
**Obtains this reference's editor location. |
|||
:'''ActorBase [[GetActorOwner - ObjectReference|GetActorOwner]]()''' |
|||
* |
:*Obtains the actor base that owns this object. |
||
*float Function [[GetHeadingAngle - ObjectReference|GetHeadingAngle]](ObjectReference akOther) |
|||
:'''Float [[GetAngleX - ObjectReference|GetAngleX]]()''' |
|||
**Gets the angle between this object's heading, and the direction the other object is in. |
|||
:*Obtains this object's rotation around the x axis. |
|||
*float Function [[GetHeight - ObjectReference|GetHeight]]() |
|||
**Gets the height of this object |
|||
:'''Float [[GetAngleY - ObjectReference|GetAngleY]]()''' |
|||
:*Obtains this object's rotation around the y axis. |
|||
**Returns how many of the specified item is in this object's inventory. |
|||
*float Function [[GetItemHealthPercent - ObjectReference|GetItemHealthPercent]]() |
|||
:'''Float [[GetAngleZ - ObjectReference|GetAngleZ]]()''' |
|||
**Returns the item health percent of this object (1.0 == 100%). |
|||
:*Obtains this object's rotation around the z axis. |
|||
*Key Function [[GetKey - ObjectReference|GetKey]]() |
|||
**Obtains the key that unlocks this object (if any). |
|||
:'''Bool [[GetAnimationVariableBool - ObjectReference|GetAnimationVariableBool]](String ''asVariableName'')''' |
|||
:*Fetches the value of a variable on the reference's animation graph (bool version). |
|||
**Obtains the length of this object. |
|||
*ObjectReference Function [[GetLinkedRef - ObjectReference|GetLinkedRef]](Keyword apKeyword) |
|||
:'''Float [[GetAnimationVariableFloat - ObjectReference|GetAnimationVariableFloat]](String ''asVariableName'')''' |
|||
**Returns our linked reference for the given Keyword, if any. |
|||
:*Fetches the value of a variable on the reference's animation graph (float version). |
|||
*int Function [[GetLockLevel - ObjectReference|GetLockLevel]]() |
|||
**Obtains the level of the lock on this object. |
|||
:'''Int [[GetAnimationVariableInt - ObjectReference|GetAnimationVariableInt]](String ''asVariableName'')''' |
|||
:*Fetches the value of a variable on the reference's animation graph (int version). |
|||
**Obtains this object's mass in Havok. |
|||
*ObjectReference Function [[GetNthLinkedRef - ObjectReference|GetNthLinkedRef]](int aiLinkedRef) |
|||
:'''Form [[GetBaseObject - ObjectReference|GetBaseObject]]()''' |
|||
**Obtains the nth linked ref from this object. |
|||
:*Obtains this reference's base object. |
|||
*int Function [[GetOpenState - ObjectReference|GetOpenState]]() |
|||
**Obtains this object's current "open state". |
|||
:'''Int [[GetCurrentDestructionStage - ObjectReference|GetCurrentDestructionStage]]()''' |
|||
:*Gets the object's current stage of destruction. |
|||
**Obtains the cell this object is currently in. |
|||
*float Function [[GetPositionX - ObjectReference|GetPositionX]]() |
|||
:'''Location [[GetCurrentLocation - ObjectReference|GetCurrentLocation]]()''' |
|||
**Returns this object's current X position. |
|||
:*Obtains this reference's current location. |
|||
*float Function [[GetPositionY - ObjectReference|GetPositionY]]() |
|||
**Returns this object's current Y position. |
|||
:'''Scene [[GetCurrentScene - ObjectReference|GetCurrentScene]]()''' |
|||
:*Obtains the scene that this reference is currently participating in, if any. |
|||
**Returns this object's current Z position. |
|||
*float Function [[GetScale - ObjectReference|GetScale]]() |
|||
:'''Float [[GetDistance - ObjectReference|GetDistance]](ObjectReference ''akOther'')''' |
|||
**Get this object's current scale. |
|||
:*Calculates the distance between this object and the passed in one. |
|||
*int Function [[GetTriggerObjectCount - ObjectReference|GetTriggerObjectCount]]() |
|||
**Returns the number of objects inside this trigger volume. |
|||
:'''Location [[GetEditorLocation - ObjectReference|GetEditorLocation]]()''' |
|||
:*Obtains this reference's editor location. |
|||
*float Function [[GetWidth - ObjectReference|GetWidth]]() |
|||
:'''Faction [[GetFactionOwner - ObjectReference|GetFactionOwner]]()''' |
|||
**Get the current width of the object. |
|||
:*Gets the faction that owns this reference. |
|||
*Worldspace Function [[GetWorldSpace - ObjectReference|GetWorldSpace]]() |
|||
**Returns the worldspace this reference is in. |
|||
:'''Float [[GetHeadingAngle - ObjectReference|GetHeadingAngle]](ObjectReference ''akOther'')''' |
|||
:*Gets the angle between this object's heading, and the direction the other object is in. |
|||
**Returns if this reference has an active effect coming from a magic effect with the specified keyword attached |
|||
*bool Function [[HasNode - ObjectReference|HasNode]](string asNodeName) |
|||
:'''Float [[GetHeight - ObjectReference|GetHeight]]()''' |
|||
**Returns if this reference has the specified name node in its 3D. |
|||
:*Gets the height of this object |
|||
*bool Function [[HasRefType - ObjectReference|HasRefType]](LocationRefType akRefType) |
|||
**Returns if this reference has the specified [[LocationRefType Script|LocationRefType]] attached. |
|||
:'''Int [[GetItemCount - ObjectReference|GetItemCount]](Form ''akItem'')''' |
|||
:*Returns how many of the specified item is in this object's inventory. |
|||
**Flags this reference as ignoring (or not ignoring) friendly hits |
|||
*Function [[InterruptCast - ObjectReference|InterruptCast]]() |
|||
:'''Float [[GetItemHealthPercent - ObjectReference|GetItemHealthPercent]]()''' |
|||
**Interrupts any spellcasting this object may be doing. |
|||
:*Returns the item health percent of this object (1.0 == 100%). |
|||
*bool Function [[IsActivateChild - ObjectReference|IsActivateChild]](ObjectReference akChild) |
|||
**Returns whether the passed in reference is an activate child of this reference. |
|||
:'''Key [[GetKey - ObjectReference|GetKey]]()''' |
|||
:*Obtains the key that unlocks this object (if any). |
|||
**Returns whether normal activation processing is currently blocked on this reference or not. |
|||
*bool Function [[Is3DLoaded - ObjectReference|Is3DLoaded]]() |
|||
:'''Float [[GetLength - ObjectReference|GetLength]]()''' |
|||
**Checks to see if this reference's 3D data is currently loaded or not. |
|||
:*Obtains the length of this object. |
|||
*bool Function [[IsDisabled - ObjectReference|IsDisabled]]() |
|||
**Is this object currently disabled? |
|||
:'''ObjectReference [[GetLinkedRef - ObjectReference|GetLinkedRef]](Keyword ''apKeyword'')''' |
|||
:*Returns our linked reference for the given Keyword, if any. |
|||
**Is this object currently enabled? |
|||
*bool Function [[IsFurnitureInUse - ObjectReference|IsFurnitureInUse]](bool abIgnoreReserved) |
|||
:'''Int [[GetLockLevel - ObjectReference|GetLockLevel]]()''' |
|||
**Is any furniture marker on this object in use? |
|||
:*Obtains the level of the lock on this object. |
|||
*bool Function [[IsFurnitureMarkerInUse - ObjectReference|IsFurnitureMarkerInUse]](int aiMarker, bool abIgnoreReserved) |
|||
**Is the specified furniture marker on this object in use? |
|||
:'''Float [[GetMass - ObjectReference|GetMass]]()''' |
|||
* |
:*Obtains this object's mass in Havok. |
||
*bool Function [[IsInDialogueWithPlayer - ObjectReference|IsInDialogueWithPlayer]]() |
|||
:'''ObjectReference [[GetNthLinkedRef - ObjectReference|GetNthLinkedRef]](Int ''aiLinkedRef'')''' |
|||
**Is this actor or talking activator currently talking to the player? |
|||
:*Obtains the nth linked ref from this object. |
|||
*bool Function [[IsInInterior - ObjectReference|IsInInterior ]] () |
|||
**Returns true if the object is in an interior cell. |
|||
:'''Int [[GetOpenState - ObjectReference|GetOpenState]]()''' |
|||
:*Obtains this object's current "open state". |
|||
**Returns true if the object is currently in that location or a child of that location. |
|||
*bool Function [[IsLocked - ObjectReference|IsLocked]]() |
|||
:'''Cell [[GetParentCell - ObjectReference|GetParentCell]]()''' |
|||
**Is the lock on this object locked? |
|||
:*Obtains the cell this object is currently in. |
|||
*bool Function [[IsMapMarkerVisible - ObjectReference|IsMapMarkerVisible]]() |
|||
**Is this map marker visible to the player? |
|||
:'''Float [[GetPositionX - ObjectReference|GetPositionX]]()''' |
|||
:*Returns this object's current X position. |
|||
**A quick-and-dirty function to tell if this object is safe to enable or disable |
|||
*Function [[KnockAreaEffect - ObjectReference|KnockAreaEffect]](float afMagnitude, float afRadius) |
|||
:'''Float [[GetPositionY - ObjectReference|GetPositionY]]()''' |
|||
**Executes a knock effect to an area |
|||
:*Returns this object's current Y position. |
|||
*Function [[Lock - ObjectReference|Lock]](bool abLock, bool abAsOwner) |
|||
**Locks or unlocks this object. |
|||
:'''Float [[GetPositionZ - ObjectReference|GetPositionZ]]()''' |
|||
*Function [[MoveTo - ObjectReference|MoveTo]](ObjectReference akTarget, float afXOffset, float afYOffset, float afZOffset, bool abMatchRotation) |
|||
:*Returns this object's current Z position. |
|||
**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) |
|||
:'''Float [[GetScale - ObjectReference|GetScale]]()''' |
|||
**Moves this object to the same location as the passed-in reference, offset by the specified amount, IF this object is not currently loaded. |
|||
:*Get this object's current scale. |
|||
*Function [[MoveToInteractionLocation - ObjectReference|MoveToInteractionLocation]](ObjectReference akTarget) |
|||
**Moves this object to the specified object's interaction location. |
|||
:'''Int [[GetTriggerObjectCount - ObjectReference|GetTriggerObjectCount]]()''' |
|||
:*Returns the number of objects inside this trigger volume. |
|||
**Moves this object to its own editor location. |
|||
*Function [[MoveToNode - ObjectReference|MoveToNode]](ObjectReference akTarget, string asNodeName) |
|||
:'''VoiceType [[GetVoiceType - ObjectReference|GetVoiceType]]()''' |
|||
**Moves this object to the position (and rotation) of the specified node on the specified object's 3D |
|||
:*Obtains the [[VoiceType Script|VoiceType]] for this actor or talking activator. |
|||
*Actor Function [[PlaceActorAtMe - ObjectReference|PlaceActorAtMe]](ActorBase akActorToPlace, int aiLevelMod, EncounterZone akZone) |
|||
**Create an actor at this object's location. |
|||
:'''Float [[GetWidth - ObjectReference|GetWidth]]()''' |
|||
:*Get the current width of the object. |
|||
**Places x copies of the passed in form at this object's current position, returning the last one created. |
|||
*bool Function [[PlayAnimation - ObjectReference|PlayAnimation]](string asAnimation) |
|||
:'''Worldspace [[GetWorldSpace - ObjectReference|GetWorldSpace]]()''' |
|||
**Plays the specified animation on this object, returning immediately. |
|||
:*Returns the worldspace this reference is in. |
|||
*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 [[HasEffectKeyword - ObjectReference|HasEffectKeyword]](Keyword ''akKeyword'')''' |
|||
*bool Function [[PlayGamebryoAnimation - ObjectReference|PlayGamebryoAnimation]](string asAnimation, bool abStartOver, float afEaseInTime) |
|||
:*Returns if this reference has an active effect coming from a magic effect with the specified keyword attached |
|||
**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) |
|||
:'''Bool [[HasNode - ObjectReference|HasNode]](String ''asNodeName'')''' |
|||
**Plays an impact effect. |
|||
:*Returns if this reference has the specified name node in its 3D. |
|||
*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 [[HasRefType - ObjectReference|HasRefType]](LocationRefType ''akRefType'')''' |
|||
*bool Function [[PlaySyncedAnimationSS - ObjectReference|PlaySyncedAnimationSS]](string asAnimation1, ObjectReference akObj2, string asAnimation2) |
|||
:*Returns if this reference has the specified [[LocationRefType Script|LocationRefType]] attached. |
|||
**Plays two animations simultaneously. |
|||
*Function [[PlayTerrainEffect - ObjectReference | PlayTerrainEffect]] (string asEffectModelName, string asAttachBoneName) |
|||
:'''[[IgnoreFriendlyHits - ObjectReference|IgnoreFriendlyHits]](Bool ''abIgnore'')''' |
|||
**Plays a terrain effect. |
|||
:*Flags this reference as ignoring (or not ignoring) friendly hits |
|||
*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. |
|||
:'''[[InterruptCast - ObjectReference|InterruptCast]]()''' |
|||
:*Interrupts any spellcasting this object may be doing. |
|||
**Pushes the other actor away from this object as if hit by the specified amount of knockback damage. |
|||
*bool Function [[RampRumble - ObjectReference|RampRumble]](float power, float duration, float falloff) |
|||
:'''Bool [[IsActivateChild - ObjectReference|IsActivateChild]](ObjectReference ''akChild'')''' |
|||
**Shakes cam/controller based on distance from player |
|||
:*Returns whether the passed in reference is an activate child of this reference. |
|||
*Function [[RemoveAllInventoryEventFilters - ObjectReference|RemoveAllInventoryEventFilters]]() |
|||
**Remove all inventory event filters on this reference. |
|||
:'''Bool [[IsActivationBlocked - ObjectReference|IsActivationBlocked]]()''' |
|||
*Function [[RemoveAllItems - ObjectReference|RemoveAllItems]](ObjectReference akTransferTo, bool abKeepOwnership, bool abSilent) |
|||
:*Returns whether normal activation processing is currently blocked on this reference or not. |
|||
**Removes all items from this container, optionall transferring them to another one. |
|||
*Function [[RemoveInventoryEventFilter - ObjectReference|RemoveInventoryEventFilter]](Form akFilter) |
|||
:'''Bool [[Is3DLoaded - ObjectReference|Is3DLoaded]]()''' |
|||
**Remove a specific inventory event filter. |
|||
:*Checks to see if this reference's 3D data is currently loaded or not. |
|||
*Function [[RemoveItem - ObjectReference|RemoveItem]](Form akItemToRemove, int aiCount, bool abSilent) |
|||
**Removes the passed in item from this object's inventory. |
|||
:'''Bool [[IsDeleted - ObjectReference|IsDeleted]]()''' |
|||
:*Checks to see if this object is currently flagged for delete. |
|||
**Resets this object reference, optionally placing the object at the new target. |
|||
*Function [[Say - ObjectReference|Say]](Topic akTopicToSay, Actor akActorToSpeakAs, bool abSpeakInPlayersHead) |
|||
:'''Bool [[IsDisabled - ObjectReference|IsDisabled]]()''' |
|||
**Causes this reference to speak a topic as if it were the specified actor. |
|||
:*Is this object currently disabled? |
|||
*Function [[SendStealAlarm - ObjectReference|SendStealAlarm]](Actor akThief) |
|||
**Sends a steal alarm as if this reference had just been stolen by the actor. |
|||
:'''Bool [[IsEnabled - ObjectReference|IsEnabled]]()''' |
|||
* |
:*Is this object currently enabled? |
||
*Function [[SetActorOwner - ObjectReference|SetActorOwner]](ActorBase akActorBase) |
|||
:'''Bool [[IsFurnitureInUse - ObjectReference|IsFurnitureInUse]](Bool ''abIgnoreReserved'')''' |
|||
**Sets this actor base as this object's owner. |
|||
:*Is any furniture marker on this object in use? |
|||
*Function [[SetAngle - ObjectReference|SetAngle]](float afXAngle, float afYAngle, float afZAngle) |
|||
**Sets this object's rotation. Angles are in degrees. |
|||
:'''Bool [[IsFurnitureMarkerInUse - ObjectReference|IsFurnitureMarkerInUse]](Int ''aiMarker'', Bool ''abIgnoreReserved'')''' |
|||
:*Is the specified furniture marker on this object in use? |
|||
**Sets the value of a variable on the reference's animation graph (bool version). |
|||
*Function [[SetAnimationVariableFloat - ObjectReference|SetAnimationVariableFloat]](string asVariableName, float afNewValue) |
|||
:'''Bool [[IsIgnoringFriendlyHits - ObjectReference|IsIgnoringFriendlyHits]]()''' |
|||
**Sets the value of a variable on the reference's animation graph (float version). |
|||
:*Is this object ignoring friendly hits? |
|||
*Function [[SetAnimationVariableInt - ObjectReference|SetAnimationVariableInt]](string asVariableName, int aiNewValue) |
|||
**Sets the value of a variable on the reference's animation graph (int version). |
|||
:'''Bool [[IsInDialogueWithPlayer - ObjectReference|IsInDialogueWithPlayer]]()''' |
|||
:*Is this actor or talking activator currently talking to the player? |
|||
**Sets or clears this object's destroyed flag. |
|||
*Function [[SetFactionOwner - ObjectReference|SetFactionOwner]](Faction akFaction) |
|||
:'''Bool [[IsInInterior - ObjectReference|IsInInterior]]()''' |
|||
**Sets this faction as this object's owner. |
|||
:*Returns true if the object is in an interior cell. |
|||
*Function [[SetLockLevel - ObjectReference|SetLockLevel]](int aiLockLevel) |
|||
**Sets the lock level on this object. |
|||
:'''Bool [[IsInLocation - ObjectReference|IsInLocation]](Location ''akLocation'')''' |
|||
:*Returns true if the object is currently in that location or a child of that location. |
|||
**Sets the havok motion type on this object. |
|||
*Function [[SetNoFavorAllowed - ObjectReference|SetNoFavorAllowed]](bool abNoFavor) |
|||
:'''Bool [[IsLocked - ObjectReference|IsLocked]]()''' |
|||
**Sets or clears this object's ability to be not used by a teammate for a favor |
|||
:*Is the lock on this object locked? |
|||
*Function [[SetOpen - ObjectReference|SetOpen]](bool abOpen) |
|||
**Opens or closes this object. |
|||
:'''Bool [[IsMapMarkerVisible - ObjectReference|IsMapMarkerVisible]]()''' |
|||
:*Is this map marker visible to the player? |
|||
**Sets this object's position. |
|||
*Function [[SetScale - ObjectReference|SetScale]](float afScale) |
|||
:'''Bool [[IsNearPlayer - ObjectReference|IsNearPlayer]]()''' |
|||
**Set the current scale of the object |
|||
:*A quick-and-dirty function to tell if this object is safe to enable or disable |
|||
*Function [[SplineTranslateTo - ObjectReference|SplineTranslateTo]](float afX, float afY, float afZ, float afAngleX, float afAngleY, float afAngleZ, float afSplineCurve, float afSpeed) |
|||
**Makes the object translate to the given pos/orient on a spline. |
|||
:'''[[KnockAreaEffect - ObjectReference|KnockAreaEffect]](Float ''afMagnitude'', Float ''afRadius'')''' |
|||
*Function [[SplineTranslateToRef - ObjectReference|SplineTranslateToRef]](ObjectReference arTarget, float afTangentMagnitude, float afSpeed, float afMaxRotationSpeed) |
|||
:*Executes a knock effect to an area |
|||
**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) |
|||
:'''[[Lock - ObjectReference|Lock]](Bool ''abLock'', Bool ''abAsOwner'')''' |
|||
**Makes the reference translate to the target node's position/orient on a spline at the given speed |
|||
:*Locks or unlocks this object. |
|||
*Function [[StopTranslation - ObjectReference|StopTranslation]]() |
|||
**Stops any translation on the object. |
|||
:'''[[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. |
|||
**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) |
|||
:'''Bool [[MoveToIfUnloaded - ObjectReference|MoveToIfUnloaded]](ObjectReference ''akTarget'', Float ''afXOffset'', Float ''afYOffset'', Float ''afZOffset'')''' |
|||
**Makes the object translate to the given pos/orient. |
|||
:*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 [[TranslateToRef - ObjectReference|TranslateToRef]](ObjectReference arTarget, float afSpeed, float afMaxRotationSpeed) |
|||
**Makes the reference translate to the target ref position/orient at the given speed |
|||
:'''[[MoveToInteractionLocation - ObjectReference|MoveToInteractionLocation]](ObjectReference ''akTarget'')''' |
|||
* |
:*Moves this object to the specified object's interaction location. |
||
:'''[[MoveToMyEditorLocation - ObjectReference|MoveToMyEditorLocation]]()''' |
|||
:*Moves this object to its own editor location. |
|||
:'''[[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 |
|||
:'''Actor [[PlaceActorAtMe - ObjectReference|PlaceActorAtMe]](ActorBase ''akActorToPlace'', Int ''aiLevelMod'', EncounterZone ''akZone'')''' |
|||
:*Create an actor at this object's location. |
|||
:'''ObjectReference [[PlaceAtMe - ObjectReference|PlaceAtMe]](Form ''akFormToPlace'', Int ''aiCount'')''' |
|||
:*Places x copies of the passed in form at this object's current position, returning the last one created. |
|||
:'''Bool [[PlayAnimation - ObjectReference|PlayAnimation]](String ''asAnimation'')''' |
|||
:*Plays the specified animation on this object, returning immediately. |
|||
:'''Bool [[PlayAnimationAndWait - ObjectReference|PlayAnimationAndWait]](String ''asAnimation'', String ''asEventName'')''' |
|||
:*Plays the specified animation on this object and waits for the specified event before returning. (latent) |
|||
:'''Bool [[PlayGamebryoAnimation - ObjectReference|PlayGamebryoAnimation]](String ''asAnimation'', Bool ''abStartOver'', Float ''afEaseInTime'')''' |
|||
:*Plays a legacy nif file based animation |
|||
:'''Bool [[PlayImpactEffect - ObjectReference|PlayImpactEffect]](ImpactDataSet ''akImpactEffect'', String ''asNodeName'', Float ''afPickDirX'', Float ''afPickDirY'', Float ''afPickDirZ'', Float ''afPickLength'', Bool ''abApplyNodeRotation'', Bool ''abUseNodeLocalRotation'')''' |
|||
:*Plays an impact effect. |
|||
:'''Bool [[PlaySyncedAnimationAndWaitSS - ObjectReference|PlaySyncedAnimationAndWaitSS]](String ''asAnimation1'', String ''asEvent1'', ObjectReference ''akObj2'', String ''asAnimation2'', String ''asEvent2'')''' |
|||
:*Plays two animations simultaneously, waiting for events from both. |
|||
:'''Bool [[PlaySyncedAnimationSS - ObjectReference|PlaySyncedAnimationSS]](String ''asAnimation1'', ObjectReference ''akObj2'', String ''asAnimation2'')''' |
|||
:*Plays two animations simultaneously. |
|||
:'''[[PlayTerrainEffect - ObjectReference |PlayTerrainEffect]](String ''asEffectModelName'', String ''asAttachBoneName'')''' |
|||
:*Plays a terrain effect. |
|||
:'''[[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. |
|||
:'''[[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. |
|||
:'''Bool [[RampRumble - ObjectReference|RampRumble]](Float ''power'', Float ''duration'', Float ''falloff'')''' |
|||
:*Shakes cam/controller based on distance from player |
|||
:'''[[RemoveAllInventoryEventFilters - ObjectReference|RemoveAllInventoryEventFilters]]()''' |
|||
:*Remove all inventory event filters on this reference. |
|||
:'''[[RemoveAllItems - ObjectReference|RemoveAllItems]](ObjectReference ''akTransferTo'', Bool ''abKeepOwnership'', Bool ''abSilent'')''' |
|||
:*Removes all items from this container, optionall transferring them to another one. |
|||
:'''[[RemoveInventoryEventFilter - ObjectReference|RemoveInventoryEventFilter]](Form ''akFilter'')''' |
|||
:*Remove a specific inventory event filter. |
|||
:'''[[RemoveItem - ObjectReference|RemoveItem]](Form ''akItemToRemove'', Int ''aiCount'', Bool ''abSilent'', ObjectReference ''akOtherContainer'')''' |
|||
:*Removes the passed in item from this object's inventory. |
|||
:'''[[Reset - ObjectReference|Reset]](ObjectReference ''akTarget'')''' |
|||
:*Resets this object reference, optionally placing the object at the new target. |
|||
:'''[[Say - ObjectReference|Say]](Topic ''akTopicToSay'', Actor ''akActorToSpeakAs'', Bool ''abSpeakInPlayersHead'')''' |
|||
:*Causes this reference to speak a topic as if it were the specified actor. |
|||
:'''[[SendStealAlarm - ObjectReference|SendStealAlarm]](Actor ''akThief'')''' |
|||
:*Sends a steal alarm as if this reference had just been stolen by the actor. |
|||
:'''[[SetActorCause - ObjectReference|SetActorCause]](Actor ''akActor'')''' |
|||
:*Sets this actor as this object's actor cause. |
|||
:'''[[SetActorOwner - ObjectReference|SetActorOwner]](ActorBase ''akActorBase'')''' |
|||
:*Sets this actor base as this object's owner. |
|||
:'''[[SetAngle - ObjectReference|SetAngle]](Float ''afXAngle'', Float ''afYAngle'', Float ''afZAngle'')''' |
|||
:*Sets this object's rotation. Angles are in degrees. |
|||
:'''[[SetAnimationVariableBool - ObjectReference|SetAnimationVariableBool]](String ''asVariableName'', Bool ''abNewValue'')''' |
|||
:*Sets the value of a variable on the reference's animation graph (bool version). |
|||
:'''[[SetAnimationVariableFloat - ObjectReference|SetAnimationVariableFloat]](String ''asVariableName'', Float ''afNewValue'')''' |
|||
:*Sets the value of a variable on the reference's animation graph (float version). |
|||
:'''[[SetAnimationVariableInt - ObjectReference|SetAnimationVariableInt]](String ''asVariableName'', Int ''aiNewValue'')''' |
|||
:*Sets the value of a variable on the reference's animation graph (int version). |
|||
:'''[[SetDestroyed - ObjectReference|SetDestroyed]](Bool ''abDestroyed'')''' |
|||
:*Sets or clears this object's destroyed flag. |
|||
:'''[[SetFactionOwner - ObjectReference|SetFactionOwner]](Faction ''akFaction'')''' |
|||
:*Sets this faction as this object's owner. |
|||
:'''[[SetLockLevel - ObjectReference|SetLockLevel]](Int ''aiLockLevel'')''' |
|||
:*Sets the lock level on this object. |
|||
:'''[[SetMotionType - ObjectReference|SetMotionType]](Int ''aiMotionType'', Bool ''abAllowActivate'')''' |
|||
:*Sets the havok motion type on this object. |
|||
:'''[[SetNoFavorAllowed - ObjectReference|SetNoFavorAllowed]](Bool ''abNoFavor'')''' |
|||
:*Sets or clears this object's ability to be not used by a teammate for a favor |
|||
:'''[[SetOpen - ObjectReference|SetOpen]](Bool ''abOpen'')''' |
|||
:*Opens or closes this object. |
|||
:'''[[SetPosition - ObjectReference|SetPosition]](Float ''afX'', Float ''afY'', Float ''afZ'')''' |
|||
:*Sets this object's position. |
|||
:'''[[SetScale - ObjectReference|SetScale]](Float ''afScale'')''' |
|||
:*Set the current scale of the object |
|||
:'''[[SplineTranslateTo - ObjectReference|SplineTranslateTo]](Float ''afX'', Float ''afY'', Float ''afZ'', Float ''afAngleX'', Float ''afAngleY'', Float ''afAngleZ'', Float ''afSplineCurve'', Float ''afSpeed'')''' |
|||
:*Makes the object translate to the given pos/orient on a spline. |
|||
:'''[[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 |
|||
:'''[[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 |
|||
:'''[[StopTranslation - ObjectReference|StopTranslation]]()''' |
|||
:*Stops any translation on the object. |
|||
:'''[[TetherToHorse - ObjectReference|TetherToHorse]](ObjectReference ''akHorse'')''' |
|||
:*Tether a prisoner cart to the given horse. |
|||
:'''[[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. |
|||
:'''[[TranslateToRef - ObjectReference|TranslateToRef]](ObjectReference ''arTarget'', Float ''afSpeed'', Float ''afMaxRotationSpeed'')''' |
|||
:*Makes the reference translate to the target ref position/orient at the given speed |
|||
:'''Bool [[WaitForAnimationEvent - ObjectReference|WaitForAnimationEvent]](String ''asEventName'')''' |
|||
:*Waits for the animation graph to send the specified event. |
|||
== SKSE Member Functions == |
|||
:'''Form[] [[GetContainerForms - ObjectReference|GetContainerForms]]()''' |
|||
:* (Container only) Returns an array of the forms in a container. (Actor ObjectReferences are containers) |
|||
:'''Int [[GetNumItems - ObjectReference|GetNumItems]]()''' |
|||
:* (Container only) Returns the number of forms in the container. (Actor ObjectReferences are containers) |
|||
:'''Form [[GetNthForm - ObjectReference|GetNthForm]](Int ''index'')''' |
|||
:* (Container only) Returns the specified form from the container. (Actor ObjectReferences are containers) |
|||
:'''Float [[GetTotalItemWeight - ObjectReference|GetTotalItemWeight]]()''' |
|||
:* (Container only - perhaps Player only) Returns the total weight of all items held in the container. |
|||
:'''Float [[GetTotalArmorWeight - ObjectReference|GetTotalArmorWeight]]()''' |
|||
:* (Container only - perhaps Player only) Returns the total weight of the armor in the container. |
|||
:'''Bool [[IsHarvested - ObjectReference|IsHarvested]]()''' |
|||
:* (Flora and Tree only) Returns whether the flora has been harvested or not. |
|||
:'''[[SetHarvested - ObjectReference|SetHarvested]](Bool ''harvested'')''' |
|||
:*Sets whether the Reference has been harvested. |
|||
:'''[[SetItemHealthPercent - ObjectReference|SetItemHealthPercent]](Float ''health'')''' |
|||
:* Set the item's tempering. 1.0 is no tempering, 1.6 appears to be legendary. Values below 1.0 do nothing. |
|||
:''' [[SetItemMaxCharge - ObjectReference|SetItemMaxCharge]](Float ''maxCharge'')''' |
|||
:*Sets the maximum charge of the item.(Only works on player enchants) |
|||
:'''Float [[GetItemMaxCharge - ObjectReference|GetItemMaxCharge]]()''' |
|||
:* Gets the maximum charge of the item. |
|||
:'''Float [[GetItemCharge - ObjectReference|GetItemCharge]]()''' |
|||
:* Gets the current charge of the item. |
|||
:'''[[SetItemCharge - ObjectReference|SetItemCharge]](Float ''charge'')''' |
|||
:*Sets the item's charge to the specified amount. |
|||
:'''[[ResetInventory - ObjectReference|ResetInventory]]()''' |
|||
:*Resets the References inventory. |
|||
:'''Bool [[IsOffLimits - ObjectReference|IsOffLimits]]()''' |
|||
:* |
|||
:'''String [[GetDisplayName - ObjectReference|GetDisplayName]]()''' |
|||
:*Returns the name of the reference (This is the name that is displayed) |
|||
:'''Bool [[SetDisplayName - ObjectReference|SetDisplayName]](String ''name'', Bool ''force'')''' |
|||
:*Sets the reference's display name. |
|||
:'''ObjectReference [[GetEnableParent - ObjectReference|GetEnableParent]]()''' |
|||
:*Returns the enable parent of the object. |
|||
:'''Enchantment [[GetEnchantment- ObjectReference|GetEnchantment]]()''' |
|||
:*Returns the player-made enchantment of the object (if there is one) |
|||
:'''[[SetEnchantment - ObjectReference|SetEnchantment]](Enchantment ''source'', Float ''maxCharge'')''' |
|||
:*Changes an item's player-made enchantment to another. |
|||
:'''[[CreateEnchantment - ObjectReference|CreateEnchantment]](Float ''maxCharge'', MagicEffect[] ''effects'', Float[] ''magnitudes'', Int[] ''areas'', Int[] ''durations'')''' |
|||
:*Creates a new Enchantment on the item with the specified parameters. |
|||
:'''Int [[GetNumReferenceAliases - ObjectReference|GetNumReferenceAliases]]()''' |
|||
:*Returns the number of reference aliases holding this reference. |
|||
:'''ReferenceAlias [[GetNthReferenceAlias - ObjectReference|GetNthReferenceAlias]](Int ''n'')''' |
|||
:*Returns the nth Reference alias holding this reference. |
|||
== Events == |
== Events == |
||
*Event [[OnActivate - ObjectReference|OnActivate]](ObjectReference akActionRef) |
|||
:'''[[OnActivate - ObjectReference|OnActivate]](ObjectReference ''akActionRef'')''' |
|||
**Event received when this object is activated. |
|||
:*Event received when this object is activated. |
|||
*Event [[OnAttachedToCell - ObjectReference|OnAttachedToCell]]() |
|||
**Event received when this reference moves from a detached cell to an attached one. |
|||
:'''[[OnAttachedToCell - ObjectReference|OnAttachedToCell]]()''' |
|||
:*Event received when this reference moves from a detached cell to an attached one. |
|||
*Event [[OnCellDetach - ObjectReference|OnCellDetach]]() |
|||
:'''[[OnCellAttach - ObjectReference|OnCellAttach]]()''' |
|||
**Event received when this reference's parent cell detaches. |
|||
:*Event received when this reference's parent cell attaches. |
|||
*Event [[OnCellLoad - ObjectReference|OnCellLoad]]() |
|||
**Event received when everything in the cell that holds this reference has loaded. |
|||
:'''[[OnCellDetach - ObjectReference|OnCellDetach]]()''' |
|||
:*Event received when this reference's parent cell detaches. |
|||
*Event [[OnContainerChanged - ObjectReference|OnContainerChanged]](ObjectReference akNewContainer, ObjectReference akOldContainer) |
|||
:'''[[OnCellLoad - ObjectReference|OnCellLoad]]()''' |
|||
**Event received when an object moves into/out of/between containers. |
|||
:*Event received when everything in the cell that holds this reference has loaded. |
|||
*Event [[OnDestructionStageChanged - ObjectReference|OnDestructionStageChanged]](int aiOldStage, int aiCurrentStage) |
|||
**Event received when this object's destruction stage has worsened. |
|||
:'''[[OnClose - ObjectReference|OnClose]](ObjectReference ''akActionRef'')''' |
|||
:*Event received when this object is finished closing. |
|||
*Event [[OnEquipped - ObjectReference|OnEquipped]](Actor akActor) |
|||
:'''[[OnContainerChanged - ObjectReference|OnContainerChanged]](ObjectReference ''akNewContainer'', ObjectReference ''akOldContainer'')''' |
|||
**Event received when this object is equipped by an actor. |
|||
:*Event received when an object moves into/out of/between containers. |
|||
*Event [[OnGrab - ObjectReference|OnGrab]]() |
|||
**Event received when this object is grabbed (z-keyed) by the player. |
|||
:'''[[OnDestructionStageChanged - ObjectReference|OnDestructionStageChanged]](Int ''aiOldStage'', Int ''aiCurrentStage'')''' |
|||
*Event [[OnHit - ObjectReference|OnHit]](ObjectReference akAggressor, Form akSource, Projectile akProjectile, bool abPowerAttack, bool abSneakAttack, bool abBashAttack, bool abHitBlocked) |
|||
:*Event received when this object's destruction stage has worsened. |
|||
*Event [[OnItemAdded - ObjectReference|OnItemAdded]](Form akBaseItem, int aiItemCount, ObjectReference akItemReference, ObjectReference akSourceContainer) |
|||
:'''[[OnDetachedFromCell - ObjectReference|OnDetachedFromCell]]()''' |
|||
**Event received when an item is inserted into this object's container. |
|||
:*Event received when this object moves from an attached cell to a detached cell. |
|||
*Event [[OnItemRemoved - ObjectReference|OnItemRemoved]](Form akBaseItem, int aiItemCount, ObjectReference akItemReference, ObjectReference akDestContainer) |
|||
**Event received when an item is removed from this object's container. |
|||
:'''[[OnEquipped - ObjectReference|OnEquipped]](Actor ''akActor'')''' |
|||
:*Event received when this object is equipped by an actor. |
|||
*Event [[OnLockStateChanged - ObjectReference|OnLockStateChanged]]() |
|||
:'''[[OnGrab - ObjectReference|OnGrab]]()''' |
|||
**Event received when the lock on this object changes its state. |
|||
:*Event received when this object is grabbed (z-keyed) by the player. |
|||
*Event [[OnMagicEffectApply - ObjectReference|OnMagicEffectApply]](ObjectReference akCaster, MagicEffect akEffect) |
|||
**Event received when a magic effect is attempting to be applied to this reference. |
|||
:'''[[OnHit - ObjectReference|OnHit]](ObjectReference ''akAggressor'', Form ''akSource'', Projectile ''akProjectile'', Bool ''abPowerAttack'', Bool ''abSneakAttack'', Bool ''abBashAttack'', Bool ''abHitBlocked'')''' |
|||
*Event [[OnOpen - ObjectReference|OnOpen]](ObjectReference akActionRef) |
|||
:*Event received when this object is hit with a weapon or projectile. |
|||
*Event [[OnRead - ObjectReference|OnRead]]() |
|||
:'''[[OnItemAdded - ObjectReference|OnItemAdded]](Form ''akBaseItem'', Int ''aiItemCount'', ObjectReference ''akItemReference'', ObjectReference ''akSourceContainer'')''' |
|||
**Event received when this object is read. (Only applies to books) |
|||
:*Event received when an item is inserted into this object's container. |
|||
*Event [[OnRelease - ObjectReference|OnRelease]]() |
|||
**Event received when this object is released by the player (stopped z-keying). |
|||
:'''[[OnItemRemoved - ObjectReference|OnItemRemoved]](Form ''akBaseItem'', Int ''aiItemCount'', ObjectReference ''akItemReference'', ObjectReference ''akDestContainer'')''' |
|||
*Event [[OnReset - ObjectReference|OnReset]]() |
|||
:*Event received when an item is removed from this object's container. |
|||
*Event [[OnSell - ObjectReference|OnSell]](Actor akSeller) |
|||
:'''[[OnLoad - ObjectReference|OnLoad]]()''' |
|||
**Event received when this object is sold by someone. |
|||
:*Event received when this object's 3d is loaded and ready. |
|||
*Event [[OnSpellCast - ObjectReference|OnSpellCast]](Form akSpell) |
|||
**Event received when this object casts a spell. |
|||
:'''[[OnLockStateChanged - ObjectReference|OnLockStateChanged]]()''' |
|||
*Event [[OnTrapHit - ObjectReference|OnTrapHit]](ObjectReference akTarget, float afXVel, float afYVel, float afZVel, float afXPos, float afYPos, float afZPos, int aeMaterial, bool abInitialHit, int aeMotionType) |
|||
:*Event received when the lock on this object changes its state. |
|||
*Event [[OnTrapHitStart - ObjectReference|OnTrapHitStart]](ObjectReference akTarget, float afXVel, float afYVel, float afZVel, float afXPos, float afYPos, float afZPos, int aeMaterial, bool abInitialHit, int aeMotionType) |
|||
:'''[[OnMagicEffectApply - ObjectReference|OnMagicEffectApply]](ObjectReference ''akCaster'', MagicEffect ''akEffect'')''' |
|||
**Event received when this trap object starts colliding with a target. |
|||
:*Event received when a magic effect is attempting to be applied to this reference. |
|||
*Event [[OnTrapHitStop - ObjectReference|OnTrapHitStop]](ObjectReference akTarget) |
|||
**Event received when this trap object stops colliding with a target. |
|||
:'''[[OnOpen - ObjectReference|OnOpen]](ObjectReference ''akActionRef'')''' |
|||
:*Event received when this object is fully opened. |
|||
*Event [[OnTranslationComplete - ObjectReference|OnTranslationComplete]]() |
|||
:'''[[OnRead - ObjectReference|OnRead]]()''' |
|||
**Event received when a translation request is complete. |
|||
:*Event received when this object is read. (Only applies to books) |
|||
*Event [[OnTranslationFailed - ObjectReference|OnTranslationFailed]]() |
|||
**Event received when a translation request has failed. |
|||
:'''[[OnRelease - ObjectReference|OnRelease]]()''' |
|||
:*Event received when this object is released by the player (stopped z-keying). |
|||
*Event [[OnTriggerEnter - ObjectReference|OnTriggerEnter]](ObjectReference akActionRef) |
|||
:'''[[OnReset - ObjectReference|OnReset]]()''' |
|||
**Event received when this object's volume is entered. |
|||
:*Event received when this object is reset. |
|||
*Event [[OnTriggerLeave - ObjectReference|OnTriggerLeave]](ObjectReference akActionRef) |
|||
**Event received when this object's volume is left. |
|||
:'''[[OnSell - ObjectReference|OnSell]](Actor ''akSeller'')''' |
|||
:*Event received when this object is sold by someone. |
|||
*Event [[OnUnload - ObjectReference|OnUnload]]() |
|||
:'''[[OnSpellCast - ObjectReference|OnSpellCast]](Form ''akSpell'')''' |
|||
**Event received when this object's 3d has been unloaded. |
|||
:*Event received when this object casts a spell. |
|||
*Event [[OnWardHit - ObjectReference|OnWardHit]](ObjectReference akCaster, Spell akSpell, int aiStatus) |
|||
**Event called when the object reference is using a ward that is hit by a spell. |
|||
:'''[[OnTrapHit - ObjectReference|OnTrapHit]](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 hits a target. |
|||
:'''[[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. |
|||
:'''[[OnTrapHitStop - ObjectReference|OnTrapHitStop]](ObjectReference ''akTarget'')''' |
|||
:*Event received when this trap object stops colliding with a target. |
|||
:'''[[OnTranslationAlmostComplete - ObjectReference|OnTranslationAlmostComplete]]()''' |
|||
:*Event received when a translation request is almost complete. |
|||
:'''[[OnTranslationComplete - ObjectReference|OnTranslationComplete]]()''' |
|||
:*Event received when a translation request is complete. |
|||
:'''[[OnTranslationFailed - ObjectReference|OnTranslationFailed]]()''' |
|||
:*Event received when a translation request has failed. |
|||
:'''[[OnTrigger - ObjectReference|OnTrigger]](ObjectReference ''akActionRef'')''' |
|||
:*Event received when this object is triggered. |
|||
:'''[[OnTriggerEnter - ObjectReference|OnTriggerEnter]](ObjectReference ''akActionRef'')''' |
|||
:*Event received when this object's volume is entered. |
|||
:'''[[OnTriggerLeave - ObjectReference|OnTriggerLeave]](ObjectReference ''akActionRef'')''' |
|||
:*Event received when this object's volume is left. |
|||
:'''[[OnUnequipped - ObjectReference|OnUnequipped]](Actor ''akActor'')''' |
|||
:*Event received when this object is unequipped by an actor. |
|||
:'''[[OnUnload - ObjectReference|OnUnload]]()''' |
|||
:*Event received when this object's 3d has been unloaded. |
|||
:'''[[OnWardHit - ObjectReference|OnWardHit]](ObjectReference ''akCaster'', Spell ''akSpell'', Int ''aiStatus'')''' |
|||
:*Event called when the object reference is using a ward that is hit by a spell. |
|||
[[Category:Scripting]] |
|||
[[Category:Papyrus]] |
|||
[[Category:Script Objects]] |
|||
[[Category:SKSE]] |
|||
Latest revision as of 20:09, 5 September 2026
Extends: Form Script
Script for the manipulation of object instances.
If you are adding a script to an object that is going to be a reference in the world (like a button for example) your script will need to extend this script.
Definition[edit | edit source]
ScriptName ObjectReference extends FormProperties[edit | edit source]
- 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.
These properties are meant to be used when calling SetMotionType:
- int Motion_Dynamic [read-only]: 1
- int Motion_SphereInertia [read-only]: 2
- int Motion_BoxInertia [read-only]: 3
- int Motion_Keyframed [read-only]: 4
- int Motion_Fixed [read-only]: 5
- int Motion_ThinBoxInertia [read-only]: 6
- int Motion_Character [read-only]: 7
Global Functions[edit | edit source]
None
Member Functions[edit | edit source]
- Activate(ObjectReference akActivator)
- Have the passed in reference activate this object.
- AddInventoryEventFilter(Form akFilter)
- Adds an inventory event filter to this reference.
- AddItem(Form akItemToAdd, Int aiCount, Bool abSilent)
- Adds the passed in item to this object's inventory.
- AddKeyIfNeeded(ObjectReference ObjectWithNeededKey)
- Adds the key to ObjectWithNeededKey if this object's inventory does not contain it already.
- AddToMap(Bool abAllowFastTravel)
- Adds this map marker to the map, optionally making it available for fast travel.
- ApplyHavokImpulse(Float afX, Float afY, Float afZ, Float afMagnitude)
- Apply a Havok impulse force to this object.
- BlockActivation(Bool abBlocked)
- Blocks normal activation processing for this reference.
- Int CalculateEncounterLevel(Int aiDifficulty)
- Calculate this object's encounter level, using the specified difficulty.
- Bool CanFastTravelToMarker()
- Can the player fast travel to this map marker?
- ClearDestruction()
- Clears all effects of destruction from this object.
- Int CountLinkedRefChain(Keyword apKeyword, Int maxExpectedLinkedRefs)
- Counts the number of linked refs that are in a linked Ref chain
- CreateDetectionEvent(Actor akOwner, Int aiSoundLevel)
- Create a detection event at this reference, with the specified owner.
- DamageObject(Float afDamage)
- Damages this object and advances the destruction stage.
- Delete()
- Deletes this object.
- DeleteWhenAble()
- Waits until this reference is out of the loaded area and then deletes it
- Disable(Bool abFadeOut)
- Disables this object.
- DisableLinkChain(Keyword apKeyword, Bool abFadeOut)
- Disables all of the references that are linked, in a chain, to this one.
- DisableNoWait(Bool abFadeOut)
- Disables this object and does not wait for the object to be disable or faded out.
- DropObject(Form akObject, Int aiCount)
- Drops the specified object from this object's inventory.
- Enable(Bool abFadeIn)
- Enables this object.
- EnableFastTravel(Bool abEnable)
- Enables or disables fast travel to this map marker.
- EnableLinkChain(Keyword apKeyword)
- Enables all of the references that are linked, in a chain, to this one.
- EnableNoWait(Bool abFadeIn)
- Enables this object and does not wait for the object to be enabled or faded in.
- ForceAddRagdollToWorld()
- Forcibly adds the ragdoll of a reference to the world
- ForceRemoveRagdollFromWorld()
- Forcibly removes the ragdoll of a reference from the world
- ActorBase GetActorOwner()
- Obtains the actor base that owns this object.
- Float GetAngleX()
- Obtains this object's rotation around the x axis.
- Float GetAngleY()
- Obtains this object's rotation around the y axis.
- Float GetAngleZ()
- Obtains this object's rotation around the z axis.
- Bool GetAnimationVariableBool(String asVariableName)
- Fetches the value of a variable on the reference's animation graph (bool version).
- Float GetAnimationVariableFloat(String asVariableName)
- Fetches the value of a variable on the reference's animation graph (float version).
- Int GetAnimationVariableInt(String asVariableName)
- Fetches the value of a variable on the reference's animation graph (int version).
- Form GetBaseObject()
- Obtains this reference's base object.
- Int GetCurrentDestructionStage()
- Gets the object's current stage of destruction.
- Location GetCurrentLocation()
- Obtains this reference's current location.
- Scene GetCurrentScene()
- Obtains the scene that this reference is currently participating in, if any.
- Float GetDistance(ObjectReference akOther)
- Calculates the distance between this object and the passed in one.
- Location GetEditorLocation()
- Obtains this reference's editor location.
- Faction GetFactionOwner()
- Gets the faction that owns this reference.
- Float GetHeadingAngle(ObjectReference akOther)
- Gets the angle between this object's heading, and the direction the other object is in.
- Float GetHeight()
- Gets the height of this object
- Int GetItemCount(Form akItem)
- Returns how many of the specified item is in this object's inventory.
- Float GetItemHealthPercent()
- Returns the item health percent of this object (1.0 == 100%).
- Key GetKey()
- Obtains the key that unlocks this object (if any).
- Float GetLength()
- Obtains the length of this object.
- ObjectReference GetLinkedRef(Keyword apKeyword)
- Returns our linked reference for the given Keyword, if any.
- Int GetLockLevel()
- Obtains the level of the lock on this object.
- Float GetMass()
- Obtains this object's mass in Havok.
- ObjectReference GetNthLinkedRef(Int aiLinkedRef)
- Obtains the nth linked ref from this object.
- Int GetOpenState()
- Obtains this object's current "open state".
- Cell GetParentCell()
- Obtains the cell this object is currently in.
- Float GetPositionX()
- Returns this object's current X position.
- Float GetPositionY()
- Returns this object's current Y position.
- Float GetPositionZ()
- Returns this object's current Z position.
- Float GetScale()
- Get this object's current scale.
- Int GetTriggerObjectCount()
- Returns the number of objects inside this trigger volume.
- VoiceType GetVoiceType()
- Obtains the VoiceType for this actor or talking activator.
- Float GetWidth()
- Get the current width of the object.
- Worldspace GetWorldSpace()
- Returns the worldspace this reference is in.
- Bool HasEffectKeyword(Keyword akKeyword)
- Returns if this reference has an active effect coming from a magic effect with the specified keyword attached
- Bool HasNode(String asNodeName)
- Returns if this reference has the specified name node in its 3D.
- Bool HasRefType(LocationRefType akRefType)
- Returns if this reference has the specified LocationRefType attached.
- IgnoreFriendlyHits(Bool abIgnore)
- Flags this reference as ignoring (or not ignoring) friendly hits
- InterruptCast()
- Interrupts any spellcasting this object may be doing.
- Bool IsActivateChild(ObjectReference akChild)
- Returns whether the passed in reference is an activate child of this reference.
- Bool IsActivationBlocked()
- Returns whether normal activation processing is currently blocked on this reference or not.
- Bool Is3DLoaded()
- Checks to see if this reference's 3D data is currently loaded or not.
- Bool IsDeleted()
- Checks to see if this object is currently flagged for delete.
- Bool IsDisabled()
- Is this object currently disabled?
- Bool IsEnabled()
- Is this object currently enabled?
- Bool IsFurnitureInUse(Bool abIgnoreReserved)
- Is any furniture marker on this object in use?
- Bool IsFurnitureMarkerInUse(Int aiMarker, Bool abIgnoreReserved)
- Is the specified furniture marker on this object in use?
- Bool IsIgnoringFriendlyHits()
- Is this object ignoring friendly hits?
- Bool IsInDialogueWithPlayer()
- Is this actor or talking activator currently talking to the player?
- Bool IsInInterior()
- Returns true if the object is in an interior cell.
- Bool IsInLocation(Location akLocation)
- Returns true if the object is currently in that location or a child of that location.
- Bool IsLocked()
- Is the lock on this object locked?
- Bool IsMapMarkerVisible()
- Is this map marker visible to the player?
- Bool IsNearPlayer()
- A quick-and-dirty function to tell if this object is safe to enable or disable
- KnockAreaEffect(Float afMagnitude, Float afRadius)
- Executes a knock effect to an area
- Lock(Bool abLock, Bool abAsOwner)
- Locks or unlocks this object.
- 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 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.
- MoveToInteractionLocation(ObjectReference akTarget)
- Moves this object to the specified object's interaction location.
- MoveToMyEditorLocation()
- Moves this object to its own editor location.
- MoveToNode(ObjectReference akTarget, String asNodeName)
- Moves this object to the position (and rotation) of the specified node on the specified object's 3D
- Actor PlaceActorAtMe(ActorBase akActorToPlace, Int aiLevelMod, EncounterZone akZone)
- Create an actor at this object's location.
- ObjectReference PlaceAtMe(Form akFormToPlace, Int aiCount)
- Places x copies of the passed in form at this object's current position, returning the last one created.
- Bool PlayAnimation(String asAnimation)
- Plays the specified animation on this object, returning immediately.
- Bool PlayAnimationAndWait(String asAnimation, String asEventName)
- Plays the specified animation on this object and waits for the specified event before returning. (latent)
- Bool PlayGamebryoAnimation(String asAnimation, Bool abStartOver, Float afEaseInTime)
- Plays a legacy nif file based animation
- Bool PlayImpactEffect(ImpactDataSet akImpactEffect, String asNodeName, Float afPickDirX, Float afPickDirY, Float afPickDirZ, Float afPickLength, Bool abApplyNodeRotation, Bool abUseNodeLocalRotation)
- Plays an impact effect.
- Bool PlaySyncedAnimationAndWaitSS(String asAnimation1, String asEvent1, ObjectReference akObj2, String asAnimation2, String asEvent2)
- Plays two animations simultaneously, waiting for events from both.
- Bool PlaySyncedAnimationSS(String asAnimation1, ObjectReference akObj2, String asAnimation2)
- Plays two animations simultaneously.
- PlayTerrainEffect(String asEffectModelName, String asAttachBoneName)
- Plays a terrain effect.
- 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.
- PushActorAway(Actor akActorToPush, Int aiKnockbackDamage)
- Pushes the other actor away from this object as if hit by the specified amount of knockback damage.
- Bool RampRumble(Float power, Float duration, Float falloff)
- Shakes cam/controller based on distance from player
- RemoveAllInventoryEventFilters()
- Remove all inventory event filters on this reference.
- RemoveAllItems(ObjectReference akTransferTo, Bool abKeepOwnership, Bool abSilent)
- Removes all items from this container, optionall transferring them to another one.
- RemoveInventoryEventFilter(Form akFilter)
- Remove a specific inventory event filter.
- RemoveItem(Form akItemToRemove, Int aiCount, Bool abSilent, ObjectReference akOtherContainer)
- Removes the passed in item from this object's inventory.
- Reset(ObjectReference akTarget)
- Resets this object reference, optionally placing the object at the new target.
- Say(Topic akTopicToSay, Actor akActorToSpeakAs, Bool abSpeakInPlayersHead)
- Causes this reference to speak a topic as if it were the specified actor.
- SendStealAlarm(Actor akThief)
- Sends a steal alarm as if this reference had just been stolen by the actor.
- SetActorCause(Actor akActor)
- Sets this actor as this object's actor cause.
- SetActorOwner(ActorBase akActorBase)
- Sets this actor base as this object's owner.
- SetAngle(Float afXAngle, Float afYAngle, Float afZAngle)
- Sets this object's rotation. Angles are in degrees.
- SetAnimationVariableBool(String asVariableName, Bool abNewValue)
- Sets the value of a variable on the reference's animation graph (bool version).
- SetAnimationVariableFloat(String asVariableName, Float afNewValue)
- Sets the value of a variable on the reference's animation graph (float version).
- SetAnimationVariableInt(String asVariableName, Int aiNewValue)
- Sets the value of a variable on the reference's animation graph (int version).
- SetDestroyed(Bool abDestroyed)
- Sets or clears this object's destroyed flag.
- SetFactionOwner(Faction akFaction)
- Sets this faction as this object's owner.
- SetLockLevel(Int aiLockLevel)
- Sets the lock level on this object.
- SetMotionType(Int aiMotionType, Bool abAllowActivate)
- Sets the havok motion type on this object.
- SetNoFavorAllowed(Bool abNoFavor)
- Sets or clears this object's ability to be not used by a teammate for a favor
- SetOpen(Bool abOpen)
- Opens or closes this object.
- SetPosition(Float afX, Float afY, Float afZ)
- Sets this object's position.
- SetScale(Float afScale)
- Set the current scale of the object
- SplineTranslateTo(Float afX, Float afY, Float afZ, Float afAngleX, Float afAngleY, Float afAngleZ, Float afSplineCurve, Float afSpeed)
- Makes the object translate to the given pos/orient on a spline.
- 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
- 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
- StopTranslation()
- Stops any translation on the object.
- TetherToHorse(ObjectReference akHorse)
- Tether a prisoner cart to the given horse.
- 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.
- TranslateToRef(ObjectReference arTarget, Float afSpeed, Float afMaxRotationSpeed)
- Makes the reference translate to the target ref position/orient at the given speed
- Bool WaitForAnimationEvent(String asEventName)
- Waits for the animation graph to send the specified event.
SKSE Member Functions[edit | edit source]
- Form[] GetContainerForms()
- (Container only) Returns an array of the forms in a container. (Actor ObjectReferences are containers)
- Int GetNumItems()
- (Container only) Returns the number of forms in the container. (Actor ObjectReferences are containers)
- Form GetNthForm(Int index)
- (Container only) Returns the specified form from the container. (Actor ObjectReferences are containers)
- Float GetTotalItemWeight()
- (Container only - perhaps Player only) Returns the total weight of all items held in the container.
- Float GetTotalArmorWeight()
- (Container only - perhaps Player only) Returns the total weight of the armor in the container.
- Bool IsHarvested()
- (Flora and Tree only) Returns whether the flora has been harvested or not.
- SetHarvested(Bool harvested)
- Sets whether the Reference has been harvested.
- SetItemHealthPercent(Float health)
- Set the item's tempering. 1.0 is no tempering, 1.6 appears to be legendary. Values below 1.0 do nothing.
- SetItemMaxCharge(Float maxCharge)
- Sets the maximum charge of the item.(Only works on player enchants)
- Float GetItemMaxCharge()
- Gets the maximum charge of the item.
- Float GetItemCharge()
- Gets the current charge of the item.
- SetItemCharge(Float charge)
- Sets the item's charge to the specified amount.
- ResetInventory()
- Resets the References inventory.
- Bool IsOffLimits()
- String GetDisplayName()
- Returns the name of the reference (This is the name that is displayed)
- Bool SetDisplayName(String name, Bool force)
- Sets the reference's display name.
- ObjectReference GetEnableParent()
- Returns the enable parent of the object.
- Enchantment GetEnchantment()
- Returns the player-made enchantment of the object (if there is one)
- SetEnchantment(Enchantment source, Float maxCharge)
- Changes an item's player-made enchantment to another.
- CreateEnchantment(Float maxCharge, MagicEffect[] effects, Float[] magnitudes, Int[] areas, Int[] durations)
- Creates a new Enchantment on the item with the specified parameters.
- Int GetNumReferenceAliases()
- Returns the number of reference aliases holding this reference.
- ReferenceAlias GetNthReferenceAlias(Int n)
- Returns the nth Reference alias holding this reference.
Events[edit | edit source]
- OnActivate(ObjectReference akActionRef)
- Event received when this object is activated.
- OnAttachedToCell()
- Event received when this reference moves from a detached cell to an attached one.
- OnCellAttach()
- Event received when this reference's parent cell attaches.
- OnCellDetach()
- Event received when this reference's parent cell detaches.
- OnCellLoad()
- Event received when everything in the cell that holds this reference has loaded.
- OnClose(ObjectReference akActionRef)
- Event received when this object is finished closing.
- OnContainerChanged(ObjectReference akNewContainer, ObjectReference akOldContainer)
- Event received when an object moves into/out of/between containers.
- OnDestructionStageChanged(Int aiOldStage, Int aiCurrentStage)
- Event received when this object's destruction stage has worsened.
- OnDetachedFromCell()
- Event received when this object moves from an attached cell to a detached cell.
- OnEquipped(Actor akActor)
- Event received when this object is equipped by an actor.
- OnGrab()
- Event received when this object is grabbed (z-keyed) by the player.
- OnHit(ObjectReference akAggressor, Form akSource, Projectile akProjectile, Bool abPowerAttack, Bool abSneakAttack, Bool abBashAttack, Bool abHitBlocked)
- Event received when this object is hit with a weapon or projectile.
- OnItemAdded(Form akBaseItem, Int aiItemCount, ObjectReference akItemReference, ObjectReference akSourceContainer)
- Event received when an item is inserted into this object's container.
- OnItemRemoved(Form akBaseItem, Int aiItemCount, ObjectReference akItemReference, ObjectReference akDestContainer)
- Event received when an item is removed from this object's container.
- OnLoad()
- Event received when this object's 3d is loaded and ready.
- OnLockStateChanged()
- Event received when the lock on this object changes its state.
- OnMagicEffectApply(ObjectReference akCaster, MagicEffect akEffect)
- Event received when a magic effect is attempting to be applied to this reference.
- OnOpen(ObjectReference akActionRef)
- Event received when this object is fully opened.
- OnRead()
- Event received when this object is read. (Only applies to books)
- OnRelease()
- Event received when this object is released by the player (stopped z-keying).
- OnReset()
- Event received when this object is reset.
- OnSell(Actor akSeller)
- Event received when this object is sold by someone.
- OnSpellCast(Form akSpell)
- Event received when this object casts a spell.
- OnTrapHit(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 hits a target.
- 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.
- OnTrapHitStop(ObjectReference akTarget)
- Event received when this trap object stops colliding with a target.
- OnTranslationAlmostComplete()
- Event received when a translation request is almost complete.
- OnTranslationComplete()
- Event received when a translation request is complete.
- OnTranslationFailed()
- Event received when a translation request has failed.
- OnTrigger(ObjectReference akActionRef)
- Event received when this object is triggered.
- OnTriggerEnter(ObjectReference akActionRef)
- Event received when this object's volume is entered.
- OnTriggerLeave(ObjectReference akActionRef)
- Event received when this object's volume is left.
- OnUnequipped(Actor akActor)
- Event received when this object is unequipped by an actor.
- OnUnload()
- Event received when this object's 3d has been unloaded.
- OnWardHit(ObjectReference akCaster, Spell akSpell, Int aiStatus)
- Event called when the object reference is using a ward that is hit by a spell.