Constraint

Object
- Constraint

```
public class Constraint
extends Object
```
This class provides a collection of RM commands concerning Constraints.

Constraints are used for areas, connections, and objects. They make sure that objects avoid other objects, that objects are placed near certain areas and similar restrictions.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`int`	`rmConstraintID(string name)` Gets constraint ID for given constraint name.
`int`	`rmCreateAreaConstraint(string name, int areaID)` Make a constraint that forces something to remain within an area.
`int`	`rmCreateAreaDistanceConstraint(string name, int areaID, float distance)` Make a constraint that forces something to stay away from an area.
`int`	`rmCreateAreaMaxDistanceConstraint(string name, int areaID, float distance)` Make a constraint that forces something to remain within a given distance from the areaID.
`int`	`rmCreateAreaOverlapConstraint(string name, int areaID)` Make an area overlap constraint.
`int`	`rmCreateBoxConstraint(string name, float startX, float startZ, float endX, float endZ, float bufferFraction)` Make a box constraint and forces something to remain in it.
`int`	`rmCreateClassDistanceConstraint(string name, int classID, float distance)` Make a class distance constraint taht forces something to stay away from everything in the given class.
`int`	`rmCreateCliffEdgeConstraint(string name, int areaID)` Make a constraint that forces something to remain within an area's cliff edge.
`int`	`rmCreateCliffEdgeDistanceConstraint(string name, int areaID, float distance)` Make an area cliff edge distance constraint.
`int`	`rmCreateCliffEdgeMaxDistanceConstraint(string name, int areaID, float distance)` Make an area cliff edge max distance constraint.
`int`	`rmCreateCliffRampConstraint(string name, int areaID)` Make a constraint that forces something to remain within an area's cliff ramp edge.
`int`	`rmCreateCliffRampDistanceConstraint(string name, int areaID, float distance)` Make an area cliff ramp edge distance constraint.
`int`	`rmCreateCliffRampMaxDistanceConstraint(string name, int areaID, float distance)` Make an area cliff ramp edge max distance constraint.
`int`	`rmCreateEdgeConstraint(string name, int areaID)` Make a constraint that forces something to remain within an area's edge.
`int`	`rmCreateEdgeDistanceConstraint(string name, int areaID, float distance)` Make an area edge distance constraint and returns its ID
`int`	`rmCreateEdgeMaxDistanceConstraint(string name, int areaID, float distance)` Make an area edge max distance constraint.
`int`	`rmCreateTerrainDistanceConstraint(string name, string type, bool passable, float distance)` Make a constraint to avoid terrain with certain a passability.
`int`	`rmCreateTerrainMaxDistanceConstraint(string name, string type, bool passable, float distance)` Make a constraint to be close to terrain with certain a passability.
`int`	`rmCreateTypeDistanceConstraint(string name, int classID, float distance)` Make a type distance constraint.

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

Method Detail

rmConstraintID
```
public int rmConstraintID(string name)
```
Gets constraint ID for given constraint name.

rmCreateAreaConstraint
```
public int rmCreateAreaConstraint(string name,
                                  int areaID)
```
Make a constraint that forces something to remain within an area. Returns its ID.

rmCreateAreaDistanceConstraint

public int rmCreateAreaDistanceConstraint(string name,
                                          int areaID,
                                          float distance)

Make a constraint that forces something to stay away from an area. Returns its ID.

rmCreateAreaMaxDistanceConstraint

public int rmCreateAreaMaxDistanceConstraint(string name,
                                             int areaID,
                                             float distance)

Make a constraint that forces something to remain within a given distance from the areaID. Returns its ID.

rmCreateAreaOverlapConstraint
```
public int rmCreateAreaOverlapConstraint(string name,
                                         int areaID)
```
Make an area overlap constraint. This prevents areas from overlapping. Returns its ID.

rmCreateBoxConstraint

public int rmCreateBoxConstraint(string name,
                                 float startX,
                                 float startZ,
                                 float endX,
                                 float endZ,
                                 float bufferFraction)

Make a box constraint and forces something to remain in it. Returns its ID.

rmCreateClassDistanceConstraint

public int rmCreateClassDistanceConstraint(string name,
                                           int classID,
                                           float distance)

Make a class distance constraint taht forces something to stay away from everything in the given class. Returns its ID.

rmCreateCliffEdgeConstraint
```
public int rmCreateCliffEdgeConstraint(string name,
                                       int areaID)
```
Make a constraint that forces something to remain within an area's cliff edge. Returns its ID.

rmCreateCliffEdgeDistanceConstraint

public int rmCreateCliffEdgeDistanceConstraint(string name,
                                               int areaID,
                                               float distance)

Make an area cliff edge distance constraint. Returns its ID.

rmCreateCliffEdgeMaxDistanceConstraint

public int rmCreateCliffEdgeMaxDistanceConstraint(string name,
                                                  int areaID,
                                                  float distance)

Make an area cliff edge max distance constraint. Returns its ID.

rmCreateCliffRampConstraint
```
public int rmCreateCliffRampConstraint(string name,
                                       int areaID)
```
Make a constraint that forces something to remain within an area's cliff ramp edge. Returns its ID.

rmCreateCliffRampDistanceConstraint

public int rmCreateCliffRampDistanceConstraint(string name,
                                               int areaID,
                                               float distance)

Make an area cliff ramp edge distance constraint. Returns its ID.

rmCreateCliffRampMaxDistanceConstraint

public int rmCreateCliffRampMaxDistanceConstraint(string name,
                                                  int areaID,
                                                  float distance)

Make an area cliff ramp edge max distance constraint. Returns its ID.

rmCreateEdgeConstraint
```
public int rmCreateEdgeConstraint(string name,
                                  int areaID)
```
Make a constraint that forces something to remain within an area's edge. Returns its ID.

rmCreateEdgeDistanceConstraint

public int rmCreateEdgeDistanceConstraint(string name,
                                          int areaID,
                                          float distance)

Make an area edge distance constraint and returns its ID

rmCreateEdgeMaxDistanceConstraint

public int rmCreateEdgeMaxDistanceConstraint(string name,
                                             int areaID,
                                             float distance)

Make an area edge max distance constraint. Returns its ID.

rmCreateTerrainDistanceConstraint

public int rmCreateTerrainDistanceConstraint(string name,
                                             string type,
                                             bool passable,
                                             float distance)

Make a constraint to avoid terrain with certain a passability.

rmCreateTerrainMaxDistanceConstraint

public int rmCreateTerrainMaxDistanceConstraint(string name,
                                                string type,
                                                bool passable,
                                                float distance)

Make a constraint to be close to terrain with certain a passability.

rmCreateTypeDistanceConstraint

public int rmCreateTypeDistanceConstraint(string name,
                                          int classID,
                                          float distance)

Make a type distance constraint.

Class Constraint

Method Summary

Methods inherited from class Object