Difference between revisions of "SplineTranslateToRefNode - 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)
 
m (Grammar)
 
(4 intermediate revisions by 3 users not shown)
Line 1: Line 1:
[[Category:Scripting]]
[[Category:Scripting]]
[[Category:Papyrus]]
[[Category:Papyrus]]
[[Category:Console Commands]]
'''Member of:''' [[ObjectReference Script]]
'''Member of:''' [[ObjectReference Script]]


Line 26: Line 25:
<source lang="papyrus">
<source lang="papyrus">
; Translate the bird ref to the rock landing node with a low spline magnitude and speed
; Translate the bird ref to the rock landing node with a low spline magnitude and speed
Bird.SplineTranslateToRef(Rock, "landing", 1.0, 1.0)
Bird.SplineTranslateToRefNode(Rock, "landing", 1.0, 1.0)
</source>
</source>
<br>
<br>
<source lang="papyrus">
<source lang="papyrus">
; Translate the bird ref to the rock landing node with a low spline magnitude and speed, and low rotation speed
; Translate the bird ref to the rock landing node with a low spline magnitude and speed, and low rotation speed
Bird.SplineTranslateToRef(Rock, "landing", 1.0, 1.0, 10)
Bird.SplineTranslateToRefNode(Rock, "landing", 1.0, 1.0, 10)
</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.
(As with SplineTranslatetoRef:)
When using Actors the height difference between point A and B matters, even at low moving speed. Reaching point B when it's significantly lower can result in fall damage.


== See Also ==
== See Also ==

Latest revision as of 05:55, 16 July 2022

Member of: ObjectReference Script

Makes the object translate to a node on the passed reference's 3D (matching position and rotation) at the given speed using a spline.

Syntax[edit | edit source]

Function SplineTranslateToRefNode(ObjectReference arTarget, string arNodeName, float afTangentMagnitude, float afSpeed, \
  float afMaxRotationSpeed = 0.0) native

Parameters[edit | edit source]

  • arTarget: The target containing the node
  • arNodeName: The name of the node to match
  • 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 the rock landing node with a low spline magnitude and speed
Bird.SplineTranslateToRefNode(Rock, "landing", 1.0, 1.0)


; Translate the bird ref to the rock landing node with a low spline magnitude and speed, and low rotation speed
Bird.SplineTranslateToRefNode(Rock, "landing", 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.

(As with SplineTranslatetoRef:)

When using Actors the height difference between point A and B matters, even at low moving speed. Reaching point B when it's significantly lower can result in fall damage.

See Also[edit | edit source]