ObjectDef

Object
- ObjectDef

```
public class ObjectDef
extends Object
```
This class provides a collection of RM commands concerning Object Definitions.

Object Definitions are used to place objects on the map.

Author:

Mythic_Freak - mythic.freak[a]gmail.com

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`bool`	`rmAddObjectDefConstraint(int defID, int constraintID)` Add specified constraint to given object def.
`void`	`rmAddObjectDefItem(int defID, string unitName, int count, float clusterDistance)` Add item to object definition.
`bool`	`rmAddObjectDefToClass(int objectDefID, int classID)` Add given object def to specified class.
`int`	`rmCreateObjectDef(string name)` Creates an object definition.
`int`	`rmGetNumberUnitsPlaced(int objectDefID)` Returns the number of units placed by this objectDefID.
`int`	`rmGetUnitPlaced(int objectDefID, int index)` Returns a unit ID that was placed by the objectDefID.
`int`	`rmGetUnitPlacedOfPlayer(int objectDefID, int playerID)` Returns the unit ID of a given player that was placed by the objectDefID.
`void`	`rmPlaceObjectDefAtAreaLoc(int defID, int playerID, int areaID, long placeCount)` Place object definition for the player at the given area's location.
`void`	`rmPlaceObjectDefAtLoc(int defID, int playerID, float xFraction, float zFraction, long placeCount)` Place object definition at specific location for given player.
`void`	`rmPlaceObjectDefAtRandomAreaOfClass(int defID, int playerID, int classID, long placeCount)` Place object definition for the player at the location of a random area in the given class.
`void`	`rmPlaceObjectDefInArea(int defID, int playerID, int areaID, long placeCount)` Place object definition for the player in the given area.
`void`	`rmPlaceObjectDefInRandomAreaOfClass(int defID, int playerID, int classID, long placeCount)` Place object definition for the player in a random area in the given class.
`void`	`rmPlaceObjectDefPerPlayer(int defID, bool playerOwned, long placeCount)` Place object definition per player.
`void`	`rmSetIgnoreForceToGaia(bool val)` If off, some objects placed will automatically convert to Mother Nature.
`void`	`rmSetObjectDefMaxDistance(int defID, float dist)` Set the maximum distance for the object definition (in meters).
`void`	`rmSetObjectDefMinDistance(int defID, float dist)` Set the minimum distance for the object definition (in meters).

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

Method Detail

rmSetObjectDefMaxDistance

public void rmSetObjectDefMaxDistance(int defID,
                                      float dist)

Set the maximum distance for the object definition (in meters).

rmSetObjectDefMinDistance

public void rmSetObjectDefMinDistance(int defID,
                                      float dist)

Set the minimum distance for the object definition (in meters).

rmAddObjectDefConstraint

public bool rmAddObjectDefConstraint(int defID,
                                     int constraintID)

Add specified constraint to given object def.

rmAddObjectDefItem

public void rmAddObjectDefItem(int defID,
                               string unitName,
                               int count,
                               float clusterDistance)

Add item to object definition.

rmAddObjectDefToClass

public bool rmAddObjectDefToClass(int objectDefID,
                                  int classID)

Add given object def to specified class.

rmCreateObjectDef
```
public int rmCreateObjectDef(string name)
```
Creates an object definition. Returns its ID.

rmGetNumberUnitsPlaced
```
public int rmGetNumberUnitsPlaced(int objectDefID)
```
Returns the number of units placed by this objectDefID.

rmGetUnitPlaced

public int rmGetUnitPlaced(int objectDefID,
                           int index)

Returns a unit ID that was placed by the objectDefID.

rmGetUnitPlacedOfPlayer

public int rmGetUnitPlacedOfPlayer(int objectDefID,
                                   int playerID)

Returns the unit ID of a given player that was placed by the objectDefID.

rmPlaceObjectDefAtAreaLoc

public void rmPlaceObjectDefAtAreaLoc(int defID,
                                      int playerID,
                                      int areaID,
                                      long placeCount)

Place object definition for the player at the given area's location.

rmPlaceObjectDefAtLoc

public void rmPlaceObjectDefAtLoc(int defID,
                                  int playerID,
                                  float xFraction,
                                  float zFraction,
                                  long placeCount)

Place object definition at specific location for given player.

rmPlaceObjectDefAtRandomAreaOfClass

public void rmPlaceObjectDefAtRandomAreaOfClass(int defID,
                                                int playerID,
                                                int classID,
                                                long placeCount)

Place object definition for the player at the location of a random area in the given class.

rmPlaceObjectDefInArea

public void rmPlaceObjectDefInArea(int defID,
                                   int playerID,
                                   int areaID,
                                   long placeCount)

Place object definition for the player in the given area.

rmPlaceObjectDefInRandomAreaOfClass

public void rmPlaceObjectDefInRandomAreaOfClass(int defID,
                                                int playerID,
                                                int classID,
                                                long placeCount)

Place object definition for the player in a random area in the given class.

rmPlaceObjectDefPerPlayer

public void rmPlaceObjectDefPerPlayer(int defID,
                                      bool playerOwned,
                                      long placeCount)

Place object definition per player.

rmSetIgnoreForceToGaia
```
public void rmSetIgnoreForceToGaia(bool val)
```
If off, some objects placed will automatically convert to Mother Nature. (e.g. gold mines).

Class ObjectDef