From 112adbef8f32a5591e001f48a88b41f63888d4e2 Mon Sep 17 00:00:00 2001 From: Eloraam Date: Sun, 31 Jul 2011 18:52:19 +0000 Subject: [PATCH] Improved some documentation. --- forge_common/net/minecraft/src/forge/IConnectRedstone.java | 6 ++++-- forge_common/net/minecraft/src/forge/IMultipassRender.java | 7 +++++++ forge_common/net/minecraft/src/forge/IOverrideReplace.java | 4 ++-- 3 files changed, 13 insertions(+), 4 deletions(-) diff --git a/forge_common/net/minecraft/src/forge/IConnectRedstone.java b/forge_common/net/minecraft/src/forge/IConnectRedstone.java index 660b94c2df..57d56a9f3e 100644 --- a/forge_common/net/minecraft/src/forge/IConnectRedstone.java +++ b/forge_common/net/minecraft/src/forge/IConnectRedstone.java @@ -17,8 +17,10 @@ import net.minecraft.src.IBlockAccess; public interface IConnectRedstone { /** - * When this returns false, the block at location i, j, k cannot provide - * redstone power to the direction given in parameter, otherwise it can. + * When this returns false, the block at location i, j, k cannot make + * a redstone connection in the direction given in parameter, otherwise + * it can. Use to control which sides are inputs and outputs for redstone + * wires. */ public boolean canConnectRedstone(IBlockAccess iba, int i, int j, int k, int dir); diff --git a/forge_common/net/minecraft/src/forge/IMultipassRender.java b/forge_common/net/minecraft/src/forge/IMultipassRender.java index 7b8fcc3b22..1f38104562 100644 --- a/forge_common/net/minecraft/src/forge/IMultipassRender.java +++ b/forge_common/net/minecraft/src/forge/IMultipassRender.java @@ -5,6 +5,13 @@ package net.minecraft.src.forge; +/** This interface is to be implemented by a Block class. Allows a block + * type to perform rendering in both render passes, in case some parts of the + * block are solid and others are transparent. + */ public interface IMultipassRender { + /** Returns true when the block has things to render in this render + * pass. + */ public boolean canRenderInPass(int n); } diff --git a/forge_common/net/minecraft/src/forge/IOverrideReplace.java b/forge_common/net/minecraft/src/forge/IOverrideReplace.java index 60fa993d13..69b2820eb2 100644 --- a/forge_common/net/minecraft/src/forge/IOverrideReplace.java +++ b/forge_common/net/minecraft/src/forge/IOverrideReplace.java @@ -18,8 +18,8 @@ public interface IOverrideReplace { /** * Return true if this block has to take control over replacement, for - * the intended replacement given by the parameter bid. If true, then - * the actual replacement is supposed to have occured in the block. + * the intended replacement given by the parameter bid. If false, then + * the block replacement will be prevented. */ public boolean canReplaceBlock(World world, int i, int j, int k, int bid);