mirror of
https://github.com/GTNewHorizons/Botania.git
synced 2026-11-15 17:45:10 +00:00
API documentation...
This commit is contained in:
1 parent
1c156490db
commit
8d33d0408f
2 files changed
+15
-1
No files matched your search
@@ -1,4 +1,4 @@
|
||||
@API(owner = "Botania", apiVersion = "10", provides = "BotaniaAPI")
|
||||
@API(owner = "Botania", apiVersion = "11", provides = "BotaniaAPI")
|
||||
package vazkii.botania.api;
|
||||
import cpw.mods.fml.common.API;
|
||||
|
||||
@@ -14,12 +14,26 @@ package vazkii.botania.api.wiki;
|
||||
import net.minecraft.util.MovingObjectPosition;
|
||||
import net.minecraft.world.World;
|
||||
|
||||
/**
|
||||
* An interface for a Wiki Provider, these are registered to allow a mod to provide a wiki
|
||||
* for all the blocks in them, used for the world interaction with the Lexica Botania.
|
||||
* A simple, mostly all-inclusive implementation can be found on SimpleWikiProvider.
|
||||
*/
|
||||
public interface IWikiProvider {
|
||||
|
||||
/**
|
||||
* Gets the name of the block being looked at for display.
|
||||
*/
|
||||
public String getBlockName(World world, MovingObjectPosition pos);
|
||||
|
||||
/**
|
||||
* Gets the URL to open when the block is clicked.
|
||||
*/
|
||||
public String getWikiURL(World world, MovingObjectPosition pos);
|
||||
|
||||
/**
|
||||
* Gets the name of the wiki for display.
|
||||
*/
|
||||
public String getWikiName(World world, MovingObjectPosition pos);
|
||||
|
||||
}
|
||||
Reference in new issue
Block a user