Skip to content

Commit

Permalink
Beginning of a saveinspectionhandler.
Browse files Browse the repository at this point in the history
  • Loading branch information
cpw committed Jan 21, 2014
1 parent 741e172 commit 544320b
Show file tree
Hide file tree
Showing 3 changed files with 50 additions and 1 deletion.
11 changes: 10 additions & 1 deletion src/main/java/cpw/mods/fml/common/Mod.java
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,18 @@
*
* This is ignored if there is a {@link NetworkCheckHandler} annotation on a method in this class.
*
* @return
* @return A version range as specified by the maven version range specification or the empty string
*/
String acceptableRemoteVersions() default "";

/**
* A version range specifying compatible save version information. If your mod follows good version numbering
* practice <a href="http://semver.org/">Like this (http://semver.org/)</a> then this should be sufficient.
*
* Advanced users can specify a {@link SaveInspectionHandler} instead.
* @return A version range as specified by the maven version range specification or the empty string
*/
String acceptableSaveVersions() default "";
/**
* An optional bukkit plugin that will be injected into the bukkit plugin framework if
* this mod is loaded into the FML framework and the bukkit coremod is present.
Expand Down
20 changes: 20 additions & 0 deletions src/main/java/cpw/mods/fml/common/SaveInspectionHandler.java
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
package cpw.mods.fml.common;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
* A method annotated with this on the {@link Mod} will be called whenever a local save is listed in
* the save games list.
*
* @author cpw
*
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface SaveInspectionHandler
{

}
20 changes: 20 additions & 0 deletions src/main/java/cpw/mods/fml/common/network/NetworkCheckHandler.java
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,27 @@
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import cpw.mods.fml.relauncher.Side;

/**
* A method annotated with this will be called when a remote network connection is offered.
* The method should have two parameters, of types {@link Map<String,String>} and {@link Side}. It should return a boolean
* true indicating that the remote party is acceptable, or false if not.
*
* <p>
* When the method is invoked, the map will contain String keys and values listing all mods and their versions present.
* The side represents the side of the remote party. So if you're on the server, it'll be CLIENT, and vice versa.
*
* <p>
* This method will be invoked both when querying the status of the remote server, and when connecting to the remote server.
*
* <p>
* <strong>NOTE: the server will not be setup at any point when this method is called. Do not try and interact with the server
* or the client in any way, except to accept or reject the list of mods.</strong>
*
* @author cpw
*
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface NetworkCheckHandler
Expand Down

0 comments on commit 544320b

Please sign in to comment.