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

No information on what exactly is the offset/direction argument in //move and //stack #31

Open
oskarkk opened this issue May 5, 2021 · 4 comments
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed

Comments

@oskarkk
Copy link
Contributor

oskarkk commented May 5, 2021

The only way to find out what exactly is the second argument of //move and //stack commands, is to use it wrong and read the error message, and even then it's not exactly accurate:

//stack 3 12
Usage: //stack [-abers] [count] [offset] [-m <mask>]
Invalid value for [offset] (Unknown direction: 12), acceptable
values are 'me' to use facing direction, or any direction, or
any block vector with x, y, z

First, the small thing: it would be better to write "any block vector with x,y,z", without spaces between xyz, because you can't write this in the command with spaces (unless you put this in quotation marks). Second, I don't think it's exactly "block" vector. I thought that when I have 3x3x3 region and I'm doing //stack 1 1,0,0, the region will be copied to the east, one block apart. Actually, it's copied one region length apart, 3 blocks in this case. So e.g. //stack 1 2,0,0 will give me 6 blocks between the two copies of the region. So it would be better to drop "block" from "block vector" in the //stack command, because it's not the blocks we're translating. In the //move command that vector is really a block vector, so it's good.

What is in the documentation is also a little inconsistent, as the manual names that argument "direction", but the command reference names it "offset". Now that's understandable as the manual doesn't mention that this argument is really an offset rather than a direction (that "east" is converted to "1,0,0"), but I think it can be confusing when you're using //move and learned that the second arg is a direction, but then you use help command, and it tells you that it's an offset. Like how can the direction be an offset, when we're passing the number of blocks in the first arg?

If I knew earlier how these commands work, I would be much more efficient with them, so I think it's worthwhile to explain them exhaustively.

@wizjany
Copy link
Contributor

wizjany commented May 5, 2021

the command page is generated and thus always has the latest syntax (as of when we update it - generally for releases). the usage pages are manually written so they tend to fall behind.
for reference:
EngineHub/WorldEdit#1430
EngineHub/WorldEdit#1539

@PhoenixIV
Copy link

@wizjany You closed my own ticket about this, referring to this ticket here. This one is also marked as close. How do you keep track that you need to update your documentation when you close these issues?

@octylFractal
Copy link
Member

This ticket is literally open.

@PhoenixIV
Copy link

🤦‍♂️
Thanks, @octylFractal I mistook the "closed" label next to my referenced ticket as this ticket's status. Sorry everyone.

@octylFractal octylFractal added enhancement New feature or request help wanted Extra attention is needed good first issue Good for newcomers labels Sep 8, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request good first issue Good for newcomers help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

4 participants