summaryrefslogtreecommitdiffstats
path: root/modules/webrtc/doc_classes
Commit message (Collapse)AuthorAgeFilesLines
* Avoid punning enum names in documentationHaoyu Qiu2023-11-091-1/+1
|
* Fix typo in WebRTCPeerConnection documentationazuloo2023-08-301-1/+1
|
* Doctool: Remove version attribute from XML headerRémi Verschelde2023-07-065-5/+5
| | | | | | 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-055-5/+5
| | | | Keep on waitin'
* Directly expose WebRTCPeerConnection::create_data_channel() to GDExtensionDavid Snopek2023-06-141-1/+1
|
* Validate code tags in documentation for potential paramsYuri Sizov2023-04-262-17/+17
| | | | | | | Adds a check to make_rst to look for matches between the text inside of the [code][/code] tag and known param identifiers. Fixes most of what was revealed.
* Bump version to 4.1-devRémi Verschelde2023-03-015-5/+5
| | | | Can't stop, won't stop, they said, huh?
* Use capitalized ID in the docHaoyu Qiu2022-12-081-2/+2
|
* [MP] Remove connection state signals from MultiplayerPeer.Fabio Alessandrelli2022-11-021-1/+1
| | | | Now handled directly by the MultiplayerAPI implementation.
* [MP] Add MultiplayerPeer disconnect_peer, close.Fabio Alessandrelli2022-10-281-6/+0
| | | | | Update ENet, WebRTC, and WebSocket to support peer disconnection and unify the close function.
* [MP] Let MultiplayerAPI handle packet relaying and peer signaling.Fabio Alessandrelli2022-10-271-13/+26
| | | | | | | | | | | | | | | | | | | | | | | | | | | | MultiplayerPeer changes: - Adds is_server_relay_supported virtual method Informs the upper MultiplayerAPI layer if it can signal peers connected to the server to other clients, and perform packet relaying among them. - Adds get_packet_channel and get_packet_mode virtual methods Allows the MultiplayerAPI to retrieve the channel and transfer modes to use when relaying the last received packet. SceneMultiplayerPeer changes: - Implement peer signaling and packet relaying when the MultiplayerPeer advertise they are supported. ENet, WebRTC, WebSocket changes: - Removed custom code for relaying from WebSocket and ENet, and let it be handled by the upper layer. - Update WebRTC to split create_client, create_server, and create_mesh, with the latter behaving like the old initialize with "server_compatibility = false", and the first two supporting the upper layer relaying protocol.
* [WebRTC] Expose more of the WebRTC API.Fabio Alessandrelli2022-09-132-0/+49
| | | | | | | | | | Add get_gathering_state() returning the iceGatheringState of the connection. Add get_signaling_state() returning the signalingState of the connection. Improve JS library.
* Simplify network GDExtension bindings using EXBIND macros.Fabio Alessandrelli2022-09-012-13/+13
| | | | | | Simplify StreamPeer, PacketPeer, MultiplayerPeer extension. Simplify and update WebRTC*Extension with newly supported types.
* Rename the argument tag to param in XML documentationYuri Sizov2022-08-084-41/+41
|
* [Net] Modularize multiplayer, expose MultiplayerAPI to extensions.Fabio Alessandrelli2022-07-261-1/+1
| | | | | | | | | - RPC configurations are now dictionaries. - Script.get_rpc_methods renamed to Script.get_rpc_config. - Node.rpc[_id] and Callable.rpc now return an Error. - Refactor MultiplayerAPI to allow extension. - New MultiplayerAPI.rpc method with Array argument (for scripts). - Move the default MultiplayerAPI implementation to a module.
* [WebRTC] Static extension registration.Fabio Alessandrelli2022-06-092-5/+7
|
* Add an XML schema for documentationHugo Locurcio2022-02-155-5/+5
| | | | | | | | 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.
* Improve some signal bindings to use specific `Object` subtypesRémi Verschelde2022-01-281-1/+1
|
* Dictionary: Serialize empty dict as `{}` instead of `{\n}`Rémi Verschelde2022-01-181-4/+2
| | | | | Also make sure to always convert multiline dictionaries to a single line for its EditorHelp representation, as multiline values break formatting.
* Fix usage of "Return" in the docskobewi2022-01-021-1/+1
|
* doc: Fix style inconsistencies for `[b]Note:[/b]` paragraphsRémi Verschelde2021-10-051-1/+2
| | | | And fix up formatting not supported by makerst.
* Fix const pointers types in docs and extension API.Fabio Alessandrelli2021-09-291-2/+2
| | | | | | The GDVIRTUAL_NATIVE_PTR did not declare the correct GDNativeConstPtr template, resulting in "void*" being used as it's type info in both the documentation and the extension API dump.
* Merge pull request #52481 from Faless/net/4.x_native_peersFabio Alessandrelli2021-09-283-4/+177
|\ | | | | [Net] Extension system for network peers, webrtc.
| * [Net/Docs] Update extensions documentation.Fabio Alessandrelli2021-09-243-4/+177
| |
* | 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
|
* Multiplayer networking renames/simplificationMax Hilbrunner2021-09-081-1/+1
| | | | Removes _networking_ prefix from some methods and members, now that multiplayer has been largely moved out of Node and SceneTree and is seperated into its own set of classes.
* [Net] Move multiplayer to core subdir, split RPCManager.Fabio Alessandrelli2021-09-071-2/+2
| | | | | | | | | | | Move multiplayer classes to "core/multiplayer" subdir. Move the RPCConfig and enums (TransferMode, RPCMode) to a separate file (multiplayer.h), and bind them to the global namespace. Move the RPC handling code to its own class (RPCManager). Renames "get_rpc_sender_id" to "get_remote_sender_id".
* [Net] Implement RPC channels in MultiplayerAPI.Fabio Alessandrelli2021-07-301-0/+2
|
* doc: Use self-closing tags for `return` and `argument`Rémi Verschelde2021-07-303-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.
* Add get_buffered_amount() to WebRTCDataChannelDavid Snopek2021-07-201-0/+7
|
* [Net] Rename WebRTCMultiplayer to WebRTCMultiplayerPeer.Fabio Alessandrelli2021-07-121-1/+1
|
* [Net] Rename NetworkedMultiplayerPeer to MultiplayerPeer.Fabio Alessandrelli2021-07-121-6/+6
|
* Rename Reference to RefCountedPedro J. Estébanez2021-06-111-1/+1
|
* Fix typos with codespellRémi Verschelde2021-05-201-1/+1
| | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | | Using codespell 2.0.0. Method: ``` $ cat > ../godot-word-whitelist.txt << EOF ang curvelinear dof doubleclick fave findn GIRD leapyear lod merchantibility nd numer ois ony que seeked synching te uint unselect webp EOF $ codespell -w -q 3 -I ../godot-word-whitelist.txt --skip="./thirdparty,*.po" $ git diff // undo unwanted changes ```
* doc: Sync classref with current sourceRémi Verschelde2020-10-091-2/+0
|
* Fix TURN server example in WebRTC documentationPouleyKetchoupp2020-09-081-1/+1
| | | | | WebRTC GDNative plugin uses `credential` and not `credentials`. https://github.com/godotengine/webrtc-native/blob/74f2c78db5cdffa5b2b6ba9cd041061d7694400c/src/WebRTCLibPeerConnection.cpp#L35-L37
* Fix WebRTCPeerConnection set_local_description docFabio Alessandrelli2020-06-041-1/+1
| | | | | | ice_candidate_created should be emitted after set_local_description no matter the type of the description (assuming no error is returned of course).
* Update docs to version 4.0clayjohn2020-01-313-3/+3
|
* doc: Drop unused 'category' property from headerRémi Verschelde2020-01-263-3/+3
| | | | | | | | | | 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: Misc updates for AnimationNode* and othersRémi Verschelde2020-01-232-2/+2
| | | | | | | | | | | | | - Add some missing descriptions. - Add links to tutorials for ARVR and AnimationTree. - Style fixes. - Engine changes: * Make `AnimationNodeTransition.input_<number>` properties internal so that they don't appear in the docs. They still appear in the inspector based on the actual number of inputs requested. * Drop unimplemented `CPUParticles.flatness`. It's only used for 3D particles in `ParticlesMaterial`, and thus only relevant for `CPUParticles3D`.
* doc: Fix parsing of self-closing XML tagsRémi Verschelde2019-09-241-2/+2
| | | | | | | Follow-up to #31925, `<member />` tags just before `</members>` would cause a parsing issue, and we'd never notice that we're no longer parsing members. Also added space before closing `/>`.
* Run doctool after overridden properties changesBojidar Marinov2019-09-041-0/+4
|
* 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-2/+2
| | | | | | | | | | | | | - 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
* doc: Replace all [code]CONSTANT[/code] by new [constant CONSTANT] hyperlinksRémi Verschelde2019-06-271-2/+2
|
* doc: Fix scoped hyperlinks to same-class enums/methodsRémi Verschelde2019-06-271-1/+1
| | | | The class name does not need to be specified when it is the current class.
* doc: Fix formatting, typos and some descriptions in new docstringsRémi Verschelde2019-06-152-15/+13
|
* Add documentation for WebRTC classes.Fabio Alessandrelli2019-06-143-0/+169
|
* WebRTC refactor. Data channels, STUN/TURN support.Fabio Alessandrelli2019-05-162-18/+133
| | | | | | | | | | | | | | | A big refactor to the WebRTC module. API is now considered quite stable. Highlights: - Renamed `WebRTCPeer` to `WebRTCPeerConnection`. - `WebRTCPeerConnection` no longer act as `PacketPeer`, it only handle the connection itself (a bit like `TCP_Server`) - Added new `WebRTCDataChannel` class which inherits from `PacketPeer` to handle data transfer. - Add `WebRTCPeerConnection.initialize` method to create a new connection with the desired configuration provided as dictionary ([see MDN docs](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/RTCPeerConnection#RTCConfiguration_dictionary)). - Add `WebRTCPeerConnection.create_data_channel` method to create a data channel for the given connection. The connection must be in `STATE_NEW` as specified by the standard ([see MDN docs for options](https://developer.mozilla.org/en-US/docs/Web/API/RTCPeerConnection/createDataChannel#RTCDataChannelInit_dictionary)). - Add a `data_channel_received` signal to `WebRTCPeerConnection` for in-band (not negotiated) channels. - Renamed `WebRTCPeerConnection` `offer_created` signal to `session_description_created`. - Renamed `WebRTCPeerConnection` `new_ice_candidate` signal to `ice_candidate_created`