Package com.prineside.tdi2.gameplayMods.mods

Class AbstractGameValueMod

java.lang.Object

com.prineside.tdi2.gameplayMods.GenericGameplayMod

com.prineside.tdi2.gameplayMods.mods.AbstractGameValueMod

All Implemented Interfaces:

KryoSerializable, GameplayMod

Direct Known Subclasses:

GV_AbilitiesEnergy, GV_AbilitiesMaxEnergy, GV_BountiesNearby, GV_DisableBountyModifierHarm, GV_MinersMaxUpgradeLevel, GV_TowersMaxExpLevel

public abstract class AbstractGameValueMod
extends GenericGameplayMod

Field Summary

Fields

Modifier and Type	Field	Description
GameplayModCategory	additionalCategory
float	baseValue
float	deltaPerPower
GameValueType	gvType
boolean	isFinalMultiplier
GameplayModCategory	mainCategory
boolean	roundToInt

Fields inherited from class com.prineside.tdi2.gameplayMods.GenericGameplayMod

maxPower, multipleInstances, power, powerLevelsUpgradedByMods, replacedMod

Constructor Summary

Constructors

Constructor	Description
AbstractGameValueMod(GameValueType gvType)
AbstractGameValueMod(GameValueType gvType, float baseValue, float deltaPerPower, boolean roundToInt, GameplayModCategory mainCategory, GameplayModCategory additionalCategory)

Method Summary

Modifier and Type	Method	Description
AbstractGameValueMod	applyConfig(JsonValue cfg)	Usually there's no need to override this method Used by mods that have specific combinations of parameters and read default parameters for each combo
GameplayModCategory	getAdditionalCategory()
GameplayModCategory	getCategory()
CharSequence	getDescription()
Drawable	getIcon()
void	read(Kryo kryo, Input input)
boolean	register(GameSystemProvider S, String activatedBy)	Note: if mod needs random number generator, it must use the one provided by GameplayModSystem
void	setRegisteredPower(int power)	If mod has adjustable power, this method can be called during the game to increase its power
void	write(Kryo kryo, Output output)

Methods inherited from class com.prineside.tdi2.gameplayMods.GenericGameplayMod

allowsMultipleInstancesFromDifferentSources, getId, getMaxPower, getPower, getReplacesUnsatisfiedMod, isPowerLevelUpgradedByOtherMod, markPowerLevelUpgradedByOtherMod, setReplacesUnsatisfiedMod

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.prineside.tdi2.gameplayMods.GameplayMod

configure, cpy, getNotSatisfiedPreconditions, isAlwaysUseless, isImmediateAndNotListed

Field Details

gvType

public GameValueType gvType

mainCategory

public GameplayModCategory mainCategory

additionalCategory

public GameplayModCategory additionalCategory

baseValue

public float baseValue

deltaPerPower

public float deltaPerPower

roundToInt

public boolean roundToInt

isFinalMultiplier

public boolean isFinalMultiplier

Constructor Details

AbstractGameValueMod

public AbstractGameValueMod(GameValueType gvType)

AbstractGameValueMod

public AbstractGameValueMod(GameValueType gvType,
 float baseValue,
 float deltaPerPower,
 boolean roundToInt,
 GameplayModCategory mainCategory,
 @Null
 GameplayModCategory additionalCategory)

Method Details

write

public void write(Kryo kryo,
 Output output)

Specified by:

write in interface KryoSerializable

Overrides:

write in class GenericGameplayMod

read

public void read(Kryo kryo,
 Input input)

Specified by:

read in interface KryoSerializable

Overrides:

read in class GenericGameplayMod

getIcon

public Drawable getIcon()

applyConfig

public AbstractGameValueMod applyConfig(JsonValue cfg)

Description copied from class: GenericGameplayMod

Usually there's no need to override this method Used by mods that have specific combinations of parameters and read default parameters for each combo

Overrides:

applyConfig in class GenericGameplayMod

getDescription

public CharSequence getDescription()

register

public boolean register(GameSystemProvider S,
 String activatedBy)

Description copied from interface: GameplayMod

Note: if mod needs random number generator, it must use the one provided by GameplayModSystem

Returns:

true if bonus has to be registered. False means that existing active mod of the same type has been upgraded

getCategory

public GameplayModCategory getCategory()

getAdditionalCategory

public GameplayModCategory getAdditionalCategory()

setRegisteredPower

public void setRegisteredPower(int power)

Description copied from interface: GameplayMod

If mod has adjustable power, this method can be called during the game to increase its power

Specified by:

setRegisteredPower in interface GameplayMod

Overrides:

setRegisteredPower in class GenericGameplayMod

Parameters:

power - new power to set for this mod when already registered. Will be in range 0..getMaxPower()