|
YATS/Forge Documentation
|
Static Public Member Functions | |
| static void | addAchievementDesc (Achievement achievement, String name, String description) |
| static int | addAllFuel (int id, int metadata) |
| static void | addAllRenderers (Map< Class<?extends Entity >, Render > renderers) |
| static int | addArmor (String armor) |
| static void | addBiome (BiomeGenBase biome) |
| static void | addEntityTracker (BaseMod mod, Class<?extends Entity > entityClass, int entityTypeId, int updateRange, int updateInterval, boolean sendVelocityInfo) |
| static void | addCommand (ICommand command) |
| static void | addDispenserBehavior (Item item, IBehaviorDispenseItem behavior) |
| static void | addLocalization (String key, String value) |
| static void | addLocalization (String key, String lang, String value) |
| static void | addName (Object instance, String name) |
| static void | addName (Object instance, String lang, String name) |
| static int | addOverride (String fileToOverride, String fileToAdd) |
| static void | addOverride (String path, String overlayPath, int index) |
| static void | addRecipe (ItemStack output, Object...params) |
| static void | addShapelessRecipe (ItemStack output, Object...params) |
| static void | addSmelting (int input, ItemStack output) |
| static void | addSmelting (int input, ItemStack output, float experience) |
| static void | addSpawn (Class<?extends EntityLiving > entityClass, int weightedProb, int min, int max, EnumCreatureType spawnList) |
| static void | addSpawn (Class<?extends EntityLiving > entityClass, int weightedProb, int min, int max, EnumCreatureType spawnList, BiomeGenBase...biomes) |
| static void | addSpawn (String entityName, int weightedProb, int min, int max, EnumCreatureType spawnList) |
| static void | addSpawn (String entityName, int weightedProb, int min, int max, EnumCreatureType spawnList, BiomeGenBase...biomes) |
| static void | addTrade (int profession, TradeEntry entry) |
| static void | clientSendPacket (Packet packet) |
| static boolean | dispenseEntity (World world, double x, double y, double z, int xVel, int zVel, ItemStack item) |
| static void | genericContainerRemoval (World world, int x, int y, int z) |
| static List< BaseMod > | getLoadedMods () |
| static Logger | getLogger () |
| static Minecraft | getMinecraftInstance () |
| static MinecraftServer | getMinecraftServerInstance () |
| static< T, E > T | getPrivateValue (Class<?super E > instanceclass, E instance, int fieldindex) |
| static< T, E > T | getPrivateValue (Class<?super E > instanceclass, E instance, String field) |
| static int | getUniqueBlockModelID (BaseMod mod, boolean inventoryRenderer) |
| static int | getUniqueEntityId () |
| static int | getUniqueSpriteIndex (String path) |
| static boolean | isChannelActive (EntityPlayer player, String channel) |
| static boolean | isGUIOpen (Class<?extends GuiScreen > gui) |
| static boolean | isModLoaded (String modname) |
| static void | loadConfig () |
| static BufferedImage | loadImage (RenderEngine renderEngine, String path) throws Exception |
| static void | onItemPickup (EntityPlayer player, ItemStack item) |
| static void | onTick (float tick, Minecraft game) |
| static void | openGUI (EntityPlayer player, GuiScreen gui) |
| static void | populateChunk (IChunkProvider generator, int chunkX, int chunkZ, World world) |
| static void | receivePacket (Packet250CustomPayload packet) |
| static KeyBinding[] | registerAllKeys (KeyBinding[] keys) |
| static void | registerAllTextureOverrides (RenderEngine cache) |
| static void | registerBlock (Block block) |
| static void | registerBlock (Block block, Class<?extends ItemBlock > itemclass) |
| static void | registerContainerID (BaseMod mod, int id) |
| static void | registerEntityID (Class<?extends Entity > entityClass, String entityName, int id) |
| static void | registerEntityID (Class<?extends Entity > entityClass, String entityName, int id, int background, int foreground) |
| static void | registerKey (BaseMod mod, KeyBinding keyHandler, boolean allowRepeat) |
| static void | registerPacketChannel (BaseMod mod, String channel) |
| static void | registerTileEntity (Class<?extends TileEntity > tileEntityClass, String id) |
| static void | registerTileEntity (Class<?extends TileEntity > tileEntityClass, String id, TileEntitySpecialRenderer renderer) |
| static void | removeBiome (BiomeGenBase biome) |
| static void | removeSpawn (Class<?extends EntityLiving > entityClass, EnumCreatureType spawnList) |
| static void | removeSpawn (Class<?extends EntityLiving > entityClass, EnumCreatureType spawnList, BiomeGenBase...biomes) |
| static void | removeSpawn (String entityName, EnumCreatureType spawnList) |
| static void | removeSpawn (String entityName, EnumCreatureType spawnList, BiomeGenBase...biomes) |
| static boolean | renderBlockIsItemFull3D (int modelID) |
| static void | renderInvBlock (RenderBlocks renderer, Block block, int metadata, int modelID) |
| static boolean | renderWorldBlock (RenderBlocks renderer, IBlockAccess world, int x, int y, int z, Block block, int modelID) |
| static void | saveConfig () |
| static void | sendPacket (Packet packet) |
| static void | serverChat (String text) |
| static void | serverLogin (NetClientHandler handler, Packet1Login loginPacket) |
| static void | serverSendPacket (NetServerHandler handler, Packet packet) |
| static void | serverOpenWindow (EntityPlayerMP player, Container container, int ID, int x, int y, int z) |
| static void | setInGameHook (BaseMod mod, boolean enable, boolean useClock) |
| static void | setInGUIHook (BaseMod mod, boolean enable, boolean useClock) |
| static< T, E > void | setPrivateValue (Class<?super T > instanceclass, T instance, int fieldindex, E value) |
| static< T, E > void | setPrivateValue (Class<?super T > instanceclass, T instance, String field, E value) |
| static void | takenFromCrafting (EntityPlayer player, ItemStack item, IInventory matrix) |
| static void | takenFromFurnace (EntityPlayer player, ItemStack item) |
| static void | throwException (String message, Throwable e) |
| static void | throwException (Throwable e) |
Static Public Attributes | |
| static final String | fmlMarker = "This is an FML marker" |
| static final Map< String, Map < String, String > > | localizedStrings =Collections.emptyMap() |
|
static |
Adds localization info for an achievement, Not used on the server.
| achievement | The achievement to name |
| name | The name |
| description | The description |
|
static |
This method is a call in hook from modified external code. Implemented elsewhere.
GameRegistry#getFuelValue(ItemStack)
| id | The Item ID |
| metadata | The Item Metadata |
|
static |
|
static |
Adds a new prefix to the armor texture list
RenderingRegistry#addNewArmourRendererPrefix(String)
| armor | The new armor prefix |
|
static |
This method adds the supplied biome to the set of candidate biomes for the default world generator type.
| biome | The biome to add |
|
static |
|
static |
Add a behaviour to the dispenser
| item | |
| behavior |
|
static |
|
static |
Add localization for the specified string
| key | Key |
| value | Value |
|
static |
Add localization for the specified string
| key | Key |
| lang | Language identifier |
| value | Value |
|
static |
Name the specified minecraft object with the supplied name
| instance | Item to name |
| name | The name to give it |
|
static |
Unimplemented on the server as it does not generate names
| instance | Item to name |
| lang | Languge identifier |
| name | Name to give it |
|
static |
Attempts to register a small image to be applied to a larger texture image, typically how old ModLoader mods add custom Item/Block textures.
Forge mods should use setTextureFile in Item/Block
Will return the icon index it was applied to.
Unimplemented on the server as it does not render textures
| fileToOverride | The texture to apply the new image to |
| fileToAdd | The new image |
|
static |
Attempts to register a small image to be applied to a larger texture image, typically how old ModLoader mods add custom Item/Block textures.
Forge mods should use setTextureFile in Item/Block
Unimplemented on the server as it does not render textures
| path | The texture to apply the new image to |
| overlayPath | The new image |
| index | Where on the texture to apply it |
|
static |
Add a Shaped Recipe
| output | The result |
| params | The input |
|
static |
Add a shapeless recipe
| output | The result |
| params | The input |
|
static |
Add a new product to be smelted
| input | |
| output |
|
static |
Add a new product to be smelted
| input | |
| output |
|
static |
Add a mob to the spawn list
| entityClass | |
| weightedProb | |
| min | |
| max | |
| spawnList |
|
static |
Add a mob to the spawn list
| entityClass | |
| weightedProb | |
| min | |
| max | |
| spawnList | |
| biomes |
|
static |
Add a mob to the spawn list
| entityName | |
| weightedProb | |
| min | |
| max | |
| spawnList |
|
static |
Add a mob to the spawn list
| entityName | |
| weightedProb | |
| min | |
| max | |
| spawnList | |
| biomes |
|
static |
|
static |
Send a packet from the client
| packet |
|
static |
This method is a call in hook from modified external code. Implemented elsewhere.
| world | |
| x | |
| y | |
| z | |
| xVel | |
| zVel | |
| item |
|
static |
Remove a container and drop all the items in it on the ground around
| world | |
| x | |
| y | |
| z |
|
static |
Get a list of all BaseMod loaded into the system ModLoaderModContainer#findAll
|
static |
Get a logger instance FMLCommonHandler#getFMLLogger()
|
static |
|
static |
|
static |
Get a value from a field using reflection ObfuscationReflectionHelper#getPrivateValue(Class, Object, int)
| instanceclass | |
| instance | |
| fieldindex |
|
static |
Get a value from a field using reflection ObfuscationReflectionHelper#getPrivateValue(Class, Object, String[])
| instanceclass | |
| instance | |
| field |
|
static |
Stubbed method on the server to return a unique model id
|
static |
Get a new unique entity id EntityRegistry#findGlobalUniqueEntityId()
|
static |
|
static |
To properly implement packet 250 protocol you should always check your channel is active prior to sending the packet
| player | |
| channel |
|
static |
|
static |
Is the named mod loaded? Loader#isModLoaded(String)
| modname |
|
static |
Implemented elsewhere
|
static |
|
static |
Call in from elsewhere. Unimplemented here.
| player | |
| item |
|
static |
Call in from elsewhere. Unimplemented here.
|
static |
|
static |
|
static |
This method is a call in hook from modified external code. Implemented elsewhere.
| packet |
|
static |
|
static |
|
static |
Register a new block
| block |
|
static |
Register a new block
| block | |
| itemclass |
|
static |
|
static |
Register a new entity ID
| entityClass | |
| entityName | |
| id |
|
static |
Register a new entity ID
| entityClass | |
| entityName | |
| id | |
| background | |
| foreground |
|
static |
|
static |
Register the mod for packets on this channel. NetworkRegistry#registerChannel(IPacketHandler, String)
| mod | |
| channel |
|
static |
Register a new tile entity class
| tileEntityClass | |
| id |
|
static |
|
static |
Remove a biome from the list of generated biomes
| biome |
|
static |
Remove a spawn
| entityClass | |
| spawnList |
|
static |
Remove a spawn
| entityClass | |
| spawnList | |
| biomes |
|
static |
Remove a spawn
| entityName | |
| spawnList |
|
static |
Remove a spawn
| entityName | |
| spawnList | |
| biomes |
|
static |
|
static |
|
static |
|
static |
Configuration is handled elsewhere ModLoaderModContainer
|
static |
Send a packet from client to server
| packet |
|
static |
Send a chat message to the server
| text |
|
static |
|
static |
|
static |
|
static |
Indicate that you want to receive ticks
| mod | receiving the events |
| enable | indicates whether you want to recieve them or not |
| useClock | don't receive render subticks, just world ticks |
|
static |
|
static |
Set a private field to a value using reflection ObfuscationReflectionHelper#setPrivateValue(Class, Object, int, Object)
| instanceclass | |
| instance | |
| fieldindex | |
| value |
|
static |
Set a private field to a value using reflection ObfuscationReflectionHelper#setPrivateValue(Class, Object, String, Object)
| instanceclass | |
| instance | |
| field | |
| value |
|
static |
This method is a call in hook from modified external code. Implemented elsewhere.
| player | |
| item | |
| matrix |
|
static |
This method is a call in hook from modified external code. Implemented elsewhere.
| player | |
| item |
|
static |
Throw the offered exception. Likely will stop the game.
| message | |
| e |
|
static |
|
static |
|
static |