the CreationKit Wiki

Difference between revisions of "Alias Script"

Alias Script (edit)

Revision as of 10:41, 20 July 2015

393 bytes added ,  10:41, 20 July 2015
m
Clarified getName() and added some more links
imported>Bot Owned
imported>Bug64
m (Clarified getName() and added some more links)
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
Native base script for every alias in the game. Don't confuse this for [[ReferenceAlias Script]] which you are more likely to use.
Native base script for every alias in the game. Don't confuse this for [[ReferenceAlias Script]] which you are more likely to use.


Line 16: Line 13:


== Member Functions ==
== Member Functions ==
'''Quest Function [[GetOwningQuest - Alias|GetOwningQuest]]()'''
*Returns the [[Quest Script|Quest]] that owns this alias.


'''Function [[RegisterForAnimationEvent - Form|RegisterForAnimationEvent]](ObjectReference akSender, string asEventName)'''
:'''Quest [[GetOwningQuest - Alias|GetOwningQuest]]()'''
*Registers this alias to receive the specified animation event from the specified object.
:*Returns the [[Quest Script|Quest]] that owns this alias.
 
:'''[[RegisterForAnimationEvent - Form|RegisterForAnimationEvent]](ObjectReference ''akSender'', String ''asEventName'')'''
:*Registers this alias to receive the specified animation event from the specified object.
 
:'''[[RegisterForLOS - Form|RegisterForLOS]](Actor ''akViewer'', ObjectReference ''akTarget'')'''
:*Registers this alias to receive gain and lost LOS events between the viewer and the target.


'''Function [[RegisterForLOS - Form|RegisterForLOS]](Actor akViewer, ObjectReference akTarget)'''
:'''[[RegisterForSingleLOSGain - Form|RegisterForSingleLOSGain]](Actor ''akViewer'', ObjectReference ''akTarget'')'''
*Registers this alias to receive gain and lost LOS events between the viewer and the target.
:*Registers this alias to receive a single LOS gain event when the viewer sees the target.


'''Function [[RegisterForSingleLOSGain - Form|RegisterForSingleLOSGain]](Actor akViewer, ObjectReference akTarget)'''
:'''[[RegisterForSingleLOSLost - Form|RegisterForSingleLOSLost]](Actor ''akViewer'', ObjectReference ''akTarget'')'''
*Registers this alias to receive a single LOS gain event when the viewer sees the target.
:*Registers this alias to receive a single LOS lost event when the viewer loses sight of the target.


'''Function [[RegisterForSingleLOSLost - Form|RegisterForSingleLOSLost]](Actor akViewer, ObjectReference akTarget)'''
:'''[[RegisterForSingleUpdate - Form|RegisterForSingleUpdate]](Float ''afInterval'')'''
*Registers this alias to receive a single LOS lost event when the viewer loses sight of the target.
:*Registers this alias to receive a single update event in the specified time.


'''Function [[RegisterForSingleUpdate - Form|RegisterForSingleUpdate]](float afInterval)'''
:'''[[RegisterForSingleUpdateGameTime - Form|RegisterForSingleUpdateGameTime]](Float ''afInterval'')'''
*Registers this alias to receive a single update event in the specified time.
:*Registers this alias to receive a single update event in the specified number of game hours.


'''Function [[RegisterForSingleUpdateGameTime - Form|RegisterForSingleUpdateGameTime]](float afInterval)'''
:'''[[RegisterForSleep - Form|RegisterForSleep]]()'''
*Registers this alias to receive a single update event in the specified number of game hours.
:*Registers this alias to receive sleep events for when the player goes to sleep or wakes up.


'''Function [[RegisterForSleep - Form|RegisterForSleep]]()'''
:'''[[RegisterForTrackedStatsEvent - Form|RegisterForTrackedStatsEvent]]()'''
*Registers this alias to receive sleep events for when the player goes to sleep or wakes up.
:*Registers this alias to receive tracked stats events for when tracked stats are updated.


'''Function [[RegisterForTrackedStatsEvent - Form|RegisterForTrackedStatsEvent]]()'''
:'''[[RegisterForUpdate - Form|RegisterForUpdate]](Float ''afInterval'')'''
*Registers this alias to receive tracked stats events for when tracked stats are updated.
:*Registers this alias to receive update events with the specified interval, or changes the update interval.


'''Function [[RegisterForUpdate - Form|RegisterForUpdate]](float afInterval)'''
:'''[[RegisterForUpdateGameTime - Form|RegisterForUpdateGameTime]](Float ''afInterval'')'''
*Registers this alias to receive update events with the specified interval, or changes the update interval.
:*Registers this alias to receive update events with the specified interval in game time hours, or changes the update interval.


'''Function [[RegisterForUpdateGameTime - Form|RegisterForUpdateGameTime]](float afInterval)'''
:'''[[StartObjectProfiling - Form|StartObjectProfiling]]()'''
*Registers this alias to receive update events with the specified interval in game time hours, or changes the update interval.
:*Starts profiling all scripts attached to this alias.


'''Function [[StartObjectProfiling - Form|StartObjectProfiling]]()'''
:'''[[StopObjectProfiling - Form|StopObjectProfiling]]()'''
*Starts profiling all scripts attached to this alias.
:*Stops profiling all scripts attached to this alias.


'''Function [[StopObjectProfiling - Form|StopObjectProfiling]]()'''
:'''[[UnregisterForAnimationEvent - Form|UnregisterForAnimationEvent]](ObjectReference ''akSender'', String ''asEventName'')'''
*Stops profiling all scripts attached to this alias.
:*Unregisters this alias from receiving the specified animation event from the specified object.


'''Function [[UnregisterForAnimationEvent - Form|UnregisterForAnimationEvent]](ObjectReference akSender, string asEventName)'''
:'''[[UnregisterForLOS - Form|UnregisterForLOS]](Actor ''akViewer'', ObjectReference ''akTarget'')'''
*Unregisters this alias from receiving the specified animation event from the specified object.
:*Unregisters this alias from any LOS events between the viewer and target.


'''Function [[UnregisterForLOS - Form|UnregisterForLOS]](Actor akViewer, ObjectReference akTarget)'''
:'''[[UnregisterForSleep - Form|UnregisterForSleep]]()'''
*Unregisters this alias from any LOS events between the viewer and target.
:*Unregisters this alias from sleep events.


'''Function [[UnregisterForSleep - Form|UnregisterForSleep]]()'''
:'''[[UnregisterForTrackedStatsEvent - Form|UnregisterForTrackedStatsEvent]]()'''
*Unregisters this alias from sleep events.
:*Unregisters this alias from tracked stats events.


'''Function [[UnregisterForTrackedStatsEvent - Form|UnregisterForTrackedStatsEvent]]()'''
:'''[[UnregisterForUpdate - Form|UnregisterForUpdate]]()'''
*Unregisters this alias from tracked stats events.
:*Unregisters this alias from update events.


'''Function [[UnregisterForUpdate - Form|UnregisterForUpdate]]()'''
:'''[[UnregisterForUpdateGameTime - Form|UnregisterForUpdateGameTime]]()'''
*Unregisters this alias from update events.
:*Unregisters this alias from game time update events.


'''Function [[UnregisterForUpdateGameTime - Form|UnregisterForUpdateGameTime]]()'''
*Unregisters this alias from game time update events.


== SKSE Member Functions ==
== SKSE Member Functions ==
'''String Function [[GetName - Alias|GetName]]()'''
* Returns the name of the alias.


'''Int Function [[GetID - Alias| GetID]]()'''
:'''String [[GetName - Alias|GetName]]()'''
* Returns the ID of the alias.
:* Returns the unique name of the alias (not its display name).  Used by calls to [[GetAliasByName - Quest|GetAliasByName]].
 
:'''Int [[GetID - Alias|GetID]]()'''
:* Returns the ID of the alias. Used by calls to [[GetNthAlias - Quest|GetNthAlias]] and [[GetAlias - Quest|GetAlias]]
 
:'''[[RegisterForNiNodeUpdate]]()'''
:*Registers the script for when a QueueNiNodeUpdate is called
 
:'''[[UnregisterForNiNodeUpdate]]()'''
:*Unregisters the script for when a QueueNiNodeUpdate is called


== Events ==
== Events ==
'''Event [[OnAnimationEvent - Form|OnAnimationEvent]](ObjectReference akSource, string asEventName)'''
*Received when one of animation events we are listening for is received.


'''Event [[OnAnimationEventUnregistered - Form|OnAnimationEventUnregistered]](ObjectReference akSource, string asEventName)'''
:'''[[OnAnimationEvent - Form|OnAnimationEvent]](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.
:*Received when one of animation events we are listening for is received.


'''Event [[OnGainLOS - Form|OnGainLOS]](Actor akViewer, ObjectReference akTarget)'''
:'''[[OnAnimationEventUnregistered - Form|OnAnimationEventUnregistered]](ObjectReference ''akSource'', String ''asEventName'')'''
*Received when the viewer goes from not seeing the target to seeing the target - if this alias is registered.
:*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 [[OnLostLOS - Form|OnLostLOS]](Actor akViewer, ObjectReference akTarget)'''
:'''[[OnGainLOS - Form|OnGainLOS]](Actor ''akViewer'', ObjectReference ''akTarget'')'''
*Received when the viewer goes from seeing the target to not seeing the target - if this alias is registered.
:*Received when the viewer goes from not seeing the target to seeing the target - if this alias is registered.


'''Event [[OnReset - ObjectReference|OnReset]]()'''
:'''[[OnLostLOS - Form|OnLostLOS]](Actor ''akViewer'', ObjectReference ''akTarget'')'''
*Event received when this object is reset (usually when the quest the alias is attached to starts up).
:*Received when the viewer goes from seeing the target to not seeing the target - if this alias is registered.


'''Event [[OnSleepStart - Form|OnSleepStart]](float afSleepStartTime, float afDesiredSleepEndTime)'''
:'''[[OnReset - ObjectReference|OnReset]]()'''
*Received when the player goes to sleep.
:*Event received when this object is reset ]](usually when the quest the alias is attached to starts up).


'''Event [[OnSleepStop - Form|OnSleepStop]](bool abInterrupted)'''
:'''[[OnSleepStart - Form|OnSleepStart]](Float ''afSleepStartTime'', Float ''afDesiredSleepEndTime'')'''
*Received when the player wakes up or is interrupted in sleep.
:*Received when the player goes to sleep.


'''Event [[OnTrackedStatsEvent - Form|OnTrackedStatsEvent]](string asStat, int aiStatValue)'''
:'''[[OnSleepStop - Form|OnSleepStop]](Bool ''abInterrupted'')'''
*Received when tracked stats are updated.
:*Received when the player wakes up or is interrupted in sleep.


'''Event [[OnUpdate - Form|OnUpdate]]()'''
:'''[[OnTrackedStatsEvent - Form|OnTrackedStatsEvent]](String ''asStat'', Int ''aiStatValue'')'''
*Received at periodic intervals, if the alias is registered.
:*Received when tracked stats are updated.


'''Event [[OnUpdateGameTime - Form|OnUpdateGameTime]]()'''
:'''[[OnUpdate - Form|OnUpdate]]()'''
*Received at periodic intervals of game time, if the alias is registered.
:*Received at periodic intervals, if the alias is registered.
 
:'''[[OnUpdateGameTime - Form|OnUpdateGameTime]]()'''
:*Received at periodic intervals of game time, if the alias is registered.
 
== SKSE Events ==
 
'''[[OnNiNodeUpdate]](ObjectReference ''akActor'')'''


==Notes==
==Notes==
*This object is often confused with [[ReferenceAlias Script]]. You probably mean to be using that.
:*This object is often confused with [[ReferenceAlias Script]]. You probably mean to be using that.
 
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Script Objects]]
Anonymous user
Retrieved from "https://ck.uesp.net/wiki/Special:MobileDiff/6641...6646"