docs: Add docs about event system in FancyCore

This commit is contained in:
Oliver
2025-11-23 19:54:28 +01:00
committed by Oliver
parent 18518f9c19
commit a22db1cbb1
2 changed files with 30 additions and 0 deletions

View File

@@ -0,0 +1,29 @@
---
icon: dot
order: 9
---
# Events
FancyCore has its own event system that allows you to listen to various events that happen in the FancyCore system.
## Registering an event listener
Example for registering a listener for the `PlayerReportedEvent`:
```java
EventService eventService = FancyCore.get().getEventService();
eventService.registerListener(PlayerReportedEvent.class, (event) -> {
System.out.println("PlayerReportedEvent fired with report id: " + event.getReport().id());
});
```
## Available events
### Player events
| Event | Description |
|-----------------------|-------------------------------------------------------------------------------|
| `PlayerModifiedEvent` | Event fired when a player's data is modified (through FancyPlayer's setters). |
| `PlayerReportedEvent` | Fired when a player is reported. |
| `PlayerPunishedEvent` | Fired when a player receives a punishment (warning, kick, mute or ban). |

View File

@@ -1,5 +1,6 @@
--- ---
icon: dot icon: dot
order: 10
--- ---
# Getting started # Getting started