Difference between revisions of "SplineTranslateToRef - ObjectReference"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jbizek
m
imported>Thingy Person
Line 8: Line 8:
== Syntax ==
== Syntax ==
<source lang="papyrus">
<source lang="papyrus">
Function SplineTranslateToRef(ObjectReference arTarget, float afTangentMagnitude, float afSpeed, float afMaxRotationSpeed = 0.0)
Function TranslateToRef(ObjectReference arTarget, float afSpeed, float afMaxRotationSpeed = 0.0)
TranslateTo(arTarget.X, arTarget.Y, arTarget.Z, arTarget.GetAngleX(), arTarget.GetAngleY(), arTarget.GetAngleZ(), afSpeed, afMaxRotationSpeed)
endFunction
</source>
</source>



Revision as of 17:02, 29 June 2013

Member of: ObjectReference Script

Makes the object translate to the passed reference (matching position and rotation) at the given speed using a spline.

Syntax

Function TranslateToRef(ObjectReference arTarget, float afSpeed, float afMaxRotationSpeed = 0.0)
	TranslateTo(arTarget.X, arTarget.Y, arTarget.Z, arTarget.GetAngleX(), arTarget.GetAngleY(), arTarget.GetAngleZ(), afSpeed, afMaxRotationSpeed)
endFunction

Parameters

  • arTarget: The target to match position and rotation to
  • afTangentMagnitude: Magnitude of the spline tangents
  • afSpeed: Movement Speed.
  • afMaxRotationSpeed: The maximum rotation speed (Default is 0 to mean "don't clamp rotation speed")
    • Default: 0

Return Value

None.

Examples

; Translate the bird ref to the rock with a low spline magnitude and speed
Bird.SplineTranslateToRef(Rock, 1.0, 1.0)


; Translate the bird ref to the rock with a low spline magnitude and speed, and low rotation speed
Bird.SplineTranslateToRef(Rock, 1.0, 1.0, 10)

Tips

A movement speed parameter (afSpeed) of 1 is extremely slow - nearly imperceptible to the human eye. Starting at a an afSpeed of 100 and working up or down towards the desired speed is recommended.

See Also