Java tutorial
/* * Minecraft Forge * Copyright (c) 2016-2019. * * This library is free software; you can redistribute it and/or * modify it under the terms of the GNU Lesser General Public * License as published by the Free Software Foundation version 2.1 * of the License. * * This library is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU * Lesser General Public License for more details. * * You should have received a copy of the GNU Lesser General Public * License along with this library; if not, write to the Free Software * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA */ package net.minecraftforge.event.entity.living; import javax.annotation.Nullable; import net.minecraft.world.spawner.AbstractSpawner; import net.minecraftforge.common.MinecraftForge; import net.minecraftforge.event.ForgeEventFactory; import net.minecraftforge.eventbus.api.Event; import net.minecraft.entity.MobEntity; import net.minecraft.entity.SpawnReason; import net.minecraft.world.IWorld; import net.minecraft.world.World; import net.minecraftforge.eventbus.api.Event.HasResult; /** * LivingSpawnEvent is fired for any events associated with Living Entities spawn status. <br> * If a method utilizes this {@link Event} as its parameter, the method will * receive every child event of this class.<br> * <br> * {@link #world} contains the world in which this living Entity is being spawned.<br> * {@link #x} contains the x-coordinate this entity is being spawned at.<br> * {@link #y} contains the y-coordinate this entity is being spawned at.<br> * {@link #z} contains the z-coordinate this entity is being spawned at.<br> * <br> * All children of this event are fired on the {@link MinecraftForge#EVENT_BUS}. **/ public class LivingSpawnEvent extends LivingEvent { private final IWorld world; private final double x; private final double y; private final double z; public LivingSpawnEvent(MobEntity entity, IWorld world, double x, double y, double z) { super(entity); this.world = world; this.x = x; this.y = y; this.z = z; } public IWorld getWorld() { return world; } public double getX() { return x; } public double getY() { return y; } public double getZ() { return z; } /** * Fires before mob spawn events. * * Result is significant: * DEFAULT: use vanilla spawn rules * ALLOW: allow the spawn * DENY: deny the spawn * */ @HasResult public static class CheckSpawn extends LivingSpawnEvent { @Nullable private final AbstractSpawner spawner; private final SpawnReason spawnReason; /** * CheckSpawn is fired when an Entity is about to be spawned. * @param entity the spawning entity * @param world the world to spawn in * @param x x coordinate * @param y y coordinate * @param z z coordinate * @param spawner position of the MobSpawner * null if it this spawn is coming from a WorldSpawner */ public CheckSpawn(MobEntity entity, IWorld world, double x, double y, double z, @Nullable AbstractSpawner spawner, SpawnReason spawnReason) { super(entity, world, x, y, z); this.spawner = spawner; this.spawnReason = spawnReason; } public boolean isSpawner() { return spawner != null; } @Nullable public AbstractSpawner getSpawner() { return spawner; } public SpawnReason getSpawnReason() { return spawnReason; } } /** * SpecialSpawn is fired when an Entity is to be spawned.<br> * This allows you to do special inializers in the new entity.<br> * <br> * This event is fired via the {@link ForgeEventFactory#doSpecialSpawn(EntityLiving, World, float, float, float)}.<br> * <br> * This event is {@link net.minecraftforge.eventbus.api.Cancelable}.<br> * If this event is canceled, the Entity is not spawned.<br> * <br> * This event does not have a result. {@link HasResult}<br> * <br> * This event is fired on the {@link MinecraftForge#EVENT_BUS}. **/ @net.minecraftforge.eventbus.api.Cancelable public static class SpecialSpawn extends LivingSpawnEvent { @Nullable private final AbstractSpawner spawner; private final SpawnReason spawnReason; /** * @param spawner the position of a tileentity or approximate position of an entity that initiated the spawn if any */ public SpecialSpawn(MobEntity entity, World world, double x, double y, double z, @Nullable AbstractSpawner spawner, SpawnReason spawnReason) { super(entity, world, x, y, z); this.spawner = spawner; this.spawnReason = spawnReason; } @Nullable public AbstractSpawner getSpawner() { return spawner; } public SpawnReason getSpawnReason() { return spawnReason; } } /** * Fired each tick for despawnable mobs to allow control over despawning. * {@link Result#DEFAULT} will pass the mob on to vanilla despawn mechanics. * {@link Result#ALLOW} will force the mob to despawn. * {@link Result#DENY} will force the mob to remain. * This is fired every tick for every despawnable entity. Be efficient in your handlers. * * Note: this is not fired <em>if</em> the mob is definitely going to otherwise despawn. It is fired to check if * the mob can be allowed to despawn. See {@link EntityLiving#despawnEntity} * * @author cpw * */ @HasResult public static class AllowDespawn extends LivingSpawnEvent { public AllowDespawn(MobEntity entity) { super(entity, entity.world, entity.func_226277_ct_(), entity.func_226278_cu_(), entity.func_226281_cx_()); } } }