You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
---
**Issue: Update README to Include Detailed API Event Documentation**
I propose updating the README to include a detailed breakdown of the API events provided by EliteMobs. The current documentation lacks clear information on what each event does and whether it can be cancelled. This addition would be helpful for developers who want to integrate EliteMobs into their projects, making the API easier to use and understand.
The update should cover:
- Event descriptions
- Use cases for each event
- Whether the event can be cancelled
This will improve clarity and provide a reference directly in the README for anyone utilizing the API.
---
Event Name
Description
Can be Cancelled?
ArenaCompleteEvent
Fires when an arena is successfully beaten by players.
No
CustomEventStartEvent
Fires when a Custom Event starts, where bosses randomly spawn in the Overworld.
Yes
DungeonInstallEvent
Fires when a dungeon is installed by an admin.
Yes
DungeonUninstallEvent
Fires when a dungeon is uninstalled by an admin.
Yes
EliteExplosionEvent
Fires when an Elite Explosion happens with a custom visual effect. Damage to terrain regenerates.
Yes
EliteMobDamagedByEliteMobEvent
Fires when one Elite damages another Elite. Similar to Bukkit's EntityDamagedByEntity event.
No (cancelling may not work)
EliteMobDamagedByPlayerAntiExploitEvent
Fires when an anti-exploit check triggers, even if an exploit isn't detected.
Yes
EliteMobDamagedByPlayerEvent
Fires when a player damages an Elite. Similar to EntityDamagedByEntity for players vs elites.
No
EliteMobDamagedEvent
Fires when an elite is damaged. Similar to Bukkit's EntityDamageEvent.
Yes (may not work fully)
EliteMobDeathEvent
Fires when an elite is killed. Similar to Bukkit's EntityDeathEvent.
No
EliteMobEnterCombatEvent
Fires when an elite enters combat against a player.
No
EliteMobExitCombatEvent
Fires when an elite leaves combat against a player.
No
EliteMobHealEvent
Fires when an elite gets healed.
Yes
EliteMobRemoveEvent
Fires when an elite mob gets removed. Removal may be temporary due to chunk unloads.
No
EliteMobsItemDetector
Detects if an ItemStack is an EliteMobs custom or dynamic item.
N/A
EliteMobSpawnEvent
Fires when an elite spawns, detecting which elite has spawned.
No
EliteMobTargetPlayerEvent
Fires when an elite targets a player.
Yes
GenericAntiExploitEvent
Fires when the anti-exploit check runs (not triggered by a player).
Yes
NPCEntityRemoveEvent
Fires when an NPC entity is removed (removal may be temporary).
No
NPCEntitySpawnEvent
Fires when an NPC entity is spawned.
No
PlayerDamagedByEliteMobEvent
Fires when a player is damaged by an elite. Similar to Bukkit's EntityDamageEvent.
No
PlayerPreTeleportEvent
Fires when a player starts teleporting through EliteMobs features (3-second delay).
Yes
PlayerTeleportEvent
Fires when a player teleports through EliteMobs features.
Yes
QuestAcceptEvent
Fires when a player accepts a quest.
Yes
QuestCompleteEvent
Fires when a player completes a quest.
Yes
QuestLeaveEvent
Fires when a player leaves a quest.
No
QuestObjectivesCompletedEvent
Fires when all quest objectives are completed.
No
QuestProgressionEvent
Fires when a player progresses in a quest (e.g., killing a quest mob or collecting a quest item).
No
QuestRewardEvent
Fires when a player gets a reward from a quest.
No
SuperMobDamageEvent
Fires when a Super Mob is damaged.
Yes
SuperMobDeathEvent
Fires when a Super Mob dies.
No
SuperMobRemoveEvent
Fires when a Super Mob is removed. Removal may be temporary due to chunk unloads.
No
SuperMobSpawnEvent
Fires when a Super Mob spawns.
Yes
The text was updated successfully, but these errors were encountered:
ArenaCompleteEvent
CustomEventStartEvent
DungeonInstallEvent
DungeonUninstallEvent
EliteExplosionEvent
EliteMobDamagedByEliteMobEvent
EntityDamagedByEntity
event.EliteMobDamagedByPlayerAntiExploitEvent
EliteMobDamagedByPlayerEvent
EntityDamagedByEntity
for players vs elites.EliteMobDamagedEvent
EntityDamageEvent
.EliteMobDeathEvent
EntityDeathEvent
.EliteMobEnterCombatEvent
EliteMobExitCombatEvent
EliteMobHealEvent
EliteMobRemoveEvent
EliteMobsItemDetector
ItemStack
is an EliteMobs custom or dynamic item.EliteMobSpawnEvent
EliteMobTargetPlayerEvent
GenericAntiExploitEvent
NPCEntityRemoveEvent
NPCEntitySpawnEvent
PlayerDamagedByEliteMobEvent
EntityDamageEvent
.PlayerPreTeleportEvent
PlayerTeleportEvent
QuestAcceptEvent
QuestCompleteEvent
QuestLeaveEvent
QuestObjectivesCompletedEvent
QuestProgressionEvent
QuestRewardEvent
SuperMobDamageEvent
SuperMobDeathEvent
SuperMobRemoveEvent
SuperMobSpawnEvent
The text was updated successfully, but these errors were encountered: