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

Class ExpirationBasedHappinessModifier

java.lang.Object

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

com.minecolonies.api.entity.citizen.happiness.ExpirationBasedHappinessModifier

All Implemented Interfaces:

IHappinessModifier, ITimeBasedHappinessModifier

public final class ExpirationBasedHappinessModifier
extends AbstractHappinessModifier
implements ITimeBasedHappinessModifier

The Expiration based happiness modifier. These modifiers are invoked for a limited period of time and have a happiness buff or boost for this time on the happiness. This can also be inverted resulting in a buff or boost if this modifier is not invoked regularly.

Field Summary

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

id

Constructor Summary

Constructors

Constructor	Description
ExpirationBasedHappinessModifier()	Create an instance of the happiness modifier.
ExpirationBasedHappinessModifier(String id, double weight, IHappinessSupplierWrapper supplier, int period)	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 data)	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

ExpirationBasedHappinessModifier

public ExpirationBasedHappinessModifier(String id,
 double weight,
 IHappinessSupplierWrapper supplier,
 int period)

Create an instance of the happiness modifier.

Parameters:

id - its string id.

weight - its weight.

period - the period.

supplier - the supplier to get the factor.

ExpirationBasedHappinessModifier

public ExpirationBasedHappinessModifier()

Create an instance of the happiness modifier.

Method Details

getFactor

public double getFactor(ICitizenData data)

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:

data - 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

dayEnd

public void dayEnd(ICitizenData data)

Description copied from interface: ITimeBasedHappinessModifier

Called at the end of each day.

Specified by:

dayEnd 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.

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.