Editing ScriptObject Script

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

'''Extends:''' None

Native base object for every script object in the game. Has no form or editor object equivalent, and will be forced as the base object of every script, even if a script does not explicitly extend it.

== Definition ==
<source lang="papyrus">
ScriptName ScriptObject Native Hidden
</source>

== Properties ==
None

== Global Functions ==
None

== Member Functions ==
*Function [[AddInventoryEventFilter - ScriptObject|AddInventoryEventFilter]](Form akFilter)
**Adds an inventory event filter to this script.
*Var Function [[CallFunction - ScriptObject|CallFunction]](string asFuncName, Var[] aParams)
**Calls a function on this script synchronously by name.
*Function [[CallFunctionNoWait - ScriptObject|CallFunctionNoWait]](string asFuncName, Var[] aParams)
**Calls a function on this script asynchronously by name.
*Function [[CancelTimer - ScriptObject|CancelTimer]](int aiTimerID)
**Cancels a pending real-time timer event on this script with the specified ID.
*Function [[CancelTimerGameTime - ScriptObject|CancelTimerGameTime]](int aiTimerID)
**Cancels a pending game-time timer event on this script with the specified ID.
*ScriptObject Function [[CastAs - ScriptObject|CastAs]](string asScriptName)
**Attempts to cast this script as another kind of script, but without adding a dependency to the caller.
*Var Function [[GetPropertyValue - ScriptObject|GetPropertyValue]](string asPropertyName)
**Obtains the value of a property on this script by name.
*string Function [[GetState - ScriptObject|GetState]]()
**Obtains this script's current state
*string Function [[GotoState - ScriptObject|GotoState]](string asNewState)
**Sets this script's current state, calling the appropriate begin/end state events.
*bool Function [[IsBoundGameObjectAvailable - ScriptObject|IsBoundGameObjectAvailable]]()
**Checks to see if this script is attached to a valid, and available, in-game object.
*Function [[RegisterForAnimationEvent - ScriptObject|RegisterForAnimationEvent]](ObjectReference akSender, string asEventName)
**Registers this script to receive the specified animation event from the specified object reference.
*Function [[RegisterForCustomEvent - ScriptObject|RegisterForCustomEvent]](ScriptObject akEventSource, CustomEventName asEventName)
**Registers this script to receive the specified custom event from the specified script.
*Function [[RegisterForDetectionLOSGain - ScriptObject|RegisterForDetectionLOSGain]](Actor akViewer, ObjectReference akTarget)
**Registers this script to receive a single detection-based LOS gain event when the viewer sees the target.
*Function [[RegisterForDetectionLOSLost - ScriptObject|RegisterForDetectionLOSLost]](Actor akViewer, ObjectReference akTarget)
**Registers this script to receive a single detection-based LOS lost event when the viewer loses sight of the target.
*Function [[RegisterForDirectLOSGain - ScriptObject|RegisterForDirectLOSGain]](ObjectReference akViewer, ObjectReference akTarget, string asViewerNode, string asTargetNode)
**Registers this script to receive a single direct LOS gain event when the viewer sees the target.
*Function [[RegisterForDirectLOSLost - ScriptObject|RegisterForDirectLOSLost]](ObjectReference akViewer, ObjectReference akTarget, string asViewerNode, string asTargetNode)
**Registers this script to receive a single direct LOS lost event when the viewer loses sight of the target.
*Function [[RegisterForDistanceGreaterThanEvent - ScriptObject|RegisterForDistanceGreaterThanEvent]](ScriptObject akObj1, ScriptObject akObj2, float afDistance)
**Registers this script to receive a single distance greater than event when the two objects are farther then afDistance apart.
*Function [[RegisterForDistanceLessThanEvent - ScriptObject|RegisterForDistanceLessThanEvent]](ScriptObject akObj1, ScriptObject akObj2, float afDistance)
**Registers this script to receive a single distance less than event when the two objects are closer then afDistance apart.
*Function [[RegisterForHitEvent - ScriptObject|RegisterForHitEvent]](ScriptObject akTarget, ScriptObject akAggressorFilter, Form akSourceFilter, Form akProjectileFilter, int aiPowerFilter, int aiSneakFilter, int aiBashFilter, int aiBlockFilter, bool abMatch)
**Registers this script to receive a single hit event matching the filters passed in.
*Function [[RegisterForLooksMenuEvent - ScriptObject|RegisterForLooksMenuEvent]]()
**Registers this script to receive looks menu events.
*Function [[RegisterForMagicEffectApplyEvent - ScriptObject|RegisterForMagicEffectApplyEvent]](ScriptObject akTarget, ScriptObject akCasterFilter, Form akEffectFilter, bool abMatch)
**Registers this script to receive a single magic effect apply event matching the filters passed in.
*Function [[RegisterForMenuOpenCloseEvent - ScriptObject|RegisterForMenuOpenCloseEvent]](string asMenuName)
**Registers this script to receive menu open/close events from a particular menu
*Function [[RegisterForPlayerSleep - ScriptObject|RegisterForPlayerSleep]]()
**Registers this script to receive sleep events for when the player goes to sleep or wakes up.
*Function [[RegisterForPlayerTeleport - ScriptObject|RegisterForPlayerTeleport]]()
**Registers this script to receive teleport events from the player.
*Function [[RegisterForPlayerWait - ScriptObject|RegisterForPlayerWait]]()
**Registers this script to receive wait events from the player.
*Function [[RegisterForRadiationDamageEvent - ScriptObject|RegisterForRadiationDamageEvent]](ScriptObject akTarget)
**Registers this script to receive a single radiation damage event from the target.
*Function [[RegisterForRemoteEvent - ScriptObject|RegisterForRemoteEvent]](ScriptObject akEventSource, ScriptEventName asEventName)
**Registers this script to receive an event when the target script receives an event.
*Function [[RegisterForTrackedStatsEvent - ScriptObject|RegisterForTrackedStatsEvent]](string asStat, int aiThreshold)
**Registers this script to receive an event when a tracked stat equals or goes past a threshold.
*Function [[RegisterForTutorialEvent - ScriptObject|RegisterForTutorialEvent]](string asEventName)
**Registers this script to receive tutorial-related events.
*Function [[RemoveAllInventoryEventFilters - ScriptObject|RemoveAllInventoryEventFilters]]()
**Remove all inventory event filters on this script.
*Function [[RemoveInventoryEventFilter - ScriptObject|RemoveInventoryEventFilter]](Form akFilter)
**Remove a specific inventory event filter.
*Function [[SendCustomEvent - ScriptObject|SendCustomEvent]](CustomEventName asEventName)
**Sends a custom event to any other script that is registered for it.
*Function [[SetPropertyValue - ScriptObject|SetPropertyValue]](string asPropertyValue, Var aValue)
**Sets a property's value on this script by name, synchronously.
*Function [[SetPropertyValueNoWait - ScriptObject|SetPropertyValueNoWait]](string asPropertyValue, Var aValue)
**Sets a property's value on this script by name, asynchronously.
*Function [[StartTimer - ScriptObject|StartTimer]](float afInterval, int aiTimerID)
**Starts a real-time timer on this script with the specified ID and interval.
*Function [[StartTimerGameTime - ScriptObject|StartTimerGameTime]](float afInterval, int aiTimerID)
**Starts a game-time timer on this script with the specified ID and interval.
*Function [[UnregisterForAllEvents - ScriptObject|UnregisterForAllEvents]]()
**Unregisters this script from all events it has registered for.
*Function [[UnregisterForAllCustomEvents - ScriptObject|UnregisterForAllCustomEvents]]()
**Unregisters this script from all custom events it has registered for.
*Function [[UnregisterForAllHitEvents - ScriptObject|UnregisterForAllHitEvents]](ScriptObject akTarget)
**Unregisters this script from receiving any hit events from the specified target (or all targets).
*Function [[UnregisterForAllMagicEffectApplyEvents - ScriptObject|UnregisterForAllMagicEffectApplyEvents]](ScriptObject akTarget)
**Unregisters this script from receiving any magic effect apply events from the specified target (or all targets).
*Function [[UnregisterForAllMenuOpenCloseEvents - ScriptObject|UnregisterForAllMenuOpenCloseEvents]]()
**Unregisters this script from receiving any menu open/close events.
*Function [[UnregisterForAllRadiationDamageEvents - ScriptObject|UnregisterForAllRadiationDamageEvents]]()
**Unregisters this script from receiving any radiation damage events from all targets.
*Function [[UnregisterForAllRemoteEvents - ScriptObject|UnregisterForAllRemoteEvents]]()
**Unregisters this script from receiving any remote events it has registered for.
*Function [[UnregisterForAllTrackedStatsEvents - ScriptObject|UnregisterForAllTrackedStatsEvents]]()
**Unregisters this script from receiving any tracked stats events.
*Function [[UnregisterForAnimationEvent - ScriptObject|UnregisterForAnimationEvent]](ObjectReference akSender, string asEventName)
**Unregisters this script from receiving the specified animation event from the specified object reference.
*Function [[UnregisterForCustomEvent - ScriptObject|UnregisterForCustomEvent]](ScriptObject akEventSource, CustomEventName asEventName)
**Unregisters this script from receiving the specified custom event from the specified script.
*Function [[UnregisterForDistanceEvents - ScriptObject|UnregisterForDistanceEvents]](ScriptObject akObj1, ScriptObject akObj2)
**Unregisters this script from receiving any distance-related events from the two objects.
*Function [[UnregisterForLooksMenuEvent - ScriptObject|UnregisterForLooksMenuEvent]]()
**Unregisters this script from looks menu events.
*Function [[UnregisterForHitEvent - ScriptObject|UnregisterForHitEvent]](ScriptObject akTarget, ScriptObject akAggressorFilter, Form akSourceFilter, Form akProjectileFilter, int aiPowerFilter, int aiSneakFilter, int aiBashFilter, int aiBlockFilter, bool abMatch)
**Unregisters this script from receiving a specific filtered hit event.
*Function [[UnregisterForLOS - ScriptObject|UnregisterForLOS]](ObjectReference akViewer, ObjectReference akTarget)
**Unregisters this script from any LOS events between the viewer and target.
*Function [[UnregisterForMagicEffectApplyEvent - ScriptObject|UnregisterForMagicEffectApplyEvent]](ScriptObject akTarget, ScriptObject akCasterFilter, Form akEffectFilter, bool abMatch)
**Unregisters this script from receiving a specific filtered magic effect apply event.
*Function [[UnregisterForMenuOpenCloseEvent - ScriptObject|UnregisterForMenuOpenCloseEvent]](string asMenuName)
**Unregisters this script from receiving open/close menu events for a particular menu.
*Function [[UnregisterForPlayerSleep - ScriptObject|UnregisterForPlayerSleep]]()
**Unregisters this script from sleep events.
*Function [[UnregisterForPlayerTeleport - ScriptObject|UnregisterForPlayerTeleport]]()
**Unregisters this script from teleport events.
*Function [[UnregisterForPlayerWait - ScriptObject|UnregisterForPlayerWait]]()
**Unregisters this script from wait events.
*Function [[UnregisterForRadiationDamageEvent - ScriptObject|UnregisterForRadiationDamageEvent]](ScriptObject akTarget)
**Unregisters this script from receiving radiation damage events from the target.
*Function [[UnregisterForRemoteEvent - ScriptObject|UnregisterForRemoteEvent]](ScriptObject akEventSource, ScriptEventName asEventName)
**Unregisters this script from the specified event from the specified event source.
*Function [[UnregisterForTrackedStatsEvent - ScriptObject|UnregisterForTrackedStatsEvent]](string asStat)
**Unregisters this script from a tracked stat event.
*Function [[UnregisterForTutorialEvent - ScriptObject|UnregisterForTutorialEvent]](string asEventName)
**Unregisters this script from tutorial events.

== F4SE Member Functions ==
*[[RegisterForKey - ScriptObject|RegisterForKey]](Int ''key'')'''
**Registers the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events.
*[[UnregisterForKey - ScriptObject|UnregisterForKey]](Int ''key'')'''
**Unregisters the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events.
*[[RegisterForControl - ScriptObject|RegisterForControl]](String ''control'')'''
**Registers the given control for OnControlDown and OnControlUp events.
*[[UnregisterForControl - ScriptObject|UnregisterForControl]](String ''control'')'''
**Unregisters the given control for OnControlDown and OnControlUp events.

== Events ==
*Event [[OnAnimationEvent - ScriptObject|OnAnimationEvent]](ObjectReference akSource, string asEventName)
**Received when one of animation events we are listening for is received.
*Event [[OnAnimationEventUnregistered - ScriptObject|OnAnimationEventUnregistered]](ObjectReference akSource, string asEventName)
**Received when one of the animation events we are listening for has been automatically unregistered by the game due to the target animation graph unloading.
*Event [[OnBeginState - ScriptObject|OnBeginState]](string asOldState)
**Event received when a state has just been entered.
*Event [[OnDistanceGreaterThan - ScriptObject|OnDistanceGreaterThan]](ObjectReference akObj1, ObjectReference akObj2, float afDistance)
**Event received when the two objects are greater than the registered distance apart
*Event [[OnDistanceLessThan - ScriptObject|OnDistanceLessThan]](ObjectReference akObj1, ObjectReference akObj2, float afDistance)
**Event received when the two objects are less than the registered distance apart
*Event [[OnEndState - ScriptObject|OnEndState]](string asNewState)
**Event received when a state has just been left.
*Event [[OnGainLOS - ScriptObject|OnGainLOS]](ObjectReference akViewer, ObjectReference akTarget)
**Received when the viewer goes from not seeing the target to seeing the target - if this script is registered.
*Event [[OnHit - ScriptObject|OnHit]](ObjectReference akTarget, ObjectReference akAggressor, Form akSource, Projectile akProjectile, bool abPowerAttack, bool abSneakAttack, bool abBashAttack, bool abHitBlocked, string apMaterial)
**Event received when the target is hit with a weapon or projectile - if this script is registered.
*Event [[OnInit - ScriptObject|OnInit]]()
**Received when this script object's properties have been set, but before any other functions are called or events are received.
*Event [[OnLooksMenuEvent - ScriptObject|OnLooksMenuEvent]](int aiFlavor)
**Received when looks menu activity should trigger dialog.
*Event [[OnLostLOS - ScriptObject|OnLostLOS]](ObjectReference akViewer, ObjectReference akTarget)
**Received when the viewer goes from seeing the target to not seeing the target - if this script is registered.
*Event [[OnMagicEffectApply - ScriptObject|OnMagicEffectApply]](ObjectReference akTarget, ObjectReference akCaster, MagicEffect akEffect)
**Event received when a magic effect is attempting to be applied to the target - if this script is registered.
*Event [[OnMenuOpenCloseEvent - ScriptObject|OnMenuOpenCloseEvent]](string asMenuName, bool abOpening)
**Event received when a menu is opened or closed - if this script is registered
*Event [[OnPlayerSleepStart - ScriptObject|OnPlayerSleepStart]](float afSleepStartTime, float afDesiredSleepEndTime, ObjectReference akBed)
**Received when the player goes to sleep.
*Event [[OnPlayerSleepStop - ScriptObject|OnPlayerSleepStop]](bool abInterrupted, ObjectReference akBed)
**Received when the player wakes up or is interrupted in sleep.
*Event [[OnPlayerTeleport - ScriptObject|OnPlayerTeleport]]()
**Received when the player teleports.
*Event [[OnPlayerWaitStart - ScriptObject|OnPlayerWaitStart]](float afWaitStartTime, float afDesiredWaitEndTime)
**Received when the player starts waiting.
*Event [[OnPlayerWaitStop - ScriptObject|OnPlayerWaitStop]](bool abInterrupted)
**Received when the player stops waiting.
*Event [[OnRadiationDamage - ScriptObject|OnRadiationDamage]](ObjectReference akTarget, bool abIngested)
**Event received when the target takes radiation damage - if this script is registered.
*Event [[OnTimer - ScriptObject|OnTimer]](int aiTimerID)
**Received when the specified real-time timer expires.
*Event [[OnTimerGameTime - ScriptObject|OnTimerGameTime]](int aiTimerID)
**Received when the specified game-time timer expires.
*Event [[OnTrackedStatsEvent - ScriptObject|OnTrackedStatsEvent]](string asStat, int aiStatValue)
**Received when tracked stats are updated.
*Event [[OnTutorialEvent - ScriptObject|OnTutorialEvent]](String asEventName, Message aMessage)
**Event called whenever a tutorial-related event occurs

== F4SE Events ==
*[[OnKeyDown - Form|OnKeyDown]](Int ''keyCode'')'''
**Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are pressed.
*[[OnKeyUp - Form|OnKeyUp]](Int ''keyCode'', Float ''holdTime'')'''
**Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are released.
*[[OnControlDown - Form|OnControlDown]](String ''control'')'''
**Received when control(s) registered via [[RegisterForControl - Form|RegisterForControl]] are pressed.
*[[OnControlUp - Form|OnControlUp]](String ''control'', Float ''holdTime'')'''
**Received when control(s) registered via [[RegisterForControl - Form|RegisterForControl]] are released.
@@ Line 1: / Line 1: @@
+[[Category:Scripting]]
+[[Category:Papyrus]]
+[[Category:Script Objects]]
 '''Extends:''' None
@@ Line 135: / Line 139: @@
 == F4SE Member Functions ==
-*[[RegisterForCameraState - ScriptObject|RegisterForCameraState]]()
+*[[RegisterForKey - ScriptObject|RegisterForKey]](Int ''key'')'''
-**Registers for a camera state change.
+**Registers the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events.
+*[[UnregisterForKey - ScriptObject|UnregisterForKey]](Int ''key'')'''
-*[[RegisterForControl - ScriptObject|RegisterForControl]](string control)
+**Unregisters the given [[Input_Script#DXScanCodes|DXScanCode]] for OnKeyDown and OnKeyUp events.
+*[[RegisterForControl - ScriptObject|RegisterForControl]](String ''control'')'''
 **Registers the given control for OnControlDown and OnControlUp events.
+*[[UnregisterForControl - ScriptObject|UnregisterForControl]](String ''control'')'''
-*[[RegisterForExternalEvent - ScriptObject|RegisterForExternalEvent]](string eventName, string callback)
-**Registers the given callback for the given event name.
-*[[RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]](var filter = None)
-**Registers for a filtered furniture event.
-*[[RegisterForKey - ScriptObject|RegisterForKey]](int key)
-**Registers the given [[DirectX_Scan_Codes|DXScanCode]] for OnKeyDown and OnKeyUp events.
-*[[UnregisterForCameraState - ScriptObject|UnregisterForCameraState]]()
-**Unregisters for a camera state change.
-*[[UnregisterForControl - ScriptObject|UnregisterForControl]](string control)
 **Unregisters the given control for OnControlDown and OnControlUp events.
-*[[UnregisterForExternalEvent - ScriptObject|UnregisterForExternalEvent]](string eventName)
-**Unregisters any callbacks for the given event name.
-*[[UnregisterForFurnitureEvent - ScriptObject|UnregisterForFurnitureEvent]](var filter = None)
-**Unregisters for a filtered furniture event.
-*[[UnregisterForKey - ScriptObject|UnregisterForKey]](int key)
-**Unregisters the given [[DirectX_Scan_Codes|DXScanCode]] for OnKeyDown and OnKeyUp events.
 == Events ==
@@ Line 214: / Line 197: @@
 == F4SE Events ==
-*[[OnControlDown - ScriptObject|OnControlDown]](string control)
+*[[OnKeyDown - Form|OnKeyDown]](Int ''keyCode'')'''
-**Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are pressed.
+**Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are pressed.
+*[[OnKeyUp - Form|OnKeyUp]](Int ''keyCode'', Float ''holdTime'')'''
-*[[OnControlUp - ScriptObject|OnControlUp]](string control, float holdTime)
+**Received when key(s) registered via [[RegisterForKey - Form|RegisterForKey]] are released.
-**Received when control(s) registered via [[RegisterForControl - ScriptObject|RegisterForControl]] are released.
+*[[OnControlDown - Form|OnControlDown]](String ''control'')'''
+**Received when control(s) registered via [[RegisterForControl - Form|RegisterForControl]] are pressed.
-*[[OnFurnitureEvent - ScriptObject|OnFurnitureEvent]](Actor akActor, ObjectReference akFurniture, bool isGettingUp)
+*[[OnControlUp - Form|OnControlUp]](String ''control'', Float ''holdTime'')'''
-**Received when a furniture event is registered via [[RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]].
+**Received when control(s) registered via [[RegisterForControl - Form|RegisterForControl]] are released.
-*[[OnKeyDown - ScriptObject|OnKeyDown]](int keyCode)
-**Received when key(s) registered via [[RegisterForKey - ScriptObject|RegisterForKey]] are pressed.
-*[[OnKeyUp - ScriptObject|OnKeyUp]](int keyCode, float holdTime)
-**Received when key(s) registered via [[RegisterForKey - ScriptObject|RegisterForKey]] are released.
-*[[OnPlayerCameraState - ScriptObject|OnPlayerCameraState]](int oldState, int newState)
-**Received when a camera state is changed while registered via [[RegisterForCameraState - ScriptObject|RegisterForCameraState]].
-[[Category:Scripting]]
-[[Category:Papyrus]]
-[[Category:Script Objects]]