Cheat Sheet for quick reference

[eon-s]

A cheat sheet section with common editor usage and scripting needs (also addressing common mistakes), could be useful for new and old users alike.

Right now, basic editor (and engine) usage and scripting is scattered on many documentation pages and could take several trial and errors to make, for example, a simple for range loop.

The cheat sheet that I like how it is formatted is http://haxeflixel.com/documentation/cheat-sheet/ Another one that is good is https://websitesetup.org/php-cheat-sheet/

Some things that this cheat sheet can include: Engine:

• Main Loop: A link to a chart or the page that explains the engine's main loop
• Input events: A link to the chart or page that explains the input event flow

Editor:

• Basic 2D scene setup
• Basic 3D scene setup
• Common resource settings (pixel art, 2D, 3D, etc.)
• Asset lib (to promote the usage)
• Common node usage:
  • CollisionObjects and CollisionShapes
  • Paths and PathFollows
  • MeshInstance, MultiMesh and Materials
  • The powerful AnimationPlayer
  • more...

Scripting:

• if, for, while
• Input event management
• Working with arrays
• Connecting signals
• Using groups
• get_node usage
• Inspector hints
• setget and its runtime problems with the tree
• Physics:
  • Common RigidBody usage and problems
  • The same for KinematicBody
• Built in math tools used commonly (including Vector methods)
• Color is float and goes from 0 to 1
• The confusing Tween node
• and more..

If there is an interest to make something like this, I suppose that the list of sections and items to include will have to be discussed, particularly with those who are more involved in helping users on the different community channels.

[cbscribe]

I'm a little unclear on the purpose of this.

• Is this intended to be a single page? Including usage of things like AnimationPlayer would make this very long indeed, ie just using it for 2D sprite animation alone, which doesn't even touch on all of its "common" uses. "Common" node usage (for whatever "common" means) needs screenshots, code, and explanations and can be quite verbose. It seems like something you should find on the node's doc page.

Or is it intended to be more of an "index" or FAQ directing people to the things they're trying to find?

• What even is a "Basic 2D scene setup"?

• I can definitely see a use for a "GDScript Cheat Sheet" showing some of the things you've listed in the "Scripting" section - although you have some node usage items in that section too.

[eon-s]

Cheat sheets are mostly for people that know what they want but can't remember how or where to look at, and the current state of the documentation is not good for that.

Going to the points:

• For complex subjects like editor usage can just link to proper documentation entries but with a list of the subjects (animation of positions, using bezier curves, discrete animations, etc.), for others, like gdscript, can be a summary of examples and snippets, maybe this can be in a FAQ format.

• With basic scene setup I mean the common order of the node tree for making a character, a physical object, canvas layers for UI, basic things that people tend to forget when coming and going from one technology to another, and that take several minutes to see in a tutorial.

  • The scripting thing may be the easiest to make and yes, includes node usage because some parts are tied to the engine (like getting nodes or using process).

[eadmaster]

some cheat sheets were here: https://docs.huihoo.com/godotengine/godot-docs/godot/reference/_cheat_sheets.html