summaryrefslogtreecommitdiff
path: root/doc/classes/Engine.xml
AgeCommit message (Collapse)Author
2022-08-08Merge pull request #64008 from YuriSizov/doctool-add-param-reference-syntaxRémi Verschelde
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-08-08Print expected `os.arch` tuple for current platform in GDExtension errorHugo Locurcio
This also adds `Engine.get_architecture_name()` to get the name of the CPU architecture the Godot binary was built for.
2022-07-27Add a Movie Quit On Finish property to AnimationPlayerHugo Locurcio
This quits the project when an animation is done playing in the given AnimationPlayer, but only in Movie Maker mode. When this happens, a message is printed with the absolute path of the AnimationPlayer node that caused the engine to quit. This can be used to create videos that stop at a specified time without having to write any script. A report is now also printed to the console when the video is done recording (as long as the engine was exited properly). This report is unfortunately not always visible in the editor's Output panel, as it's printed too late. A method was also added to get the path to the output file from the scripting API.
2022-03-27Add GDExtension support to Scriptreduz
* Ability to create script languages from GDExtension * Some additions to gdnative_extension.h to make this happen * Moved the GDExtension binder to core This now allows creating scripting languages from GDExtension, with the same ease as if it was a module. It replaces the old PluginScript from Godot 3.x. Warning: GodotCPP will need to be updated to support this (it may be a bit of work as ScriptInstance needs to be created over there again).
2022-02-15Add an XML schema for documentationHugo Locurcio
This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions.
2021-12-06Document physics simulation being limited to 8 ticks per rendered frameHugo Locurcio
2021-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-09-25Merge pull request #52855 from Calinou/engine-editor-hint-getter-onlyRémi Verschelde
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-09-20Remove `Engine.editor_hint` in favor of `Engine.is_editor_hint()`Hugo Locurcio
The `Engine.set_editor_hint()` setter method is no longer exposed to scripting, which makes the property effectively read-only from an user perspective.
2021-09-12Improve documentation for `Engine.get_process_frames/get_physics_frames()`Hugo Locurcio
2021-08-25Add ability to register singletons from engine APIreduz
* Exposed functions in Engine to register and unregister singletons. * Added the concept of user singletons, which can be removed (the system ones can't).
2021-08-11Rename `iterations_per_second` to `physics_ticks_per_second`Hugo Locurcio
This makes it clearer that this property is only about physics FPS, not rendering FPS. The `physics_fps` project setting was also renamed to `physics_ticks_per_second` for consistency.
2021-07-30doc: Use self-closing tags for `return` and `argument`Rémi Verschelde
For the time being we don't support writing a description for those, preferring having all details in the method's description. Using self-closing tags saves half the lines, and prevents contributors from thinking that they should write the argument or return documentation there.
2021-07-23Fix doc typosNicholas Huelin
This pull request fixes an assortment of typos and improves conciseness in `Animation`, `Area2D`, `Array`, `ArrayMesh`, `Control`, `Directory`, `EditorPlugin`, `Engine`, and `OS`.
2021-06-20Merge pull request #48359 from Calinou/add-engine-print-error-propertyRémi Verschelde
2021-06-08Tweak the physics FPS property hint to only allow reasonable valuesHugo Locurcio
Physics FPS above 1000 cause the whole project to slow down and are not very practical in the first place (since no CPU currently available can keep up).
2021-05-01Add `Engine.print_error_messages` property to disable printing errorsHugo Locurcio
This can be used during unit test suite runs to hide error and warning messages. Care should be taken when using this feature, as it can hide important information if used wrongly.
2021-04-20Improve the `Engine.editor_hint` property documentationHugo Locurcio
2021-03-19class reference proofreadingPaul Joannon
2021-01-04doc: Sync classref with current sourceRémi Verschelde
2020-12-22Rename MainLoop methods to match Node methodsMarcel Admiraal
2020-11-01Port code examples to C# (D)HaSa1002
Includes: * Decal * Dictionary * Directory * DisplayServer * DTLSServer * DynamicFont * EditorImportPlugin * EditorPlugin * EditorScenePostImport * EditorScript * EditorSettings * EditorTranslationParserPlugin * Engine * Expression Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-08-14Update AUTHORS and DONORS listRémi Verschelde
New contributors added to AUTHORS: @hinlopen, @naithar, @rrcore, @SkyLucilfer, @TwistedTwigleg Thanks to all contributors and donors for making Godot possible! --- Also changes to relevant code that parses the DONORS.md to match the new tiers.
2020-05-09[DOCS] minor description changesChris Bradfield
2020-02-27Improve documentation related to fixed physics processingHugo Locurcio
2020-01-31Update docs to version 4.0clayjohn
2020-01-26doc: Drop unused 'category' property from headerRémi Verschelde
We already removed it from the online docs with #35132. Currently it can only be "Built-In Types" (Variant types) or "Core" (everything else), which is of limited use. We might also want to consider dropping it from `ClassDB` altogether in Godot 4.0.
2020-01-14Document `Engine.get_idle/physics_frames` methodsAndrii Doroshenko (Xrayez)
2020-01-10Complete documentation of various classesTomasz Chabora
2019-07-11Add access to interpolation fraction for fixed timestep interpolationlawnjelly
Addresses #30068 This is a prerequisite for allowing proper support for fixed timestep interpolation, exposing the interpolation fraction to the engine, modules and gdscript. The interpolation fraction is the fraction through the current physics tick at the time of the current frame.
2019-06-30doc: Remove hardcoded default values from descriptionsRémi Verschelde
They are now generated automatically by doctool.
2019-06-30doc: Add default values to all propertiesRémi Verschelde
Thanks to @bojidar-bg's impressive work in #29380.
2019-06-27Proofread and improve the whole class referenceHugo Locurcio
- Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies
2019-06-21Improve the `Engine.get_version_info()` documentationHugo Locurcio
This documents some keys that were missing and improves formatting.
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-05Merge pull request #27465 from ↵Rémi Verschelde
neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough EditorHelp: Improve enum ref resolving and add constant ref support
2019-04-01doc: Bump version to 3.2Rémi Verschelde
2019-03-29ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry
Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
2019-02-25doc: Sync classref with current sourceRémi Verschelde
2019-02-17Add hex-encoded version number to Engine singleton for easy comparisonsRémi Verschelde
2018-06-15doc: Remove extraneous empty lines in descriptionsRémi Verschelde
2018-05-19GDScript access to copyright, license, author and donor information.Ibrahn Sahir
Adds following functions to the Engine singleton: get_author_info - names of Godot authors get_copyright_info - detailed source copyright get_license_info get_donor_info - donor names get_license_info - full text of licenses used, indexed by license names get_license_text - the text of the Godot Expat license
2018-05-12Sync classref with current sourceRémi Verschelde
2018-05-04correct documentation for version number data typeKelly Thomas
2018-02-27doc: Remove status from hardcoded version stringRémi Verschelde
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-19doc: Update version string in headerRémi Verschelde
2018-01-25doc: Sync with current sourceRémi Verschelde
Also enhance RigidBody docs as per https://github.com/godotengine/godot-docs/pull/1018 and fix the version tag in all files (not really stable yet, but it makes no sense to hardcode rc3 at this stage).
2018-01-13doc: Sync with current sourceRémi Verschelde
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-30 19:10:53 +0000