View source for X0 i0 position

{{bug}}



=x0_i0_position=

<nwscript>
Library file for functions that can be used to determine locations and positions.
</nwscript>

====Constants====

{| border="1" cellpadding="5"
! Name
! Value
! Brief Description
|-
| DISTANCE_HUGE
| 20.0
| Distance used for determining positions.
|-
| DISTANCE_LARGE
| 10.0
| Distance used for determining positions.
|-
| DISTANCE_MEDIUM
| 5.0
| Distance used for determining positions.
|-
| DISTANCE_SHORT
| 3.0
| Distance used for determining positions.
|-
| DISTANCE_TINY
| 1.0
| Distance used for determining positions.
|}

<br />

====Functions====

{| border="1" cellpadding="5"
! Name
! Brief Description
|-
| GenerateNewLocation
| Internal function. Used to get the new location.
|-
|
[[GenerateNewLocationFromLocation | GenerateNewLocationFromLocation ]]
| Internal function. Creates a new location from a given location.
|-
| GetAheadLeftLocation
| Returns location to the forward left and facing the target. This is useful for one of two people facing off against the target.
|-
|
[[GetAheadLocation | GetAheadLocation ]]
| This function returns a location directly in front of the target.
|-
| GetAheadRightLocation
| Returns location to the forward right and facing the target. This is useful for one of two people facing off against the target.
|-
|
[[GetAngleBetweenLocations | GetAngleBetweenLocations ]]
| Returns a float representing the angle between Location One and Location Two.
|-
|
[[GetBehindLocation | GetBehindLocation ]]
| Returns location directly behind the target and facing same direction as the target.
|-
| GetCenterPointOfArea
| Internal function. Get the (roughly) center point of an area.<br /><br />This works by going through all the objects in an area and getting their positions, so it is resource-intensive.
|-
|
[[GetChangedPosition | GetChangedPosition ]]
| Convenience function that returns a vector that is fDistance away in fAngle direction.
|-
|
[[GetChangeInX | GetChangeInX ]]
| Convenience function to calculate the change in the X axis.
|-
|
[[GetChangeInY | GetChangeInY ]]
| Convinence function to calculate the change in the Y axis.
|-
|
[[GetCustomLeftDirection | GetCustomLeftDirection ]]
| This function returns a normalized number that is the sum of the current facing and the angle to target.
|-
|
[[GetCustomRightDirection | GetCustomRightDirection ]]
| This returns a float that is a normalized remainder of fDirection - fAngle.
|-
|
[[GetFarLeftDirection | GetFarLeftDirection ]]
| This function returns a normalized number that is +135 from the current facing.
|-
|
[[GetFarRightDirection | GetFarRightDirection ]]
| Returns a normalized number that is -135 from the current facing.
|-
|
[[GetFlankingLeftLocation | GetFlankingLeftLocation ]]
| Returns a location on the left flank of the target.
|-
|
[[GetFlankingRightLocation | GetFlankingRightLocation ]]
| Returns a location that is the right flank (to the right and slightly behind) the Target.
|-
|
[[GetForwardFlankingLeftLocation | GetForwardFlankingLeftLocation ]]
| Returns location to the forward left flank of the target.
|-
|
[[GetForwardFlankingRightLocation | GetForwardFlankingRightLocation ]]
| Returns location to the forward right flank of the target.
|-
|
[[GetHalfLeftDirection | GetHalfLeftDirection ]]
| This function returns a number that is +45 degrees from the current facing.
|-
|
[[GetHalfRightDirection | GetHalfRightDirection ]]
| Returns a normalized value that is -45 from fDirection.
|-
|
[[GetLeftDirection | GetLeftDirection ]]
| This function returns a float representing a direction +90 degrees.
|-
|
[[GetNormalizedDirection | GetNormalizedDirection ]]
| Internal function. This function returns a float that is constrained from 0 - 360.
|-
|
[[GetOppositeDirection | GetOppositeDirection ]]
| Returns a normalized direction that is -180 from fDirection.
|-
|
[[GetOppositeLocation | GetOppositeLocation ]]
| Returns a location that is directly behind the target.
|-
|
[[GetRightDirection | GetRightDirection ]]
| Returns a normalized float that is -90 from the facing passed in.
|-
| GetStepLeftLocation
| Returns location just a step to the left.
|-
| GetStepRightLocation
| Returns location just a step to the right.
|-
| GetRandomLocation
| <nwscript>location GetRandomLocation(object oArea, object oSource=OBJECT_INVALID, float fDist=0.0);</nwscript>
Get a random location in a given area based on a given object, the specified distance away.<br /><br />If no object is given, will use a random object in the area.<br /><br />If that is not available, will use the roughly-center point of the area.<br /><br />If distance is set to 0.0, a random distance will be used.
|-
|
[[LocationToString | LocationToString ]]
| Turn a location into a string.
|-
|
[[MoveToNewLocation | MoveToNewLocation ]]
| Tells the object to move to a new location.
|-
|
[[PrintLocation | PrintLocation ]]
| Internal function. Prints a location to the logfile.
|-
|
[[SpeakLocation | SpeakLocation ]]
| Internal function. Make the caller of the function speak a string representation of its current location.
|-
|
[[TurnToFaceObject | TurnToFaceObject ]]
| Turns the target object to face another object.
|-
|
[[VectorToString | VectorToString ]]
| Turn a vector into a string.
|}

<br />


== Known Bugs ==

`GetRandomLocation` returns a location that is 0 to 179 degrees `Random(140) + 40` from point instead of a full 360.

----
<font color="gray">  author: Charles Feduke, editor: Mistress</font><br />  <br />
[[Category:include]]