io.pzstorm.storm.event.ZomboidEvent 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;

/**
 * This class represents game events recognized by Storm. These events are created by installed
 * {@code StormHook}s and included as a method parameter in a callback to {@link StormEventDispatcher}.
 * They are then dispatched to all methods that subscribe to those specific events.
 */
@SuppressWarnings("WeakerAccess")
public interface ZomboidEvent {

	/**
	 * Returns a readable name that identifies this event.
	 */
	String getName();
}