Skip to content

Commit

Permalink
Add javadoc to EntityStruckByLightningEvent
Browse files Browse the repository at this point in the history
  • Loading branch information
AlphaMode committed Dec 11, 2023
1 parent c2a27d1 commit d623971
Showing 1 changed file with 10 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,16 @@
import net.minecraft.world.entity.Entity;
import net.minecraft.world.entity.LightningBolt;

/**
* EntityStruckByLightningEvent is fired when an Entity is about to be struck by lightening.<br>
* This event is fired whenever an EntityLightningBolt is updated to strike an Entity in
* {@link LightningBolt#tick()}.<br>
* <br>
* {@link #lightning} contains the instance of EntityLightningBolt attempting to strike an entity.<br>
* <br>
* If this event is canceled, the Entity is not struck by the lightening.<br>
* <br>
**/
public class EntityStruckByLightningEvent extends EntityEvents {
private final LightningBolt lightning;

Expand Down

0 comments on commit d623971

Please sign in to comment.