Difference between revisions of "TranslateToRef - ObjectReference"
Jump to navigation
Jump to search
imported>Docclox (Created a missing page for the TranslateToRef function.) |
|||
| Line 14: | Line 14: | ||
== Parameters == | == Parameters == | ||
*arTarget: The target to match position and rotation to | *arTarget: The target to match position and rotation to | ||
*afSpeed: Movement Speed. | *afSpeed: Movement Speed in game units per second. afSpeed is clamped to a minimum of 1.0 | ||
*afMaxRotationSpeed: The maximum rotation speed (Default is 0 to mean "don't clamp rotation speed") - Negative values can cause unpredictable rotation. | *afMaxRotationSpeed: The maximum rotation speed (Default is 0 to mean "don't clamp rotation speed") - Negative values can cause unpredictable rotation. | ||
**'''Default''': 0.0 | **'''Default''': 0.0 | ||
Latest revision as of 15:20, 8 September 2023
Member of: ObjectReference Script
Makes the object translate to the passed reference (matching position and rotation) at the given speed.
Syntax[edit | edit source]
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)
endFunctionParameters[edit | edit source]
- arTarget: The target to match position and rotation to
- afSpeed: Movement Speed in game units per second. afSpeed is clamped to a minimum of 1.0
- afMaxRotationSpeed: The maximum rotation speed (Default is 0 to mean "don't clamp rotation speed") - Negative values can cause unpredictable rotation.
- Default: 0.0
Return Value[edit | edit source]
None.
Examples[edit | edit source]
; 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)