com.germ.germplugin.api

Class GermKeyAPI

java.lang.Object

com.germ.germplugin.api.GermKeyAPI

public class GermKeyAPI
extends java.lang.Object

萌芽按键API

提供按键注册、取消注册和按键绑定管理功能

注册按键后，服务器才能监听到相应的按键事件

Since:

2020/7/1

Constructor Summary

Constructors

Constructor and Description
GermKeyAPI()

Method Summary

Modifier and Type	Method and Description
static java.util.Map<java.lang.String,KeyBinding>	getRegisteredKeyBinding() 获取所有已注册的按键绑定
static java.util.Set<KeyType>	getRegisteredKeys() 获得被注册的按键列表
static void	registerKey(int keyId) Deprecated. 请使用 registerKey(KeyType) 方法
static void	registerKey(KeyType keyType) 注册按键 不注册服务器不会监听到事件
static void	registerKeyBinding(KeyBinding keyBinding) 注册按键绑定 将按键绑定信息发送给所有在线玩家
static void	sendRegisteredKeysToAllPlayer() 给全体玩家发送所有被注册的按键和按键绑定 通常在玩家加入服务器或重载配置时调用
static void	unregisterKey(int keyId) Deprecated. 请使用 unregisterKey(KeyType) 方法
static void	unregisterKey(KeyType keyType) 取消按键注册
static void	unregisterKeyBinding(KeyBinding keyBinding) 取消注册按键绑定
static void	unregisterKeyBinding(java.lang.String index) 通过索引取消注册按键绑定

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GermKeyAPI

public GermKeyAPI()

Method Detail

registerKey

@Deprecated
public static void registerKey(int keyId)

Deprecated. 请使用 registerKey(KeyType) 方法

注册按键（已弃用）
不注册服务器不会监听到事件

Parameters:

keyId - 按键的ID

registerKey

public static void registerKey(KeyType keyType)

注册按键
不注册服务器不会监听到事件

Parameters:

keyType - 按键类型

registerKeyBinding

public static void registerKeyBinding(KeyBinding keyBinding)

注册按键绑定

将按键绑定信息发送给所有在线玩家

Parameters:

keyBinding - 按键绑定对象

unregisterKeyBinding

public static void unregisterKeyBinding(KeyBinding keyBinding)

取消注册按键绑定

Parameters:

keyBinding - 要取消注册的按键绑定对象

unregisterKeyBinding

public static void unregisterKeyBinding(java.lang.String index)

通过索引取消注册按键绑定

Parameters:

index - 按键绑定索引

getRegisteredKeyBinding

public static java.util.Map<java.lang.String,KeyBinding> getRegisteredKeyBinding()

获取所有已注册的按键绑定

Returns:

已注册的按键绑定映射表

unregisterKey

@Deprecated
public static void unregisterKey(int keyId)

Deprecated. 请使用 unregisterKey(KeyType) 方法

取消按键注册（已弃用）

Parameters:

keyId - 按键ID

unregisterKey

public static void unregisterKey(KeyType keyType)

取消按键注册

Parameters:

keyType - 按键类型

getRegisteredKeys

public static java.util.Set<KeyType> getRegisteredKeys()

获得被注册的按键列表

Returns:

已注册的按键类型集合

sendRegisteredKeysToAllPlayer

public static void sendRegisteredKeysToAllPlayer()

给全体玩家发送所有被注册的按键和按键绑定

通常在玩家加入服务器或重载配置时调用