Package io.papermc.paper
Interface ServerBuildInfo
Information about the current server build.
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic enum
String representation types. -
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionasString
(@NotNull ServerBuildInfo.StringRepresentation representation) Creates a string representation of the server build information.brandId()
Gets the brand id of the server.Gets the brand name of the server.static @NotNull ServerBuildInfo
Gets theServerBuildInfo
.Gets the build number.Gets the build time.Gets the git commit branch.Gets the git commit hash.boolean
isBrandCompatible
(@NotNull Key brandId) Checks if the current server supports the specified brand.Gets the Minecraft version id.Gets the Minecraft version name.
-
Field Details
-
BRAND_PAPER_ID
The brand id for Paper. -
BRAND_PUFFERFISH_ID
The brand id for Pufferfish. -
BRAND_PURPUR_ID
The brand id for Purpur.
-
-
Method Details
-
buildInfo
Gets theServerBuildInfo
.- Returns:
- the
ServerBuildInfo
-
brandId
Gets the brand id of the server.- Returns:
- the brand id of the server (e.g. "papermc:paper")
-
isBrandCompatible
Checks if the current server supports the specified brand.- Parameters:
brandId
- the brand to check (e.g. "papermc:folia")- Returns:
true
if the server supports the specified brand
-
brandName
Gets the brand name of the server.- Returns:
- the brand name of the server (e.g. "Paper")
-
minecraftVersionId
Gets the Minecraft version id.- Returns:
- the Minecraft version id (e.g. "1.20.4", "1.20.2-pre2", "23w31a")
-
minecraftVersionName
Gets the Minecraft version name.- Returns:
- the Minecraft version name (e.g. "1.20.4", "1.20.2 Pre-release 2", "23w31a")
-
buildNumber
Gets the build number.- Returns:
- the build number
-
buildTime
Gets the build time.- Returns:
- the build time
-
gitBranch
Gets the git commit branch.- Returns:
- the git commit branch
-
gitCommit
Gets the git commit hash.- Returns:
- the git commit hash
-
asString
@NotNull @NotNull String asString(@NotNull @NotNull ServerBuildInfo.StringRepresentation representation) Creates a string representation of the server build information.- Parameters:
representation
- the type of representation- Returns:
- a string
-