mirror of
https://github.com/MinecraftForge/MinecraftForge.git
synced 2026-11-19 11:59:25 +00:00
182 lines
5.3 KiB
Java
182 lines
5.3 KiB
Java
/*
|
|
* The FML Forge Mod Loader suite.
|
|
* Copyright (C) 2012 cpw
|
|
*
|
|
* This library is free software; you can redistribute it and/or modify it under the terms of the GNU Lesser General Public License as published by the Free
|
|
* Software Foundation; either version 2.1 of the License, or any later version.
|
|
*
|
|
* This library 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 Lesser General Public License for more details.
|
|
*
|
|
* You should have received a copy of the GNU Lesser General Public License along with this library; if not, write to the Free Software Foundation, Inc., 51
|
|
* Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
|
|
*/
|
|
package cpw.mods.fml.common;
|
|
|
|
import java.lang.annotation.ElementType;
|
|
import java.lang.annotation.Retention;
|
|
import java.lang.annotation.RetentionPolicy;
|
|
import java.lang.annotation.Target;
|
|
|
|
import cpw.mods.fml.common.event.FMLInitializationEvent;
|
|
import cpw.mods.fml.common.event.FMLPostInitializationEvent;
|
|
import cpw.mods.fml.common.event.FMLPreInitializationEvent;
|
|
import cpw.mods.fml.common.event.FMLServerStartedEvent;
|
|
import cpw.mods.fml.common.event.FMLServerStartingEvent;
|
|
import cpw.mods.fml.common.event.FMLServerStoppingEvent;
|
|
|
|
import net.minecraft.src.ItemBlock;
|
|
|
|
/**
|
|
* The new mod style in FML 1.3
|
|
*
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.TYPE)
|
|
public @interface Mod
|
|
{
|
|
/**
|
|
* The unique mod identifier for this mod
|
|
* @return
|
|
*/
|
|
String modid();
|
|
/**
|
|
* A user friendly name for the mod
|
|
* @return
|
|
*/
|
|
String name() default "";
|
|
/**
|
|
* A version string for this mod
|
|
* @return
|
|
*/
|
|
String version() default "";
|
|
/**
|
|
* A simple dependency string for this mod (see modloader's "priorities" string specification)
|
|
* @return
|
|
*/
|
|
String dependencies() default "";
|
|
/**
|
|
* Whether to use the mcmod.info metadata by default for this mod.
|
|
* If true, settings in the mcmod.info file will override settings in these annotations.
|
|
* @return
|
|
*/
|
|
boolean useMetadata() default false;
|
|
|
|
/**
|
|
* Mark the designated method as being called at the "pre-initialization" phase
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.METHOD)
|
|
public @interface PreInit {
|
|
static Class<?>[] paramTypes = new Class[] { FMLPreInitializationEvent.class };
|
|
}
|
|
/**
|
|
* Mark the designated method as being called at the "initialization" phase
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.METHOD)
|
|
public @interface Init {
|
|
static Class<?>[] paramTypes = new Class[] { FMLInitializationEvent.class };
|
|
}
|
|
/**
|
|
* Mark the designated method as being called at the "post-initialization" phase
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.METHOD)
|
|
public @interface PostInit {
|
|
static Class<?>[] paramTypes = new Class[] { FMLPostInitializationEvent.class };
|
|
}
|
|
/**
|
|
* Mark the designated method as being called at the "server-starting" phase
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.METHOD)
|
|
public @interface ServerStarting {
|
|
static Class<?>[] paramTypes = new Class[] { FMLServerStartingEvent.class };
|
|
}
|
|
/**
|
|
* Mark the designated method as being called at the "post-initialization" phase
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.METHOD)
|
|
public @interface ServerStarted {
|
|
static Class<?>[] paramTypes = new Class[] { FMLServerStartedEvent.class };
|
|
}
|
|
/**
|
|
* Mark the designated method as being called at the "post-initialization" phase
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.METHOD)
|
|
public @interface ServerStopping {
|
|
static Class<?>[] paramTypes = new Class[] { FMLServerStoppingEvent.class };
|
|
}
|
|
/**
|
|
* Populate the annotated field with the mod instance.
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.FIELD)
|
|
public @interface Instance {}
|
|
/**
|
|
* Populate the annotated field with the mod's metadata.
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.FIELD)
|
|
public @interface Metadata {}
|
|
/**
|
|
* Populate the annotated field with an instance of the Block as specified
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.FIELD)
|
|
public @interface Block {
|
|
/**
|
|
* The block's name
|
|
* @return
|
|
*/
|
|
String name();
|
|
/**
|
|
* The associated ItemBlock subtype for the item (can be null for an ItemBlock)
|
|
* @return
|
|
*/
|
|
Class<?> itemTypeClass() default ItemBlock.class;
|
|
}
|
|
/**
|
|
* Populate the annotated field with an Item
|
|
* @author cpw
|
|
*
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target(ElementType.FIELD)
|
|
public @interface Item {
|
|
/**
|
|
* The name of the item
|
|
* @return
|
|
*/
|
|
String name();
|
|
/**
|
|
* The type of the item
|
|
* @return
|
|
*/
|
|
String typeClass();
|
|
}
|
|
}
|