Class LivingBreatheEvent
java.lang.Object
net.minecraftforge.eventbus.api.Event
net.minecraftforge.event.entity.EntityEvent
net.minecraftforge.event.entity.living.LivingEvent
net.minecraftforge.event.entity.living.LivingBreatheEvent
LivingBreatheEvent is fired whenever a living entity ticks.
This event is fired via
This event is not
This event does not have a result.
This event is fired on
This event is fired via
ForgeHooks.onLivingBreathe(LivingEntity, int, int)
.This event is not
Cancelable
.This event does not have a result.
Event.HasResult
This event is fired on
MinecraftForge.EVENT_BUS
-
Nested Class Summary
Nested classes/interfaces inherited from class net.minecraftforge.event.entity.living.LivingEvent
LivingEvent.LivingJumpEvent, LivingEvent.LivingTickEvent, LivingEvent.LivingVisibilityEvent
Nested classes/interfaces inherited from class net.minecraftforge.event.entity.EntityEvent
EntityEvent.EnteringSection, EntityEvent.EntityConstructing
Nested classes/interfaces inherited from class net.minecraftforge.eventbus.api.Event
net.minecraftforge.eventbus.api.Event.HasResult, net.minecraftforge.eventbus.api.Event.Result
-
Field Summary
Modifier and TypeFieldDescriptionprivate boolean
private boolean
private int
private int
-
Constructor Summary
ConstructorDescriptionLivingBreatheEvent
(LivingEntity entity, boolean canBreathe, int consumeAirAmount, int refillAirAmount) Deprecated, for removal: This API element is subject to removal in a future version.LivingBreatheEvent
(LivingEntity entity, boolean canBreathe, int consumeAirAmount, int refillAirAmount, boolean canRefillAir) -
Method Summary
Modifier and TypeMethodDescriptionboolean
If the entity can breathe andcanRefillAir()
returns true, their air value will be increased bygetRefillAirAmount()
.
If the entity can breathe andcanRefillAir()
returns false, their air value will stay the same.
If the entity cannot breathe, their air value will be reduced bygetConsumeAirAmount()
.boolean
If the entity can breathe,canRefillAir()
will be checked to see if their air value should be refilled.int
int
void
setCanBreathe
(boolean canBreathe) Sets if the entity can breathe or not.void
setCanRefillAir
(boolean canRefillAir) Sets if the entity can refill its air value or not.void
setConsumeAirAmount
(int consumeAirAmount) Sets the new consumed air amount.void
setRefillAirAmount
(int refillAirAmount) Sets the new refilled air amount.Methods inherited from class net.minecraftforge.event.entity.living.LivingEvent
getEntity
Methods inherited from class net.minecraftforge.eventbus.api.Event
getListenerList, getPhase, getResult, hasResult, isCancelable, isCanceled, setCanceled, setPhase, setResult
-
Field Details
-
canBreathe
private boolean canBreathe -
canRefillAir
private boolean canRefillAir -
consumeAirAmount
private int consumeAirAmount -
refillAirAmount
private int refillAirAmount
-
-
Constructor Details
-
LivingBreatheEvent
@Internal @Deprecated(forRemoval=true, since="1.20.1") public LivingBreatheEvent(LivingEntity entity, boolean canBreathe, int consumeAirAmount, int refillAirAmount) Deprecated, for removal: This API element is subject to removal in a future version. -
LivingBreatheEvent
@Internal public LivingBreatheEvent(LivingEntity entity, boolean canBreathe, int consumeAirAmount, int refillAirAmount, boolean canRefillAir)
-
-
Method Details
-
canBreathe
public boolean canBreathe()If the entity can breathe andcanRefillAir()
returns true, their air value will be increased bygetRefillAirAmount()
.
If the entity can breathe andcanRefillAir()
returns false, their air value will stay the same.
If the entity cannot breathe, their air value will be reduced bygetConsumeAirAmount()
.- Returns:
- True if the entity can breathe
-
setCanBreathe
public void setCanBreathe(boolean canBreathe) Sets if the entity can breathe or not.- Parameters:
canBreathe
- The new value.
-
canRefillAir
public boolean canRefillAir()If the entity can breathe,canRefillAir()
will be checked to see if their air value should be refilled.- Returns:
- True if the entity can refill its air value
-
setCanRefillAir
public void setCanRefillAir(boolean canRefillAir) Sets if the entity can refill its air value or not.- Parameters:
canRefillAir
- The new value.
-
getConsumeAirAmount
public int getConsumeAirAmount()- Returns:
- The amount the entity's air supply will be reduced by if the entity cannot breathe.
-
setConsumeAirAmount
public void setConsumeAirAmount(int consumeAirAmount) Sets the new consumed air amount.- Parameters:
consumeAirAmount
- The new value.- See Also:
-
getRefillAirAmount
public int getRefillAirAmount()- Returns:
- The amount the entity's air supply will be increased by if the entity can breathe.
-
setRefillAirAmount
public void setRefillAirAmount(int refillAirAmount) Sets the new refilled air amount.- Parameters:
refillAirAmount
- The new value.- See Also:
-