com.springrts.ai.oo
Class Mod

java.lang.Object
  com.springrts.ai.oo.Mod

All Implemented Interfaces:

Comparable<Mod>

public class Mod
extends Object
implements Comparable<Mod>

Method Summary

int	compareTo(Mod other)
boolean	equals(Object otherObject)
float	getAirLosMul() units airsightdistance will be multiplied with this, for testing purposes
int	getAirMipLevel() miplevel to use for airlos
boolean	getAllowTeamColors()
float	getCaptureEnergyCostFactor() How much should energy should capture cost, default 0.0
boolean	getConstructionDecay() Should constructions without builders decay?
float	getConstructionDecaySpeed() How fast do they decay?
int	getConstructionDecayTime() How long until they start decaying?
String	getDescription()
String	getFileName() archive filename
int	getFireAtCrashing() 1 = units fire at crashing aircrafts, 0 = units ignore crashing aircrafts
int	getFireAtKilled() 1 = units fire at enemies running Killed() script, 0 = units ignore such enemies
int	getFlankingBonusModeDefault() 0=no flanking bonus; 1=global coords, mobile; 2=unit coords, mobile; 3=unit coords, locked
String	getHumanName() archive filename
int	getLosMipLevel() miplevel for los
float	getLosMul() units sightdistance will be multiplied with this, for testing purposes
int	getMultiReclaim() 0 = 1 reclaimer per feature max, otherwise unlimited
String	getMutator()
boolean	getReclaimAllowAllies() Allow reclaiming allies? default true
boolean	getReclaimAllowEnemies() Allow reclaiming enemies? default true
float	getReclaimFeatureEnergyCostFactor() How much should energy should reclaiming a feature cost, default 0.0
int	getReclaimMethod() 0 = gradual reclaim, 1 = all reclaimed at end, otherwise reclaim in reclaimMethod chunks
float	getReclaimUnitEfficiency() How much metal should reclaim return, default 1.0
float	getReclaimUnitEnergyCostFactor() How much energy should reclaiming a unit cost, default 0.0
int	getReclaimUnitMethod() 0 = Revert to wireframe, gradual reclaim, 1 = Subtract HP, give full metal at end, default 1
float	getRepairEnergyCostFactor() How much should energy should repair cost, default 0.0
boolean	getRequireSonarUnderWater() when underwater, units are not in LOS unless also in sonar
float	getResurrectEnergyCostFactor() How much should energy should resurrect cost, default 0.5
String	getShortName()
int	getTransportAir() 0 = all air units cannot be transported, 1 = all air units can be transported (mass and size restrictions still apply).
int	getTransportGround() 0 = all ground units cannot be transported, 1 = all ground units can be transported (mass and size restrictions still apply).
int	getTransportHover() 0 = all hover units cannot be transported, 1 = all hover units can be transported (mass and size restrictions still apply).
int	getTransportShip() 0 = all naval units cannot be transported, 1 = all naval units can be transported (mass and size restrictions still apply).
String	getVersion()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

compareTo

public int compareTo(Mod other)

Specified by:

compareTo in interface Comparable<Mod>

equals

public boolean equals(Object otherObject)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object

getFileName

public String getFileName()

archive filename

getHumanName

public String getHumanName()

archive filename

getShortName

public String getShortName()

getVersion

public String getVersion()

getMutator

public String getMutator()

getDescription

public String getDescription()

getAllowTeamColors

public boolean getAllowTeamColors()

getConstructionDecay

public boolean getConstructionDecay()

Should constructions without builders decay?

getConstructionDecayTime

public int getConstructionDecayTime()

How long until they start decaying?

getConstructionDecaySpeed

public float getConstructionDecaySpeed()

How fast do they decay?

getMultiReclaim

public int getMultiReclaim()

0 = 1 reclaimer per feature max, otherwise unlimited

getReclaimMethod

public int getReclaimMethod()

0 = gradual reclaim, 1 = all reclaimed at end, otherwise reclaim in reclaimMethod chunks

getReclaimUnitMethod

public int getReclaimUnitMethod()

0 = Revert to wireframe, gradual reclaim, 1 = Subtract HP, give full metal at end, default 1

getReclaimUnitEnergyCostFactor

public float getReclaimUnitEnergyCostFactor()

How much energy should reclaiming a unit cost, default 0.0

getReclaimUnitEfficiency

public float getReclaimUnitEfficiency()

How much metal should reclaim return, default 1.0

getReclaimFeatureEnergyCostFactor

public float getReclaimFeatureEnergyCostFactor()

How much should energy should reclaiming a feature cost, default 0.0

getReclaimAllowEnemies

public boolean getReclaimAllowEnemies()

Allow reclaiming enemies? default true

getReclaimAllowAllies

public boolean getReclaimAllowAllies()

Allow reclaiming allies? default true

getRepairEnergyCostFactor

public float getRepairEnergyCostFactor()

How much should energy should repair cost, default 0.0

getResurrectEnergyCostFactor

public float getResurrectEnergyCostFactor()

How much should energy should resurrect cost, default 0.5

getCaptureEnergyCostFactor

public float getCaptureEnergyCostFactor()

How much should energy should capture cost, default 0.0

getTransportGround

public int getTransportGround()

0 = all ground units cannot be transported, 1 = all ground units can be transported (mass and size restrictions still apply). Defaults to 1.

getTransportHover

public int getTransportHover()

0 = all hover units cannot be transported, 1 = all hover units can be transported (mass and size restrictions still apply). Defaults to 0.

getTransportShip

public int getTransportShip()

0 = all naval units cannot be transported, 1 = all naval units can be transported (mass and size restrictions still apply). Defaults to 0.

getTransportAir

public int getTransportAir()

0 = all air units cannot be transported, 1 = all air units can be transported (mass and size restrictions still apply). Defaults to 0.

getFireAtKilled

public int getFireAtKilled()

1 = units fire at enemies running Killed() script, 0 = units ignore such enemies

getFireAtCrashing

public int getFireAtCrashing()

1 = units fire at crashing aircrafts, 0 = units ignore crashing aircrafts

getFlankingBonusModeDefault

public int getFlankingBonusModeDefault()

0=no flanking bonus; 1=global coords, mobile; 2=unit coords, mobile; 3=unit coords, locked

getLosMipLevel

public int getLosMipLevel()

miplevel for los

getAirMipLevel

public int getAirMipLevel()

miplevel to use for airlos

getLosMul

public float getLosMul()

units sightdistance will be multiplied with this, for testing purposes

getAirLosMul

public float getAirLosMul()

units airsightdistance will be multiplied with this, for testing purposes

getRequireSonarUnderWater

public boolean getRequireSonarUnderWater()

when underwater, units are not in LOS unless also in sonar