summaryrefslogtreecommitdiff
path: root/doc/classes/File.xml
AgeCommit message (Collapse)Author
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-16Merge pull request #49041 from madmiraal/fix-docs-4085Max Hilbrunner
Clarify that eof_reached() cannot be used to check if more data is available
2021-08-22Replace HTTP links with HTTPS for sites with HTTPS versionsAaron Franke
2021-08-04Tests: Improve coverage for `File::get_csv_line()`Rémi Verschelde
Adds a few more complex edge cases which are supported. Also adds some documentation, simplifies the code a bit and forbids using double quotes as a delimiter.
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-29Merge pull request #49470 from levilindsey/masterRémi Verschelde
Update File.store_var description to mention which properties of an object are included.
2021-06-15Update File.store_var description to mention which properties of an object ↵Levi Lindsey
are included.
2021-06-12Merge pull request #49123 from aaronfranke/it-is-timeRémi Verschelde
Add a Time singleton
2021-06-11Rename Reference to RefCountedPedro J. Estébanez
2021-06-11Add Time singletonAaron Franke
2021-06-03Merge pull request #48889 from Calinou/file-rename-endian-swapRémi Verschelde
Rename File's `endian_swap` to `big_endian`
2021-05-28Clarify that eof_reached() cannot be used to check if more data is availableMarcel Admiraal
2021-05-25Rename File::get_len() get_length()Marcel Admiraal
2021-05-20Rename File's `endian_swap` to `big_endian`Hugo Locurcio
This new name is more consistent with ResourceSaver and StreamPeer.
2021-05-01Document that `File.open_compressed()` can only open files saved by GodotHugo Locurcio
2021-02-13Expose a `File.flush()` method to scriptingHugo Locurcio
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.
2021-02-02Improve the `File.endian_swap` documentationHugo Locurcio
2020-11-25Docs: Port Code Examples to C# (F, G, H, I, J, K, L)HaSa1002
Includes: * File * Geometry2D * HashingContext * HTTPClient * HTTPRequest * Image * Input * int * ItemList * JSONParseResult * KinematicBody2D * LineEdit Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
2020-10-01Link to demos from within the class referenceAaron Franke
2020-10-01Clarify store_string vs store_line.Ryan Roden-Corrent
While the behavior can be implied from the name, it seems worth stating it explicitly.
2020-09-24Move note about using Resource in the File documentationskyace65
2020-08-31Add link titles for all links in the class referenceHugo Locurcio
This makes them display in a nicer way in the editor help. (The title will display instead of the full URL.)
2020-08-04Updated cursor positioning description for File open()Maganty Rushyendra
Added more details about the cursor offsets for the different ModeFlags in the `File` class.
2020-07-31Added missing information about File.open_encrypted function to docs.codetorex
2020-07-15Mention the Data paths documentation in the File classHugo Locurcio
This closes https://github.com/godotengine/godot-docs/issues/3799.
2020-06-09doc: Make File store/get integer methods clearerRémi Verschelde
Add an example on how to store signed integers on less than 64 bits, using one bit for the signedness.
2020-03-25Improve the `File.store_{8,16,32,64}()` documentationDanil Alexeev
Added information about the intervals of values that the functions `store_{8,16,32,64}()` can correctly write to the file.
2020-02-18doc: Sync classref with current sourceRémi Verschelde
Handle removal of Pool*Array types and other recent changes.
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-27doc: Don't use `GlobalScope` scope in hyperlinks, it's automatically inferredRémi Verschelde
2019-06-18doc: Improve docs for Resource* classesRémi Verschelde
Also move module-specific classes to their own module's `doc_classes` folder.
2019-04-19doc: Drop unused <demos> tagRémi Verschelde
2019-04-15doc: Sync classref with current sourceRémi Verschelde
2019-04-06Clarify encoding used for text by the File classshartte
2019-04-01Merge pull request #27485 from Faless/io/encode_decode_safety_prRémi Verschelde
Safer encode/decode variant.
2019-04-01Add object encoding param to serialization methodsFabio Alessandrelli
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-01doc: Bump version to 3.2Rémi Verschelde
2019-02-17Clear up eof_reached function, fixes #16919Juan Linietsky
2019-01-26doc: Add caveat for File.file_exists for imported resourcesRémi Verschelde
Fixes #25347.
2018-12-20doc: Add missing commas after "If true/false"Rémi Verschelde
2018-11-20doc: Sync classref with current sourceRémi Verschelde
2018-11-16Add store_csv_line method for FileKanabenki
2018-11-05doc: Use HTTPS for docs.godotengine.org and point to latest branchRémi Verschelde
Fixes #23509.
2018-06-12Add support for tutorial links to makerst.pyrobojumper
Also change the <tutorials> structure to make use of individual <link> tags
2018-06-05Doc: Fix typo in File documentationRémi Verschelde
Fixes #19383.
2018-04-10doc: Sync classref with current sourceRémi Verschelde