1230169ad1
Fix broken links in Class Reference
...
(cherry picked from commit b1153f8829
2021-12-10 17:30:31 +01:00
03bfedc67c
Improve store_string() description
...
(cherry picked from commit 09b1fc1956
2021-12-07 09:14:27 +01:00
1d07feca54
Merge pull request #49042 from madmiraal/fix-docs-4085-3.x
...
[3.x] Clarify that eof_reached() cannot be used to check if more data is available
2021-09-16 00:20:12 +02:00
f0b37b1519
doc: Point URLs to 3.4 version of the online docs
2021-08-12 17:08:10 +02:00
b3c555504f
Improve documentation and simplifies code for `File::get_csv_line()`
...
Also forbids using double quotes as a delimiter.
(cherry picked from commit b8c08ba5ad
2021-08-06 11:13:43 +02:00
f5836b40d4
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.
(cherry picked from commit 7adf4cc9b5
2021-08-03 10:20:19 +02:00
f72ce41700
Update File.store_var description to mention which properties of an object are included.
...
(cherry picked from commit 2b7c0cfb34
2021-06-29 14:02:24 +02:00
b84714055b
Clarify that eof_reached() cannot be used to check if more data is available
2021-05-24 19:42:37 +01:00
c0ccde9752
Document that `File.open_compressed()` can only open files saved by Godot
...
(cherry picked from commit 5f098d6db6
2021-05-05 15:28:12 +02:00
c3272997cd
doc: Update classref headers with 3.4 version
2021-04-26 13:15:29 +02:00
015973df04
doc: Make all tutorial links point to 3.3 branch of docs
2021-03-26 10:43:43 +01:00
1aba997d75
doc: Sync classref with 3.3 version bump
2021-03-23 13:40:34 +01:00
6c6f4e9895
Expose a `File.flush()` method to scripting
...
This can be used to ensure a file has its contents saved
even if the project crashes or is killed by the user
(among other use cases).
See discussion in #29075 .
(cherry picked from commit ab397460e9
2021-02-16 14:27:38 +01:00
ee89da129f
Improve the `File.endian_swap` documentation
...
(cherry picked from commit c5f0db45df
2021-02-05 09:26:09 +01:00
4287af5148
doc: Make docs.godotengine.org links point to 3.2 branch
2020-10-19 16:10:01 +02:00
069ed4ec63
Link to demos from within the class reference
...
(cherry picked from commit 439be614f4
2020-10-19 16:10:01 +02:00
35d58c4435
Clarify store_string vs store_line.
...
While the behavior can be implied from the name, it seems worth stating
it explicitly.
(cherry picked from commit 2762821c08
2020-10-01 16:00:47 +02:00
a2c4564dc3
Move note about using Resource in the File documentation
...
(cherry picked from commit 75c5a8b354
2020-09-29 08:54:45 +02:00
fdb5561e55
Updated cursor positioning description for File open()
...
Added more details about the cursor offsets for the different ModeFlags
in the `File` class.
(cherry picked from commit 5e77eea216
2020-08-31 15:29:43 +02:00
3869b82bc1
Added missing information about File.open_encrypted function to docs.
...
(cherry picked from commit 3f6a7c74e3
2020-07-31 13:08:59 +02:00
753ff1fad2
Mention the Data paths documentation in the File class
...
This closes https://github.com/godotengine/godot-docs/issues/3799 .
(cherry picked from commit d4085d6bfb
2020-07-24 10:31:57 +02:00
3202df9b5c
doc: Make File store/get integer methods clearer
...
Add an example on how to store signed integers on less than 64 bits,
using one bit for the signedness.
(cherry picked from commit cd25d184a5
2020-06-10 15:30:52 +02:00
2ef1ee9da7
Improve the `File.store_{8,16,32,64}()` documentation
...
Added information about the intervals of values that the functions
`store_{8,16,32,64}()` can correctly write to the file.
(cherry picked from commit 97e20b2f30
2020-04-16 11:44:58 +02:00
2d20fc39aa
doc: Drop unused 'category' property from header
...
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-26 16:02:39 +01:00
c6cea6e9b3
doc: Add default values to all properties
...
Thanks to @bojidar-bg's impressive work in #29380 .
2019-06-30 13:58:07 +02:00
f7f6115f76
Proofread and improve the whole class reference
...
- 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-27 22:30:19 +02:00
528c4722d6
doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferred
2019-06-27 14:43:37 +02:00
0764451dc5
doc: Improve docs for Resource* classes
...
Also move module-specific classes to their own module's `doc_classes`
folder.
2019-06-18 20:07:26 +02:00
6af69f851a
doc: Drop unused <demos> tag
2019-04-19 11:03:46 +02:00
09e94aa087
doc: Sync classref with current source
2019-04-15 14:49:41 +02:00
d1c095b30a
Clarify encoding used for text by the File class
2019-04-06 12:39:58 +02:00
e3bd84fa57
Merge pull request #27485 from Faless/io/encode_decode_safety_pr
...
Safer encode/decode variant.
2019-04-01 17:00:40 +02:00
393e62b98a
Add object encoding param to serialization methods
...
Network peers get_var/put_var
File get_var/store_var
GDScript/Mono/VisualScript bytes2var/var2bytes
Add MultiplayerAPI.allow_object_decoding member which deprecates PacketPeer.allow_object_decoding.
Break ABI compatibaility (API compatibility for GDNative).
2019-04-01 15:53:19 +02:00
39c868171e
doc: Bump version to 3.2
2019-04-01 12:33:56 +02:00
1aa7e22b67
Clear up eof_reached function, fixes #16919
2019-02-17 09:05:32 -03:00
33d8c19999
doc: Add caveat for File.file_exists for imported resources
...
Fixes #25347 .
2019-01-26 20:25:36 +01:00
6cdcde7114
doc: Add missing commas after "If true/false"
2018-12-20 13:47:12 +01:00
daa9092ed3
doc: Sync classref with current source
2018-11-20 09:34:45 +01:00
48166a9f3c
Add store_csv_line method for File
2018-11-16 11:09:05 +01:00
5f8af252e8
doc: Use HTTPS for docs.godotengine.org and point to latest branch
...
Fixes #23509 .
2018-11-05 08:46:27 +01:00
98b59cf2a3
Add support for tutorial links to makerst.py
...
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-12 17:40:24 +02:00
8569a0db3c
Doc: Fix typo in File documentation
...
Fixes #19383 .
2018-06-05 21:04:58 +02:00
cb7fe2c793
doc: Sync classref with current source
2018-04-10 10:12:42 +02:00
a4e64c5454
Added File.get_path and File.get_path_absolute functions
2018-03-13 12:07:37 -03:00
3fa77b3172
doc: Remove status from hardcoded version string
...
It has no practical use case and just generates noise for each alpha, beta, etc.
2018-02-27 13:40:49 +01:00
612ab4bbc6
Fix typos with codespell
...
Found via `codespell -q 3 --skip="./thirdparty,./editor/translations" -I ../godot-word-whitelist.txt`
Whitelist consists of:
```
ang
doubleclick
lod
nd
que
te
unselect
```
2018-02-21 19:46:06 +01:00
3c7a39b40c
doc: Update version string in header
2018-02-19 10:46:33 +01:00
f2e3825616
doc: Fix references to online tutorials after godotengine/godot-docs#1015
2018-01-25 09:03:59 +01:00
d516aab8fa
doc: Sync with current source
...
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-25 08:50:56 +01:00
6c46787749
doc: Replace some more "val" with "value" + sync
2018-01-17 10:43:23 +01:00
Haoyu Qiu
kobewi
Max Hilbrunner
Rémi Verschelde
Levi Lindsey
Marcel Admiraal
Hugo Locurcio
Aaron Franke
Ryan Roden-Corrent
skyace65
Maganty Rushyendra
codetorex
Danil Alexeev
shartte
Fabio Alessandrelli
Juan Linietsky
Kanabenki
robojumper
Marcelo Fernandez
luz.paz