InputHook - how to clear Input

Share your ideas as to how the documentation can be improved.
Descolada
Posts: 1193
Joined: 23 Dec 2021, 02:30

InputHook - how to clear Input

Post by Descolada » 22 Dec 2022, 11:01

Inspired from this thread - would it be possible to add a small note to InputHook documentation under InputHook.Input about how to reset the Input buffer?
I would assume this is a rather common problem/question when dealing with InputHooks, and the solution isn't that obvious: stopping and restarting the hook could reasonably be assumed to also *not* reset the Input property and instead continue on where it was left off. Only when reading the docs very carefully it's revealed under InputHook.Start() why this works: "Returns any text collected since the last time Input was started."

lexikos
Posts: 9688
Joined: 30 Sep 2013, 04:07
Contact:

Re: InputHook - how to clear Input

Post by lexikos » 23 Dec 2022, 18:58

It can surely be clarified, but as for "it's revealed under InputHook.Start()"... one probably wouldn't be looking under Start(), so if it was there, it would be hard to find. But it's not. It's in the one-line description of Input, which is the very property you want to reset.

Descolada
Posts: 1193
Joined: 23 Dec 2021, 02:30

Re: InputHook - how to clear Input

Post by Descolada » 24 Dec 2022, 00:03

@lexikos, sorry, it seems I mistyped: the quote is indeed under InputHook.Input as you said. Yet the point remains that the way of resetting Input is non-intuitive.

Post Reply

Return to “Suggestions on Documentation Improvements”