44 lines
1.6 KiB
Java
44 lines
1.6 KiB
Java
/*
|
|
* Minecraft Forge
|
|
* Copyright (c) 2016-2018.
|
|
*
|
|
* 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 version 2.1
|
|
* of the License.
|
|
*
|
|
* 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 net.minecraftforge.registries;
|
|
|
|
import java.lang.annotation.ElementType;
|
|
import java.lang.annotation.Retention;
|
|
import java.lang.annotation.RetentionPolicy;
|
|
import java.lang.annotation.Target;
|
|
|
|
/**
|
|
* ObjectHolder can be used to automatically populate public static final fields with entries
|
|
* from the registry. These values can then be referred within mod code directly.
|
|
*/
|
|
@Retention(RetentionPolicy.RUNTIME)
|
|
@Target({ElementType.TYPE, ElementType.FIELD})
|
|
public @interface ObjectHolder
|
|
{
|
|
/**
|
|
* If used on a class, this represents a modid only.
|
|
* If used on a field, it represents a name, which can be abbreviated or complete.
|
|
* Abbreviated names derive their modid from an enclosing ObjectHolder at the class level.
|
|
*
|
|
* @return either a modid or a name based on the rules above
|
|
*/
|
|
String value();
|
|
}
|