Difference between revisions of "GetAngle"

GetAngle (edit)

Revision as of 23:41, 30 July 2009

406 bytes added , 23:41, 30 July 2009

edited to match template

Anonymous user

imported>Omzy

@@ Line 1: / Line 1: @@
-'''Syntax:'''
+{{Function
-  GetAngle axis
+  |CSWikiPage = GetAngle
-'''Example:'''
+ |origin = GECK1
-  GetAngle Z
+  |summary = Returns the angle of the calling object relative to the world on the specified axis (X, Y, or Z).
+ |name = GetAngle
+ |returnType = float
-Returns the current world rotation angle of the object on the selected axis (X, Y, or Z) in float.
+ |referenceType = [Object]
+ |arguments =
+  {{FunctionArgument
+   |Name = Axis
+   |Type = char
+   |Value = X, Y, Z
+  }}
+ |example = ActorRef.GetAngle Z
+ Player.GetAngle X
+}}
 == Notes ==
 *'''Special Notes (relative to GetAngle called upon the player)'''
-**Z angle returns a value from 0 to 360 depending on the player's current heading. Z angle is measured with the positive ''y''-axis as 0 and increasing clockwise from there. In the Wasteland worldspace, this is North, however, the same is not true of interiors (other exterior worldspaces have not been tested) - GetAngle is based on the game's coordinate system and the Compass is based on the NorthMarker object in each cell. Therefore, GetAngle Z is only useful for determining compass directions in the exterior Wasteland worldspace.
+**'Player.GetAngle X' returns a value (theorically) from -90 to 90.  The true in-game range is -89 to 89, with -89 if the player is looking above himself, and 89 if player is looking at his feet. Note that the player actually ''is'' looking 89 degrees above or below horizontal - you cannot look exactly up or exactly down in game.
-**Trigonometry with the Z angle could be done using the following conversion formula:
+**'Player.GetAngle' Z returns a value from 0 to 360 depending on the player's current heading. Z angle is measured with the positive ''y''-axis as 0 and increasing clockwise from there. In the Wasteland worldspace, this is North, however, the same is not true of interiors (other exterior worldspaces have not been tested) - GetAngle is based on the game's coordinate system and the Compass is based on the NorthMarker object in each cell. Therefore, GetAngle Z is only useful for determining compass directions in the exterior Wasteland worldspace.
+**The in-game angles are not the same as the world standard interpretation of angles. Trigonometry with the Z angle could be done using the following conversion formula:
   float GetAngleZ  ;the game's version
   float TrigAngleZ ;the rest of the world's interpretation of the same
@@ Line 20: / Line 29: @@
     set TrigAngleZ to 450 - GetAngleZ
   endif
-**X angle returns a value (theorically) from -90 to 90.  The true in-game range is -89 to 89, with -89 if the player is looking above himself, and 89 if player is looking at his feet. Note that the player actually ''is'' looking 89 degrees above or below horizontal - you cannot look exactly up or exactly down in game.
+==See Also==
+*[[GetHeadingAngle]]
+*[[SetAngle]]
+*[[Rotate]]
+*[[GetPos]]
+*[[SetPos]]
@@ Line 26: / Line 41: @@
 [[Category:Movement Functions]]
 [[Category:Condition Functions]]
 <!-- Begin Search Terms
   Get