Difference between revisions of "SplineTranslateToRefNode - ObjectReference"

From the CreationKit Wiki
Jump to navigation Jump to search
imported>Jbizek
m (comment about recommended starting point for afSpeed)
imported>Threedee
m (Fixed bad syntax in the examples given.)
Line 26: Line 26:
<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>



Revision as of 16:08, 21 April 2013

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

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

Parameters

  • 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

None.

Examples

; 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

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.

See Also