Difference between revisions of "TranslateToRef - ObjectReference"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Scornett-Bot
m (Script running global find and replace: Category:Console Commands for Category:Functions)
 
imported>RedwoodElf
Line 14: Line 14:
*arTarget: The target to match position and rotation to
*arTarget: The target to match position and rotation to
*afSpeed: Movement Speed.
*afSpeed: Movement Speed.
*afMaxRotationSpeed: The maximum rotation speed (Default is 0 to mean "don't clamp rotation speed")
*afMaxRotationSpeed: The maximum rotation speed (Default is 0 to mean "don't clamp rotation speed") - Negative values can cause unpredictable rotation.
**'''Default''': 0
**'''Default''': 0



Revision as of 09:47, 21 February 2012

Member of: ObjectReference Script

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

Syntax

Function TranslateToRef(ObjectReference arTarget, float afSpeed, float afMaxRotationSpeed = 0.0)

Parameters

  • arTarget: The target to match position and rotation to
  • afSpeed: Movement Speed.
  • afMaxRotationSpeed: The maximum rotation speed (Default is 0 to mean "don't clamp rotation speed") - Negative values can cause unpredictable rotation.
    • Default: 0

Return Value

None.

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)

See Also