OnPlayerTeleport - ScriptObject

From Creation Kit
Jump to: navigation, search

Member of: ScriptObject

Event called when the player teleports via load doors, fast travel, MoveTo and the like - if this active magic effect/alias/form is registered for it.

This event will only be sent to the specific script that registered for it. Other scripts attached to the same form/alias/active magic effect will not receive the event unless they also register.

Syntax

Event OnPlayerTeleport()

Parameters

None.

Example

Function SomeFunction()
  RegisterForPlayerTeleport() ; Before we can use OnPlayerTeleport we must register.
EndFunction
 
Event OnPlayerTeleport()
  Debug.Trace("Player teleported!")
endEvent

Notes

  • Aliases and quests will automatically unregister for this event when the quest stops. Active magic effects will automatically unregister when they are removed.

See Also