From a22db1cbb1eebe1020677bfb4930a4e5ebe3b50e Mon Sep 17 00:00:00 2001 From: Oliver Date: Sun, 23 Nov 2025 19:54:28 +0100 Subject: [PATCH] docs: Add docs about event system in FancyCore --- docs/src/fancycore/api/events.md | 29 +++++++++++++++++++++++ docs/src/fancycore/api/getting-started.md | 1 + 2 files changed, 30 insertions(+) create mode 100644 docs/src/fancycore/api/events.md diff --git a/docs/src/fancycore/api/events.md b/docs/src/fancycore/api/events.md new file mode 100644 index 00000000..63743e12 --- /dev/null +++ b/docs/src/fancycore/api/events.md @@ -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). | diff --git a/docs/src/fancycore/api/getting-started.md b/docs/src/fancycore/api/getting-started.md index 6660f645..5404bc6a 100644 --- a/docs/src/fancycore/api/getting-started.md +++ b/docs/src/fancycore/api/getting-started.md @@ -1,5 +1,6 @@ --- icon: dot +order: 10 --- # Getting started