Difference between revisions of "TranslateTo - ObjectReference"
Jump to navigation
Jump to search
imported>Jbizek m (comment about recommended starting point for afSpeed) |
imported>Nickudell (Altered Parameters to reflect which are absolute coordinates and which are relative coordinates) |
||
| Line 13: | Line 13: | ||
== Parameters == | == Parameters == | ||
*afX: Position along the X axis. | *afX: Position along the X axis (Absolute world coordinates). | ||
*afY: Position along the Y axis. | *afY: Position along the Y axis (Absolute world coordinates). | ||
*afZ: Position along the Z axis. | *afZ: Position along the Z axis (Absolute world coordinates). | ||
*afAngleX: Destination X Angle. | *afAngleX: Destination X Angle (Relative to original angle). | ||
*afAngleY: Destination Y Angle (rarely used). | *afAngleY: Destination Y Angle (Relative to original angle) (rarely used). | ||
*afAngleZ: Destination Z Angle. | *afAngleZ: Destination Z Angle (Relative to original angle). | ||
*afSpeed: Movement Speed. | *afSpeed: Movement Speed. | ||
*afMaxRotationSpeed: Maximum rotation Speed (default is 0 to mean "don't clamp the rotation speed") - Negative values cause unpredictable rotation. | *afMaxRotationSpeed: Maximum rotation Speed (default is 0 to mean "don't clamp the rotation speed") - Negative values cause unpredictable rotation. | ||
Revision as of 18:29, 3 March 2012
Member of: ObjectReference Script
Makes the object translate to the passed in position and orientation at the given speed.
Syntax
Function TranslateTo(float afX, float afY, float afZ, float afAngleX, float afAngleY, float afAngleZ, float afSpeed, \
float afMaxRotationSpeed = 0.0) nativeParameters
- afX: Position along the X axis (Absolute world coordinates).
- afY: Position along the Y axis (Absolute world coordinates).
- afZ: Position along the Z axis (Absolute world coordinates).
- afAngleX: Destination X Angle (Relative to original angle).
- afAngleY: Destination Y Angle (Relative to original angle) (rarely used).
- afAngleZ: Destination Z Angle (Relative to original angle).
- afSpeed: Movement Speed.
- afMaxRotationSpeed: Maximum rotation Speed (default is 0 to mean "don't clamp the rotation speed") - Negative values cause unpredictable rotation.
Return Value
None.
Examples
; Translate the bird slowly to 0,0,0 with a rotation of 90,90,90
Bird.TranslateTo(0.0, 0.0, 0.0, 90.0, 90.0, 90.0, 1.0)
; Translate the bird slowly to 0,0,0 with a rotation of 90,90,90 with a max rotation speed of 10
Bird.TranslateTo(0.0, 0.0, 0.0, 90.0, 90.0, 90.0, 1.0, 10.0)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.