MoveToWhenUnloaded - ObjectReference

Revision as of 18:14, 29 June 2013 by imported>Thingy Person (→‎Syntax)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)

DEPRECATED ----- DO NOT USE

Member of: ObjectReference Script (Papyrus)

Moves this reference to the location of the target reference, with the specified offset, if both this reference and the target reference are in current locations which are not currently loaded.

Caution: this will pause the calling script until the actor is unloaded and moved.

SyntaxEdit

function MoveToWhenUnloaded(ObjectReference akTarget, float afXOffset = 0.0, float afYOffset = 0.0, float afZOffset = 0.0)
	while self.GetCurrentLocation().IsLoaded() || akTarget.GetCurrentLocation().IsLoaded()
		Utility.Wait(5)
	EndWhile
	self.MoveTo(akTarget, afXOffset, afYOffset, afZOffset)
EndFunction

ParametersEdit

  • akTarget: The target reference to move this one to.
  • afXOffset: How much to offset the move in the X direction.
    • Default: 0.0
  • afYOffset: How much to offset the move in the Y direction.
    • Default: 0.0
  • afZOffset: How much to offset the move in the Z direction.
    • Default: 0.0

Return ValueEdit

None.

See AlsoEdit