From dc3df3edd5843bde0c1335d6a8e460b2c832aa48 Mon Sep 17 00:00:00 2001 From: Foghrye4 Date: Sat, 17 Jun 2017 08:12:18 +0300 Subject: full project files --- javadoc/cpw/mods/fml/common/SidedProxy.html | 270 ++++++++++++++++++++++++++++ 1 file changed, 270 insertions(+) create mode 100644 javadoc/cpw/mods/fml/common/SidedProxy.html (limited to 'javadoc/cpw/mods/fml/common/SidedProxy.html') diff --git a/javadoc/cpw/mods/fml/common/SidedProxy.html b/javadoc/cpw/mods/fml/common/SidedProxy.html new file mode 100644 index 0000000..b382668 --- /dev/null +++ b/javadoc/cpw/mods/fml/common/SidedProxy.html @@ -0,0 +1,270 @@ + + + + + +SidedProxy (Forge API) + + + + + + + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + +
+
cpw.mods.fml.common
+

Annotation Type SidedProxy

+
+
+
+
    +
  • +
    +
    +
    @Retention(value=RUNTIME)
+@Target(value=FIELD)
+public @interface SidedProxy
    +
    Sided proxies are loaded based on the specific environment they find themselves loaded into. + They are used to ensure that client-specific code (such as GUIs) is only loaded into the game + on the client side. + It is applied to static fields of a class, anywhere in your mod code. FML will scan + and load any classes with this annotation at mod construction time. + +

    + This example will load a CommonProxy on the server side, and a ClientProxy on the client side. + + 

    public class MySidedProxyHolder {
+      {@literal @}SidedProxy(modId="MyModId",clientSide="mymod.ClientProxy", serverSide="mymod.CommonProxy")
+      public static CommonProxy proxy;
+  }
+
+  public class CommonProxy {
+      // Common or server stuff here that needs to be overridden on the client
+  }
+
+  public class ClientProxy extends CommonProxy {
+      // Override common stuff with client specific stuff here
+  }
+ 
+
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Optional Element Summary

      + + + + + + + + + + + + + + + + + + +
      Optional Elements 
      Modifier and TypeOptional Element and Description
      java.lang.StringclientSide +
      The name of the client side class to load and populate
      +
      java.lang.StringmodId +
      The (optional) name of a mod to load this proxy for.
      +
      java.lang.StringserverSide +
      The name of the server side class to load and populate
      +
      +
      • +
    +
    • +
+
+
+
    +
  • + +
      +
    • + + +

      Element Detail

      + + + +
        +
      • +

        clientSide

        +
        public abstract java.lang.String clientSide
        +
        The name of the client side class to load and populate
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        serverSide

        +
        public abstract java.lang.String serverSide
        +
        The name of the server side class to load and populate
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      + + + +
        +
      • +

        modId

        +
        public abstract java.lang.String modId
        +
        The (optional) name of a mod to load this proxy for. This will help ensure correct behaviour when loading a combined + scala/java mod package. It is almost never going to be required, unless you ship both Scala and Java Mod content + in a single jar.
        +
        +
        Default:
        +
        ""
        +
        +
        • +
      +
      • +
    +
    • +
+
+
+ + +
+ + + + + +
+
+ + + +
+ +
+
+ + +
+ + +
+ + + -- cgit v1.2.3