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

Cached vegetation. More...

Inheritance diagram for CachedVegetation:

Public Member Functions

Constructors
CachedVegetation new (float sectorDimension, int propfieldCellCount)
 Create cached vegetation object. More...
 
Management
void setCollisionFilter (CollisionFilter collisionFilter)
 Set collision filter for all prop fields. More...
 
void hasSector (Point coordinates)
 Sector with coordinates exists. More...
 
void addSector (Point coordinates, String cacheFile)
 Add sector using cache file. More...
 
void removeSector (Point coordinates)
 Remove sector. More...
 
void removeAllSectors ()
 Remove all sectors. More...
 
void setWorld (World world)
 Set world or null to clear. More...
 

Detailed Description

Cached vegetation.

Manages prop fields using vegetation cache files created by the IGDE World Editor. This is a native class.

Author
Roland Pl├╝ss
Version
1.0
Date
2015

Member Function Documentation

§ addSector()

void addSector ( Point  coordinates,
String  cacheFile 
)

Add sector using cache file.

§ hasSector()

void hasSector ( Point  coordinates)

Sector with coordinates exists.

§ new()

CachedVegetation new ( float  sectorDimension,
int  propfieldCellCount 
)

Create cached vegetation object.

Creates prop fields.

Exceptions
EInvalidParamsectorDimension is less than 1.
EInvalidParampropfieldCellCount is less than 1,

§ removeAllSectors()

void removeAllSectors ( )

Remove all sectors.

§ removeSector()

void removeSector ( Point  coordinates)

Remove sector.

Exceptions
EInvalidParamNo sector exists with coordinates.

§ setCollisionFilter()

void setCollisionFilter ( CollisionFilter  collisionFilter)

Set collision filter for all prop fields.

§ setWorld()

void setWorld ( World  world)

Set world or null to clear.


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