程序包 net.minecraftforge.fml

记录类 IExtensionPoint.DisplayTest

java.lang.Object
java.lang.Record
net.minecraftforge.fml.IExtensionPoint.DisplayTest
所有已实现的接口:
IExtensionPoint<IExtensionPoint.DisplayTest>
封闭接口:
IExtensionPoint<T extends Record>
public static record IExtensionPoint.DisplayTest(Supplier<String> suppliedVersion, BiPredicate<String,Boolean> remoteVersionTest) extends Record implements IExtensionPoint<IExtensionPoint.DisplayTest>
Extension point for the compatibility display test used on the server selection screen. Note: "server" and "client" refers to the dedicated server and game client physical distributions, rather than the logical server and client.

The Supplier provides the local compatibility version, which is sent from the server to the client for multiplayer connections or stored to disk for the world save. The BiPredicate accepts the remote compatibility version and a boolean indicating whether the remote version is from the server or a world save, where true means it is from the server and false means it is from the world save. The return value of the predicate determines whether the remote version is "compatible" for the purposes of the display test.

The local compatibility version may be of the value IGNORESERVERONLY, in which case clients will ignore the mod's presence if it is present on the server but not on the client. However, the remote version test predicate must still accept this value as a remote version in order to display as compatible if the mod is present on the client.

The compatibility display test does not necessarily indicate the success or failure of an actual connection attempt. Factors such as display test extension misconfiguration, truncation of ping data, difference of registry data or network channels between server and client, and others may cause the result of the compatibility test to not reflect the actual likelihood of a connection successfully being established between the server and the client.

An example declaration of a display test extension registration for a regular mod (requires to be present on server and client) is as follows:


 String compatibilityVersion = "1"; // Could be linked with a network channel version or mod version
 ModLoadingContext.get().registerExtensionPoint(IExtensionPoint.DisplayTest.class,
         () -> new IExtensionPoint.DisplayTest(
                 () -> compatibilityVersion,
                 (remoteVersion, isFromServer) -> remoteVersion.equals(compatibilityVersion)
         )
 );

An example declaration of a display test extension registration for a server-side-only mod (does not require to be present on the client) is as follows:


 ModLoadingContext.get().registerExtensionPoint(IExtensionPoint.DisplayTest.class,
         () -> new IExtensionPoint.DisplayTest(
                 // Ignore this mod if not present on the client
                 () -> NetworkConstants.IGNORESERVERONLY,
                 // If present on the client, accept any version if from a server
                 (remoteVersion, isFromServer) -> isFromServer
         )
 );

An example declaration of a display test extension registration for a client-side-only mod (does not require to be present on the server) is as follows:


 ModLoadingContext.get().registerExtensionPoint(IExtensionPoint.DisplayTest.class,
         () -> new IExtensionPoint.DisplayTest(
                 // Send any version from server to client, since we will be accepting any version as well
                 () -> "dQw4w9WgXcQ",
                 // Accept any version on the client, from server or from save
                 (remoteVersion, isFromServer) -> true
         )
 );
另请参阅:

  • 字段详细资料

    • suppliedVersion

      private final Supplier<String> suppliedVersion
      suppliedVersion 记录组件的字段。

    • remoteVersionTest

      private final BiPredicate<String,Boolean> remoteVersionTest
      remoteVersionTest 记录组件的字段。

    • IGNORESERVERONLY

      public static final String IGNORESERVERONLY
      另请参阅:

    • IGNORE_SERVER_VERSION

      public static final Supplier<IExtensionPoint.DisplayTest> IGNORE_SERVER_VERSION
      Ignores any version information coming from the server - use for server only mods

    • IGNORE_ALL_VERSION

      public static final Supplier<IExtensionPoint.DisplayTest> IGNORE_ALL_VERSION
      Ignores all information and provides no information

      Note: If your mod is purely client-side and has no multiplayer functionality (be it dedicated servers or Open to LAN), consider setting clientSideOnly=true in the root of your mods.toml.

  • 构造器详细资料

    • DisplayTest

      public DisplayTest(String version, BiPredicate<String,Boolean> remoteVersionTest)
      An optional alternative to DisplayTest(Supplier, BiPredicate) which accepts a constant version string instead of a Supplier.

      Internally, the provided version string is wrapped in a Supplier for you.

    • DisplayTest

      public DisplayTest(Supplier<String> suppliedVersion, BiPredicate<String,Boolean> remoteVersionTest)
      创建 DisplayTest 记录类的实例。
      参数:
      suppliedVersion - suppliedVersion 记录组件的值
      remoteVersionTest - remoteVersionTest 记录组件的值

  • 方法详细资料

    • toString

      public final String toString()
      返回此记录类的字符串表示形式。此表示形式包含类的名称，后跟每个记录组件的名称和值。
      指定者:
      toString 在类中 Record
      返回:
      此对象的字符串表示形式

    • hashCode

      public final int hashCode()
      返回此对象的哈希代码值。此值派生自每个记录组件的哈希代码。
      指定者:
      hashCode 在类中 Record
      返回:
      此对象的哈希代码值

    • equals

      public final boolean equals(Object o)
      指示某个其他对象是否“等于”此对象。如果两个对象属于同一个类，而且所有记录组件都相等，则这两个对象相等。 此记录类中的所有组件都使用 Objects::equals(Object,Object) 进行比较。
      指定者:
      equals 在类中 Record
      参数:
      o - 要与之进行比较的对象
      返回:
      如果此对象与 o 参数相同，则为 true；否则为 false。

    • suppliedVersion

      public Supplier<String> suppliedVersion()
      返回 suppliedVersion 记录组件的值。
      返回:
      suppliedVersion 记录组件的值

    • remoteVersionTest

      public BiPredicate<String,Boolean> remoteVersionTest()
      返回 remoteVersionTest 记录组件的值。
      返回:
      remoteVersionTest 记录组件的值