{"action":"created","issue":{"url":"https://api.github.com/repos/godotengine/godot/issues/9962","repository_url":"https://api.github.com/repos/godotengine/godot","labels_url":"https://api.github.com/repos/godotengine/godot/issues/9962/labels{/name}","comments_url":"https://api.github.com/repos/godotengine/godot/issues/9962/comments","events_url":"https://api.github.com/repos/godotengine/godot/issues/9962/events","html_url":"https://github.com/godotengine/godot/issues/9962","id":246492749,"number":9962,"title":"Example of Good Commenting - Hello Mario Engine","user":{"login":"P-Star7","id":26371167,"avatar_url":"https://avatars1.githubusercontent.com/u/26371167?v=4","gravatar_id":"","url":"https://api.github.com/users/P-Star7","html_url":"https://github.com/P-Star7","followers_url":"https://api.github.com/users/P-Star7/followers","following_url":"https://api.github.com/users/P-Star7/following{/other_user}","gists_url":"https://api.github.com/users/P-Star7/gists{/gist_id}","starred_url":"https://api.github.com/users/P-Star7/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/P-Star7/subscriptions","organizations_url":"https://api.github.com/users/P-Star7/orgs","repos_url":"https://api.github.com/users/P-Star7/repos","events_url":"https://api.github.com/users/P-Star7/events{/privacy}","received_events_url":"https://api.github.com/users/P-Star7/received_events","type":"User","site_admin":false},"labels":[],"state":"open","locked":false,"assignee":null,"assignees":[],"milestone":null,"comments":0,"created_at":"2017-07-29T02:11:31Z","updated_at":"2017-07-29T02:30:57Z","closed_at":null,"body":"I know this isn't really a bug, but I think that this is important for Godot, more specifically its documentation and example projects\r\nhttps://github.com/HelloFangaming/HelloMarioEngine\r\nThis engine written in Game Maker Language is very good at explaining all things written in the object code that aren't immediately obvious from the GameMaker UI (which means such as which parent the object has, which default sprite the object uses, and which mask the object has). For example, the code explains an object's behaviors such as setting the object's creation parameters in the Create event (such as facing direction, which state of the FSM it is in when starting, and which qualities it has such as immune to fireballs, can be stomped, etc.) Speaking of those, it also helped me understand finite state machines in the step events, too (such as how an object changes graphics and movement behavior when it changes to a state, such as throwing, jumping, etc., and how they have variables such as having one sprite when jumping but switch to another when they land). I'm sorry for my fuzzy instructions, because it's been a while since I used that engine due to not wanting to continue development on a project that wasn't GPL-friendly. What I mean to be taken away from this is that I really appreciate when projects do not assume knowledge of the student, and that seeing the same \"you do this to x\" explanation in each object helped me get the concepts in a general sense."},"comment":{"url":"https://api.github.com/repos/godotengine/godot/issues/comments/318797727","html_url":"https://github.com/godotengine/godot/issues/9962#issuecomment-318797727","issue_url":"https://api.github.com/repos/godotengine/godot/issues/9962","id":318797727,"user":{"login":"reduz","id":6265307,"avatar_url":"https://avatars2.githubusercontent.com/u/6265307?v=4","gravatar_id":"","url":"https://api.github.com/users/reduz","html_url":"https://github.com/reduz","followers_url":"https://api.github.com/users/reduz/followers","following_url":"https://api.github.com/users/reduz/following{/other_user}","gists_url":"https://api.github.com/users/reduz/gists{/gist_id}","starred_url":"https://api.github.com/users/reduz/starred{/owner}{/repo}","subscriptions_url":"https://api.github.com/users/reduz/subscriptions","organizations_url":"https://api.github.com/users/reduz/orgs","repos_url":"https://api.github.com/users/reduz/repos","events_url":"https://api.github.com/users/reduz/events{/privacy}","received_events_url":"https://api.github.com/users/reduz/received_events","type":"User","site_admin":false},"created_at":"2017-07-29T02:30:57Z","updated_at":"2017-07-29T02:30:57Z","body":"This was brought up many times, but you have to understand that Godot is\nnearly a million lines of code and the internals use advanced programming\ntechniques that already require programmers to have a considerable\nbackground before tackling many of it's subsystems.\n\nThat said, the exposed API should be as best documented and easy to use as\npossible, so any feedback on improving this is welcome\n\nOn Jul 28, 2017 11:11 PM, \"P-Star7\" <notifications@github.com> wrote:\n\nI know this isn't really a bug, but I think that this is important for\nGodot, more specifically its documentation and example projects\nhttps://github.com/HelloFangaming/HelloMarioEngine\nThis engine written in Game Maker Language is very good at explaining all\nthings written in the object code that aren't immediately obvious from the\nGameMaker UI (which means such as which parent the object has, which\ndefault sprite the object uses, and which mask the object has). For\nexample, the code explains an object's behaviors such as setting the\nobject's creation parameters in the Create event (such as facing direction,\nwhich state of the FSM it is in when starting, and which qualities it has\nsuch as immune to fireballs, can be stomped, etc.) Speaking of those, it\nalso helped me understand finite state machines in the step events, too\n(such as how an object changes graphics and movement behavior when it\nchanges to a state, such as throwing, jumping, etc., and how they have\nvariables such as having one sprite when jumping but switch to another when\nthey land). I'm sorry for my fuzzy instructions, because it's been a while\nsince I used that engine due to not wanting to continue development on a\nproject that wasn't GPL-friendly. What I mean to be taken away from this is\nthat I really appreciate when projects do not assume knowledge of the\nstudent, and that seeing the same \"you do this to x\" explanation in each\nobject helped me get the concepts in a general sense.\n\n—\nYou are receiving this because you are subscribed to this thread.\nReply to this email directly, view it on GitHub\n<https://github.com/godotengine/godot/issues/9962>, or mute the thread\n<https://github.com/notifications/unsubscribe-auth/AF-Z21Hqffx63FfeCsNSmOprl-jRrCdSks5sSpTdgaJpZM4OnOdp>\n.\n"}}
{"actor":{"display_login":"reduz"}}