summaryrefslogtreecommitdiff
path: root/doc/classes/Resource.xml
AgeCommit message (Collapse)Author
2022-08-09[doc] Use "param" instead of "code" to refer to parameters #3Andy Maloney
2022-08-08Rename the argument tag to param in XML documentationYuri Sizov
2022-03-10Discern between virtual and abstract class bindingsreduz
* Previous "virtual" classes (which can't be instantiated) are not corretly named "abstract". * Added a new "virtual" category for classes, they can't be instantiated from the editor, but can be inherited from script and extensions. * Converted a large amount of classes from "abstract" to "virtual" where it makes sense. Most classes that make sense have been converted. Missing: * Physics servers * VideoStream * Script* classes. which will go in a separate PR due to the complexity involved.
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-11-15Replace Godot docs URL with `$DOCS_URL` in XML class referenceRémi Verschelde
2021-10-06doc: Update links to latest documentation after content reorganizationRémi Verschelde
2021-09-20Don't generate empty doc sections and reduce code duplicationAaron Franke
2021-09-16Merge pull request #44885 from Jummit/duplicate-docsRémi Verschelde
Clarify that duplicate only copies exported members and fails with a constructor
2021-09-12clarify what duplicate does and its limitationsJummit
2021-08-22Replace BIND_VMETHOD by new GDVIRTUAL syntaxreduz
* New syntax is type safe. * New syntax allows for type safe virtuals in native extensions. * New syntax permits extremely fast calling. Note: Everything was replaced where possible except for `_gui_input` `_input` and `_unhandled_input`. These will require API rework on a separate PR as they work different than the rest of the functions. Added a new method flag METHOD_FLAG_OBJECT_CORE, used internally. Allows to not dump the core virtuals like `_notification` to the json API, since each language will implement those as it is best fits.
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-06-19Rename `instance()`->`instantiate()` when it's a verbLightning_A
2021-06-11Rename Reference to RefCountedPedro J. Estébanez
2021-05-31Document `Resource.duplicate()` only copying exported variables' valuesHugo Locurcio
2021-01-23Document a built-in use of `Resource.resource_name`Hugo Locurcio
2021-01-13Expose `Resource.emit_changed()` to scriptAndrii Doroshenko (Xrayez)
Also known as `emit_signal("changed")`.
2021-01-11Remove the implication that references and resources are not objected from ↵skyace65
their description
2020-12-03Mention that 'changed' signal needs manual emitTomasz Chabora
2020-11-23Document C# garbage collection caveats in Reference and ResourceHugo Locurcio
2020-07-27Improve the Object, Reference and Resource class documentationsHugo Locurcio
2020-07-08Update Resource.xml to explain behavior of duplicate when subresources is ↵Bob Gardner
true and a subresource contains further nested resources. Updated documentation for duplicate() on Resource to better explain the behavior. As per #30385.
2020-02-12doc: Sync classref with current sourceRémi Verschelde
Lots of internal API changes and some docstrings were lost in the conversion. I manually salvaged many of them but for all the rendering-related ones, an additional pass is needed. Added missing enum bindings in BaseMaterial3D and VisualServer.
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.
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-26doc: Proofread and complete various nodesRémi Verschelde
All 100% completed: MainLoop, Node, Object, Path, Performance, Reference, Resource, SceneState, SceneTree, UndoRedo. Also fixed some en_GB occurrences as the reference spelling is en_US.
2019-06-18doc: Improve docs for Resource* classesRémi Verschelde
Also move module-specific classes to their own module's `doc_classes` folder.
2019-06-01doc: Make all tutorial links track "latest" in master branchRémi Verschelde
While the master branch is in development state for the next stable branch, its links should point to the "latest" docs branch, to ensure that users of the unstable builds are linked to the relevant documentation. Those links could be switched to stable branch subdomains before branching off for a new major or minor release, to start tracking the frozen stable docs branches. See discussion in #29104.
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-17Small improvements to the Resource docMichael Alexsander Silva Dias
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: Update version string in XMLRémi Verschelde
2017-11-24doc: Remove setters and getters now exposed via properties/membersRémi Verschelde
2017-11-24doc: Update header version for 3.0-betaRémi Verschelde
2017-11-15doc: Remove revision.module_config from version stringRémi Verschelde
It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
2017-10-22classref: Sync with current sourceRémi Verschelde
Also fix hyperlink references to same class as per the guidelines. [ci skip]
2017-09-13doc: Sync classref with current sourceRémi Verschelde
[ci skip]
2017-09-12Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky
possible to save module files in module directories and the build system will recognize them.
generated by cgit v1.2.3 (git 2.25.1) at 2024-11-01 23:29:59 +0000