Package com.minecolonies.api.entity.citizen.happiness

Class TimeBasedHappinessModifier

java.lang.Object

com.minecolonies.api.entity.citizen.happiness.AbstractHappinessModifier

com.minecolonies.api.entity.citizen.happiness.TimeBasedHappinessModifier

All Implemented Interfaces:

IHappinessModifier, ITimeBasedHappinessModifier

public final class TimeBasedHappinessModifier
extends AbstractHappinessModifier
implements ITimeBasedHappinessModifier

The time based happiness modifier. Over a time the buff/boost gets worse.

Field Summary

Fields inherited from class com.minecolonies.api.entity.citizen.happiness.AbstractHappinessModifier

id

Constructor Summary

Constructors

Constructor	Description
TimeBasedHappinessModifier()	Create an instance of the happiness modifier.
TimeBasedHappinessModifier(String id, double weight, IHappinessSupplierWrapper supplier, Tuple<Integer,Double>... timeBasedFactor)	Create an instance of the happiness modifier.
TimeBasedHappinessModifier(String id, double weight, IHappinessSupplierWrapper supplier, BiPredicate<TimeBasedHappinessModifier,ICitizenData> dayRollOverPredicate, Tuple<Integer,Double>... timeBasedFactor)	Create an instance of the happiness modifier.

Method Summary

Modifier and Type	Method	Description
void	dayEnd(ICitizenData data)	Called at the end of each day.
int	getDays()	Get the days this is active.
double	getFactor(ICitizenData citizenData)	Get the factor of the happiness.
void	read(net.minecraft.nbt.CompoundTag compoundNBT, boolean persist)	Read the modifier from nbt.
void	reset()	Reset the modifier.
void	write(net.minecraft.nbt.CompoundTag compoundNBT, boolean persist)	Write it to NBT.

Methods inherited from class com.minecolonies.api.entity.citizen.happiness.AbstractHappinessModifier

getId, getWeight

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.minecolonies.api.entity.citizen.happiness.IHappinessModifier

getId, getWeight

Constructor Details

TimeBasedHappinessModifier

@SafeVarargs
public TimeBasedHappinessModifier(String id,
 double weight,
 IHappinessSupplierWrapper supplier,
 Tuple<Integer,Double>... timeBasedFactor)

Create an instance of the happiness modifier.

Parameters:

id - its string id.

weight - its weight.

supplier - the supplier to get the factor.

timeBasedFactor - tuples about the boost/buff factor over time.

TimeBasedHappinessModifier

@SafeVarargs
public TimeBasedHappinessModifier(String id,
 double weight,
 IHappinessSupplierWrapper supplier,
 BiPredicate<TimeBasedHappinessModifier,ICitizenData> dayRollOverPredicate,
 Tuple<Integer,Double>... timeBasedFactor)

Create an instance of the happiness modifier.

Parameters:

id - its string id.

weight - its weight.

supplier - the supplier to get the factor.

timeBasedFactor - tuples about the boost/buff factor over time.

dayRollOverPredicate - a predicate to check whether the current day should roll over or reset.

TimeBasedHappinessModifier

public TimeBasedHappinessModifier()

Create an instance of the happiness modifier.

Method Details

getFactor

public double getFactor(ICitizenData citizenData)

Description copied from interface: IHappinessModifier

Get the factor of the happiness. value between 0 and 1 if negative. value above 1 if positive.

Specified by:

getFactor in interface IHappinessModifier

Overrides:

getFactor in class AbstractHappinessModifier

Parameters:

citizenData - the citizen the factor is for.

Returns:

the value of the factor.

reset

public void reset()

Description copied from interface: ITimeBasedHappinessModifier

Reset the modifier.

Specified by:

reset in interface ITimeBasedHappinessModifier

getDays

public int getDays()

Description copied from interface: ITimeBasedHappinessModifier

Get the days this is active.

Specified by:

getDays in interface ITimeBasedHappinessModifier

Returns:

the days.

dayEnd

public void dayEnd(ICitizenData data)

Description copied from interface: ITimeBasedHappinessModifier

Called at the end of each day.

Specified by:

dayEnd in interface ITimeBasedHappinessModifier

read

public void read(net.minecraft.nbt.CompoundTag compoundNBT,
 boolean persist)

Description copied from interface: IHappinessModifier

Read the modifier from nbt.

Specified by:

read in interface IHappinessModifier

Overrides:

read in class AbstractHappinessModifier

Parameters:

compoundNBT - the compound to read it from.

persist - whether we're reading from persisted data or from networking.

write

public void write(net.minecraft.nbt.CompoundTag compoundNBT,
 boolean persist)

Description copied from interface: IHappinessModifier

Write it to NBT.

Specified by:

write in interface IHappinessModifier

Overrides:

write in class AbstractHappinessModifier

Parameters:

compoundNBT - the compound to write it to.

persist - whether we're reading from persisted data or from networking.