io.pzstorm.storm.event.SubscribeEvent Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of storm-api Show documentation

Project Zomboid Storm API

There is a newer version: 0.2.1

/*
 * Zomboid Storm - Java modding toolchain for Project Zomboid
 * Copyright (C) 2021 Matthew Cain
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program. If not, see .
 */

package io.pzstorm.storm.event;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * This annotation is used to subscribe methods to {@link ZomboidEvent} types. Methods are registered
 * in bulk via event handler classes. To register an event handler call an appropriate class in
 * {@link StormEventDispatcher}. Once the event handler has been registered all methods belonging to
 * the event handler annotated with {@link SubscribeEvent} will be subscribed to events they specify
 * as method parameters. Read more about this process in {@link StormEventDispatcher} class documentation.
 */
@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
@SuppressWarnings("WeakerAccess")
public @interface SubscribeEvent {

}