Background for Skyrim SE
Member of the ObjectReference script
voidfunctionTranslateToRef(ObjectReferencearTarget, floatafSpeed, floatafMaxRotationSpeed=0.0)

Description

Wiki Description

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

Documentation Comment

Makes the reference translate to the target ref position/orient at the given speed


Caveats

CK Wiki - Notes

  • The movement speed is in units per second.
  • The rotation speed is in degrees per second.
  • afMaxRotationSpeed equal to 0 means that the object will reach the target's rotation when it reaches the target's position.
  • It is not possible to cause the object to rotate faster than it would with afMaxRotationSpeed equal to 0. (Cannot reach target's rotation before target's position.)
  • The OnTranslationComplete event will fire when the object reaches both the target's position and target's rotation.
  • The OnTranslationAlmostComplete event can fire even when the target's rotation is far from being reached.

Parameters

ObjectReferencearTarget

CK Wiki Description

The target to match position and rotation to

floatafSpeed

CK Wiki Description

Movement Speed.

floatafMaxRotationSpeed=0.0

CK Wiki Description

The maximum rotation speed (Default is 0 to mean "don't clamp rotation speed") - Negative values can cause unpredictable rotation.

  • Default:0.0

Examples

; Translate the bird ref to the rock with a low speed
Bird.TranslateToRef(Rock, 1.0)
; Translate the bird ref to the rock with a low speed, and low rotation speed
Bird.TranslateToRef(Rock, 1.0, 10.0)

Auto-Generated Example

ObjectReference myObjectReference__arTarget
float myFloat__afSpeed
float myFloat__afMaxRotationSpeed

myObjectReference__toCallFunctionOn.TranslateToRef(myObjectReference__arTarget, myFloat__afSpeed, myFloat__afMaxRotationSpeed)

Related Pages


Additional References

View this function’s page on the Skyrim Creation Kit Wiki

Some data provided by the Skyrim Creation Kit Wiki. Licensed under the Creative Commons Attribution-ShareAlike license.