Skip to content

Commit 4ef1557

Browse files
committed
Add some docs to MiniModelTileEntity
1 parent 2571606 commit 4ef1557

File tree

1 file changed

+9
-0
lines changed

1 file changed

+9
-0
lines changed

src/main/java/io/github/cadiboo/examplemod/tileentity/MiniModelTileEntity.java

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,15 @@
1212
import javax.annotation.Nullable;
1313

1414
/**
15+
* This is the TileEntity for our MiniModel.
16+
* It stores the render data for its surroundings.
17+
* <p>
18+
* Rendering code only exists on the client distribution so @OnlyIn is used a lot.
19+
* The @OnlyIn annotation makes it so that a class/field/method annotated with it does not
20+
* exist on the other distribution. This is important as TileEntities exist on both distributions
21+
* but rendering only happens on the client.
22+
* As a general rule you should avoid using @OnlyIn unless it is absolutely necessary.
23+
*
1524
* @author Cadiboo
1625
*/
1726
public class MiniModelTileEntity extends TileEntity {

0 commit comments

Comments
 (0)