Scripting API

Home Scripting API Index Class Overview

com.nolimitscoaster

Class Park

public final class Park
extends Object

Represents the loaded park inside the editor. Right now only terrain heights can be changed. In future versions, there will be added more to this class.

Terrain dimension X: goes from west to east (identical to x axis inside editor); Terrain dimension Y: goes from south to north (identical to -z axis inside editor)

Method Summary
float getTerrainHeightAtVertex(int x, int y)
  Returns the height (in meters) of the discrete terrain marker at x,y
void getTerrainHeightsAtVertices(int sourceStartX, int sourceStartY, int sourceNumX, int sourceNumY, int destX, int destY, float[][] heightsOut)
  Returns multiple heights (in meters) of discrete terrain markers
int getTerrainVertexDimX()
  Returns the number of terrain markers in x dimension
int getTerrainVertexDimY()
  Returns the number of terrain markers in y dimension
void setTerrainHeightAtVertex(int x, int y, float height)
  Sets the height (in meters) of the discrete terrain marker at x,y
void setTerrainHeightsAtVertices(float[][] heightsIn, int sourceStartX, int sourceStartY, int sourceNumX, int sourceNumY, int destX, int destY)
  Sets multiple heights (in meters) for discrete terrain markers


Method Detail

getTerrainHeightAtVertex

public float getTerrainHeightAtVertex(int x, int y)

Returns the height (in meters) of the discrete terrain marker at x,y

Parameters:

x - terrain vertex index (0...getTerrainVertexDimX()-1)
y - terrain vertex index (0...getTerrainVertexDimY()-1)

getTerrainHeightsAtVertices

public void getTerrainHeightsAtVertices(int sourceStartX, int sourceStartY, int sourceNumX, int sourceNumY, int destX, int destY, float[][] heightsOut)

Returns multiple heights (in meters) of discrete terrain markers

Parameters:

sourceStartX - first x marker to be read: 0...getTerrainVertexDimX()-1
sourceStartY - first y marker to be read: 0...getTerrainVertexDimY()-1
sourceNumX - number of markers on x dimension: must be >= 0 and sourceNumX + sourceStartX <= getTerrainVertexDimX()
sourceNumY - number of markers on y dimension: must be >= 0 and sourceNumY + sourceStartY <= getTerrainVertexDimY()
destX - index inside heightsOut in the first dimension where the results should be saved, must be >= 0
destY - index inside heighteOut in the second dimension where te results should be saved, must be >= 0
heightsOut - two dimensional array which should receive the heights. The size of the dimensions must be at least [destX + sourceNumX][destY + sourceNumY]

getTerrainVertexDimX

public int getTerrainVertexDimX()

Returns the number of terrain markers in x dimension

getTerrainVertexDimY

public int getTerrainVertexDimY()

Returns the number of terrain markers in y dimension

setTerrainHeightAtVertex

public void setTerrainHeightAtVertex(int x, int y, float height)

Sets the height (in meters) of the discrete terrain marker at x,y

The height will be clamped to the allowed range

Parameters:

x - terrain vertex index (0...getTerrainVertexDimx()-1)
y - terrain vertex index (0...getTerrainVertexDimY()-1)

setTerrainHeightsAtVertices

public void setTerrainHeightsAtVertices(float[][] heightsIn, int sourceStartX, int sourceStartY, int sourceNumX, int sourceNumY, int destX, int destY)

Sets multiple heights (in meters) for discrete terrain markers

Parameters:

heightsIn - two dimensional array with heights. The size of the array must be at least [sourceStartX + sourceNumX][sourceStartX + sourceNumY]
sourceStartX - index in x dimension of first height from heightsIn, must be >= 0
sourceStartY - index in y dimension of first height from heightsIn, must be >= 0
sourceNumX - number of markers in x dimension to be set, must be >= 0
sourceNumY - number of markers in y dimension to be set, must be >= 0
destX - index in x dimension on the terrain to be set, must be >= 0, destX + sourceNumX must be < getTerrainVertexDimX()
destY - index in y dimension on the terrain to be set, must be >= 0, destY + sourceNumY must be < getTerrainVertexDimY()