Terrain

Object
- Terrain

```
public class Terrain
extends Object
```
This class provides a collection of Console commands concerning Terrains, Areas and related tools.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Local Call
Terrain commands are all local.

Editor Mode Only
Terrain commands all require Editor Mode.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`areaIncrementAreaToRender(int playerID)` Increments the area to render.
`void`	`brushCircularSize(float value)` Sets the circular brush size.
`void`	`brushSize(int size)` Sets brush size.
`void`	`rotateWaterLeft(int keyState)` Indicates that the rotate water left button has gone up/down.
`void`	`rotateWaterRight(int keyState)` Indicates that the rotate water right button has gone up/down.
`void`	`terrainAdjustGlobalHeight(float meters)` Adjusts (raise/lower) the terrain height by the specified meters.
`void`	`terrainAmbient(int r, int g, int b)` Set terrain ambient reflectivity to the given RGB (0-255)
`void`	`terrainFilter()` Filters the entire terrain.
`void`	`terrainFilterArea(int X1, int Y1, int X2, int Y2)` Filters a sub-area of the terrain.
`void`	`terrainFlatten()` Flattens the entire terrain.
`void`	`terrainFlattenArea(int X1, int Y1, int X2, int Y2)` Flattens a sub-area of the terrain.
`void`	`terrainGetAmbient()` Get terrain ambient reflectivity.
`void`	`terrainPaint()` Paint whole terrain with given texture.
`void`	`terrainPaintMix()` Paint whole terrain with given mix name.
`void`	`terrainPasteBufferLoad(string filename)` Loads a terrain paste buffer.
`void`	`terrainPasteBufferSave(string filename)` Saves the current terrain paste buffer.
`void`	`terrainResizeSubtype(int delta)` Resize current terrain subtype.
`void`	`terrainSetSubtype(int type)` Sets the terrain subtype to paint.
`void`	`terrainSetType(int type)` Sets the terrain type to paint.
`void`	`uiChangeBrushSize(float param1, float param2, float param3, float param4)` Changes the size of the current brush.
`void`	`uiChangeBrushType(string name)` Changes the brush to the named type.
`void`	`uiChangeElevationToSample(int keyState)` Indicates that the change elevation to sample button has gone up/down.
`void`	`uiCoverTerrainWithWater(float waterHeight, float depth, string waterName)` Flattens terrain and paints water over the entire map.
`void`	`uiDecreaseTextureDensity(int keyState)` Indicates that the decrease texture density button has gone up/down.
`void`	`uiFilterTerrainSelection()` Filter the current terrain selection.
`void`	`uiFlattenTerrainSelection()` F latte n the current terrain selection.
`void`	`uiIncreaseTextureDensity(int keyState)` Indicates that the increase texture density button has gone up/down.
`void`	`uiLowerElevation(int keyState)` Indicates that the l o we r elevation button has gone up.
`void`	`uiLowerTerrainSelection(int keyState)` Indicates that the lower terrain selection button has gone up/down.
`void`	`uiLowerWater(int keyState)` Indicates that the lower water button has gone up/down.
`void`	`uiPaint(bool paint, bool absolute)` Indicates that the paint button has gone up/down.
`void`	`uiPaintCliff(int keyState)` Indicates that the paint cliff button has gone up/down.
`void`	`uiPaintTerrainOverlay(int keyState)` Indicates that the paint terrain overlay button has gone up/down.
`void`	`uiPaintTerrainToSample(int keyState)` Indicates that the sample terrain button has gone up/down.
`void`	`uiPaintWater(int keyState)` Indicates that the paint water button has gone up/down.
`void`	`uiPaintWaterArea(int keyState)` Painting water area.
`void`	`uiPaintWaterObjects()` Paint objects on the currently selected water.
`void`	`uiRaiseElevation(int keyState)` Indicates that the raise elevation button has gone up.
`void`	`uiRaiseTerrainSelection(int keyState)` Indicates that the raise terrain selection button has gone up/down.
`void`	`uiRaiseWater(int keyState)` Indicates that the raise water button has gone up/down.
`void`	`uiRemoveTerrainOverlay()` Removes the painted terrain overlay at the given mouse position.
`void`	`uiRoughen(int keyState)` Indicates that the roughen button has gone up/down.
`void`	`uiSampleCliffElevationAtPointer()` Samples C lift elevation height at pointer.
`void`	`uiSampleElevationAtPointer()` Samples elevation height at pointer.
`void`	`uiSampleTerrainAtPointer()` Samples terrain type at pointer.
`void`	`uiScrollBrushSize()` Increment the size of the current brush up/down.
`void`	`uiSetBrushType(string name, float param1, float param2, float param3, float param4)` Makes the current brush based on the name and parameters.
`void`	`uiSetCliffType(string cliffName)` Sets the cliff type by name.
`void`	`uiSetCliffTypeNum(long cliffType)` Sets the cliff type by index.
`void`	`uiSetForestJype(long forestType)` Sets the forest type by index.
`void`	`uiSetForestType(string forestName)` Sets the forest type by name.
`void`	`uiSetTerrainOverlayColor(float r, float g, float b)` Sets the terrain overlay color to the given (R,G,B) color.
`void`	`uiSetWaterType(string waterName)` Sets the water type by name.
`void`	`uiSetWaterTypeNum(long waterType)` Sets the water type by index.
`void`	`uiSmooth(int keyState)` Indicates that the smooth button has gone up.
`void`	`uiTerrainSelection(int keyState)` Indicates that the terrain selection button has gone up/down.
`void`	`uiToggleBrushMask()` This is not what you are looking for.

Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Method Detail
  - areaIncrementAreaToRender
```
public void areaIncrementAreaToRender(int playerID)
```
    Increments the area to render.
  - terrainFilter
```
public void terrainFilter()
```
    Filters the entire terrain.
  - terrainFilterArea
```
public void terrainFilterArea(int X1,
                              int Y1,
                              int X2,
                              int Y2)
```
    Filters a sub-area of the terrain.
  - terrainFlatten
```
public void terrainFlatten()
```
    Flattens the entire terrain.
  - terrainFlattenArea
```
public void terrainFlattenArea(int X1,
                               int Y1,
                               int X2,
                               int Y2)
```
    Flattens a sub-area of the terrain.
  - terrainSetType
```
public void terrainSetType(int type)
```
    Sets the terrain type to paint.
  - terrainSetSubtype
```
public void terrainSetSubtype(int type)
```
    Sets the terrain subtype to paint.
  - terrainPaint
```
public void terrainPaint()
```
    Paint whole terrain with given texture.
  - terrainPaintMix
```
public void terrainPaintMix()
```
    Paint whole terrain with given mix name.
  - terrainAmbient
```
public void terrainAmbient(int r,
                           int g,
                           int b)
```
    Set terrain ambient reflectivity to the given RGB (0-255)
  - terrainGetAmbient
```
public void terrainGetAmbient()
```
    Get terrain ambient reflectivity.
  - terrainResizeSubtype
```
public void terrainResizeSubtype(int delta)
```
    Resize current terrain subtype.
  - terrainAdjustGlobalHeight
```
public void terrainAdjustGlobalHeight(float meters)
```
    Adjusts (raise/lower) the terrain height by the specified meters.
  - terrainPasteBufferSave
```
public void terrainPasteBufferSave(string filename)
```
    Saves the current terrain paste buffer.
  - terrainPasteBufferLoad
```
public void terrainPasteBufferLoad(string filename)
```
    Loads a terrain paste buffer.
  - uiIncreaseTextureDensity
```
public void uiIncreaseTextureDensity(int keyState)
```
    Indicates that the increase texture density button has gone up/down.
  - uiDecreaseTextureDensity
```
public void uiDecreaseTextureDensity(int keyState)
```
    Indicates that the decrease texture density button has gone up/down.
  - uiChangeElevationToSample
```
public void uiChangeElevationToSample(int keyState)
```
    Indicates that the change elevation to sample button has gone up/down.
  - uiSampleElevationAtPointer
```
public void uiSampleElevationAtPointer()
```
    Samples elevation height at pointer.
  - uiSampleCliffElevationAtPointer
```
public void uiSampleCliffElevationAtPointer()
```
    Samples C lift elevation height at pointer.
  - uiPaintTerrainToSample
```
public void uiPaintTerrainToSample(int keyState)
```
    Indicates that the sample terrain button has gone up/down.
  - uiSampleTerrainAtPointer
```
public void uiSampleTerrainAtPointer()
```
    Samples terrain type at pointer.
  - uiRaiseElevation
```
public void uiRaiseElevation(int keyState)
```
    Indicates that the raise elevation button has gone up. down.
  - uiLowerElevation
```
public void uiLowerElevation(int keyState)
```
    Indicates that the l o we r elevation button has gone up. down.
  - uiSmooth
```
public void uiSmooth(int keyState)
```
    Indicates that the smooth button has gone up. down.
  - uiPaintWater
```
public void uiPaintWater(int keyState)
```
    Indicates that the paint water button has gone up/down.
  - uiPaintWaterArea
```
public void uiPaintWaterArea(int keyState)
```
    Painting water area.
  - uiPaintCliff
```
public void uiPaintCliff(int keyState)
```
    Indicates that the paint cliff button has gone up/down.
  - uiTerrainSelection
```
public void uiTerrainSelection(int keyState)
```
    Indicates that the terrain selection button has gone up/down.
  - uiRaiseTerrainSelection
```
public void uiRaiseTerrainSelection(int keyState)
```
    Indicates that the raise terrain selection button has gone up/down.
  - uiLowerTerrainSelection
```
public void uiLowerTerrainSelection(int keyState)
```
    Indicates that the lower terrain selection button has gone up/down.
  - uiFlattenTerrainSelection
```
public void uiFlattenTerrainSelection()
```
    F latte n the current terrain selection.
  - uiFilterTerrainSelection
```
public void uiFilterTerrainSelection()
```
    Filter the current terrain selection.
  - uiRoughen
```
public void uiRoughen(int keyState)
```
    Indicates that the roughen button has gone up/down.
  - uiPaint
```
public void uiPaint(bool paint,
                    bool absolute)
```
    Indicates that the paint button has gone up/down.
  - uiPaintTerrainOverlay
```
public void uiPaintTerrainOverlay(int keyState)
```
    Indicates that the paint terrain overlay button has gone up/down.
  - uiRemoveTerrainOverlay
```
public void uiRemoveTerrainOverlay()
```
    Removes the painted terrain overlay at the given mouse position.
  - uiSetTerrainOverlayColor
```
public void uiSetTerrainOverlayColor(float r,
                                     float g,
                                     float b)
```
    Sets the terrain overlay color to the given (R,G,B) color.
  - uiCoverTerrainWithWater
```
public void uiCoverTerrainWithWater(float waterHeight,
                                    float depth,
                                    string waterName)
```
    Flattens terrain and paints water over the entire map.
  - uiSetCliffType
```
public void uiSetCliffType(string cliffName)
```
    Sets the cliff type by name.
  - uiSetCliffTypeNum
```
public void uiSetCliffTypeNum(long cliffType)
```
    Sets the cliff type by index.
  - uiSetWaterType
```
public void uiSetWaterType(string waterName)
```
    Sets the water type by name.
  - uiSetWaterTypeNum
```
public void uiSetWaterTypeNum(long waterType)
```
    Sets the water type by index.
  - uiSetForestType
```
public void uiSetForestType(string forestName)
```
    Sets the forest type by name.
  - uiSetForestJype
```
public void uiSetForestJype(long forestType)
```
    Sets the forest type by index.
  - uiPaintWaterObjects
```
public void uiPaintWaterObjects()
```
    Paint objects on the currently selected water.
  - uiRaiseWater
```
public void uiRaiseWater(int keyState)
```
    Indicates that the raise water button has gone up/down.
  - uiLowerWater
```
public void uiLowerWater(int keyState)
```
    Indicates that the lower water button has gone up/down.
  - rotateWaterLeft
```
public void rotateWaterLeft(int keyState)
```
    Indicates that the rotate water left button has gone up/down.
  - rotateWaterRight
```
public void rotateWaterRight(int keyState)
```
    Indicates that the rotate water right button has gone up/down.
  - brushSize
```
public void brushSize(int size)
```
    Sets brush size.
  - brushCircularSize
```
public void brushCircularSize(float value)
```
    Sets the circular brush size.
  - uiSetBrushType
```
public void uiSetBrushType(string name,
                           float param1,
                           float param2,
                           float param3,
                           float param4)
```
    Makes the current brush based on the name and parameters.
  - uiChangeBrushType
```
public void uiChangeBrushType(string name)
```
    Changes the brush to the named type.
  - uiChangeBrushSize
```
public void uiChangeBrushSize(float param1,
                              float param2,
                              float param3,
                              float param4)
```
    Changes the size of the current brush.
  - uiScrollBrushSize
```
public void uiScrollBrushSize()
```
    Increment the size of the current brush up/down.
  - uiToggleBrushMask
```
public void uiToggleBrushMask()
```
    This is not what you are looking for.

Class Terrain

Method Summary

Methods inherited from class Object

Method Detail

areaIncrementAreaToRender

terrainFilter

terrainFilterArea

terrainFlatten

terrainFlattenArea

terrainSetType

terrainSetSubtype

terrainPaint

terrainPaintMix

terrainAmbient

terrainGetAmbient

terrainResizeSubtype

terrainAdjustGlobalHeight

terrainPasteBufferSave

terrainPasteBufferLoad

uiIncreaseTextureDensity

uiDecreaseTextureDensity

uiChangeElevationToSample

uiSampleElevationAtPointer

uiSampleCliffElevationAtPointer

uiPaintTerrainToSample

uiSampleTerrainAtPointer

uiRaiseElevation

uiLowerElevation

uiSmooth

uiPaintWater

uiPaintWaterArea

uiPaintCliff

uiTerrainSelection

uiRaiseTerrainSelection

uiLowerTerrainSelection

uiFlattenTerrainSelection

uiFilterTerrainSelection

uiRoughen

uiPaint

uiPaintTerrainOverlay

uiRemoveTerrainOverlay

uiSetTerrainOverlayColor

uiCoverTerrainWithWater

uiSetCliffType

uiSetCliffTypeNum

uiSetWaterType

uiSetWaterTypeNum

uiSetForestType

uiSetForestJype

uiPaintWaterObjects

uiRaiseWater

uiLowerWater

rotateWaterLeft

rotateWaterRight

brushSize

brushCircularSize

uiSetBrushType

uiChangeBrushType

uiChangeBrushSize

uiScrollBrushSize

uiToggleBrushMask