Guide to using JSON, hotkey chords, changes to project format & Git-related changes, reworked tilemap pages and other additions #114
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…r "Additional Information", add examples, etc. * Logging this under the above manual ticket, as this commit contains a bit of preparation for this * Documented json_encode's optional "prettify" parameter * General cleanup of pages json_encode and json_decode * Substantial cleanup of both pages: * Moved explanation of JSON to a snippet, inserted on both function pages * Consistency between notes by moving all notes under a "Usage Notes" section * A few typo fixes and visual updates here and there
YoYoGames/GameMaker-Bugs#4532 * Fixed on phy_collision_x and phy_collision_y pages * Moved note about "collision event only" to a snippet and inserted on all function pages * Explicitly added "Collision Event" to the examples to indicate context * On phy_collision_points page: "between the two objects in the collision" => "between the two instances in the collision" * A few typo fixes here and there
YoYoGames/GameMaker-Bugs#4532 * Updated the pages of all collision event variables again: * Inserted "Note" snippet on each page to explain built-in arrays aren't "real" arrays * Syntax changed to "builtin_array[index]", return type kept as "real", since - in theory - you can only access an array through an array lookup and that array lookup *does* return a real (omitting the subscript is allowed for backward compatibility) * Removed semicolons ";" at the end of the syntax line as these are expressions, rather than statements * Updated manual pages of other built-in global arrays as well. All of these pages should be updated by this commit. * Changed "Note" snippet about built-in arrays not being "real" arrays: "read" -> "access"
YoYoGames/GameMaker-Bugs#4331 * Updated the Async Steam Event page * The part starting at the section "Uploading Data" will likely be removed, as all this information is in the wiki
YoYoGames/GameMaker-Bugs#4331 * Actually remove the sections
YoYoGames/GameMaker-Bugs#4586 * Added pr_trianglefan to the image showing primitive types * Moved the Primitive Type Constants table to a snippet: * Added a more detailed description to every constant * Added a warning to pr_trianglefan * vertex_submit/vertex_submit_ext: * Added extra note to Usage Notes list to mention conversion of pr_trianglefan to pr_trianglelist might occur
…n documentation, but GM expects it YoYoGames/GameMaker-Bugs#4973 * Added the default value (false) to matchAll parameter description * Linked to Offset and Length section on Array Functions page again (somehow this link can get lost for cross-references)
…ariables are private and cannot be accessed YoYoGames/GameMaker-Bugs#4687 * Static variables of the function of an instance method can be accessed * Added a note to the static_get page that explains that the static struct of the function can be accessed through the method index
YoYoGames/YoYoStudio#9634 * Updated screenshots
This reverts commit bae12d8.
Also removed older Python script and output HTML file YoYoGames/YoYoStudio#8701
YoYoGames/YoYoStudio#8701 Now supports finding the JSON files directly in an install directory (on Windows)
YoYoGames/YoYoStudio#8701 * Reworked IDE Input and Navigation page * Added animated GIF on Redefine Keys Preferences page showing how to set a hotkey chord * Added a "See Also" on "IDE Navigation", linked on IDE Input and Navigation page * Tiny typo fixes
YoYoGames/GameMaker-Bugs#4816 * Added note to sqrt function page * Moved default epsilon to a variable and inserted it on the pages * A couple of tiny changes and fixes
Replaces the icon with "Lmb", "Rmb", "Mmb" if the image is missing
…ference pages MAN-643: Add a "Guide to Using JSON" page to the manual under "Additional Information" * Updated various DS pages * Added function reference and headers, link IDs * Changed return type in descriptions to "Handle" * Updated notes on ds_*_create and ds_*_destroy pages
…o string conversion rules
MAN-642: Update the JSON pages to make it more clear when to use json_encode and json_stringify MAN-643: Add a "Guide to Using JSON" page to the manual under "Additional Information" * Added "Guide to Using JSON" page under "Additional Information" * Added variable for JSON max nesting limit (when parsing) * Updated json_encode, json_decode, json_stringify & json_parse pages: * Moved some notes to "Guide to Using JSON", added links instead * "DS Maps", "DS Lists" & "Encoding And Hashing" pages: * Replaced links with cross-references * Added structure using headers & added element IDs * Various updates to DS list & DS map marking function pages (e.g. ds_list_mark_as_map) * Tiny update of "Ini Files" page
…page MAN-862: tilemap_set_mask page is confusing with poor examples
MAN-862: tilemap_set_mask page is confusing with poor examples
…details * General changes to the pages, etc.
MAN-862: tilemap_set_mask page is confusing with poor examples * Rewrote introduction of "Rooms" page a bit * Added variable for the max index bits of tile data * Renamed "General Layer Functions" page to "Layers", adding an explanation on how room layers are used, added structure using headers, linked part_system_create_layer as it's related * Renamed remaining "<Room Editor layer type> Layers" to "<Room Editor layer type> Elements" (layer types are a Room Editor thing)
MAN-862: tilemap_set_mask page is confusing with poor examples * Added two examples to the tilemap_set_mask page, one extended copy-pastable example that shows how to write and read back a random value * Added example to the tilemap_set_global_mask page, showing how to override the global mask for a specific tile map * Reworked "Tile Map Elements" page, moving info from tilemap_set_mask & tilemap_set_global_mask pages there, added all info under headers with an element ID * Tile Mask Constant table can now be linked to using a cross-reference
…alue if it doesn't return a new one
YoYoGames/GameMaker-Bugs#4923 The GameMaker Changelog page also refers to the release notes, but explicitly mentions they're for older GM versions => not changed
…d OneDrive, now that Windows puts My Documents inside OneDrive YoYoGames/GameMaker-Bugs#4372 * Updated the items and screenshot * Added "My Projects" and "Template Projects" as RH variables
…over OneDrive/Dropbox/iCloud/Google Drive and other cloud sync drives YoYoGames/GameMaker-Bugs#2859 * Added a "warning" note snippet and linked it * Also added a couple of separate "warning" notes (with slightly different text)
…ibutes file YoYoGames/GameMaker-Bugs#2922 YoYoGames/GameMaker-Bugs#4559 * Updated the screenshot on the "Plugin Preferences" page and listed the new preferences * Added info on the default .gitignore and .gitattributes files and LF endings on the "Project Format" page, added links to prefs where appropriate
…ibutes file YoYoGames/GameMaker-Bugs#4559 * Updated the screenshot on the "Plugin Preferences" page, it now shows a merge and diff tool configured
…ojects created from local asset packages YoYoGames/GameMaker-Bugs#5513
YoYoGames/YoYoStudio#8701 * Also added all descriptions to "default_hotkeys.json" file * Did an automatic export of all shortcuts in the beta version using the script * All shortcuts updated in the manual
YoYoGames/YoYoStudio#8701 * Replaced code editor names by the right variables * Linked to the Hotkey Chords section of the "IDE Input & Navigation" page from the "Keyboard shortcuts" page
|
tempted to just drop a LGTM |
# Conflicts: # Manual/contents/GameMaker_Language/GML_Reference/File_Handling/Ini_Files/Ini_Files.htm # Manual/contents/GameMaker_Language/GML_Reference/GML_Reference.htm
|
alright, LGTM |
gurpreetsinghmatharoo
added a commit
that referenced
this pull request
Apr 29, 2024
* develop: (98 commits) docs(feature): Reviewed PR #114 docs(general): updated shortcut styles on the IDE Input page YoYoGames/YoYoStudio#8701 docs(feature): replaced code editor 1 & 2 names with a variable YoYoGames/YoYoStudio#8701 docs(feature): updated all shortcuts on the keyboard shortcuts page YoYoGames/YoYoStudio#8701 docs(general): tiny change to shortcut script's export path example final fix docs(general): a couple of tiny typo fixes fixes for pushing to s3 fixes for pushing to s3 fixes for pushing to s3 adding some logging adding some logging adding some logging adding some logging adding some logging testing if python script is working testing if python script is working testing if git is present in the runner testing if git is present in the runner testing if git is present in the runner ...
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR contains changes for the following: