summaryrefslogtreecommitdiffstats
path: root/doc/classes/StreamPeer.xml
Commit message (Collapse)AuthorAgeFilesLines
* Add half precision floating point support to `StreamPeer`Pablo Andres Fuente2024-11-121-0/+13
| | | | | | | | | | | Closes godotengine/godot-proposals#5983 Adds put/get methods to `StreamPeer` that handles half precision floating point values. Adds endode/decode half precision floating point to `marshalls`. Adds `get_half` and `store_half` to `FileAccess` Co-Authored-By: "Alfonso J. Ramos" <theraot@gmail.com>
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-061-1/+1
| | | | | | 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).
* Bump version to 4.2-devRémi Verschelde2023-07-051-1/+1
| | | | Keep on waitin'
* Merge pull request #76526 from MewPurPur/improve-docs-top-sections-COREYuri Sizov2023-05-291-2/+2
|\ | | | | Overhaul the top sections of the class reference (Core classes)
| * Overhaul the top sections of the class reference (Core classes)VolTer2023-05-191-2/+2
| |
* | Minor grammar fixes to documentationNinni Pipping2023-05-281-2/+2
|/
* Make documentation sorting use natural orderNinni Pipping2023-05-091-26/+26
|
* Change to_utf8 to to_utf8_buffer and to_ascii to to_ascii_buffer in ↵mara2023-04-101-4/+4
| | | | | | | | remaining docs The method `to_utf8` doesn't exist in Godot 4, but is still mentioned in the documentation in some places. Replace it with the new name `to_utf8_buffer`. Same for ascii. Same for C#.
* Bump version to 4.1-devRémi Verschelde2023-03-011-1/+1
| | | | Can't stop, won't stop, they said, huh?
* Merge pull request #71572 from RedMser/docs-binary-variantYuri Sizov2023-02-101-0/+2
|\ | | | | Document internal usage of `encode`/`decode_variant`
| * Document internal usage of encode/decode_variantRedMser2023-01-171-0/+2
| |
* | Fix C# examples in documentationRaul Santos2023-01-311-1/+1
|/ | | | | | | | | | - Fix documentation after C# renames. - Add missing `partial` in C# class declarations. - Change `delta` parameter type to `double` in C#. - Ensure parameters match base declaration. - Use `$` string interpolation in C#. - Fix invalid or outdated C# code. - Changed some examples to follow our style guide more closely.
* Style: Misc docs and comment style and language fixesRémi Verschelde2022-11-021-4/+4
| | | | | | | | | | - Removed empty paragraphs in XML. - Consistently use bold style for "Example:", on a new line. - Fix usage of `[code]` when hyperlinks could be used (`[member]`, `[constant]`). - Fix invalid usage of backticks for inline code in BBCode. - Fix some American/British English spelling inconsistencies. - Other minor fixes spotted along the way, including typo fixes with codespell. - Don't specify `@GlobalScope` for `enum` and `constant`.
* [doc] Fix grammar in class docs: amount vs. numberAndy Maloney2022-08-171-3/+3
| | | | | | Number is used for things that can be counted (discrete items - think "integer" in this context). Also fixes a couple of awkward phrases.
* [doc] Use "param" instead of "code" to refer to parameters #3Andy Maloney2022-08-091-5/+5
|
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-081-21/+21
|
* Add an XML schema for documentationHugo Locurcio2022-02-151-1/+1
| | | | | | | | 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.
* Fix multiple missing UTF-8 decoding.bruvzg2022-01-061-1/+1
|
* doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphsRémi Verschelde2021-10-051-2/+2
| | | | And fix up formatting not supported by makerst.
* Document Android permission requirements for network access where neededHugo Locurcio2021-09-251-0/+1
|
* Don't generate empty doc sections and reduce code duplicationAaron Franke2021-09-201-2/+0
|
* doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-301-104/+52
| | | | | | | | 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.
* Rename Reference to RefCountedPedro J. Estébanez2021-06-111-1/+1
|
* [Doc] Remove reference to UNIX sockets in StreamPeer.Fabio Alessandrelli2021-05-201-1/+1
| | | | | That class can be used as a base to implement them, but there is no actual implementation for it in Godot.
* Docs: Port Code Examples to C# (R, S, T, U)HaSa10022021-03-051-4/+14
| | | | | | | | | | | | | | | | | | | | | * RenderingServer * RichTextEffect * SceneTree * SceneTreeTimer * ScriptCreateDialog * SpinBox * Sprite2D * StreamPeer * String * SurfaceTool * TextEdit * TileMap * Tree * Tween * UDPServer * UndoRedo Co-authored-by: Aaron Franke <arnfranke@yahoo.com>
* doc: Sync classref with current sourceRémi Verschelde2020-02-181-2/+2
| | | | Handle removal of Pool*Array types and other recent changes.
* Update docs to version 4.0clayjohn2020-01-311-1/+1
|
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-261-1/+1
| | | | | | | | | | 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.
* doc: Add note about sending strings without size in StreamPeerRémi Verschelde2019-10-041-0/+8
| | | | Follow-up to #29153.
* doc: Add default values to all propertiesRémi Verschelde2019-06-301-1/+1
| | | | Thanks to @bojidar-bg's impressive work in #29380.
* Proofread and improve the whole class referenceHugo Locurcio2019-06-271-32/+32
| | | | | | | | | | | | | - 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
* Change "Return" to "Returns" where necessary in XML documentationSean Heffernan2019-05-231-3/+3
| | | | | | | | In many of the XML files it had been noted that when the documentation refers to a return value, both "Return" and "Returns" are used. This has now been fixed to only say "Returns". Fixes #28867
* doc: Drop unused <demos> tagRémi Verschelde2019-04-191-2/+0
|
* Merge pull request #27465 from ↵Rémi Verschelde2019-04-051-2/+2
|\ | | | | | | | | neikeq/road-to-lang-agnostic-docs-is-going-to-be-tough EditorHelp: Improve enum ref resolving and add constant ref support
| * ClassRef: Replace [code]CurrentClass[/code] with [CurrentClass]Ignacio Etcheverry2019-03-291-2/+2
| | | | | | | | Modified makerst to generate code tags for these to avoid hyperlinks to the same class.
* | Merge pull request #27485 from Faless/io/encode_decode_safety_prRémi Verschelde2019-04-011-2/+7
|\ \ | | | | | | Safer encode/decode variant.
| * | Add object encoding param to serialization methodsFabio Alessandrelli2019-04-011-2/+7
| |/ | | | | | | | | | | | | | | | | 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).
* / doc: Bump version to 3.2Rémi Verschelde2019-04-011-1/+1
|/
* StreamPeer get[_utf8]_string with negative length.Fabio Alessandrelli2018-09-221-5/+14
| | | | | | | | | If the "bytes" parameter of get_string and get_utf8_string is negative, the length will be read from the stream instead. The bytes parameter has now a default (-1), allowing to use them directly as reverses of put_string and put_utf8_string . put_string was not implemented, so I implemented it to allow sending ASCII strings (which are much smaller than UTF8 ones).
* doc: Remove status from hardcoded version stringRémi Verschelde2018-02-271-1/+1
| | | | It has no practical use case and just generates noise for each alpha, beta, etc.
* doc: Update version string in headerRémi Verschelde2018-02-191-1/+1
|
* doc: Sync with current sourceRémi Verschelde2018-01-251-1/+1
| | | | | | 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).
* doc: Replace some more "val" with "value" + syncRémi Verschelde2018-01-171-12/+12
|
* doc: Update version string in XMLRémi Verschelde2018-01-131-1/+1
|
* Update docsBojidar Marinov2018-01-121-16/+5
| | | | [ci skip]
* Minor docs fixPoommetee Ketson2017-12-311-1/+1
|
* doc: Update header version for 3.0-betaRémi Verschelde2017-11-241-1/+1
|
* doc: Remove revision.module_config from version stringRémi Verschelde2017-11-151-1/+1
| | | | | It is now "3.0-alpha" instead of "3.0.alpha.custom_build{,.mono}", limits unnecessary diffs.
* classref: Sync with current sourceRémi Verschelde2017-10-221-3/+3
| | | | | Also fix hyperlink references to same class as per the guidelines. [ci skip]
* Changed the doc class generation to individual files per class. It is also ↵Juan Linietsky2017-09-121-0/+279
possible to save module files in module directories and the build system will recognize them.