Difference between revisions of "TranslateToRef - ObjectReference"
Jump to navigation
Jump to search
imported>Scornett-Bot m (Script running global find and replace: Category:Console Commands for Category:Functions) |
imported>Threedee (Removed this from the Console Category because this is not a console command.) |
||
| (6 intermediate revisions by 4 users not shown) | |||
| Line 1: | Line 1: | ||
[[Category:Scripting]] | [[Category:Scripting]] | ||
[[Category:Papyrus]] | [[Category:Papyrus]] | ||
'''Member of:''' [[ObjectReference Script]] | '''Member of:''' [[ObjectReference Script]] | ||
| Line 9: | Line 8: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
Function TranslateToRef(ObjectReference arTarget, 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> | ||
| Line 14: | Line 15: | ||
*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.0 | ||
== Return Value == | == Return Value == | ||
| Line 28: | Line 29: | ||
<source lang="papyrus"> | <source lang="papyrus"> | ||
; Translate the bird ref to the rock with a low speed, and low rotation speed | ; Translate the bird ref to the rock with a low speed, and low rotation speed | ||
Bird.TranslateToRef(Rock, 1.0, 10) | Bird.TranslateToRef(Rock, 1.0, 10.0) | ||
</source> | </source> | ||
== 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. | |||
== Notes == | |||
*The movement speed is in [[Units|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. | |||
== See Also == | == See Also == | ||
Latest revision as of 05:47, 14 August 2013
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.
- 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)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.
Notes[edit | edit source]
- 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.