https://github.com/kneelawk/common-events

Cross-platform Minecraft event library
https://github.com/kneelawk/common-events

Last synced: 25 days ago
JSON representation

Cross-platform Minecraft event library

• Host: GitHub
• URL: https://github.com/kneelawk/common-events
• Owner: Kneelawk
• License: apache-2.0
• Created: 2024-04-10T03:02:28.000Z (9 months ago)
• Default Branch: 0.1.x-1.20.5
• Last Pushed: 2024-05-28T19:49:10.000Z (7 months ago)
• Last Synced: 2024-05-28T21:41:24.443Z (7 months ago)
• Language: Java
• Size: 361 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: changelogs/changelog-v0.1.0+1.20.5.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Common-Events

Cross-platform Minecraft event library

This library is based on [QSL]'s event system, but makes use of class scanning like forge uses, to allow for easy

registration of event listeners.

[QSL]: https://github.com/QuiltMC/quilt-standard-libraries

## How to Register Listeners

Like in Fabric and Quilt's event systems, callback listeners can be registered directly on event objects. However,

callback listeners can also be registered via annotations, ensuring that callbacks are called without having to worry

about manual registration.

* First, create a `common-events.json` file in your mod's root directory with the following content:

    ```json

    {

        "scan": true

    }

    ```

* Then annotate a class within your mod with `@Listener`. This will allow that class to be searched for listening

  methods.

* Finally, annotate a `public static` method with `@Listen(.class)`. The listening method *must*

  have the same signature as the callback interface's single method.

### Class-Loading and Static Initializers

Common-Events will scan all mods at the earliest possible occasion. However, this will not cause class-loading

of `@Listener`-annotated classes. These classes will only be loaded and statically initialized when an event is created

with a callback-interface type that one of the class's methods listens for, unless the classes are loaded by something

else sooner. This allows `@Listener`-annotated classes to safely listen for client-sided events without having to worry

about accidentally getting loaded on dedicated servers.

### Only Scanning Specific Classes

The `scan` field of the `common-events.json` file can instead contain an array of classes to scan for event listeners,

like so:

```json

{

    "scan": [

        "com.kneelawk.example.ExampleListener",

        "com.kneelawk.example.client.ExampleClientListener"

    ]

}

```

Classes referenced here also have the same kind of delayed initialization as classes annotated with `@Listener`.

## Adapters & Kotlin Support

Adapter support, as well as an official Kotlin adapter, are planned. However, I want to focus on getting the java

portion of this library working first.

For the time-being, annotating functions marked with `@Listen` with the `@JvmStatic` annotation works quite well.