UnderminersTeam
UndertaleCodeEditor: Open GameMaker documentation referece by middle-click on a built-in function
Feature request. Something like middle-click on a function in the GameMaker Studio code editor.
Do you mean in the official Game Maker Studio editor, or do you mean UndertaleModTool?
He is suggesting to add a little documentation pop-up when you middle-click a (built-in) function name, mimicking the behavior found in the official GameMaker Studio when you middle-click a function name :P
He is suggesting to add a little documentation pop-up when you middle-click a (built-in) function name, mimicking the behavior found in the official GameMaker Studio when you middle-click a function name :P
Yeah i mean it.
Ah. This seems doable.
Documentation URL: https://docs2.yoyogames.com/
Though, upon first glance, it might be non-trivial to figure out which page to display.
I found a point to help you easily find the function docs. https://docs.yoyogames.com/files/helpindexdat.js https://docs2.yoyogames.com/files/helpindexdat.js
Oh, wow, that makes it easy. So, as for implementation in the UI, I feel like it should prompt you (at least the first time to ask for preference) whether or not to go to the docs.
Or use https://dobby233liu.github.io/find-gms-function-doc
usage: (requires JS) You can define parameters.
s2: Define it to y to find in the GMS2 docs. Default: undefined. for example https://dobby233liu.github.io/find-gms-function-doc/?s2=y will redirect to https://docs2.yoyogames.com/source/_build/3_scripting/3_gml_overview/9_data_types.html
q: Keyword. Default undefined. for example https://dobby233liu.github.io/find-gms-function-doc/?s2=y&q=window_set_caption will redirect to https://docs2.yoyogames.com/source/_build/3_scripting/4_gml_reference/cameras%20and%20display/display/the%20game%20window/window_set_caption.html, and https://dobby233liu.github.io/find-gms-function-doc/?q=window_set_caption to https://docs.yoyogames.com/source/dadiospice/002_reference/windows%20and%20views/the%20game%20window/window_set_caption.html
While that is pretty cool, I feel like we can just parse the file from the tool ourselves- that way we can prompt the user with the URL we want before they go there (for safety reasons, of course). It seems pretty consistent and we can just ignore most of the JS syntax I think.
Since the gms1 and gms2.3- docs got nuked on yoyogames.com this might not make sense anymore, closing.
These pages are archived on the way back machine and are available locally for rehosting. This is not a valid reason to close this issue.
While a neat feature, this feels kinda eh to implement, unless we actually are able to open the proper docs for each version. Some games for example (like undertale) use docs pre 1.4.99999, where some functions do differ, and then opening the wrong docs there seems wrong.
