Difference between revisions of "FastTravel - Game"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Terra Nova2
m
imported>Thingy Person
 
(3 intermediate revisions by 2 users not shown)
Line 24: Line 24:
== Notes ==
== Notes ==
*Scripted fast-travel does not save the player's game.
*Scripted fast-travel does not save the player's game.
 
*If akDestination is a map marker with a fast travel marker set up via linked reference, this function will use that fast travel marker.
*If akDestination is located on an exterior cell, a loading screen will play and the player will stay on the same spot.
*In some cases, a loading screen will play but the player will stay on the same spot.
 
*This function doesn't always work as intended. An alternative is using [[MoveTo - ObjectReference]]. Due note however that MoveTo does not advance time.
*This function doesn't always work as intended. An alternative is using [[MoveTo - ObjectReference]]. Due note however that MoveTo does not advance time.
* Neither FastTravel nor MoveTo will work properly if the player is currently ragdolling. If the map marker is in another worldspace, the player will go to their current coordinates in that worldspace; if the marker is in the same worldspace, the player's physics will glitch and carry them toward the marker until they stop ragdolling. To avoid these problems, you should call [[ForceRemoveRagdollFromWorld - ObjectReference]] on the player before trying to fast-travel.


== See Also ==
== See Also ==
*[[Game Script]]
*[[Game Script]]

Latest revision as of 07:29, 14 November 2020

Member of: Game Script

Fast-travels the player to the specified ObjectReference's location.

Syntax[edit | edit source]

Function FastTravel(ObjectReference akDestination) native global

Parameters[edit | edit source]

  • akDestination: The object to fast travel to.

Return Value[edit | edit source]

None.

Examples[edit | edit source]

; Fast-travel home
Game.FastTravel(HomeMarker)

Notes[edit | edit source]

  • Scripted fast-travel does not save the player's game.
  • If akDestination is a map marker with a fast travel marker set up via linked reference, this function will use that fast travel marker.
  • In some cases, a loading screen will play but the player will stay on the same spot.
  • This function doesn't always work as intended. An alternative is using MoveTo - ObjectReference. Due note however that MoveTo does not advance time.
  • Neither FastTravel nor MoveTo will work properly if the player is currently ragdolling. If the map marker is in another worldspace, the player will go to their current coordinates in that worldspace; if the marker is in the same worldspace, the player's physics will glitch and carry them toward the marker until they stop ragdolling. To avoid these problems, you should call ForceRemoveRagdollFromWorld - ObjectReference on the player before trying to fast-travel.

See Also[edit | edit source]