Expand Events #330

gabizou · 2014-12-27T22:08:13Z

Adds the following events:

TileEntityEvents
- BrewingStandBrewEvent
- BrewingStandEvent
- FurnaceBurnEvent
- FurnaceCookEvent
- FurnaceEvent
- SignChangeEvent
- SignEvent
- TileEntityEvent
EntityEvents
- EntityBreedEvent
- EntityEquipmentChangeEvent
- EntityExpireEvent
- EntityIgniteEvent
- EntityItemConsumeEvent
- EnttyLeashEvent
- ProjectileLaunchEvent
LivingEvents
- LivingChangeBlockEvent
- LivingChangeHealthEvent
- LivingDeathEvent
- LivingDropItemEvent
- LivingEquipmentChangeEvent
- LivingEvent
- LivingExpirePotionEffectEvent
- LivingInteractBlockEvent
- LivingInteractEntityEvent
- LivingInteractEvent
- LivingItemConsumeEvent
- LivingMoveEvent
- LivingPickUpItemEvent
- LivingPlaceBlockEvent
- LivingPotionEffectEvent
- LivingRemovePotionEffectEvent
- LivingUpdateEvent
HumanEvents
- HumanBreakBlockEvent
- HumanChangeBlockEvent
- HumanChangeGameModeEvent
- HumanChangeHealthEvent
- HumanDeathEvent
- HumanDropItemEvent
- HumanEnterBedEvent
- HumanEquipmentChangeEvent
- HumanEvent
- HumanExpChangeEvent
- HumanInteractBlockEvent
- HumanInteractEntityEvent
- HumanInteractEvent
- HumanItemConsumeEvent
- HumanLeaveBedEvent
- HumanLevelChangeEvent
- HumanMoveEvent
- HumanPickUpItemEvent
- HumanPlaceBlockEvent
- HumanSleepEvent
- HumanUpdateEvent
PlayerEvents
- PlayerChangeGameModeEvent
- PlayerChangeHealthEvent
- PlayerDeathEvent
- PlayerEnterBedEvent
- PlayerEquipmentChangeEvent
- PlayerEvent
- PlayerExpChangeEvent
- PlayerItemConsumeEvent
- PlayerLeaveBedEvent
- PlayerLevelChangeEvent
- PlayerPickUpItemEvent
MinecartEvents
- MinecartEvent
ItemEvents
- ItemEvent
- ItemExpireEvent
- ItemMergeEvent

Modifies the following events:

EntityDeathEvent
EntityInteractEvent
ProjectileLaunchEvent

More events are to follow as seen fit.

Aaron1011 · 2014-12-27T22:13:06Z

src/main/java/org/spongepowered/api/event/player/PlayerBedEvent.java

+public interface PlayerBedEvent extends PlayerEvent {
+
+    /**
+     * Gets the location of the player in respect to the bed.


This should probably be Gets the location of the player *before entering the bed* instead.

simon816 · 2014-12-28T00:15:07Z

src/main/java/org/spongepowered/api/event/entity/EntityDeathEvent.java

 /**
 * Called when an {@link Entity} is killed or removed due to unload.
 */
 public interface EntityDeathEvent extends EntityEvent, CauseTracked, Cancellable {
+
+    /**
+     * Gets a copy of the {@link ItemStack}s this entity will drop on death.


Why a copy? Could this list be mutable?

I think that's addressed by setDrops

It is, but seems unnecessary since List has methods to make it simpler

event.getDrops().add(event.getGame().getRegistry().getItemBuilder() ...);

Is neater than

List<ItemStack> drops = event.getDrops(); drops.add(event.getGame().getRegistry().getItemBuilder() ...); event.setDrops(drops);

I disagree with leaving lists mutable, I'd rather have copies handed around to prevent manipulating or holding references of live ItemStacks following death events.

Is there not a way to use a mutable list, without leaking references to itemstacks afterwards? Like using an editable snapshot which doesn't get used again?

ST-DDT · 2014-12-29T16:25:48Z

What about EntityDamagedEvent, EntityDamagedByBlockEvent, EntityDamagedByEntityEvent or PlayerDamagedEvent?

simon816 · 2014-12-29T16:50:25Z

@ST-DDT I'm not sure how event causes are going to work but that sounds like something that would be described in the cause.

gabizou · 2014-12-29T18:26:59Z

What about EntityDamagedEvent, EntityDamagedByBlockEvent, EntityDamagedByEntityEvent or PlayerDamagedEvent?

What about them? Are you copying the events we had from Bukkit?

ST-DDT · 2014-12-29T19:32:41Z

@simon816 Maybe, i'm not sure about using Cause for that (or at least not as standalone solution). Because there are multiple mutable values involved in that: the damage itself, the damage modifiers ... Although i can thing of some advantages of additionally using the Cause/Reason stuff. Entity died -> get cause = entity damaged -> get cause = projectile hit -> get cause = projectile shot -> by whom = playerABC. (Some kind of gameplay stacktrace)

@gabizou What? I only suggested them or similar things to be added.
(Was my phrasing impolite or unclear? Maybe this in one of the things you cannot properly translate. It was intended to be a simple question pointing to something that has not been part of the discussion here yet.)
I just want to (help) recreate most part of the API, so that I can easily move my plugins if there is no similar method/class/interface in the API either does it in another way or it is not implemented yet.
Currently there is no way (i don't know any way) to get the functionality of the DamageEvents so I pointed at them / asked whether they have been forgotten until yet. simon816 gave me a good hint that they are already/will be handled using the Causes.

ryantheleach · 2014-12-30T01:08:30Z

src/main/java/org/spongepowered/api/event/entity/EntityDeathEvent.java

+     *
+     * @param drops The list of drops the entity will drop on death
+     */
+    void setDrops(List<ItemStack> drops);


are set drops removed from the players inventory, or will removing an item from the drops not replace it in the players inventory?

I think the player will lose everything on death, and this is what it drops. (Correct me if I am wrong)

Aaron1011 · 2014-12-31T22:13:08Z

src/main/java/org/spongepowered/api/event/player/PlayerInteractEvent.java

+     * Gets the clicked position of this interact event.
+     *
+     * <p>This may not always be available, in which case
+     * {@link Optional#absent()} is returned. Specifically, when a player


The clicked position is sent by the client for all entities. The only time it's not available is for blocks.

Is this event going to be subclassed to handle interacting with entities, or are those method going to be added to this class?

The clicked position is sent by the client for all entities

No it is not. Again, refer to the protocol.

The only time it's not available is for blocks.

It's almost always available for blocks.

Is this event going to be subclassed to handle interacting with entities, or are those method going to be added to this class?

No. It isn't necessary since PlayerInteractEntity extends PlayerInteract.

No it is not. Again, refer to the protocol.

I've looked at MCP - two packets get sent for all interactions, except for ArmorStand: only INTERACT_AT is sent. Even if it wasn't, there's no reason it couldn't be calculated server-side.

Additionally, I've seen thing while working on handling the Use Entity packet in Glowstone.

thomas15v · 2015-01-13T11:29:01Z

Just wondering should PlayerExpChangeEvent not have a setCurrent. It would avoid the whole getPlayer().setExperience() thing. And it would allow multiple plugins to change/modify the experience gain.

Aaron1011 · 2015-01-17T18:21:29Z

src/main/java/org/spongepowered/api/entity/living/Human.java

+    int getTotalExperinece();
+
+    /**
+     * Sets the experience accumulated towards the next level.


There should be a note about how much experience advances a player to the next level.

Aaron1011 · 2015-01-17T18:28:32Z

src/main/java/org/spongepowered/api/event/entity/living/human/HumanLeaveBedEvent.java

+public interface HumanLeaveBedEvent extends HumanSleepEvent {
+
+    /**
+     * Gets whether the spawn location for the player was set.


There should be a note explaining why this could be false.

AlphaModder · 2015-01-19T05:08:05Z

Some events I thought of:

EntityAddStatusEffectEvent
EntityRemoveStatusEffectEvent
BlockHitEvent
BlockFallEvent
EntityStruckByLightningEvent
NoteblockPlayEvent
EntityIgniteEvent
EntityExplodeEvent (maybe)
EntityEnterPortalEvent
EntityLeashedEvent

Aaron1011 · 2015-01-21T18:02:25Z

src/main/java/org/spongepowered/api/event/entity/living/player/PlayerInteractEvent.java

+     * Gets the clicked position of this interact event.
+     *
+     * <p>This may not always be available, in which case
+     * {@link Optional#absent()} is returned. Specifically, when a player


Currently, the location is sent for all entities (although it's only used for AmorStands)

me4502 · 2015-01-21T22:04:46Z

From what I can tell we are missing SignChangeEvent. Maybe make it extend BlockChangeEvent

gabizou · 2015-01-22T00:12:41Z

Just wondering should PlayerExpChangeEvent not have a setCurrent. It would avoid the whole getPlayer().setExperience() thing. And it would allow multiple plugins to change/modify the experience gain.

The problem with doing this is that the event is a "state". Changing the experience via getPlayer() would be overwritten when the event is completed and processed.

From what I can tell we are missing SignChangeEvent. Maybe make it extend BlockChangeEvent

Will add.

EntityAddStatusEffectEvent
EntityRemoveStatusEffectEvent

Adding in a different way, but being added nonetheless.

BlockHitEvent

Could you elaborate on what this does?

BlockFallEvent

EntityStruckByLightningEvent

Already covered by LightingStrikeEvent#getStruckEntities()

NoteblockPlayEvent

Perhaps a more generic way to do this?

EntityIgniteEvent

Will add.

EntityEnterPortalEvent

Perhaps can be handled via EntityTeleportEvent since all portals do teleport entities.

EntityLeashedEvent

Will add.

AlphaModder · 2015-01-22T00:38:00Z

@gabizou BlockHitEvent is essentially when a player starts breaking a block. Bukkit had a BlockDamageEvent that did the same thing and allowed you to get/setInstant(). You might say you could do the same with interact and then set the block to air, but if you want drops or other vanilla block breaking handling or something it's useful.

AlphaModder · 2015-01-22T16:15:54Z

MerchantTradeEvent? perhaps with TradeOffer getOffer(), ItemStack getFirstStack() and ItemStack getSecondStack()?

Zidane · 2015-01-23T01:49:16Z

src/main/java/org/spongepowered/api/event/block/data/FurnaceBurnEvent.java

+import org.spongepowered.api.item.inventory.ItemStack;
+
+/**
+ * An event when a {@link Furnace}


Missing docs?

- Living - Human - Player - TileEntity

gabizou mentioned this pull request Dec 27, 2014

Added PlayerSleepInBedEvent and PlayerWakeUpEvent #296

Closed

Aaron1011 reviewed Dec 27, 2014
View reviewed changes

gabizou mentioned this pull request Dec 27, 2014

Add PlayerDeathEvent and PlayerRespawnEvent #209

Closed

gabizou added this to the 1.1-Release milestone Dec 27, 2014

gabizou self-assigned this Dec 27, 2014

simon816 reviewed Dec 28, 2014
View reviewed changes

ryantheleach reviewed Dec 30, 2014
View reviewed changes

gabizou mentioned this pull request Dec 31, 2014

PlayerClickEvent and friends #345

Closed

Aaron1011 reviewed Dec 31, 2014
View reviewed changes

gabizou force-pushed the feature/player-events branch from a4749d8 to e3317ba Compare January 5, 2015 16:07

gabizou mentioned this pull request Jan 13, 2015

Added PlayerExperienceChangeEvent! #385

Closed

gabizou force-pushed the feature/player-events branch from ef45426 to 41875fe Compare January 15, 2015 11:25

gabizou changed the title ~~[WIP] Add more expansive Player related events~~ [WIP] Expand Events Jan 15, 2015

gabizou mentioned this pull request Jan 17, 2015

Fix many (many many) minor issues #392

Closed

Aaron1011 reviewed Jan 17, 2015
View reviewed changes

gabizou force-pushed the feature/player-events branch from 5a112fa to 458d5f4 Compare January 21, 2015 06:11

gabizou mentioned this pull request Jan 21, 2015

Add ItemMergeEvent #401

Closed

Aaron1011 reviewed Jan 21, 2015
View reviewed changes

gabizou force-pushed the feature/player-events branch 2 times, most recently from c6c539c to 97b3e76 Compare January 22, 2015 01:37

gabizou changed the title ~~[WIP] Expand Events~~ Expand Events Jan 22, 2015

Zidane reviewed Jan 23, 2015
View reviewed changes

gabizou force-pushed the feature/player-events branch from 23c3449 to e4912e7 Compare January 23, 2015 02:30

Add Living, Human, Player event hierarchy. Add TileEntity events.

8fdacff

gabizou force-pushed the feature/player-events branch from e4912e7 to 8fdacff Compare January 23, 2015 02:53

gabizou closed this in 57d70e3 Jan 23, 2015

gabizou deleted the feature/player-events branch January 23, 2015 04:10

gabizou added a commit that referenced this pull request Jan 23, 2015

Event Hierarchy. Closes #330 .

2443e0e

- Living - Human - Player - TileEntity

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Expand Events #330

Expand Events #330

gabizou commented Dec 27, 2014

Aaron1011 Dec 27, 2014

simon816 Dec 28, 2014

Aaron1011 Dec 28, 2014

simon816 Dec 28, 2014

gabizou Dec 28, 2014

ryantheleach Dec 30, 2014

ST-DDT commented Dec 29, 2014

simon816 commented Dec 29, 2014

gabizou commented Dec 29, 2014

ST-DDT commented Dec 29, 2014

ryantheleach Dec 30, 2014

JonathanBrouwer Jan 3, 2015

Aaron1011 Dec 31, 2014

gabizou Dec 31, 2014

Aaron1011 Dec 31, 2014

thomas15v commented Jan 13, 2015

Aaron1011 Jan 17, 2015

Aaron1011 Jan 17, 2015

AlphaModder commented Jan 19, 2015

Aaron1011 Jan 21, 2015

me4502 commented Jan 21, 2015

gabizou commented Jan 22, 2015

AlphaModder commented Jan 22, 2015

AlphaModder commented Jan 22, 2015

Zidane Jan 23, 2015

Expand Events #330

Expand Events #330

Conversation

gabizou commented Dec 27, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ST-DDT commented Dec 29, 2014

simon816 commented Dec 29, 2014

gabizou commented Dec 29, 2014

ST-DDT commented Dec 29, 2014

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

thomas15v commented Jan 13, 2015

Choose a reason for hiding this comment

Choose a reason for hiding this comment

AlphaModder commented Jan 19, 2015

Choose a reason for hiding this comment

me4502 commented Jan 21, 2015

gabizou commented Jan 22, 2015

AlphaModder commented Jan 22, 2015

AlphaModder commented Jan 22, 2015

Choose a reason for hiding this comment