mirrors/yarn
mirrors
/
yarn
mirror of https://github.com/FabricMC/yarn.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Some server javadoc (#2169) 

* Some server javadoc

* Update mappings/net/minecraft/server/MinecraftServer.mapping

Co-authored-by: enbrain <69905075+enbrain@users.noreply.github.com>

* Apply suggestions from code review

Co-authored-by: enbrain <69905075+enbrain@users.noreply.github.com>

Co-authored-by: enbrain <69905075+enbrain@users.noreply.github.com>
This commit is contained in:
i509VCB 2021-03-26 07:54:19 -05:00 committed by GitHub
parent 54332c40e1
commit 783ee457f8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 25 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
mappings/net/minecraft/server/MinecraftServer.mapping
View File

@ -1,4 +1,20 @@
CLASS net/minecraft/server/MinecraftServer
COMMENT Represents a logical Minecraft server.
COMMENT
COMMENT <p>Since Minecraft uses a Client-Server architecture for the game, the server processes all logical game functions.
COMMENT A few of the actions a Minecraft server will handle includes processing player actions, handling damage to entities, advancing the world time and executing commands.
COMMENT
COMMENT <p>There are two primary implementations for a Minecraft server: a dedicated and an integrated server.
COMMENT
COMMENT <p>A dedicated server is a Minecraft server not attached to a Minecraft game client and may be run remotely from any connected players.
COMMENT A dedicated server has a few exclusive features such as a whitelist/blacklist, remote rcon connections, and a terminal to input commands.
COMMENT
COMMENT <p>An integrated server is functionally equivalent to a dedicated server except that is hosted by a Minecraft game client and is typically used in a single player world.
COMMENT An integrated server differs from a dedicated server by allowing connections within the local area network (LAN) and the host client.
COMMENT Generally, you will always want to treat connection to an integrated server like you would to a dedicated server since the concept of an integrated server is an implementation detail in Minecraft.
COMMENT
COMMENT @see net.minecraft.server.dedicated.MinecraftDedicatedServer
COMMENT @see net.minecraft.server.integrated.IntegratedServer
FIELD field_16205 metricsData Lnet/minecraft/class_3517;
FIELD field_16257 serverThread Ljava/lang/Thread;
FIELD field_16258 profiler Lnet/minecraft/class_3695;
@ -266,14 +282,23 @@ CLASS net/minecraft/server/MinecraftServer
METHOD method_3815 setPvpEnabled (Z)V
ARG 1 pvpEnabled
METHOD method_3816 isDedicated ()Z
COMMENT Checks whether this server is a dedicated server.
COMMENT
COMMENT <p>A dedicated server refers to a Minecraft server implementation which is detached from a parent Minecraft client process.
COMMENT A dedicated Minecraft server only accepts remote connections.
METHOD method_3818 getServerMotd ()Ljava/lang/String;
METHOD method_3819 getServerIp ()Ljava/lang/String;
METHOD method_3820 isLoading ()Z
METHOD method_3821 exit ()V
METHOD method_3823 setupServer ()Z
COMMENT Setups a Minecraft server to be ready for players to connect.
COMMENT This method does several things including loading server properties and loading worlds.
COMMENT
COMMENT @return true if the Minecraft server was successfully setup, false if the server failed to be setup.
METHOD method_3826 getServerStartTime ()J
METHOD method_3827 getVersion ()Ljava/lang/String;
METHOD method_3828 isOnlineMode ()Z
COMMENT Checks whether this Minecraft server should require all connected players are using a licensed Minecraft account when connecting to this server.
METHOD method_3829 getSpawnRadius (Lnet/minecraft/class_3218;)I
ARG 1 world
METHOD method_3830 getTickTime ()F