godotengine/godot
1
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2025-11-06 12:20:30 +00:00
Code Releases Wiki Activity
77,278 Commits 19 Branches 65 Tags
af08ab49f79c30234edda8cb07b51cec86cc3cdd
Commit Graph

68 Commits

Author SHA1 Message Date
Haoyu Qiu
2952e6f6aa Improve ResourceLoader.get_dependencies()'s description 2025-06-16 16:07:53 +08:00
kobewi
13f642d959 Replace XML codeblock spaces with tabs 2025-06-06 14:35:38 +02:00
Haoyu Qiu
1e82bafa3a Remove redundant info on the enum types used 2025-06-04 08:21:47 +08:00
Wierdox
0689522e61 Normalize description of ResourceLoader.list_directory() 2025-04-17 00:09:44 -07:00
Wierdox
368335bf0a Fix incomplete description for ResourceLoader.list_directory() 2025-04-15 01:51:23 -07:00
Micky
ca4b29b18d Standardize all "Prints" comments in documentation 2024-12-23 21:26:00 +01:00
Thaddeus Crews
a07fea1e93 Merge pull request #97906 from Calinou/doc-fileaccess-non-resource-export 
Document non-resource file handling in FileAccess and ResourceLoader
 2024-11-11 14:18:39 -06:00
Thaddeus Crews
a5873ff1e8 Merge pull request #99031 from Mickeon/white-space-jumpscare 
Trim a few no-break and zero-width spaces from codebase
 2024-11-11 14:18:31 -06:00
Thaddeus Crews
c8ff788052 Merge pull request #96590 from reduz/list-directory 
Provide a reliable way to see original resources in a directory
 2024-11-11 14:18:28 -06:00
Micky
1ffe8bb191 Trim a few no-break and zero-width spaces from codebase 2024-11-10 19:04:32 +01:00
Hugo Locurcio
44b2c4e00d Clarify ResourceLoader.load_threaded_get_status() completion ratio description 2024-11-06 16:53:18 +01:00
Juan
e05d5b8813 Provide a reliable way to see original resources in a directory 
When exporting a project, resources are often moved, converted or
remapped (source import files are gone, text scenes are converted to binary,
etc).

This new function allows to list a directory and obtain the actual original
resource files.

Example

```GDScript
var resources = ResourceLoader.list_directory("res://images")
print(resources)
```
Result will be something like:
```
["image1.png","image2.png","image3.png"]
```
instead of
```
["image1.png.import","image2.png.import","image3.png.import"]
```
 2024-10-07 09:47:22 +02:00
Hugo Locurcio
f8cc67e175 Document non-resource file handling in FileAccess and ResourceLoader 2024-10-07 01:53:49 +02:00
Rémi Verschelde
8c5d1b42ab Merge pull request #92530 from Naros/expose-resource-cache-get-ref 
Expose `get_cached_ref` from `ResourceCache`
 2024-08-28 15:46:35 +02:00
Pedro J. Estébanez
ec61c5064c ResourceLoader: Support polling and get-before-complete on the main thread 2024-06-28 11:25:10 +02:00
Chris Cranford
f76b7ed5fc Expose get_cached_ref from ResourceCache 2024-05-29 18:43:56 -04:00
pgh1686
62526ed1a5 Update ResourceLoader.xml to clarify behaviour when no file is found 2024-05-05 21:39:01 -04:00
Rémi Verschelde
2ae6343533 Merge pull request #90310 from mhilbrunner/OutdatedDemos 
Update links to outdated asset library demos
 2024-04-08 11:21:38 +02:00
skyace65
c83718624f Update links to outdated asset library demos 
Update links to outdated asset library demos

Co-authored-by: Max Hilbrunner <m.hilbrunner@gmail.com>
 2024-04-07 16:59:43 +02:00
A Thousand Ships
2508c2e309 [Doc] Document loading behavior with relative paths 2024-03-30 13:33:49 +01:00
Pedro J. Estébanez
5e144022e7 Enhance cache modes in resource loading 
- Unify documentation, hoping to clear misconcepctions about about propagation of the cache mode across dependant loads.
- Clarify in docs that `CACHE_MODE_REPLACE` now also works on the main resource (from #87008).
- Add two recursive modes, counterparts of `CACHE_MODE_REPLACE` and `CACHE_MODE_IGNORE`, since it seems some need them (see #59669, #82830).
- Let resources, even loaded with one of the ignore-cache modes, get a path, which is useful for tools.
 2024-02-26 14:59:04 +01:00
kobewi
a1aa1a468f Clarify some descriptions regarding resource cache 2023-12-10 20:30:01 +01:00
kobewi
f567af413a Clarify return value of get_dependencies() 2023-07-11 13:28:34 +02:00
Rémi Verschelde
81064cc239 Doctool: Remove version attribute from XML header 
We don't use that info for anything, and it generates unnecessary diffs
every time we bump the minor version (and CI failures if we forget to
sync some files from opt-in modules (mono, text_server_fb).
 2023-07-06 10:08:21 +02:00
Rémi Verschelde
346f1ab86b Bump version to 4.2-dev 
Keep on waitin'
 2023-07-05 22:07:03 +02:00
VolTer
04562662d3 Overhaul the top sections of the class reference (Core classes) 2023-05-19 07:04:48 +02:00
Hugo Locurcio
febc674f48 Document caveats related to exported project binary resource conversion 2023-05-08 07:02:00 +02:00
Rémi Verschelde
1c1524a651 Bump version to 4.1-dev 
Can't stop, won't stop, they said, huh?
 2023-03-01 01:44:37 +01:00
Andy Maloney
1f72f48361 [doc] Use "param" instead of "code" to refer to parameters #3 2022-08-09 22:00:19 -04:00
Yuri Sizov
c5d7115038 Rename the argument tag to param in XML documentation 2022-08-08 22:34:31 +03:00
Robin Arys
1cfe3c3f8b Expose load_threaded_request's cachemode to GDScript 2022-07-31 14:04:11 +02:00
luz paz
38aaaa3cf9 Fix various typos not caught by codespell 
Revert upstream `core/input/gamecontrollerdb.txt`. Upstream fix: https://github.com/gabomdq/SDL_GameControllerDB/pull/600
 2022-07-21 07:38:23 -04:00
Rémi Verschelde
fa2dcc7ace Merge pull request #47935 from HaSa1002/doc-loading-run-time 2022-07-20 22:33:49 +02:00
leogeier
359f7fc51f Exposes methods for adding and removing ResourceFormatLoaders and -Savers in the ClassDB 2022-06-29 21:38:20 +02:00
Johannes Witt
8c7d4996c9 Document how to load Images and MP3 files at run-time 2022-06-16 13:18:36 +02:00
Hugo Locurcio
b68dd2e189 Add an XML schema for documentation 
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.
 2022-02-15 00:03:31 +01:00
Fabio Alessandrelli
9798d08ac2 [Core] Expose ResourceLoader.get_resource_uid. 2021-08-09 16:26:56 +02:00
Rémi Verschelde
7adf4cc9b5 doc: Use self-closing tags for return and argument 
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-30 15:29:52 +02:00
Michael Alexsander Silva Dias
0ff4095b36 Better format arguments in variant parser 2021-06-18 00:06:40 -03:00
Rémi Verschelde
0d1d719178 doc: Sync classref with current source 
And fix various bogus bindings following previous PRs.
 2021-02-19 14:39:14 +01:00
skyace65
dbcc9d3600 Document what can be used as a type hint 2020-12-15 19:16:43 -05:00
Rémi Verschelde
3556bc48a1 Merge pull request #42439 from Xrayez/doc-gdscript-load-and-resloader-xref 
Cross-reference GDScript `load` and `ResourceLoader.load` in classref
 2020-10-04 20:48:07 +02:00
Aaron Franke
439be614f4 Link to demos from within the class reference 2020-10-01 23:57:21 -04:00
Andrii Doroshenko (Xrayez)
a8404cf56c Cross-reference GDScript load and ResourceLoader.load in classref 
The GDScript `load` mention is moved from the class `ResourceLoader`
description to the `ResourceLoader.load` method description instead,
where it is more likely to be found.
 2020-09-30 23:03:36 +03:00
Tomasz Chabora
e103f21a40 Add LOTS of missing docs 2020-03-13 16:35:03 +01:00
Rémi Verschelde
5332853b62 doc: Fix wrong reference after last update 2020-02-29 22:35:23 +01:00
Rémi Verschelde
16486a9055 doc: Sync classref with current source 2020-02-29 14:22:57 +01:00
Rémi Verschelde
213a85521d doc: Sync classref with current source 
Handle removal of Pool*Array types and other recent changes.
 2020-02-18 14:02:02 +01:00
Rémi Verschelde
54ac8eaba6 Remove more deprecated methods and code 2020-02-13 12:37:45 +01:00
clayjohn
57e27683ba Update docs to version 4.0 2020-01-31 17:15:41 -08:00