cn.nukkit.block.customblock.CustomBlock Maven / Gradle / Ivy
package cn.nukkit.block.customblock;
import cn.nukkit.block.Block;
import cn.nukkit.block.BlockFallableMeta;
import cn.nukkit.block.BlockMeta;
import cn.nukkit.item.Item;
import java.util.Locale;
/**
* 继承这个类实现自定义方块,重写{@link Block}中的方法控制方块属性
*
* Inherit this class to implement a custom block, override the methods in the {@link Block} to control the feature of the block.
*/
public interface CustomBlock {
/**
* 覆写该方法设置自定义方块的摩擦因数
*
* {@code @Override} this method to set the friction factor of the custom block
*/
double getFrictionFactor();
/**
* 覆写该方法设置自定义方块的爆炸抗性
*
* {@code @Override} this method to set the Explosive resistance of the custom block
*/
double getResistance();
/**
* 覆写该方法设置自定义方块的吸收光的等级
*
* {@code @Override} this method to set the level of light absorption of the custom block
*/
int getLightFilter();
/**
* 覆写该方法设置自定义方块的发出光的等级
*
* {@code @Override} this method to set the level of light emitted by the custom block
*/
int getLightLevel();
/**
* 覆写该方法设置自定义方块的被挖掘所需要的时间(单位秒)
*
* {@code @Override} this method to set the amount of time (in seconds) it takes for a custom block to be dug
*/
double calculateBreakTime();
/**
* 覆写该方法设置自定义方块的命名空间ID
*
* {@code @Override} this method to set the namespace ID of the custom block
*/
String getNamespaceId();
/**
* 一般不需要被覆写,继承父类会提供
*
* Generally, it does not need to be {@code @Override}, extend from the parent class will provide
*/
Item toItem();
/**
* 该方法设置自定义方块的定义
*
* This method sets the definition of custom block
*/
CustomBlockDefinition getDefinition();
/* 下面两个方法需要被手动覆写,请使用接口的定义 */
/**
* 该方法必须被覆写为使用接口的定义，请使用
*
* The method must be {@code @Override} to use the definition of the interface, please use the
*
* {@code @Override}
{@code public int getId() {
* return CustomBlock.super.getId();
* } }
*/
default int getId() {
return Block.CUSTOM_BLOCK_ID_MAP.get(getNamespaceId().toLowerCase(Locale.ENGLISH));
}
/**
* 该方法必须被覆写为使用接口的定义，请使用
*
* The method must be {@code @Override} to use the definition of the interface, please use the
*
* {@code @Override}
{@code public String getName() {
* return CustomBlock.super.getName();
* } }
*/
default String getName() {
return this.getNamespaceId().split(":")[1].toLowerCase(Locale.ENGLISH);
}
/**
* Plugins do not need {@code @Override}
*
* @return the block
*/
default Block toCustomBlock() {
return ((Block) this).clone();
}
/**
* Plugins do not need {@code @Override}
*
* @return the block
*/
default Block toCustomBlock(int meta) {
var block = toCustomBlock();
if (block instanceof BlockMeta || block instanceof BlockFallableMeta) {
block.getMutableState().setDataStorageFromInt(meta, true);
}
return block;
}
/**
* @return 是否反转自定义方块属性解析的顺序
Whether to reverse the order of properties parsing
*/
default boolean reverseSending() {
return true;
}
}