The Alias script is a part of Skyrim SE’s Papyrus scripting ecosystem. It is included with the base game, and is extended/modified by modded sources such as Skyrim Script Extender x64 (SKSE).
For this script, the Papyrus index knows about:
- 19 events
- 42 functions
Inheritance Tree
| Script | Extended By | ||||||
|---|---|---|---|---|---|---|---|
| — | |||||||
|
Properties
No properties found.
Events
- eventOnAnimationEvent(ObjectReferenceakSource, stringasEventName)
Event called when the active magic effect/alias/form receives one of the animation events it was listening for.
- eventOnAnimationEventUnregistered(ObjectReferenceakSource, stringasEventName)
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. This event is not received when you manually unregister for the event.
- eventOnGainLOS(ActorakViewer, ObjectReferenceakTarget)
Event called when a viewer goes from not seeing the target, to seeing the target - if this active magic effect/alias/form is registered for it.
- eventOnLostLOS(ActorakViewer, ObjectReferenceakTarget)
Event called when a viewer goes from seeing the target, to not seeing the target - if this active magic effect/alias/form is registered for it.
- eventOnSleepStart(floatafSleepStartTime, floatafDesiredSleepEndTime)
Received when the player sleeps. Start and desired end time are in game time days (after registering)
- eventOnSleepStop(boolabInterrupted)
Received when the player stops sleeping - whether naturally or interrupted (after registering)
- eventOnTrackedStatsEvent(stringarStatName, intaiStatValue)
Event received when a tracked stat is updated for the player
- eventOnUpdateGameTime()
Update event, sent every X hours of game time while this alias is registered for them
- Found in:
- SKSE
eventOnControlDown(stringcontrol)- Found in:
- SKSE
eventOnControlUp(stringcontrol, floatholdTime)- Found in:
- SKSE
eventOnMenuOpen(stringmenuName)- Found in:
- SKSE
eventOnMenuClose(stringmenuName)- Found in:
- SKSE
eventOnPlayerCameraState(intoldState, intnewState)- Found in:
- SKSE
eventOnCrosshairRefChange(ObjectReferenceref)- Found in:
- SKSE
eventOnActorAction(intactionType, ActorakActor, Formsource, intslot)- Found in:
- SKSE
eventOnNiNodeUpdate(ObjectReferenceakActor)
Functions
Gets the quest that owns this alias.
Register for the specified animation event from the specified object - returns true if it successfully registered
Register for LOS gain and lost events between the viewer and the target
A loss or gain event will be sent immediately, depending on whether or not the viewer is already looking at the target or not
If the viewer is not the player, the target must be another actorRegister for only the first LOS gain event between the viewer and the target
If the viewer is already looking at the target, an event will be received almost immediately
If the viewer is not the player, the target must be another actorRegister for only the first LOS lost event between the viewer and the target
If the viewer is already not looking at the target, an event will be received almost immediately
If the viewer is not the player, the target must be another actorRegister for a single OnUpdate event, in afInterval seconds. All scripts attached to this alias will get the update events
Of course, this means you don't need to call UnregisterForUpdate()
If you find yourself doing this:
Event OnUpdate()
UnregisterForUpdate()
{Do some stuff}
endEvent
Then you should use RegisterForSingleUpdate insteadRegister for OnUpdate events, every X seconds, where X is the interval. All scripts attached to this alias will get the update events
Register for OnUpdateGameTime events, every X hours of game time, where X is the interval. All scripts attached to this alias will get the update events
Register for a single OnUpdateGameTime event, in afInterval hours of game time. All scripts attached to this alias will get the update events
Registers this alias to receive events when the player sleeps and wakes up
Registers this alias to receive events when tracked stats are updated
Turns on profiling for this specific object and all scripts attached to it - setting doesn't persist across saves
Will do nothing on release console builds, and if the Papyrus:bEnableProfiling ini setting is offTurns off profiling for this specific object and all scripts attached to it - setting doesn't persist across saves
Will do nothing on release console builds, and if the Papyrus:bEnableProfiling ini setting is offUnregister for any LOS events between the viewer and target
Unregister for the specified animation event from the specified object
Unregisters this alias to receive events when the player sleeps and wakes up
Unregisters this alias from receiving events when tracked stats are updated
Unregister for OnUpdate events, all attached scripts will stop getting update events
Unregister for OnUpdateGameTime events, all attached scripts will stop getting update game time events
- Found in:
- SKSE
Returns the unique name of the alias (not its display name). This is the name appearing in the Alias Name field of the Reference Alias form.
- Found in:
- SKSE
Registers for OnKeyDown and OnKeyUp events for the given keycode.
- Found in:
- SKSE
- Found in:
- SKSE
- Found in:
- SKSE
Registers for OnControlDown and OnControlUp events for the given control.
For a list of valid controls, see Input.psc.- Found in:
- SKSE
- Found in:
- SKSE
- Found in:
- SKSE
Registers for OnMenuOpen and OnMenuClose events for the given menu.
Registrations have to be refreshed after each game load.
For a list of valid menu names, see UI.psc.- Found in:
- SKSE
- Found in:
- SKSE
- Found in:
- SKSE
Registers a custom event callback for given event name.
Registrations have to be refreshed after each game load.Examples:
RegisterForModEvent("myCustomEvent", "MyModEventCallback")Event signature of custom event callbacks:
Event MyModEventCallback(string eventName, string strArg, float numArg, Form sender)
endEvent- Found in:
- SKSE
- Found in:
- SKSE
- Found in:
- SKSE
Sends custom event with given generic parameters.
- Found in:
- SKSE
See Form.psc
- Found in:
- SKSE
- Found in:
- SKSE
See Form.psc
- Found in:
- SKSE
- Found in:
- SKSE
See Form.psc
- Found in:
- SKSE
- Found in:
- SKSE
Registers the script for when a QueueNiNodeUpdate is called
- Found in:
- SKSE