learning_new_features.rst 4.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114
  1. .. _doc_learning_new_features:
  2. Learning new features
  3. =====================
  4. This page explains how to learn more about things you do not know.
  5. The Manual and Class Reference
  6. ------------------------------
  7. What you are reading now is the manual. It provides an overview of each of the
  8. engine's concepts. When learning a new topic, start with the manual to see if
  9. it already has an official explanation. If a page exists for a topic, it will
  10. often link to more related content.
  11. Godot provides most of its features through its scripting API ("Application
  12. Programmer Interface"). This is the collection of Nodes, Resources, and other
  13. classes available to your scenes and scripts. The
  14. :ref:`Class Reference <toc-class-ref>` provides detailed explanations of
  15. every class. This includes...
  16. 1. Where the class exists in the inheritance hierarchy.
  17. 2. An explanation of the class's properties, methods, signals, enums, and
  18. constants.
  19. 3. Links to manual pages further detailing the class.
  20. 4. A summary of the class's role and use cases in the Godot API.
  21. If the manual or class reference is missing or has insufficient information,
  22. please open an Issue in the official
  23. `godot-docs <https://github.com/godotengine/godot-docs/issues>`_ GitHub
  24. repository to report it.
  25. In the top-left corner of the documentation, you can search the manual and
  26. class reference for anything.
  27. You will also find an offline Godot API reference within the Godot Editor.
  28. Click F4 to begin searching the Godot API, or go to Help > Search Help in the
  29. main toolbar. Ctrl-clicking the name of a class, property, method, signal, or
  30. constant will also open its description.
  31. Tutorials
  32. ---------
  33. The manual and class reference do not cover basic programming concepts.
  34. For this, please use external learning resources such as the free
  35. and open `CS50 courseware at Harvard <https://cs50.harvard.edu/x/2020/>`_
  36. or
  37. `Al Sweigart's Automate The Boring Stuff With Python <https://automatetheboringstuff.com/>`_
  38. series.
  39. Besides the 2D and 3D getting started series, they also do not cover tutorials.
  40. For more detailed breakdowns of how to use Godot for specific tasks, please
  41. see :ref:`doc_community_tutorials` for content made by the Godot community.
  42. Questions
  43. ---------
  44. If you have specific questions, please ask them in your preferred
  45. :ref:`doc_community_channels`.
  46. Please submit your questions to the official Q&A site. Share links to your
  47. questions on other social platforms as needed. Q&A responses show up in
  48. search engine results and the core Godot developers maintain them.
  49. Before asking a question on other platforms, be sure to look for existing
  50. questions that might serve your needs using your preferred search engine.
  51. To get immediate help with live people, try the various chat-based
  52. communities such as IRC, Matrix, and Discord.
  53. When asking questions, please include the following information:
  54. 1. Which version of the engine are you using?
  55. The available solutions may differ based on which version it is.
  56. 2. What is your goal?
  57. If you are having trouble figuring out how to make a solution work, then
  58. there may be a different, easier solution that accomplishes the same goal.
  59. 3. If there is an error involved, what is the exact error message you see?
  60. Users sometimes share an inaccurate paraphrase of their errors. The exact
  61. error message in the debugger or console is precise in what it states went
  62. wrong. Knowing what it says can help community members better identify how
  63. you triggered the error.
  64. 4. If there is code involved, can you share a code sample?
  65. Seeing what code is causing the problem can provide more context for
  66. community members to better assist you. A screenshot of the scene hierarchy
  67. where the code is executing also helps.
  68. Bug Reports
  69. -----------
  70. If you think you have found a bug but are unsure, then go ahead and open a bug
  71. report on `GitHub <https://github.com/godotengine/godot/issues>`. Be sure to
  72. check through previous issues to see if you can find a similar one.
  73. If you do, please upvote the post to show that you too want to see the bug
  74. fixed. If you have more information or context to add to the bug report, please
  75. add a comment to it.
  76. If you do not find any similar past issues, then please follow the template to
  77. submit a new bug report.
  78. If you ask in a community platform and someone informs you that it is a bug,
  79. then please remember to submit the bug report. Without it, there is little
  80. chance the Godot contributors will fix it.