57 lines
1.8 KiB
Java
57 lines
1.8 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 net.minecraft.util.ResourceLocation;
|
|
|
|
|
|
/**
|
|
* A registry delegate for holding references to items or blocks
|
|
* These should be safe to use in things like lists though aliased items and blocks will not
|
|
* have object identity with respect to their delegate.
|
|
*
|
|
* @author cpw
|
|
*
|
|
* @param <T> the type of thing we're holding onto
|
|
*/
|
|
public interface IRegistryDelegate<T> {
|
|
/**
|
|
* Get the referent pointed at by this delegate. This will be the currently active item or block, and will change
|
|
* as world saves come and go. Note that item.delegate.get() may NOT be the same object as item, due to item and
|
|
* block substitution.
|
|
*
|
|
* @return The referred object
|
|
*/
|
|
T get();
|
|
|
|
/**
|
|
* Get the unique resource location for this delegate. Completely static after registration has completed, and
|
|
* will never change.
|
|
* @return The name
|
|
*/
|
|
ResourceLocation name();
|
|
|
|
/**
|
|
* Get the delegate type. It will be dependent on the registry this delegate is sourced from.
|
|
* @return The type of delegate
|
|
*/
|
|
Class<T> type();
|
|
}
|