mirror of https://github.com/GeyserMC/Geyser.git
76 lines
3.4 KiB
Java
76 lines
3.4 KiB
Java
/*
|
|
* Copyright (c) 2019-2022 GeyserMC. http://geysermc.org
|
|
*
|
|
* Permission is hereby granted, free of charge, to any person obtaining a copy
|
|
* of this software and associated documentation files (the "Software"), to deal
|
|
* in the Software without restriction, including without limitation the rights
|
|
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
|
|
* copies of the Software, and to permit persons to whom the Software is
|
|
* furnished to do so, subject to the following conditions:
|
|
*
|
|
* The above copyright notice and this permission notice shall be included in
|
|
* all copies or substantial portions of the Software.
|
|
*
|
|
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
|
|
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
|
|
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
|
|
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
|
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
|
|
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
|
|
* THE SOFTWARE.
|
|
*
|
|
* @author GeyserMC
|
|
* @link https://github.com/GeyserMC/Geyser
|
|
*/
|
|
|
|
package org.geysermc.geyser.api.event.lifecycle;
|
|
|
|
import org.checkerframework.checker.nullness.qual.NonNull;
|
|
import org.geysermc.geyser.api.block.custom.CustomBlockData;
|
|
import org.geysermc.geyser.api.block.custom.CustomBlockState;
|
|
import org.geysermc.geyser.api.block.custom.nonvanilla.JavaBlockState;
|
|
import org.geysermc.event.Event;
|
|
|
|
/**
|
|
* Called on Geyser's startup when looking for custom blocks. Custom blocks must be registered through this event.
|
|
* <p>
|
|
* This event will not be called if the "add-non-bedrock-items" setting is disabled in the Geyser config.
|
|
*/
|
|
public abstract class GeyserDefineCustomBlocksEvent implements Event {
|
|
/**
|
|
* Registers the given {@link CustomBlockData} as a custom block
|
|
*
|
|
* @param customBlockData the custom block to register
|
|
*/
|
|
public abstract void register(@NonNull CustomBlockData customBlockData);
|
|
|
|
/**
|
|
* Registers the given {@link CustomBlockState} as an override for the
|
|
* given java state identifier
|
|
* Java state identifiers are listed
|
|
* <a href="https://raw.githubusercontent.com/GeyserMC/mappings/master/blocks.json">here</a>
|
|
*
|
|
* @param javaIdentifier the java state identifier to override
|
|
* @param customBlockState the custom block state with which to override java state identifier
|
|
*/
|
|
public abstract void registerOverride(@NonNull String javaIdentifier, @NonNull CustomBlockState customBlockState);
|
|
|
|
/**
|
|
* Registers the given {@link CustomBlockData} as an override for the
|
|
* given java item identifier
|
|
*
|
|
* @param javaIdentifier the java item identifier to override
|
|
* @param customBlockData the custom block data with which to override java item identifier
|
|
*/
|
|
public abstract void registerItemOverride(@NonNull String javaIdentifier, @NonNull CustomBlockData customBlockData);
|
|
|
|
/**
|
|
* Registers the given {@link CustomBlockState} as an override for the
|
|
* given {@link JavaBlockState}
|
|
*
|
|
* @param javaBlockState the java block state for the non-vanilla block
|
|
* @param customBlockState the custom block state with which to override java state identifier
|
|
*/
|
|
public abstract void registerOverride(@NonNull JavaBlockState javaBlockState, @NonNull CustomBlockState customBlockState);
|
|
}
|