OnPlayerTeleport - ScriptObject script | Starfield

Found in:

Vanilla

Description

Wiki Description

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.

Documentation Comment

Received when the player teleports (load door, fast travel, moveto) (after registering)

Caveats

CK Wiki - Notes

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

Examples

Function SomeFunction()
  RegisterForPlayerTeleport() ; Before we can use OnPlayerTeleport we must register.
EndFunction

Event OnPlayerTeleport()
  Debug.Trace("Player teleported!")
endEvent

Auto-Generated Example

Scriptname MyCoolScript extends ScriptObject

event OnPlayerTeleport()
    Debug.trace("Event received - OnPlayerTeleport")
endEvent

Additional References

View this event’s page on the Fallout 4 Creation Kit Wiki