aom.scripting.xs.rm

Class Area

Object

Area

public class Area
extends Object

This class provides a collection of RM commands concerning Areas.

Areas are regions on a map. They are often irregular in shape, but can be rectangular as well. Some areas are used for placing specific terrain, like a cliff or ocean, while others are just used as boundaries for other areas. Special types of areas are player areas, which belong to a certain player, or team areas, which belong to a team. Saying these areas "belong" is just a convenient method of making sure other areas or objects are placed in that area.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

Modifier and Type	Method and Description
void	rmAddAreaCliffEdgeAvoidClass(int areaID, int avoidID, float minDist) Adds a class for an area's cliff edge to avoid.
bool	rmAddAreaConstraint(int areaID, int constraintID) Add specified constraint to an area.
void	rmAddAreaInfluencePoint(int areaID, float xFraction, float zFraction) Adds an area influence point.
void	rmAddAreaInfluenceSegment(int areaID, float xFraction1, float zFraction1, float xFraction2, float zFraction2) Adds an area influence segment.
void	rmAddAreaRemoveType(int areaID, string typeName) Add an unit type that the specified area removes.
void	rmAddAreaTerrainLayer(int areaID, string terrain, float minDist, float maxDist) Adds a terrain layer to an area.
void	rmAddAreaTerrainReplacement(int areaID, string terrainTypeName, string newTypeName) Adds a terrain replacement rule to the area.
bool	rmAddAreaToClass(int areaID, int classID) Add given area to specified class.
int	rmAreaID(string name) Gets the area ID for given area name.
void	rmBuildAllAreas() Simultaneously builds all unbuilt areas.
void	rmBuildArea(int areaID) Builds the specified area.
int	rmCreateArea(string name, int parentAreaID) Creates an area and returns the areaID.
void	rmPaintAreaTerrain(int areaID) Paints the terrain for a specified area.
void	rmSetAreaBaseHeight(int areaID, float height) Sets the base height for an area.
void	rmSetAreaCliffEdge(int areaID, int count, float size, float variance, float spacing, int mapEdge) Set cliff edge parameters for an area.
void	rmSetAreaCliffHeight(int areaID, float val, float variance, float ramp) Set an area's cliff height.
void	rmSetAreaCliffPainting(int areaID, bool paintGround, bool paintOutsideEdge, bool paintSide, float minSideHeight, bool paintInsideEdge) Set cliff painting options for an area.
void	rmSetAreaCliffType(int areaID, string cliffName) Sets the cliff type for an area.
void	rmSetAreaCoherence(int areaID, float coherence) Sets area coherence (0-1).
void	rmSetAreaForestType(int areaID, string forestName) Sets the forest type for an area.
void	rmSetAreaHeightBlend(int areaID, int heightBlend) Sets how smoothly area height blends into surroundings.
void	rmSetAreaLocation(int areaID, float xFraction, float zFraction) Set the area location.
void	rmSetAreaLocPlayer(int areaID, int playerID) Set the area location to player's location.
void	rmSetAreaLocTeam(int areaID, int teamID) Set the area location to team's location.
void	rmSetAreaMaxBlobDistance(int areaID, float dist) Sets maximum blob distance.
void	rmSetAreaMaxBlobs(int areaID, int blobs) Sets maximum number of area blobs.
void	rmSetAreaMinBlobDistance(int areaID, float dist) Sets minimum blob distance.
void	rmSetAreaMinBlobs(int areaID, int blobs) Sets minimum number of area blobs.
void	rmSetAreaSize(int areaID, float minFraction, float maxFraction) Set the area size to a min/max fraction of the map.
void	rmSetAreaSmoothDistance(int areaID, int smoothDistance) Sets area edge smoothing distance (distance is number of neighbouring points to consider in each direction).
void	rmSetAreaTerrainLayerVariance(int areaID, bool variance) Specifies if the area should vary the terrain layer edges.
void	rmSetAreaTerrainType(int areaID, string terrainTypeName) Sets the terrain type for an area.
void	rmSetAreaWarnFailure(int areaID, bool warn) Sets whether the area build process will warn if it fails.
void	rmSetAreaWaterType(int areaID, string waterName) Sets the water type for an area.

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

rmAddAreaCliffEdgeAvoidClass

public void rmAddAreaCliffEdgeAvoidClass(int areaID,
                                         int avoidID,
                                         float minDist)

Adds a class for an area's cliff edge to avoid.

rmAddAreaConstraint

public bool rmAddAreaConstraint(int areaID,
                                int constraintID)

Add specified constraint to an area.

rmAddAreaInfluencePoint

public void rmAddAreaInfluencePoint(int areaID,
                                    float xFraction,
                                    float zFraction)

Adds an area influence point.

rmAddAreaInfluenceSegment

public void rmAddAreaInfluenceSegment(int areaID,
                                      float xFraction1,
                                      float zFraction1,
                                      float xFraction2,
                                      float zFraction2)

Adds an area influence segment. You may want an area to grow towards specific points or lines. A circular area placed at the center of the map with an influence point of 1, 1 will produce a peninsula that protrudes towards 12 o’clock. Influence points and segments can be useful in getting areas, such as rivers, to extend beyond the edge of the map.

rmAddAreaRemoveType

public void rmAddAreaRemoveType(int areaID,
                                string typeName)

Add an unit type that the specified area removes. Sometimes you may want an area to clean itself of objects, such as removing trees from ice. This will only work if the objects are already placed before the area, which is the reverse of how most ES maps are generated. You can reference specific units or abstract types, such as "unit" and "building."

rmAddAreaTerrainLayer

public void rmAddAreaTerrainLayer(int areaID,
                                  string terrain,
                                  float minDist,
                                  float maxDist)

Adds a terrain layer to an area. Terrain layers allow you to place a border of one or more textures around an area. For example, you can have grassDirt50 and grassDirt75 around an area of grass. You can specify multiple layers for an area, as long as the minDistance for one starts where the maxDistance for another leaves off. Because different textures overlap one another you may need to experiment with distances to get a good effect. Here is an example: rmSetAreaTerrainType(areaID, "GrassA"); rmAddAreaTerrainLayer(areaID, "SnowGrass75", 13, 20); rmAddAreaTerrainLayer(areaID, "SnowGrass50", 6, 13); rmAddAreaTerrainLayer(areaID, "SnowGrass25", 0, 6);

rmAddAreaTerrainReplacement

public void rmAddAreaTerrainReplacement(int areaID,
                                        string terrainTypeName,
                                        string newTypeName)

Adds a terrain replacement rule to the area. If you place an area with no terrain specified, it will use the terrain of the parent area (including the base map). However, specifying terrain replacement will paint an area only when another texture is present. This command is most useful with connections, where you want to replace water with land where a connection goes across a river, or replace rock with snow for mountain passes.

rmAddAreaToClass

public bool rmAddAreaToClass(int areaID,
                             int classID)

Add given area to specified class.

rmAreaID

public int rmAreaID(string name)

Gets the area ID for given area name.

rmBuildAllAreas

public void rmBuildAllAreas()

Simultaneously builds all unbuilt areas. This does not include connections.

See Also:

rmBuildArea(int)

rmBuildArea

public void rmBuildArea(int areaID)

Builds the specified area. Actually builds the area. Choosing when to use this command can have a big effect on your map. For example, if you place each player area one by one, the first few will have enough room to build, but if after 11 areas, area 12 still needs to be placed, it might have run out of space because the others were to greedy. To avoid this, build all player area's at the same time, so that the script can try to find a fair balance between all areas.

See Also:

rmBuildAllAreas()

rmCreateArea

public int rmCreateArea(string name,
                        int parentAreaID)

Creates an area and returns the areaID.

rmPaintAreaTerrain

public void rmPaintAreaTerrain(int areaID)

Paints the terrain for a specified area.

rmSetAreaBaseHeight

public void rmSetAreaBaseHeight(int areaID,
                                float height)

Sets the base height for an area.

rmSetAreaCliffEdge

public void rmSetAreaCliffEdge(int areaID,
                               int count,
                               float size,
                               float variance,
                               float spacing,
                               int mapEdge)

Set cliff edge parameters for an area. Determines whether there should be pathable ramps or not connecting the top of the cliff to the surrounding area.

Parameters:

count - Number of cliff edges to create. The count times the size should not be more than 1.0. Defaults to 1.

size - This specifies how much of the area's outline should be turned into cliff edges. It should be between 0.0 and 1.0. Set to 1.0 to make the whole area surrounded. Defaults to 0.5.

variance - The variance to use for the size. Defaults to 0.0.

spacing - Spacing modifier. This should be between 0.0 and 1.0. The smaller this is, the closer together the cliff edges will be. Defaults to 1.0.

mapEdge - Specifies where the cliff edge should be in relation to the map edge. Set to 0 for any, 1 to be away from the map edge, or 2 to be close to the map edge. Defaults to 0.

rmSetAreaCliffHeight

public void rmSetAreaCliffHeight(int areaID,
                                 float val,
                                 float variance,
                                 float ramp)

Set an area's cliff height.

Parameters:

val - Make positive for raised cliffs and negative for lowered cliffs. Defaults to 4.0.

variance - The variance to use for the height.

ramp - This is used to determine how quickly the height ramps up to the cliff height (it refers to steepness in this context, not pathable ramps to reach the top of a cliff). Defaults to 0.5.

rmSetAreaCliffPainting

public void rmSetAreaCliffPainting(int areaID,
                                   bool paintGround,
                                   bool paintOutsideEdge,
                                   bool paintSide,
                                   float minSideHeight,
                                   bool paintInsideEdge)

Set cliff painting options for an area. Determines how a cliff is painted with impassable and passable textures.

Parameters:

paintGround - Specifies if the ground should be painted or just left whatever it already is. Defaults true.

paintSide - Specifies if the cliff sides should be painted. Defaults true.

paintOutsideEdge - Specifies if the outside cliff edge should be painted. This is the area between the cliff side and the ground. Defaults true.

minSideHeight - Specifies the minimum height that a cliff tile must be sloped before treating it as a cliff side. Set to 0 to have the minimum amount of cliff sides painted. Defaults to 1.5.

paintInsideEdge - Specifies if the inside cliff edge should be painted. This is the area between the cliff side and the ground. Defaults true.

rmSetAreaCliffType

public void rmSetAreaCliffType(int areaID,
                               string cliffName)

Sets the cliff type for an area.

rmSetAreaCoherence

public void rmSetAreaCoherence(int areaID,
                               float coherence)

Sets area coherence (0-1).

rmSetAreaForestType

public void rmSetAreaForestType(int areaID,
                                string forestName)

Sets the forest type for an area.

rmSetAreaHeightBlend

public void rmSetAreaHeightBlend(int areaID,
                                 int heightBlend)

Sets how smoothly area height blends into surroundings. Corresponds to the smooth tool in the Scenario Editor. Usually a heightBlend of 0 will leave geometric-looking jagged edges. A heightBlend of 1 will smooth smaller areas. A heightBlend of 2 will smooth larger areas or areas of disproportionate heights. Anything above 2 may flatten an area completely.

rmSetAreaLocation

public void rmSetAreaLocation(int areaID,
                              float xFraction,
                              float zFraction)

Set the area location.

rmSetAreaLocPlayer

public void rmSetAreaLocPlayer(int areaID,
                               int playerID)

Set the area location to player's location.

rmSetAreaLocTeam

public void rmSetAreaLocTeam(int areaID,
                             int teamID)

Set the area location to team's location.

rmSetAreaMaxBlobDistance

public void rmSetAreaMaxBlobDistance(int areaID,
                                     float dist)

Sets maximum blob distance.

rmSetAreaMaxBlobs

public void rmSetAreaMaxBlobs(int areaID,
                              int blobs)

Sets maximum number of area blobs. An area can be placed with multiple blobs. Blobs are placed independently, using the minimum and maximum distances below. Areas made with a single blob will be circular. Areas made with multiple blobs can be come long and sinuous.

rmSetAreaMinBlobDistance

public void rmSetAreaMinBlobDistance(int areaID,
                                     float dist)

Sets minimum blob distance.

rmSetAreaMinBlobs

public void rmSetAreaMinBlobs(int areaID,
                              int blobs)

Sets minimum number of area blobs.

rmSetAreaSize

public void rmSetAreaSize(int areaID,
                          float minFraction,
                          float maxFraction)

Set the area size to a min/max fraction of the map.

rmSetAreaSmoothDistance

public void rmSetAreaSmoothDistance(int areaID,
                                    int smoothDistance)

Sets area edge smoothing distance (distance is number of neighbouring points to consider in each direction).

rmSetAreaTerrainLayerVariance

public void rmSetAreaTerrainLayerVariance(int areaID,
                                          bool variance)

Specifies if the area should vary the terrain layer edges. Usually, variance in terrain layers looks better, but sometimes you might want to turn it off. Defaults to true.

rmSetAreaTerrainType

public void rmSetAreaTerrainType(int areaID,
                                 string terrainTypeName)

Sets the terrain type for an area. Even if your area does not place special terrain, it can be helpful to temporarily paint the area with a distinct texture, such as "Black" or "SnowA", to see where and if it is actually getting placed.

rmSetAreaWarnFailure

public void rmSetAreaWarnFailure(int areaID,
                                 bool warn)

Sets whether the area build process will warn if it fails. It is very easy to over-constrain areas to the point where there is no room for them. This can cause two problems: the map may take a long time to generate, or if you are in debug mode, the debugger will pop up and generation will stop. Sometimes you want to catch these errors, but when you are done with your map it is a good idea to set SetAreaWarnFailure to false.

rmSetAreaWaterType

public void rmSetAreaWaterType(int areaID,
                               string waterName)

Sets the water type for an area.