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

Height terrain. More...

Inheritance diagram for HeightTerrain:

Public Member Functions

Constructors
HeightTerrain new ()
 Create height terrain. More...
 
Management
int getImageDimension ()
 Image dimension. More...
 
float getSectorDimension ()
 Sector dimension. More...
 
CollisionFilter getCollisionFilter ()
 Collision filter. More...
 
void setCollisionFilter (CollisionFilter collisionFilter)
 Set collision filter. More...
 
Sectors
void hasSector (Point coordinates)
 Sector with coordinates exists. More...
 
void addSector (Point coordinates, HTSBuilder builder)
 Add using a builder as the prototype. More...
 
void removeSector (Point coordinates)
 Remove sector with the given coordinates. More...
 
void removeAllSectors ()
 Remove all sectors. More...
 
Decals
int getDecalCount ()
 Number of decals. More...
 
Decal getDecalAt (int index)
 Decal at index. More...
 
void addDecal (Decal decal)
 Add decal. More...
 
void insertDecalAt (int index, Decal decal)
 Insert decal at index. More...
 
void removeDecal (Decal decal)
 Remove decal. More...
 
void removeAllDecals ()
 Remove all decals. More...
 
Navigation spaces
int getNavSpaceCount ()
 Number of navigation spaces. More...
 
int addNavSpace ()
 Add navigation returning index. More...
 
void removeNavSpaceAt (int navspace)
 Remove navigation space at index. More...
 
void removeAllNavSpaces ()
 Remove all navigation spaces. More...
 
int navspaceGetType (int navspace)
 Type of navigation space at index. More...
 
void navspaceSetType (int navspace, int type)
 Set type of navigation space at index. More...
 
int navspaceGetLayer (int navspace)
 Layer of navigation space at index. More...
 
void navspaceSetLayer (int navspace, int layer)
 Set layer of navigation space at index. More...
 
float navspaceGetSnapDistance (int navspace)
 Snap distance of navigation space at index. More...
 
void navspaceSetSnapDistance (int navspace, float distance)
 Set snap distance of navigation space at index. More...
 
float navspaceGetSnapAngle (int navspace)
 Snap angle of navigation space at index. More...
 
void navspaceSetSnapAngle (int navspace, float angle)
 Set snap angle of navigation space at index. More...
 
int navspaceGetCornerCount (int navspace)
 Number of corners of navigation space at index. More...
 
void navspaceSetCornerCount (int navspace, int count)
 Set number of corners of navigation space at index. More...
 
int navspaceGetCornerAt (int navspace, int corner)
 Corner of navigation space at index. More...
 
void navspaceSetCornerAt (int navspace, int corner, int navpoint)
 Set corner of navigation space at index. More...
 
int navspaceGetEdgeCount (int navspace)
 Number of edges of navigation space at index. More...
 
void navspaceSetEdgeCount (int navspace, int count)
 Set number of edges of navigation space at index. More...
 
int navspaceEdgeGetPoint1 (int navspace, int edge)
 First navpoint of edge of navigation space at index. More...
 
int navspaceEdgeGetPoint2 (int navspace, int edge)
 Second navpoint of edge of navigation space at index. More...
 
int navspaceEdgeGetType1 (int navspace, int edge)
 Type to use for edge to travel from first to second navpoint of edge of navigation space at index. More...
 
int navspaceEdgeGetType2 (int navspace, int edge)
 Type to use for edge to travel from second to first navpoint of edge of navigation space at index. More...
 
void navspaceSetEdgeAt (int navspace, int edge, int point1, int point2, int type1, int type2)
 Set edge of navigation space at index. More...
 
int navspaceGetFaceCount (int navspace)
 Number of faces of navigation space at index. More...
 
void navspaceSetFaceCount (int navspace, int count)
 Set number of faces of navigation space at index. More...
 
int navspaceFaceGetCornerCount (int navspace, int face)
 Number of corners of face of navigation space at index. More...
 
int navspaceFaceGetType (int navspace, int face)
 Type of face of navigation space at index. More...
 
void navspaceSetFaceAt (int navspace, int face, int cornerCount, int type)
 Set number of corners and type of face of navigation space at index. More...
 
void navspaceLayoutChanged (int navspace)
 Layout of navigation space at index. More...
 

Detailed Description

Height terrain.

This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

void addDecal ( Decal  decal)

Add decal.

int addNavSpace ( )

Add navigation returning index.

void addSector ( Point  coordinates,
HTSBuilder  builder 
)

Add using a builder as the prototype.

Exceptions
EInvalidParamSector with coordinates present.
CollisionFilter getCollisionFilter ( )

Collision filter.

Decal getDecalAt ( int  index)

Decal at index.

Exceptions
EOutOfBoundaryindex is less than 0 or greater than or equal to getDecalCount().
int getDecalCount ( )

Number of decals.

int getImageDimension ( )

Image dimension.

int getNavSpaceCount ( )

Number of navigation spaces.

float getSectorDimension ( )

Sector dimension.

void hasSector ( Point  coordinates)

Sector with coordinates exists.

void insertDecalAt ( int  index,
Decal  decal 
)

Insert decal at index.

Exceptions
EOutOfBoundaryindex is less than 0 or greater than getDecalCount().
int navspaceEdgeGetPoint1 ( int  navspace,
int  edge 
)

First navpoint of edge of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundaryedge is less than 0 or greater than navspaceGetEdgeCount().
int navspaceEdgeGetPoint2 ( int  navspace,
int  edge 
)

Second navpoint of edge of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundaryedge is less than 0 or greater than navspaceGetEdgeCount().
int navspaceEdgeGetType1 ( int  navspace,
int  edge 
)

Type to use for edge to travel from first to second navpoint of edge of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundaryedge is less than 0 or greater than navspaceGetEdgeCount().
int navspaceEdgeGetType2 ( int  navspace,
int  edge 
)

Type to use for edge to travel from second to first navpoint of edge of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundaryedge is less than 0 or greater than navspaceGetEdgeCount().
int navspaceFaceGetCornerCount ( int  navspace,
int  face 
)

Number of corners of face of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundaryface is less than 0 or greater than navspaceGetFaceCount().
int navspaceFaceGetType ( int  navspace,
int  face 
)

Type of face of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundaryface is less than 0 or greater than navspaceGetFaceCount().
int navspaceGetCornerAt ( int  navspace,
int  corner 
)

Corner of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundarycorner is less than 0 or greater than navspaceGetCornerCount().
int navspaceGetCornerCount ( int  navspace)

Number of corners of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
int navspaceGetEdgeCount ( int  navspace)

Number of edges of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
int navspaceGetFaceCount ( int  navspace)

Number of faces of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
int navspaceGetLayer ( int  navspace)

Layer of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
float navspaceGetSnapAngle ( int  navspace)

Snap angle of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
float navspaceGetSnapDistance ( int  navspace)

Snap distance of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
int navspaceGetType ( int  navspace)

Type of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
void navspaceLayoutChanged ( int  navspace)

Layout of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
void navspaceSetCornerAt ( int  navspace,
int  corner,
int  navpoint 
)

Set corner of navigation space at index.

Call navspaceLayoutChanged() once you finished changing the content.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundarycorner is less than 0 or greater than navspaceGetCornerCount().
EInvalidParamnavpoint is less than 0 or greater than (getImageDimension()-1) squared.
void navspaceSetCornerCount ( int  navspace,
int  count 
)

Set number of corners of navigation space at index.

Call navspaceLayoutChanged() once you finished changing the content.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EInvalidParamcount is less than 0.
void navspaceSetEdgeAt ( int  navspace,
int  edge,
int  point1,
int  point2,
int  type1,
int  type2 
)

Set edge of navigation space at index.

Call navspaceLayoutChanged() once you finished changing the content.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundaryedge is less than 0 or greater than navspaceGetEdgeCount().
void navspaceSetEdgeCount ( int  navspace,
int  count 
)

Set number of edges of navigation space at index.

Call navspaceLayoutChanged() once you finished changing the content.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EInvalidParamcount is less than 0.
void navspaceSetFaceAt ( int  navspace,
int  face,
int  cornerCount,
int  type 
)

Set number of corners and type of face of navigation space at index.

Call navspaceLayoutChanged() once you finished changing the content.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EOutOfBoundaryface is less than 0 or greater than navspaceGetFaceCount().
EOutOfBoundarycornerCount is less than 0.
void navspaceSetFaceCount ( int  navspace,
int  count 
)

Set number of faces of navigation space at index.

Call navspaceLayoutChanged() once you finished changing the content.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
EInvalidParamcount is less than 0.
void navspaceSetLayer ( int  navspace,
int  layer 
)

Set layer of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
void navspaceSetSnapAngle ( int  navspace,
float  angle 
)

Set snap angle of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
void navspaceSetSnapDistance ( int  navspace,
float  distance 
)

Set snap distance of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
void navspaceSetType ( int  navspace,
int  type 
)

Set type of navigation space at index.

Exceptions
EOutOfBoundarynavspace is less than 0 or greater than getNavSpaceCount().
HeightTerrain new ( )

Create height terrain.

void removeAllDecals ( )

Remove all decals.

void removeAllNavSpaces ( )

Remove all navigation spaces.

void removeAllSectors ( )

Remove all sectors.

void removeDecal ( Decal  decal)

Remove decal.

void removeNavSpaceAt ( int  navspace)

Remove navigation space at index.

Exceptions
EOutOfBoundaryindex is less than 0 or greater than getNavSpaceCount().
void removeSector ( Point  coordinates)

Remove sector with the given coordinates.

Exceptions
EInvalidParamSector with coordinates is absent.
void setCollisionFilter ( CollisionFilter  collisionFilter)

Set collision filter.


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