Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Orientable Blocks wiki page #111

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Binary file added static/blocks/blackwood_log_top.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added static/blocks/glowing_blackwood_log.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
62 changes: 62 additions & 0 deletions wiki/blocks/oriented-block/en.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
---
title: Creating an Oriented Block
index: 0
---

# Creating an Oriented Block
Blocks such as Oak, Spruce and Birch logs are an example of an oriented block. The following example will show you how to make your own oriented block
with "Glowing Blackwood Log" being the example block.
woodiertexas marked this conversation as resolved.
Show resolved Hide resolved


First off, you will want to make two block model json like the following:
The X, Y, and Z are your blockstate's axis.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this should be moved, so that the code is directly after you say 'like the following'


`src/main/resources/assets/yeefpineapple/blockstates/glowing_blackwood.json`:
```json
{
"variants": {
"axis=x": {
"model": "yeefpineapple:block/glowing_blackwood",
"x": 90,
"y": 90
},
"axis=y": {
"model": "yeefpineapple:block/glowing_blackwood"
},
"axis=z": {
"model": "yeefpineapple:block/glowing_blackwood",
"x": 90
}
}
}
```

Then you will need to create a class file for the block you're adding. In this example, the file will be called "GlowingBlackwood.java".
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i'd add an explanation for why we need to create a dedicated class for the block -- explain that it needs custom code in order to work


`src/main/com/example/yeefpineapple/blocks/GlowingBlackwood.java`:
```java
public class BeamBlock extends PillarBlock {
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

explain this code!! why is it called BeamBlock when we're making a log? what do all those methods do? all that will confuse a new modder

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

(by explain the code, i mean break it into smaller chunks and explain in the article instead of comments. I'd first present the rotate method, explain it, then explain the getPlacementState method)

// The following deals with block rotation
@Override
public BlockState rotate(BlockState state, BlockRotation rotation) {
return changeRotation(state, rotation);
}

public static BlockState changeRotation(BlockState state, BlockRotation rotation) {
return switch (rotation) {
case COUNTERCLOCKWISE_90, CLOCKWISE_90 -> switch (state.get(AXIS)) {
case X -> state.with(AXIS, Direction.Axis.Z);
case Z -> state.with(AXIS, Direction.Axis.X);
default -> state;
};
default -> state;
};
}

// Deals with placing the block properly in accordance to direction.
@Override
public BlockState getPlacementState(ItemPlacementContext context) {
return this.getDefaultState().with(AXIS, context.getSide().getAxis());
}
}
```
Loading