SplineTranslateTo - ObjectReference
Revision as of 05:42, 14 August 2013 by imported>Threedee (Removed this from the Console Category because this is not a console command.)
Member of: ObjectReference Script
Makes the object translate to the passed in position and orientation at the given speed using a spline.
Syntax
Function SplineTranslateTo(float afX, float afY, float afZ, float afAngleX, float afAngleY, float afAngleZ, float afTangentMagnitude, \
float afSpeed, float afMaxRotationSpeed = 0.0) native
Parameters
- afX: Position along the X axis.
- afY: Position along the Y axis.
- afZ: Position along the Z axis.
- afAngleX: Destination X Angle.
- afAngleY: Destination Y Angle (rarely used).
- afAngleZ: Destination Z Angle.
- 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 0,0,0 with an angle of 90,90,90 with a low spline magnitude and speed
Bird.SplineTranslateTo(0.0, 0.0, 0.0, 90.0, 90.0, 90.0, 1.0, 1.0)
; Translate the bird ref to 0,0,0 with an angle of 90,90,90 with a low spline magnitude and speed, and low rotation speed
Bird.SplineTranslateTo(0.0, 0.0, 0.0, 90.0, 90.0, 90.0, 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
- ObjectReference Script
- SplineTranslateToRef - ObjectReference
- SplineTranslateToRefNode - ObjectReference
- StopTranslation - ObjectReference
- TranslateTo - ObjectReference
- TranslateToRef - ObjectReference
- OnTranslationComplete - ObjectReference
- OnTranslationFailed - ObjectReference
- Spatial functions and snippets