Drag[en]gine Script Module DragonScript Script API  1.0
NavigationInfo Class Reference

Navigation information. More...

Inheritance diagram for NavigationInfo:

Public Member Functions

Constructors
NavigationInfo new ()
 Create navigation information. More...
 
NavigationInfo new (NavigationInfo copy)
 Create copy of navigation information. More...
 
Management
DVector getPosition ()
 Position. More...
 
void setPosition (DVector position)
 Set position. More...
 
int getCostType ()
 Cost type at position if position is not null. More...
 
void setCostType (int costType)
 Set cost type at position. More...
 
int getPathIndex ()
 Index along navigation path. More...
 
void setPathIndex (int index)
 Set index along navigation path. More...
 
float getPathFactor ()
 Factor along path between getPathIndex() and getPathIndex()+1 from 0 to 1. More...
 
void setPathFactor (float factor)
 Set factor along path between getPathIndex() and getPathIndex()+1 from 0 to 1. More...
 
bool equals (Object other)
 Navigation information is equal to another object. More...
 
int hashCode ()
 Hash code for use as dictionary keys. More...
 

Detailed Description

Navigation information.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ equals()

bool equals ( Object  other)

Navigation information is equal to another object.

Implements Object.equals(Object).

Returns
true if other is of type NavigationInfo and both point to the same navigation info object.

§ getCostType()

int getCostType ( )

Cost type at position if position is not null.

§ getPathFactor()

float getPathFactor ( )

Factor along path between getPathIndex() and getPathIndex()+1 from 0 to 1.

§ getPathIndex()

int getPathIndex ( )

Index along navigation path.

-1 indicates navigation start position towards first path point.

§ getPosition()

DVector getPosition ( )

Position.

§ hashCode()

int hashCode ( )

Hash code for use as dictionary keys.

Implements Object.hashCode().

§ new() [1/2]

NavigationInfo new ( )

Create navigation information.

§ new() [2/2]

Create copy of navigation information.

§ setCostType()

void setCostType ( int  costType)

Set cost type at position.

§ setPathFactor()

void setPathFactor ( float  factor)

Set factor along path between getPathIndex() and getPathIndex()+1 from 0 to 1.

§ setPathIndex()

void setPathIndex ( int  index)

Set index along navigation path.

-1 indicates navigation start position towards first path point.

Exceptions
EInvalidParamindex is less than -1.

§ setPosition()

void setPosition ( DVector  position)

Set position.


The documentation for this class was generated from the following file: