View source for Resource:Creation Kit/ScriptObject Script

{{Creation Kit}}
'''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 ==
<pre>
ScriptName ScriptObject Native Hidden
</pre>

== Properties ==
None

== Global Functions ==
None

== Member Functions ==
*Function [[Resource:Creation Kit/AddInventoryEventFilter - ScriptObject|AddInventoryEventFilter]](Form akFilter)
**Adds an inventory event filter to this script.
*Var Function [[Resource:Creation Kit/CallFunction - ScriptObject|CallFunction]](string asFuncName, Var[] aParams)
**Calls a function on this script synchronously by name.
*Function [[Resource:Creation Kit/CallFunctionNoWait - ScriptObject|CallFunctionNoWait]](string asFuncName, Var[] aParams)
**Calls a function on this script asynchronously by name.
*Function [[Resource:Creation Kit/CancelTimer - ScriptObject|CancelTimer]](int aiTimerID)
**Cancels a pending real-time timer event on this script with the specified ID.
*Function [[Resource:Creation Kit/CancelTimerGameTime - ScriptObject|CancelTimerGameTime]](int aiTimerID)
**Cancels a pending game-time timer event on this script with the specified ID.
*ScriptObject Function [[Resource:Creation Kit/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 [[Resource:Creation Kit/GetPropertyValue - ScriptObject|GetPropertyValue]](string asPropertyName)
**Obtains the value of a property on this script by name.
*string Function [[Resource:Creation Kit/GetState - ScriptObject|GetState]]()
**Obtains this script's current state
*string Function [[Resource:Creation Kit/GotoState - ScriptObject|GotoState]](string asNewState)
**Sets this script's current state, calling the appropriate begin/end state events.
*bool Function [[Resource:Creation Kit/IsBoundGameObjectAvailable - ScriptObject|IsBoundGameObjectAvailable]]()
**Checks to see if this script is attached to a valid, and available, in-game object.
*Function [[Resource:Creation Kit/RegisterForAnimationEvent - ScriptObject|RegisterForAnimationEvent]](ObjectReference akSender, string asEventName)
**Registers this script to receive the specified animation event from the specified object reference.
*Function [[Resource:Creation Kit/RegisterForCustomEvent - ScriptObject|RegisterForCustomEvent]](ScriptObject akEventSource, CustomEventName asEventName)
**Registers this script to receive the specified custom event from the specified script.
*Function [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/RegisterForLooksMenuEvent - ScriptObject|RegisterForLooksMenuEvent]]()
**Registers this script to receive looks menu events.
*Function [[Resource:Creation Kit/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 [[Resource:Creation Kit/RegisterForMenuOpenCloseEvent - ScriptObject|RegisterForMenuOpenCloseEvent]](string asMenuName)
**Registers this script to receive menu open/close events from a particular menu
*Function [[Resource:Creation Kit/RegisterForPlayerSleep - ScriptObject|RegisterForPlayerSleep]]()
**Registers this script to receive sleep events for when the player goes to sleep or wakes up.
*Function [[Resource:Creation Kit/RegisterForPlayerTeleport - ScriptObject|RegisterForPlayerTeleport]]()
**Registers this script to receive teleport events from the player.
*Function [[Resource:Creation Kit/RegisterForPlayerWait - ScriptObject|RegisterForPlayerWait]]()
**Registers this script to receive wait events from the player.
*Function [[Resource:Creation Kit/RegisterForRadiationDamageEvent - ScriptObject|RegisterForRadiationDamageEvent]](ScriptObject akTarget)
**Registers this script to receive a single radiation damage event from the target.
*Function [[Resource:Creation Kit/RegisterForRemoteEvent - ScriptObject|RegisterForRemoteEvent]](ScriptObject akEventSource, ScriptEventName asEventName)
**Registers this script to receive an event when the target script receives an event.
*Function [[Resource:Creation Kit/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 [[Resource:Creation Kit/RegisterForTutorialEvent - ScriptObject|RegisterForTutorialEvent]](string asEventName)
**Registers this script to receive tutorial-related events.
*Function [[Resource:Creation Kit/RemoveAllInventoryEventFilters - ScriptObject|RemoveAllInventoryEventFilters]]()
**Remove all inventory event filters on this script.
*Function [[Resource:Creation Kit/RemoveInventoryEventFilter - ScriptObject|RemoveInventoryEventFilter]](Form akFilter)
**Remove a specific inventory event filter.
*Function [[Resource:Creation Kit/SendCustomEvent - ScriptObject|SendCustomEvent]](CustomEventName asEventName)
**Sends a custom event to any other script that is registered for it.
*Function [[Resource:Creation Kit/SetPropertyValue - ScriptObject|SetPropertyValue]](string asPropertyValue, Var aValue)
**Sets a property's value on this script by name, synchronously.
*Function [[Resource:Creation Kit/SetPropertyValueNoWait - ScriptObject|SetPropertyValueNoWait]](string asPropertyValue, Var aValue)
**Sets a property's value on this script by name, asynchronously.
*Function [[Resource:Creation Kit/StartTimer - ScriptObject|StartTimer]](float afInterval, int aiTimerID)
**Starts a real-time timer on this script with the specified ID and interval.
*Function [[Resource:Creation Kit/StartTimerGameTime - ScriptObject|StartTimerGameTime]](float afInterval, int aiTimerID)
**Starts a game-time timer on this script with the specified ID and interval.
*Function [[Resource:Creation Kit/UnregisterForAllEvents - ScriptObject|UnregisterForAllEvents]]()
**Unregisters this script from all events it has registered for.
*Function [[Resource:Creation Kit/UnregisterForAllCustomEvents - ScriptObject|UnregisterForAllCustomEvents]]()
**Unregisters this script from all custom events it has registered for.
*Function [[Resource:Creation Kit/UnregisterForAllHitEvents - ScriptObject|UnregisterForAllHitEvents]](ScriptObject akTarget)
**Unregisters this script from receiving any hit events from the specified target (or all targets).
*Function [[Resource:Creation Kit/UnregisterForAllMagicEffectApplyEvents - ScriptObject|UnregisterForAllMagicEffectApplyEvents]](ScriptObject akTarget)
**Unregisters this script from receiving any magic effect apply events from the specified target (or all targets).
*Function [[Resource:Creation Kit/UnregisterForAllMenuOpenCloseEvents - ScriptObject|UnregisterForAllMenuOpenCloseEvents]]()
**Unregisters this script from receiving any menu open/close events.
*Function [[Resource:Creation Kit/UnregisterForAllRadiationDamageEvents - ScriptObject|UnregisterForAllRadiationDamageEvents]]()
**Unregisters this script from receiving any radiation damage events from all targets.
*Function [[Resource:Creation Kit/UnregisterForAllRemoteEvents - ScriptObject|UnregisterForAllRemoteEvents]]()
**Unregisters this script from receiving any remote events it has registered for.
*Function [[Resource:Creation Kit/UnregisterForAllTrackedStatsEvents - ScriptObject|UnregisterForAllTrackedStatsEvents]]()
**Unregisters this script from receiving any tracked stats events.
*Function [[Resource:Creation Kit/UnregisterForAnimationEvent - ScriptObject|UnregisterForAnimationEvent]](ObjectReference akSender, string asEventName)
**Unregisters this script from receiving the specified animation event from the specified object reference.
*Function [[Resource:Creation Kit/UnregisterForCustomEvent - ScriptObject|UnregisterForCustomEvent]](ScriptObject akEventSource, CustomEventName asEventName)
**Unregisters this script from receiving the specified custom event from the specified script.
*Function [[Resource:Creation Kit/UnregisterForDistanceEvents - ScriptObject|UnregisterForDistanceEvents]](ScriptObject akObj1, ScriptObject akObj2)
**Unregisters this script from receiving any distance-related events from the two objects.
*Function [[Resource:Creation Kit/UnregisterForLooksMenuEvent - ScriptObject|UnregisterForLooksMenuEvent]]()
**Unregisters this script from looks menu events.
*Function [[Resource:Creation Kit/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 [[Resource:Creation Kit/UnregisterForLOS - ScriptObject|UnregisterForLOS]](ObjectReference akViewer, ObjectReference akTarget)
**Unregisters this script from any LOS events between the viewer and target.
*Function [[Resource:Creation Kit/UnregisterForMagicEffectApplyEvent - ScriptObject|UnregisterForMagicEffectApplyEvent]](ScriptObject akTarget, ScriptObject akCasterFilter, Form akEffectFilter, bool abMatch)
**Unregisters this script from receiving a specific filtered magic effect apply event.
*Function [[Resource:Creation Kit/UnregisterForMenuOpenCloseEvent - ScriptObject|UnregisterForMenuOpenCloseEvent]](string asMenuName)
**Unregisters this script from receiving open/close menu events for a particular menu.
*Function [[Resource:Creation Kit/UnregisterForPlayerSleep - ScriptObject|UnregisterForPlayerSleep]]()
**Unregisters this script from sleep events.
*Function [[Resource:Creation Kit/UnregisterForPlayerTeleport - ScriptObject|UnregisterForPlayerTeleport]]()
**Unregisters this script from teleport events.
*Function [[Resource:Creation Kit/UnregisterForPlayerWait - ScriptObject|UnregisterForPlayerWait]]()
**Unregisters this script from wait events.
*Function [[Resource:Creation Kit/UnregisterForRadiationDamageEvent - ScriptObject|UnregisterForRadiationDamageEvent]](ScriptObject akTarget)
**Unregisters this script from receiving radiation damage events from the target.
*Function [[Resource:Creation Kit/UnregisterForRemoteEvent - ScriptObject|UnregisterForRemoteEvent]](ScriptObject akEventSource, ScriptEventName asEventName)
**Unregisters this script from the specified event from the specified event source.
*Function [[Resource:Creation Kit/UnregisterForTrackedStatsEvent - ScriptObject|UnregisterForTrackedStatsEvent]](string asStat)
**Unregisters this script from a tracked stat event.
*Function [[Resource:Creation Kit/UnregisterForTutorialEvent - ScriptObject|UnregisterForTutorialEvent]](string asEventName)
**Unregisters this script from tutorial events.

== F4SE Member Functions ==
*[[Resource:Creation Kit/RegisterForCameraState - ScriptObject|RegisterForCameraState]]()
**Registers for a camera state change.

*[[Resource:Creation Kit/RegisterForControl - ScriptObject|RegisterForControl]](string control)
**Registers the given control for OnControlDown and OnControlUp events.

*[[Resource:Creation Kit/RegisterForExternalEvent - ScriptObject|RegisterForExternalEvent]](string eventName, string callback)
**Registers the given callback for the given event name.

*[[Resource:Creation Kit/RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]](var filter = None)
**Registers for a filtered furniture event.

*[[Resource:Creation Kit/RegisterForKey - ScriptObject|RegisterForKey]](int key)
**Registers the given [[Resource:Creation Kit/DirectX_Scan_Codes|DXScanCode]] for OnKeyDown and OnKeyUp events.

*[[Resource:Creation Kit/UnregisterForCameraState - ScriptObject|UnregisterForCameraState]]()
**Unregisters for a camera state change.

*[[Resource:Creation Kit/UnregisterForControl - ScriptObject|UnregisterForControl]](string control)
**Unregisters the given control for OnControlDown and OnControlUp events.

*[[Resource:Creation Kit/UnregisterForExternalEvent - ScriptObject|UnregisterForExternalEvent]](string eventName)
**Unregisters any callbacks for the given event name.

*[[Resource:Creation Kit/UnregisterForFurnitureEvent - ScriptObject|UnregisterForFurnitureEvent]](var filter = None)
**Unregisters for a filtered furniture event.

*[[Resource:Creation Kit/UnregisterForKey - ScriptObject|UnregisterForKey]](int key)
**Unregisters the given [[Resource:Creation Kit/DirectX_Scan_Codes|DXScanCode]] for OnKeyDown and OnKeyUp events.

== Events ==
*Event [[Resource:Creation Kit/OnAnimationEvent - ScriptObject|OnAnimationEvent]](ObjectReference akSource, string asEventName)
**Received when one of animation events we are listening for is received.
*Event [[Resource:Creation Kit/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 [[Resource:Creation Kit/OnBeginState - ScriptObject|OnBeginState]](string asOldState)
**Event received when a state has just been entered.
*Event [[Resource:Creation Kit/OnDistanceGreaterThan - ScriptObject|OnDistanceGreaterThan]](ObjectReference akObj1, ObjectReference akObj2, float afDistance)
**Event received when the two objects are greater than the registered distance apart
*Event [[Resource:Creation Kit/OnDistanceLessThan - ScriptObject|OnDistanceLessThan]](ObjectReference akObj1, ObjectReference akObj2, float afDistance)
**Event received when the two objects are less than the registered distance apart
*Event [[Resource:Creation Kit/OnEndState - ScriptObject|OnEndState]](string asNewState)
**Event received when a state has just been left.
*Event [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/OnLooksMenuEvent - ScriptObject|OnLooksMenuEvent]](int aiFlavor)
**Received when looks menu activity should trigger dialog.
*Event [[Resource:Creation Kit/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 [[Resource:Creation Kit/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 [[Resource:Creation Kit/OnMenuOpenCloseEvent - ScriptObject|OnMenuOpenCloseEvent]](string asMenuName, bool abOpening)
**Event received when a menu is opened or closed - if this script is registered
*Event [[Resource:Creation Kit/OnPlayerSleepStart - ScriptObject|OnPlayerSleepStart]](float afSleepStartTime, float afDesiredSleepEndTime, ObjectReference akBed)
**Received when the player goes to sleep.
*Event [[Resource:Creation Kit/OnPlayerSleepStop - ScriptObject|OnPlayerSleepStop]](bool abInterrupted, ObjectReference akBed)
**Received when the player wakes up or is interrupted in sleep.
*Event [[Resource:Creation Kit/OnPlayerTeleport - ScriptObject|OnPlayerTeleport]]()
**Received when the player teleports.
*Event [[Resource:Creation Kit/OnPlayerWaitStart - ScriptObject|OnPlayerWaitStart]](float afWaitStartTime, float afDesiredWaitEndTime)
**Received when the player starts waiting.
*Event [[Resource:Creation Kit/OnPlayerWaitStop - ScriptObject|OnPlayerWaitStop]](bool abInterrupted)
**Received when the player stops waiting.
*Event [[Resource:Creation Kit/OnRadiationDamage - ScriptObject|OnRadiationDamage]](ObjectReference akTarget, bool abIngested)
**Event received when the target takes radiation damage - if this script is registered.
*Event [[Resource:Creation Kit/OnTimer - ScriptObject|OnTimer]](int aiTimerID)
**Received when the specified real-time timer expires.
*Event [[Resource:Creation Kit/OnTimerGameTime - ScriptObject|OnTimerGameTime]](int aiTimerID)
**Received when the specified game-time timer expires.
*Event [[Resource:Creation Kit/OnTrackedStatsEvent - ScriptObject|OnTrackedStatsEvent]](string asStat, int aiStatValue)
**Received when tracked stats are updated.
*Event [[Resource:Creation Kit/OnTutorialEvent - ScriptObject|OnTutorialEvent]](String asEventName, Message aMessage)
**Event called whenever a tutorial-related event occurs

== F4SE Events ==
*[[Resource:Creation Kit/OnControlDown - ScriptObject|OnControlDown]](string control)
**Received when control(s) registered via [[Resource:Creation Kit/RegisterForControl - ScriptObject|RegisterForControl]] are pressed.

*[[Resource:Creation Kit/OnControlUp - ScriptObject|OnControlUp]](string control, float holdTime)
**Received when control(s) registered via [[Resource:Creation Kit/RegisterForControl - ScriptObject|RegisterForControl]] are released.

*[[Resource:Creation Kit/OnFurnitureEvent - ScriptObject|OnFurnitureEvent]](Actor akActor, ObjectReference akFurniture, bool isGettingUp)
**Received when a furniture event is registered via [[Resource:Creation Kit/RegisterForFurnitureEvent - ScriptObject|RegisterForFurnitureEvent]].

*[[Resource:Creation Kit/OnKeyDown - ScriptObject|OnKeyDown]](int keyCode)
**Received when key(s) registered via [[Resource:Creation Kit/RegisterForKey - ScriptObject|RegisterForKey]] are pressed.

*[[Resource:Creation Kit/OnKeyUp - ScriptObject|OnKeyUp]](int keyCode, float holdTime)
**Received when key(s) registered via [[Resource:Creation Kit/RegisterForKey - ScriptObject|RegisterForKey]] are released.

*[[Resource:Creation Kit/OnPlayerCameraState - ScriptObject|OnPlayerCameraState]](int oldState, int newState)
**Received when a camera state is changed while registered via [[Resource:Creation Kit/RegisterForCameraState - ScriptObject|RegisterForCameraState]].


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