IncomingRpcMethods.java

net.minecraft.server.jsonrpc.IncomingRpcMethods

信息

• 全限定名：net.minecraft.server.jsonrpc.IncomingRpcMethods
• 类型：public class
• 包：net.minecraft.server.jsonrpc
• 源码路径：src/main/java/net/minecraft/server/jsonrpc/IncomingRpcMethods.java
• 起始行号：L15
• 职责：

  TODO

字段/常量

• 无

内部类/嵌套类型

• 无

构造器

• 无

方法

下面的方法块按源码顺序生成。

public static IncomingRpcMethod<?,?> bootstrap(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L16

• 方法名：bootstrap
• 源码定位：L16
• 返回类型：IncomingRpcMethod
• 修饰符：public static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

private static void registerAllowListService(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L32

• 方法名：registerAllowListService
• 源码定位：L32
• 返回类型：void
• 修饰符：private static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

private static void registerBanlistService(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L58

• 方法名：registerBanlistService
• 源码定位：L58
• 返回类型：void
• 修饰符：private static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

private static void registerIpBanlistService(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L84

• 方法名：registerIpBanlistService
• 源码定位：L84
• 返回类型：void
• 修饰符：private static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

private static void registerPlayerService(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L110

• 方法名：registerPlayerService
• 源码定位：L110
• 返回类型：void
• 修饰符：private static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

private static void registerOperatorService(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L122

• 方法名：registerOperatorService
• 源码定位：L122
• 返回类型：void
• 修饰符：private static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

private static void registerServerStateService(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L148

• 方法名：registerServerStateService
• 源码定位：L148
• 返回类型：void
• 修饰符：private static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

private static void registerServerSettingsService(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L169

• 方法名：registerServerSettingsService
• 源码定位：L169
• 返回类型：void
• 修饰符：private static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

private static void registerGameRuleService(Registry<IncomingRpcMethod<?,?>> methodRegistry) @ L352

• 方法名：registerGameRuleService
• 源码定位：L352
• 返回类型：void
• 修饰符：private static

参数:

• methodRegistry: Registry<IncomingRpcMethod>

说明:

TODO

代码

public class IncomingRpcMethods {
    public static IncomingRpcMethod<?, ?> bootstrap(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        registerAllowListService(methodRegistry);
        registerBanlistService(methodRegistry);
        registerIpBanlistService(methodRegistry);
        registerPlayerService(methodRegistry);
        registerOperatorService(methodRegistry);
        registerServerStateService(methodRegistry);
        registerServerSettingsService(methodRegistry);
        registerGameRuleService(methodRegistry);
        return IncomingRpcMethod.<DiscoveryService.DiscoverResponse>method(apiService -> DiscoveryService.discover(Schema.getSchemaRegistry()))
            .undiscoverable()
            .notOnMainThread()
            .response("result", Schema.DISCOVERY_SCHEMA)
            .register(methodRegistry, "rpc.discover");
    }
 
    private static void registerAllowListService(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        IncomingRpcMethod.method(AllowlistService::get)
            .description("Get the allowlist")
            .response("allowlist", Schema.PLAYER_SCHEMA.asArray())
            .register(methodRegistry, "allowlist");
        IncomingRpcMethod.method(AllowlistService::set)
            .description("Set the allowlist")
            .param("players", Schema.PLAYER_SCHEMA.asArray())
            .response("allowlist", Schema.PLAYER_SCHEMA.asArray())
            .register(methodRegistry, "allowlist/set");
        IncomingRpcMethod.method(AllowlistService::add)
            .description("Add players to allowlist")
            .param("add", Schema.PLAYER_SCHEMA.asArray())
            .response("allowlist", Schema.PLAYER_SCHEMA.asArray())
            .register(methodRegistry, "allowlist/add");
        IncomingRpcMethod.method(AllowlistService::remove)
            .description("Remove players from allowlist")
            .param("remove", Schema.PLAYER_SCHEMA.asArray())
            .response("allowlist", Schema.PLAYER_SCHEMA.asArray())
            .register(methodRegistry, "allowlist/remove");
        IncomingRpcMethod.method(AllowlistService::clear)
            .description("Clear all players in allowlist")
            .response("allowlist", Schema.PLAYER_SCHEMA.asArray())
            .register(methodRegistry, "allowlist/clear");
    }
 
    private static void registerBanlistService(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        IncomingRpcMethod.method(BanlistService::get)
            .description("Get the ban list")
            .response("banlist", Schema.PLAYER_BAN_SCHEMA.asArray())
            .register(methodRegistry, "bans");
        IncomingRpcMethod.method(BanlistService::set)
            .description("Set the banlist")
            .param("bans", Schema.PLAYER_BAN_SCHEMA.asArray())
            .response("banlist", Schema.PLAYER_BAN_SCHEMA.asArray())
            .register(methodRegistry, "bans/set");
        IncomingRpcMethod.method(BanlistService::add)
            .description("Add players to ban list")
            .param("add", Schema.PLAYER_BAN_SCHEMA.asArray())
            .response("banlist", Schema.PLAYER_BAN_SCHEMA.asArray())
            .register(methodRegistry, "bans/add");
        IncomingRpcMethod.method(BanlistService::remove)
            .description("Remove players from ban list")
            .param("remove", Schema.PLAYER_SCHEMA.asArray())
            .response("banlist", Schema.PLAYER_BAN_SCHEMA.asArray())
            .register(methodRegistry, "bans/remove");
        IncomingRpcMethod.method(BanlistService::clear)
            .description("Clear all players in ban list")
            .response("banlist", Schema.PLAYER_BAN_SCHEMA.asArray())
            .register(methodRegistry, "bans/clear");
    }
 
    private static void registerIpBanlistService(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        IncomingRpcMethod.method(IpBanlistService::get)
            .description("Get the ip ban list")
            .response("banlist", Schema.IP_BAN_SCHEMA.asArray())
            .register(methodRegistry, "ip_bans");
        IncomingRpcMethod.method(IpBanlistService::set)
            .description("Set the ip banlist")
            .param("banlist", Schema.IP_BAN_SCHEMA.asArray())
            .response("banlist", Schema.IP_BAN_SCHEMA.asArray())
            .register(methodRegistry, "ip_bans/set");
        IncomingRpcMethod.method(IpBanlistService::add)
            .description("Add ip to ban list")
            .param("add", Schema.INCOMING_IP_BAN_SCHEMA.asArray())
            .response("banlist", Schema.IP_BAN_SCHEMA.asArray())
            .register(methodRegistry, "ip_bans/add");
        IncomingRpcMethod.method(IpBanlistService::remove)
            .description("Remove ip from ban list")
            .param("ip", Schema.STRING_SCHEMA.asArray())
            .response("banlist", Schema.IP_BAN_SCHEMA.asArray())
            .register(methodRegistry, "ip_bans/remove");
        IncomingRpcMethod.method(IpBanlistService::clear)
            .description("Clear all ips in ban list")
            .response("banlist", Schema.IP_BAN_SCHEMA.asArray())
            .register(methodRegistry, "ip_bans/clear");
    }
 
    private static void registerPlayerService(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        IncomingRpcMethod.method(PlayerService::get)
            .description("Get all connected players")
            .response("players", Schema.PLAYER_SCHEMA.asArray())
            .register(methodRegistry, "players");
        IncomingRpcMethod.method(PlayerService::kick)
            .description("Kick players")
            .param("kick", Schema.KICK_PLAYER_SCHEMA.asArray())
            .response("kicked", Schema.PLAYER_SCHEMA.asArray())
            .register(methodRegistry, "players/kick");
    }
 
    private static void registerOperatorService(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        IncomingRpcMethod.method(OperatorService::get)
            .description("Get all oped players")
            .response("operators", Schema.OPERATOR_SCHEMA.asArray())
            .register(methodRegistry, "operators");
        IncomingRpcMethod.method(OperatorService::set)
            .description("Set all oped players")
            .param("operators", Schema.OPERATOR_SCHEMA.asArray())
            .response("operators", Schema.OPERATOR_SCHEMA.asArray())
            .register(methodRegistry, "operators/set");
        IncomingRpcMethod.method(OperatorService::add)
            .description("Op players")
            .param("add", Schema.OPERATOR_SCHEMA.asArray())
            .response("operators", Schema.OPERATOR_SCHEMA.asArray())
            .register(methodRegistry, "operators/add");
        IncomingRpcMethod.method(OperatorService::remove)
            .description("Deop players")
            .param("remove", Schema.PLAYER_SCHEMA.asArray())
            .response("operators", Schema.OPERATOR_SCHEMA.asArray())
            .register(methodRegistry, "operators/remove");
        IncomingRpcMethod.method(OperatorService::clear)
            .description("Deop all players")
            .response("operators", Schema.OPERATOR_SCHEMA.asArray())
            .register(methodRegistry, "operators/clear");
    }
 
    private static void registerServerStateService(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        IncomingRpcMethod.method(ServerStateService::status)
            .description("Get server status")
            .response("status", Schema.SERVER_STATE_SCHEMA.asRef())
            .register(methodRegistry, "server/status");
        IncomingRpcMethod.method(ServerStateService::save)
            .description("Save server state")
            .param("flush", Schema.BOOL_SCHEMA)
            .response("saving", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "server/save");
        IncomingRpcMethod.method(ServerStateService::stop)
            .description("Stop server")
            .response("stopping", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "server/stop");
        IncomingRpcMethod.method(ServerStateService::systemMessage)
            .description("Send a system message")
            .param("message", Schema.SYSTEM_MESSAGE_SCHEMA.asRef())
            .response("sent", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "server/system_message");
    }
 
    private static void registerServerSettingsService(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        IncomingRpcMethod.method(ServerSettingsService::autosave)
            .description("Get whether automatic world saving is enabled on the server")
            .response("enabled", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/autosave");
        IncomingRpcMethod.method(ServerSettingsService::setAutosave)
            .description("Enable or disable automatic world saving on the server")
            .param("enable", Schema.BOOL_SCHEMA)
            .response("enabled", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/autosave/set");
        IncomingRpcMethod.method(ServerSettingsService::difficulty)
            .description("Get the current difficulty level of the server")
            .response("difficulty", Schema.DIFFICULTY_SCHEMA.asRef())
            .register(methodRegistry, "serversettings/difficulty");
        IncomingRpcMethod.method(ServerSettingsService::setDifficulty)
            .description("Set the difficulty level of the server")
            .param("difficulty", Schema.DIFFICULTY_SCHEMA.asRef())
            .response("difficulty", Schema.DIFFICULTY_SCHEMA.asRef())
            .register(methodRegistry, "serversettings/difficulty/set");
        IncomingRpcMethod.method(ServerSettingsService::enforceAllowlist)
            .description("Get whether allowlist enforcement is enabled (kicks players immediately when removed from allowlist)")
            .response("enforced", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/enforce_allowlist");
        IncomingRpcMethod.method(ServerSettingsService::setEnforceAllowlist)
            .description("Enable or disable allowlist enforcement (when enabled, players are kicked immediately upon removal from allowlist)")
            .param("enforce", Schema.BOOL_SCHEMA)
            .response("enforced", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/enforce_allowlist/set");
        IncomingRpcMethod.method(ServerSettingsService::usingAllowlist)
            .description("Get whether the allowlist is enabled on the server")
            .response("used", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/use_allowlist");
        IncomingRpcMethod.method(ServerSettingsService::setUsingAllowlist)
            .description("Enable or disable the allowlist on the server (controls whether only allowlisted players can join)")
            .param("use", Schema.BOOL_SCHEMA)
            .response("used", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/use_allowlist/set");
        IncomingRpcMethod.method(ServerSettingsService::maxPlayers)
            .description("Get the maximum number of players allowed to connect to the server")
            .response("max", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/max_players");
        IncomingRpcMethod.method(ServerSettingsService::setMaxPlayers)
            .description("Set the maximum number of players allowed to connect to the server")
            .param("max", Schema.INT_SCHEMA)
            .response("max", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/max_players/set");
        IncomingRpcMethod.method(ServerSettingsService::pauseWhenEmpty)
            .description("Get the number of seconds before the game is automatically paused when no players are online")
            .response("seconds", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/pause_when_empty_seconds");
        IncomingRpcMethod.method(ServerSettingsService::setPauseWhenEmpty)
            .description("Set the number of seconds before the game is automatically paused when no players are online")
            .param("seconds", Schema.INT_SCHEMA)
            .response("seconds", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/pause_when_empty_seconds/set");
        IncomingRpcMethod.method(ServerSettingsService::playerIdleTimeout)
            .description("Get the number of seconds before idle players are automatically kicked from the server")
            .response("seconds", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/player_idle_timeout");
        IncomingRpcMethod.method(ServerSettingsService::setPlayerIdleTimeout)
            .description("Set the number of seconds before idle players are automatically kicked from the server")
            .param("seconds", Schema.INT_SCHEMA)
            .response("seconds", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/player_idle_timeout/set");
        IncomingRpcMethod.method(ServerSettingsService::allowFlight)
            .description("Get whether flight is allowed for players in Survival mode")
            .response("allowed", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/allow_flight");
        IncomingRpcMethod.method(ServerSettingsService::setAllowFlight)
            .description("Allow or disallow flight for players in Survival mode")
            .param("allow", Schema.BOOL_SCHEMA)
            .response("allowed", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/allow_flight/set");
        IncomingRpcMethod.method(ServerSettingsService::motd)
            .description("Get the server's message of the day displayed to players")
            .response("message", Schema.STRING_SCHEMA)
            .register(methodRegistry, "serversettings/motd");
        IncomingRpcMethod.method(ServerSettingsService::setMotd)
            .description("Set the server's message of the day displayed to players")
            .param("message", Schema.STRING_SCHEMA)
            .response("message", Schema.STRING_SCHEMA)
            .register(methodRegistry, "serversettings/motd/set");
        IncomingRpcMethod.method(ServerSettingsService::spawnProtection)
            .description("Get the spawn protection radius in blocks (only operators can edit within this area)")
            .response("radius", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/spawn_protection_radius");
        IncomingRpcMethod.method(ServerSettingsService::setSpawnProtection)
            .description("Set the spawn protection radius in blocks (only operators can edit within this area)")
            .param("radius", Schema.INT_SCHEMA)
            .response("radius", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/spawn_protection_radius/set");
        IncomingRpcMethod.method(ServerSettingsService::forceGameMode)
            .description("Get whether players are forced to use the server's default game mode")
            .response("forced", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/force_game_mode");
        IncomingRpcMethod.method(ServerSettingsService::setForceGameMode)
            .description("Enable or disable forcing players to use the server's default game mode")
            .param("force", Schema.BOOL_SCHEMA)
            .response("forced", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/force_game_mode/set");
        IncomingRpcMethod.method(ServerSettingsService::gameMode)
            .description("Get the server's default game mode")
            .response("mode", Schema.GAME_TYPE_SCHEMA.asRef())
            .register(methodRegistry, "serversettings/game_mode");
        IncomingRpcMethod.method(ServerSettingsService::setGameMode)
            .description("Set the server's default game mode")
            .param("mode", Schema.GAME_TYPE_SCHEMA.asRef())
            .response("mode", Schema.GAME_TYPE_SCHEMA.asRef())
            .register(methodRegistry, "serversettings/game_mode/set");
        IncomingRpcMethod.method(ServerSettingsService::viewDistance)
            .description("Get the server's view distance in chunks")
            .response("distance", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/view_distance");
        IncomingRpcMethod.method(ServerSettingsService::setViewDistance)
            .description("Set the server's view distance in chunks")
            .param("distance", Schema.INT_SCHEMA)
            .response("distance", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/view_distance/set");
        IncomingRpcMethod.method(ServerSettingsService::simulationDistance)
            .description("Get the server's simulation distance in chunks")
            .response("distance", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/simulation_distance");
        IncomingRpcMethod.method(ServerSettingsService::setSimulationDistance)
            .description("Set the server's simulation distance in chunks")
            .param("distance", Schema.INT_SCHEMA)
            .response("distance", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/simulation_distance/set");
        IncomingRpcMethod.method(ServerSettingsService::acceptTransfers)
            .description("Get whether the server accepts player transfers from other servers")
            .response("accepted", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/accept_transfers");
        IncomingRpcMethod.method(ServerSettingsService::setAcceptTransfers)
            .description("Enable or disable accepting player transfers from other servers")
            .param("accept", Schema.BOOL_SCHEMA)
            .response("accepted", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/accept_transfers/set");
        IncomingRpcMethod.method(ServerSettingsService::statusHeartbeatInterval)
            .description("Get the interval in seconds between server status heartbeats")
            .response("seconds", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/status_heartbeat_interval");
        IncomingRpcMethod.method(ServerSettingsService::setStatusHeartbeatInterval)
            .description("Set the interval in seconds between server status heartbeats")
            .param("seconds", Schema.INT_SCHEMA)
            .response("seconds", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/status_heartbeat_interval/set");
        IncomingRpcMethod.method(ServerSettingsService::operatorUserPermissionLevel)
            .description("Get default operator permission level")
            .response("level", Schema.PERMISSION_LEVEL_SCHEMA)
            .register(methodRegistry, "serversettings/operator_user_permission_level");
        IncomingRpcMethod.method(ServerSettingsService::setOperatorUserPermissionLevel)
            .description("Set default operator permission level")
            .param("level", Schema.PERMISSION_LEVEL_SCHEMA)
            .response("level", Schema.PERMISSION_LEVEL_SCHEMA)
            .register(methodRegistry, "serversettings/operator_user_permission_level/set");
        IncomingRpcMethod.method(ServerSettingsService::hidesOnlinePlayers)
            .description("Get whether the server hides online player information from status queries")
            .response("hidden", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/hide_online_players");
        IncomingRpcMethod.method(ServerSettingsService::setHidesOnlinePlayers)
            .description("Enable or disable hiding online player information from status queries")
            .param("hide", Schema.BOOL_SCHEMA)
            .response("hidden", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/hide_online_players/set");
        IncomingRpcMethod.method(ServerSettingsService::repliesToStatus)
            .description("Get whether the server responds to connection status requests")
            .response("enabled", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/status_replies");
        IncomingRpcMethod.method(ServerSettingsService::setRepliesToStatus)
            .description("Enable or disable the server responding to connection status requests")
            .param("enable", Schema.BOOL_SCHEMA)
            .response("enabled", Schema.BOOL_SCHEMA)
            .register(methodRegistry, "serversettings/status_replies/set");
        IncomingRpcMethod.method(ServerSettingsService::entityBroadcastRangePercentage)
            .description("Get the entity broadcast range as a percentage")
            .response("percentage_points", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/entity_broadcast_range");
        IncomingRpcMethod.method(ServerSettingsService::setEntityBroadcastRangePercentage)
            .description("Set the entity broadcast range as a percentage")
            .param("percentage_points", Schema.INT_SCHEMA)
            .response("percentage_points", Schema.INT_SCHEMA)
            .register(methodRegistry, "serversettings/entity_broadcast_range/set");
    }
 
    private static void registerGameRuleService(Registry<IncomingRpcMethod<?, ?>> methodRegistry) {
        IncomingRpcMethod.method(GameRulesService::get)
            .description("Get the available game rule keys and their current values")
            .response("gamerules", Schema.TYPED_GAME_RULE_SCHEMA.asRef().asArray())
            .register(methodRegistry, "gamerules");
        IncomingRpcMethod.<GameRulesService.GameRuleUpdate<?>,GameRulesService.GameRuleUpdate<?>>method(GameRulesService::update)
            .description("Update game rule value")
            .param("gamerule", Schema.UNTYPED_GAME_RULE_SCHEMA.asRef())
            .response("gamerule", Schema.TYPED_GAME_RULE_SCHEMA.asRef())
            .register(methodRegistry, "gamerules/update");
    }
}

引用的其他类

• Registry

  • 引用位置: 参数

• IncomingRpcMethod

  • 引用位置: 参数/方法调用/返回值
  • 关联成员: IncomingRpcMethod.method()

• Schema

  • 引用位置: 方法调用
  • 关联成员: Schema.getSchemaRegistry()

• DiscoveryService

  • 引用位置: 方法调用
  • 关联成员: DiscoveryService.discover()