Command usage tip?

Question

Command usage tip?

Closed this issue 6 years ago · 4 comments

Is there any workaround to add an suggestion how to use a command?
lets say we have command "rate". how to output the tip like: "usage rate 25000"
instead of the default error "'rate' requires exactly 1 argument? thanks.

Answer 1 · 2018-09-10T19:22:47.000Z

Would printing a Hint message after the error message be useful?

[RegisterCommand(MinArgCount = 1, MaxArgCount = 1, Hint = "rate 25000")]
static void CommandRate(CommandArg[] args) { }

The error printed would then be:

Error: 'rate' requires exactly 1 argument
    Usage: rate 25000

Answer 2 · 2018-09-11T00:44:05.000Z

Yes, it would be useful for sure. Since a user does not know the proper usage of the command. With the "Error: 'rate' requires exactly 1 argument" it is unclear what is the parameter has to be?

With a hint it would be understandable how to use the command. Thank you.

Answer 3 · 2018-09-13T00:41:05.000Z

Added in 08a66da. Thanks for the suggestion!

Answer 4 · 2018-09-14T03:29:08.000Z

Thank you for the implementation!