Binding of RoR::Terrain; represents a loaded terrain. More...

#include <TerrainClass.h>

Public Member Functions
General
string	getTerrainName ()

string	getTerrainFileName ()

string	getTerrainFileResourceGroup ()

string	getGUID ()

int	getVersion ()

CacheEntryPtr	getCacheEntry ()

Gameplay
bool	isFlat ()

float	getHeightAt (float x, float z)

vector3	getSpawnPos ()

degree	getSpawnRot ()

Subsystems

void	addSurveyMapEntity (const std::string &type, const std::string &filename, const std::string &resource_group, const std::string &caption, const Ogre::Vector3 &pos, float angle, int id)
	Adds an icon with description to survey map (minimap). More...

void	delSurveyMapEntities (int id)
	Removes all survey map icons with the given ID. More...

ProceduralManagerClass	getProceduralManager ()

Detailed Description

Binding of RoR::Terrain; represents a loaded terrain.

Note: Obtain the object using game.getTerrain().

Definition at line 16 of file TerrainClass.h.

Member Function Documentation

◆ addSurveyMapEntity()

void Script2Game::TerrainClass::addSurveyMapEntity	(	const std::string &	type,
		const std::string &	filename,
		const std::string &	resource_group,
		const std::string &	caption,
		const Ogre::Vector3 &	pos,
		float	angle,
		int	id
	)

Adds an icon with description to survey map (minimap).

Parameters

type	informational, optional
filename	The file name. Don't forget to specify the resource group!
resource_group	Leave empty to use TexturesRG ('icons.zip/famicons.zip'), otherwise use `BeamClass/TerrainClass getResourceGroup()` to read from actor/terrain ZIP.
caption	optional
pos	The world position of the point of interest, in meters.
angle	The world yaw in radians.
id	The race ID of the icon (>=0), or -1 if not a race icon. You can use larger negative numbers for custom IDs.

◆ delSurveyMapEntities()

void Script2Game::TerrainClass::delSurveyMapEntities ( int id )

Removes all survey map icons with the given ID.

Parameters

id	The race ID of the icon (>=0), or -1 if not a race icon. You can use larger negative numbers for custom IDs.

◆ getCacheEntry()

CacheEntryPtr Script2Game::TerrainClass::getCacheEntry ( )

◆ getGUID()

string Script2Game::TerrainClass::getGUID ( )

Returns: GUID (global unique ID) of the terrain, or empty string if not specified.

◆ getHeightAt()

float Script2Game::TerrainClass::getHeightAt	(	float	x,
		float	z
	)

◆ getProceduralManager()

ProceduralManagerClass Script2Game::TerrainClass::getProceduralManager ( )

◆ getSpawnPos()

vector3 Script2Game::TerrainClass::getSpawnPos ( )

Returns: Player spawn position when entering game (defined in .terrn2 file).

◆ getSpawnRot()

degree Script2Game::TerrainClass::getSpawnRot ( )

Returns: Player spawn rotation when entering game (defined in .terrn2 file).

◆ getTerrainFileName()

string Script2Game::TerrainClass::getTerrainFileName ( )

Returns: File name of the terrain definition (TERRN2 format).

◆ getTerrainFileResourceGroup()

string Script2Game::TerrainClass::getTerrainFileResourceGroup ( )

Returns: OGRE resource group of the terrain bundle (ZIP/directory under 'mods/') where definition files live.

◆ getTerrainName()

string Script2Game::TerrainClass::getTerrainName ( )

Returns: Full name of the terrain

◆ getVersion()

int Script2Game::TerrainClass::getVersion ( )

Returns: version of the terrain, as specified by author.

◆ isFlat()

bool Script2Game::TerrainClass::isFlat ( )

Returns: true if specified as flat (no heightmap).

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

doc/angelscript/Script2Game/TerrainClass.h

Public Member Functions