Minecraftforge: JavaDocs for ScreenshotEvent is erroneous

So there won't be a second event when the file is created? I just needed it! 😅

I wanted to convert the image directly at the source 😅

There are quite a few javadocs issues, I have always stated that I am crap with documentation.
I would suggest that if you care about javadocs, it may be worth getting a couple people together and doing a big sweep of cleaning/adding javadocs.
It may be the next omnibus branch?

Not your fault here, Lex, the guy forgot to fix the javadoc after implementing your request :)

I will consider to join you guys on Discord to contribute.

Now that @LotuxPunk came up with that again, I will comment on the problems with the event and code surrounding it. First, the flow:

1. MC listens in some loop for F2 key press
2. MC calls a take screen func that returns the TextComponent that's put into chat (from the loop above)
3. take screen calls capture buffer
   a. If event is not cancelled, TextComponent is returned and file saved
   b. If event is cancelled, the buffer has already been captured, file not saved. Yet since that function returns a TextC - the best you can do is to return an empty text, empty line will appear in chat*

My idea was to re-schedule the screenshot, so it would capture less/more debug info rendered by my mod (chunk/region outlines etc.) It works. Yet due to the empty line appearing on the following screenshot I had to remove it manually from chat. Since MC's removeLine ( id ) doesn't just remove one line at key id (at least in my ver, don't roll your eyes) I had to manually grab a ref to the chat history + recent messages Lists to remove them properly.

Regardless of how I do it and what for:

• You cannot cancel the capture of the current screen buffer (a "pre" hook at Step 1 above)
• If you cancel the event (current "post" hook), you still get a chat line
  
  
  
  • if you overwrite the msg to be empty: confusion and empty line in both chat and log
  
  
  • if you want to do it proper like I did, you are onto more digging into MC GUI internals
  
  

Idk what the guidance with Forge events is, but I think there should be actually 3 events/states:

• Early hook: after F2 registered, but before take screen called (to prevent the chat message or buffer capture on cancellation)
• Current hook: with filled screen buffer (buffer/chat msg modification or general event listeners)
• Late hook: image encoded and file written (for post-actions on file)

@LotuxPunk with the current event hook: the idea is you modify the captured screen buffer as part of the event, not wait until its written to file.