Package megamek.common.util

Class BuildingTemplate

java.lang.Object

megamek.common.util.BuildingTemplate

All Implemented Interfaces:

Serializable

public class BuildingTemplate
extends Object
implements Serializable

Building template, for placing on the map during map generation.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final int	BASEMENT_RANDOM

Constructor Summary

Constructors

Constructor	Description
BuildingTemplate(BuildingType type, ArrayList<Coords> coords)	Deprecated, for removal: This API element is subject to removal in a future version. Unused, will be removed in future versions.
BuildingTemplate(BuildingType type, ArrayList<Coords> coords, int CF, int height, int basement)

Method Summary

Modifier and Type	Method	Description
boolean	containsCoords(Coords c)
int	getBasement()
int	getCF()
Iterator<Coords>	getCoords()
int	getHeight()
BuildingType	getType()

Methods inherited from class java.lang.Object

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

Field Details

BASEMENT_RANDOM

public static final int BASEMENT_RANDOM

See Also:

• Constant Field Values

Constructor Details

BuildingTemplate

@Deprecated(since="0.50.07",
            forRemoval=true)
public BuildingTemplate(BuildingType type,
 ArrayList<Coords> coords)

Deprecated, for removal: This API element is subject to removal in a future version.

Unused, will be removed in future versions. Use the other constructor

Constructor for a building template.

Parameters:

type - type of the building BuildingType

coords - vector containing Coords of all hexes the building covers

BuildingTemplate

public BuildingTemplate(BuildingType type,
 ArrayList<Coords> coords,
 int CF,
 int height,
 int basement)

Method Details

getCoords

public Iterator<Coords> getCoords()

Returns:

vector containing Coords of all hexes the building covers

getType

public BuildingType getType()

Returns:

type of the building (Building.LIGHT - Building.HARDENED)

getCF

public int getCF()

Returns:

construction factor, used to initialise BLDG_CF

getHeight

public int getHeight()

Returns:

height of the building, used to initialise BLDG_ELEV

getBasement

public int getBasement()

Returns:

basement settings - basements arent implemented yet

containsCoords

public boolean containsCoords(Coords c)