SplineTranslateTo - ObjectReference

From the CreationKit Wiki
Jump to navigation Jump to search

Member of: ObjectReference Script

Makes the object translate to the passed in position and orientation at the given speed using a spline.

Syntax[edit | edit source]

Function SplineTranslateTo(float afX, float afY, float afZ, float afAngleX, float afAngleY, float afAngleZ, float afTangentMagnitude, \
  float afSpeed, float afMaxRotationSpeed = 0.0) native

Parameters[edit | edit source]

  • afX: Position along the X axis.
  • afY: Position along the Y axis.
  • afZ: Position along the Z axis.
  • afAngleX: Destination X Angle.
  • afAngleY: Destination Y Angle (rarely used).
  • afAngleZ: Destination Z Angle.
  • 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[edit | edit source]

None.

Examples[edit | edit source]

; Translate the bird ref to 0,0,0 with an angle of 90,90,90 with a low spline magnitude and speed
Bird.SplineTranslateTo(0.0, 0.0, 0.0, 90.0, 90.0, 90.0, 1.0, 1.0)


; Translate the bird ref to 0,0,0 with an angle of 90,90,90 with a low spline magnitude and speed, and low rotation speed
Bird.SplineTranslateTo(0.0, 0.0, 0.0, 90.0, 90.0, 90.0, 1.0, 1.0, 10)

Tips[edit | edit source]

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.

Note[edit | edit source]

This is known to have issues. If you set afMaxRotationSpeed to anything higher than 0, it will not translate the rotation correctly. Other than *TranslateTo - ObjectReference, it will force the objects position at the destination point, when the translation ends. This may cause a sudden position change of objects.

See Also[edit | edit source]

Retrieved from "https://ck.uesp.net/w/index.php?title=SplineTranslateTo_-_ObjectReference&oldid=16076"