diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2018-05-09 01:41:01 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-05-09 01:41:01 +0200 |
| commit | e744d12e568c22d2f260eee15fc9b2cade3dcdd8 (patch) | |
| tree | 06c480ec011f817af8733a1208f20b7aa1fd391b /doc/classes/SceneTree.xml | |
| parent | 9a22a835f6527af3f2165ee048c875cd2ce6b2cf (diff) | |
| parent | dd546dc5b86e0bb9c397919fd8bfcf8e8460bc38 (diff) | |
Merge pull request #18709 from Faless/multiplayer_docs
Rename multiplayer_api to multiplayer, add docs
Diffstat (limited to 'doc/classes/SceneTree.xml')
| -rw-r--r-- | doc/classes/SceneTree.xml | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/doc/classes/SceneTree.xml b/doc/classes/SceneTree.xml index dec0cbbcc3..55063bbe24 100644 --- a/doc/classes/SceneTree.xml +++ b/doc/classes/SceneTree.xml @@ -266,7 +266,8 @@ <member name="edited_scene_root" type="Node" setter="set_edited_scene_root" getter="get_edited_scene_root"> The root of the edited scene. </member> - <member name="multiplayer_api" type="MultiplayerAPI" setter="set_multiplayer_api" getter="get_multiplayer_api"> + <member name="multiplayer" type="MultiplayerAPI" setter="set_multiplayer" getter="get_multiplayer"> + The default [MultiplayerAPI] instance for this SceneTree. </member> <member name="network_peer" type="NetworkedMultiplayerPeer" setter="set_network_peer" getter="get_network_peer"> The peer object to handle the RPC system (effectively enabling networking when set). Depending on the peer itself, the SceneTree will become a network server (check with [method is_network_server()]) and will set root node's network mode to master (see NETWORK_MODE_* constants in [Node]), or it will become a regular peer with root node set to slave. All child nodes are set to inherit the network mode by default. Handling of networking-related events (connection, disconnection, new clients) is done by connecting to SceneTree's signals. |