Connection

Object
- Connection

```
public class Connection
extends Object
```
This class provides a collection of RM commands concerning Connections.

Connections are special areas that are used to connect other areas. They are typically used to place land-bridges or mountain-passes among players. Connections must be placed after the areas they are trying to connect, but often need to be defined before those areas if the area needs the rmAddConnectionArea command.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Field Summary

Fields
Modifier and Type Field and Description

int cConnectAllies

int cConnectAreas

int cConnectEnemies

int cConnectPlayers

Fields
Modifier and Type	Field and Description
`int`	`cConnectAllies`
`int`	`cConnectAreas`
`int`	`cConnectEnemies`
`int`	`cConnectPlayers`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`rmAddConnectionArea(int connectionID, int areaID)` Adds an area to the connection.
`bool`	`rmAddConnectionConstraint(int connectionID, int constraintID)` Add specified constraint to a connection.
`bool`	`rmAddConnectionEndConstraint(int connectionID, int constraintID)` Add specified constraint for a connection end point.
`bool`	`rmAddConnectionStartConstraint(int connectionID, int constraintID)` Add specified constraint for a connection start point.
`void`	`rmAddConnectionTerrainReplacement(int connectionID, string terrainTypeName, string newTypeName)` Adds a terrain replacement rule to the connection.
`void`	`rmAddConnectionToClass(int connectionID, int classID)` Adds the connection to specified class.
`void`	`rmBuildConnection(int connectionID)` Builds the given connection.
`void`	`rmCreateConnection(string name)` Creates an connection.
`void`	`rmSetConnectionBaseHeight(int connectionID, float width)` Sets the base height of a connection.
`void`	`rmSetConnectionBaseTerrainCost(int connectionID, float cost)` Sets the base terrain cost for a connection.
`void`	`rmSetConnectionCoherence(int connectionID, float width)` Sets area coherence (0.0-1.0).
`void`	`rmSetConnectionHeightBlend(int connectionID, float width)` Sets how smoothly connection height blends into surroundings.
`void`	`rmSetConnectionPositionVariance(int connectionID, float variance)` Sets the position variance of a connection.
`void`	`rmSetConnectionSmoothDistance(int connectionID, float width)` Sets connection edge smoothing distance (distance is number of neighboring points to consider in each direction).
`void`	`rmSetConnectionTerrainCost(int connectionID, string terrainTypeName, float cost)` Sets the terrain cost for a connection.
`void`	`rmSetConnectionType(int connectionID, int connectionType, bool connectAll, float connectPercentage)` Sets the connection type.
`void`	`rmSetConnectionWarnFailure(int connectionID, bool warn)` Sets whether a connection warns on failure.
`void`	`rmSetConnectionWidth(int connectionID, float width, float variance)` Sets the width of a connection.

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

- Field Detail
  - cConnectAreas
```
public final int cConnectAreas
```
  - cConnectPlayers
```
public final int cConnectPlayers
```
  - cConnectAllies
```
public final int cConnectAllies
```
  - cConnectEnemies
```
public final int cConnectEnemies
```
- Method Detail
  - rmAddConnectionArea
```
public void rmAddConnectionArea(int connectionID,
                                int areaID)
```
    Adds an area to the connection. This is only valid if you set the connection type is set to cConnectAreas. You must specify this while defining the area, after the connection is defined, and before building the connection.
  - rmAddConnectionConstraint
```
public bool rmAddConnectionConstraint(int connectionID,
                                      int constraintID)
```
    Add specified constraint to a connection.
  - rmAddConnectionEndConstraint
```
public bool rmAddConnectionEndConstraint(int connectionID,
                                         int constraintID)
```
    Add specified constraint for a connection end point.
  - rmAddConnectionStartConstraint
```
public bool rmAddConnectionStartConstraint(int connectionID,
                                           int constraintID)
```
    Add specified constraint for a connection start point.
  - rmAddConnectionTerrainReplacement
```
public void rmAddConnectionTerrainReplacement(int connectionID,
                                              string terrainTypeName,
                                              string newTypeName)
```
    Adds a terrain replacement rule to the connection.
  - rmAddConnectionToClass
```
public void rmAddConnectionToClass(int connectionID,
                                   int classID)
```
    Adds the connection to specified class.
  - rmBuildConnection
```
public void rmBuildConnection(int connectionID)
```
    Builds the given connection.
  - rmCreateConnection
```
public void rmCreateConnection(string name)
```
    Creates an connection.
  - rmSetConnectionBaseHeight
```
public void rmSetConnectionBaseHeight(int connectionID,
                                      float width)
```
    Sets the base height of a connection.
  - rmSetConnectionBaseTerrainCost
```
public void rmSetConnectionBaseTerrainCost(int connectionID,
                                           float cost)
```
    Sets the base terrain cost for a connection.
  - rmSetConnectionCoherence
```
public void rmSetConnectionCoherence(int connectionID,
                                     float width)
```
    Sets area coherence (0.0-1.0).
  - rmSetConnectionHeightBlend
```
public void rmSetConnectionHeightBlend(int connectionID,
                                       float width)
```
    Sets how smoothly connection height blends into surroundings.
  - rmSetConnectionPositionVariance
```
public void rmSetConnectionPositionVariance(int connectionID,
                                            float variance)
```
    Sets the position variance of a connection. The connection will normally start at the area's position, but this allows it to vary from that position. You can set this to -1 for it to pick completely random positions within the starting and ending areas. This command is often needed when specifying multiple connections (for example, one within a team and another between teams) so that the connections do not overlap.
  - rmSetConnectionSmoothDistance
```
public void rmSetConnectionSmoothDistance(int connectionID,
                                          float width)
```
    Sets connection edge smoothing distance (distance is number of neighboring points to consider in each direction).
  - rmSetConnectionTerrainCost
```
public void rmSetConnectionTerrainCost(int connectionID,
                                       string terrainTypeName,
                                       float cost)
```
    Sets the terrain cost for a connection.
  - rmSetConnectionType
```
public void rmSetConnectionType(int connectionID,
                                int connectionType,
                                bool connectAll,
                                float connectPercentage)
```
    Sets the connection type.
    Parameters:
    connectionType - This command determines which players are connected. The valid values are:
    
    cConnectAreas: This is the default that is used if you don't call rmSetConnectionType. You have to specify each area to be connected by calling rmAddConnectionArea().
    
    cConnectPlayers: Connect all player areas.
    
    cConnectAllies: Connect all ally player areas.
    
    cConnectEnemies: Connect enemy player areas.
    connectAll - Set this parameter to true if you want all of the areas to get connected to all of the other areas. Set it to false to have the areas connected sequentially where the first area gets connected to the second area, the second area gets connected to the third area, etc.
    
    connectPercentage - You can use this parameter to reduce the number of connections that are generated. For example, if you set it to 0.5, then half of the connections will get generated. The ones that are generated are randomly chosen. Some ES maps with connections connect all players when player number is small (less than 6) and uses a connection percentage on larger maps, otherwise so many connections can get placed that the barrier (like water or rock) is obscured.
  - rmSetConnectionWarnFailure
```
public void rmSetConnectionWarnFailure(int connectionID,
                                       bool warn)
```
    Sets whether a connection warns on failure.
  - rmSetConnectionWidth
```
public void rmSetConnectionWidth(int connectionID,
                                 float width,
                                 float variance)
```
    Sets the width of a connection.

Class Connection

Field Summary

Method Summary

Methods inherited from class Object

Field Detail

cConnectAreas

cConnectPlayers

cConnectAllies

cConnectEnemies

Method Detail

rmAddConnectionArea

rmAddConnectionConstraint

rmAddConnectionEndConstraint

rmAddConnectionStartConstraint

rmAddConnectionTerrainReplacement

rmAddConnectionToClass

rmBuildConnection

rmCreateConnection

rmSetConnectionBaseHeight

rmSetConnectionBaseTerrainCost

rmSetConnectionCoherence

rmSetConnectionHeightBlend

rmSetConnectionPositionVariance

rmSetConnectionSmoothDistance

rmSetConnectionTerrainCost

rmSetConnectionType

rmSetConnectionWarnFailure

rmSetConnectionWidth