mirror/godot
2
0
Fork 0
mirror of https://github.com/godotengine/godot.git synced 2024-12-27 11:24:59 +08:00
Code Issues Packages Projects Releases Wiki Activity
f79b90a6c0
godot/modules/multiplayer/scene_replication_config.cpp

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

286 lines
11 KiB
C++
Raw Normal View History

One Copyright Update to rule them all As many open source projects have started doing it, we're removing the current year from the copyright notice, so that we don't need to bump it every year. It seems like only the first year of publication is technically relevant for copyright notices, and even that seems to be something that many companies stopped listing altogether (in a version controlled codebase, the commits are a much better source of date of publication than a hardcoded copyright statement). We also now list Godot Engine contributors first as we're collectively the current maintainers of the project, and we clarify that the "exclusive" copyright of the co-founders covers the timespan before opensourcing (their further contributions are included as part of Godot Engine contributors). Also fixed "cf." Frenchism - it's meant as "refer to / see".
2023-01-05 20:25:55 +08:00
/**************************************************************************/
/* scene_replication_config.cpp */
/**************************************************************************/
/* This file is part of: */
/* GODOT ENGINE */
/* https://godotengine.org */
/**************************************************************************/
/* Copyright (c) 2014-present Godot Engine contributors (see AUTHORS.md). */
/* Copyright (c) 2007-2014 Juan Linietsky, Ariel Manzur. */
/* */
/* Permission is hereby granted, free of charge, to any person obtaining */
/* a copy of this software and associated documentation files (the */
/* "Software"), to deal in the Software without restriction, including */
/* without limitation the rights to use, copy, modify, merge, publish, */
/* distribute, sublicense, and/or sell copies of the Software, and to */
/* permit persons to whom the Software is furnished to do so, subject to */
/* the following conditions: */
/* */
/* The above copyright notice and this permission notice shall be */
/* included in all copies or substantial portions of the Software. */
/* */
/* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, */
/* EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF */
/* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. */
/* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY */
/* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, */
/* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE */
/* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. */
/**************************************************************************/
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
#include "scene_replication_config.h"
[Net] Modularize multiplayer, expose MultiplayerAPI to extensions. - 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.
2022-07-13 05:12:42 +08:00
#include "scene/main/multiplayer_api.h"
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
#include "scene/main/node.h"
bool SceneReplicationConfig::_set(const StringName &p_name, const Variant &p_value) {
Fix MSVC warnings, rename shadowed variables, fix uninitialized values, change warnings=all to use /W4.
2022-09-29 17:53:28 +08:00
String prop_name = p_name;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
Fix MSVC warnings, rename shadowed variables, fix uninitialized values, change warnings=all to use /W4.
2022-09-29 17:53:28 +08:00
if (prop_name.begins_with("properties/")) {
int idx = prop_name.get_slicec('/', 1).to_int();
String what = prop_name.get_slicec('/', 2);
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
if (properties.size() == idx && what == "path") {
ERR_FAIL_COND_V(p_value.get_type() != Variant::NODE_PATH, false);
NodePath path = p_value;
ERR_FAIL_COND_V(path.is_empty() || path.get_subname_count() == 0, false);
add_property(path);
return true;
}
ERR_FAIL_INDEX_V(idx, properties.size(), false);
ReplicationProperty &prop = properties[idx];
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
if (what == "replication_mode") {
ERR_FAIL_COND_V(p_value.get_type() != Variant::INT, false);
ReplicationMode mode = (ReplicationMode)p_value.operator int();
ERR_FAIL_COND_V(mode < REPLICATION_MODE_NEVER || mode > REPLICATION_MODE_ON_CHANGE, false);
property_set_replication_mode(prop.name, mode);
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
return true;
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
}
ERR_FAIL_COND_V(p_value.get_type() != Variant::BOOL, false);
if (what == "spawn") {
property_set_spawn(prop.name, p_value);
return true;
} else if (what == "sync") {
// Deprecated.
property_set_sync(prop.name, p_value);
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
return true;
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
} else if (what == "watch") {
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
// Deprecated.
property_set_watch(prop.name, p_value);
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
return true;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
}
return false;
}
bool SceneReplicationConfig::_get(const StringName &p_name, Variant &r_ret) const {
Fix MSVC warnings, rename shadowed variables, fix uninitialized values, change warnings=all to use /W4.
2022-09-29 17:53:28 +08:00
String prop_name = p_name;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
Fix MSVC warnings, rename shadowed variables, fix uninitialized values, change warnings=all to use /W4.
2022-09-29 17:53:28 +08:00
if (prop_name.begins_with("properties/")) {
int idx = prop_name.get_slicec('/', 1).to_int();
String what = prop_name.get_slicec('/', 2);
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
ERR_FAIL_INDEX_V(idx, properties.size(), false);
const ReplicationProperty &prop = properties[idx];
if (what == "path") {
r_ret = prop.name;
return true;
} else if (what == "spawn") {
r_ret = prop.spawn;
return true;
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
} else if (what == "replication_mode") {
r_ret = prop.mode;
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
return true;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
}
return false;
}
void SceneReplicationConfig::_get_property_list(List<PropertyInfo> *p_list) const {
for (int i = 0; i < properties.size(); i++) {
p_list->push_back(PropertyInfo(Variant::STRING, "properties/" + itos(i) + "/path", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
p_list->push_back(PropertyInfo(Variant::STRING, "properties/" + itos(i) + "/spawn", PROPERTY_HINT_NONE, "", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
p_list->push_back(PropertyInfo(Variant::INT, "properties/" + itos(i) + "/replication_mode", PROPERTY_HINT_ENUM, "Never,Always,On Change", PROPERTY_USAGE_NO_EDITOR | PROPERTY_USAGE_INTERNAL));
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
}
TypedArray<NodePath> SceneReplicationConfig::get_properties() const {
TypedArray<NodePath> paths;
for (const ReplicationProperty &prop : properties) {
paths.push_back(prop.name);
}
return paths;
}
void SceneReplicationConfig::add_property(const NodePath &p_path, int p_index) {
ERR_FAIL_COND(properties.find(p_path));
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
ERR_FAIL_COND(p_path == NodePath());
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
if (p_index < 0 || p_index == properties.size()) {
properties.push_back(ReplicationProperty(p_path));
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
dirty = true;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
return;
}
ERR_FAIL_INDEX(p_index, properties.size());
List<ReplicationProperty>::Element *I = properties.front();
int c = 0;
while (c < p_index) {
I = I->next();
c++;
}
properties.insert_before(I, ReplicationProperty(p_path));
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
dirty = true;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
void SceneReplicationConfig::remove_property(const NodePath &p_path) {
properties.erase(p_path);
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
dirty = true;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
Improve MultiplayerSynchronizer editor usability * Add a button to add properties (which lets you select node and property) * Add ability to drag properties and drop them to the editor. * Made the editor transient (not always visible on the bottom) since its not needed most of the time. * Added the ability to pin the editor, in case dragging properties from other nodes is desired.
2022-05-23 08:24:14 +08:00
bool SceneReplicationConfig::has_property(const NodePath &p_path) const {
for (int i = 0; i < properties.size(); i++) {
if (properties[i].name == p_path) {
return true;
}
}
return false;
}
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
int SceneReplicationConfig::property_get_index(const NodePath &p_path) const {
for (int i = 0; i < properties.size(); i++) {
if (properties[i].name == p_path) {
return i;
}
}
ERR_FAIL_V(-1);
}
bool SceneReplicationConfig::property_get_spawn(const NodePath &p_path) {
List<ReplicationProperty>::Element *E = properties.find(p_path);
ERR_FAIL_COND_V(!E, false);
return E->get().spawn;
}
void SceneReplicationConfig::property_set_spawn(const NodePath &p_path, bool p_enabled) {
List<ReplicationProperty>::Element *E = properties.find(p_path);
ERR_FAIL_COND(!E);
if (E->get().spawn == p_enabled) {
return;
}
E->get().spawn = p_enabled;
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
dirty = true;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
bool SceneReplicationConfig::property_get_sync(const NodePath &p_path) {
List<ReplicationProperty>::Element *E = properties.find(p_path);
ERR_FAIL_COND_V(!E, false);
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
return E->get().mode == REPLICATION_MODE_ALWAYS;
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
void SceneReplicationConfig::property_set_sync(const NodePath &p_path, bool p_enabled) {
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
if (p_enabled) {
property_set_replication_mode(p_path, REPLICATION_MODE_ALWAYS);
} else if (property_get_replication_mode(p_path) == REPLICATION_MODE_ALWAYS) {
property_set_replication_mode(p_path, REPLICATION_MODE_NEVER);
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
}
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
bool SceneReplicationConfig::property_get_watch(const NodePath &p_path) {
List<ReplicationProperty>::Element *E = properties.find(p_path);
ERR_FAIL_COND_V(!E, false);
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
return E->get().mode == REPLICATION_MODE_ON_CHANGE;
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
}
void SceneReplicationConfig::property_set_watch(const NodePath &p_path, bool p_enabled) {
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
if (p_enabled) {
property_set_replication_mode(p_path, REPLICATION_MODE_ON_CHANGE);
} else if (property_get_replication_mode(p_path) == REPLICATION_MODE_ON_CHANGE) {
property_set_replication_mode(p_path, REPLICATION_MODE_NEVER);
}
}
SceneReplicationConfig::ReplicationMode SceneReplicationConfig::property_get_replication_mode(const NodePath &p_path) {
List<ReplicationProperty>::Element *E = properties.find(p_path);
ERR_FAIL_COND_V(!E, REPLICATION_MODE_NEVER);
return E->get().mode;
}
void SceneReplicationConfig::property_set_replication_mode(const NodePath &p_path, ReplicationMode p_mode) {
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
List<ReplicationProperty>::Element *E = properties.find(p_path);
ERR_FAIL_COND(!E);
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
if (E->get().mode == p_mode) {
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
return;
}
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
E->get().mode = p_mode;
dirty = true;
}
void SceneReplicationConfig::_update() {
if (!dirty) {
return;
}
dirty = false;
sync_props.clear();
spawn_props.clear();
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
watch_props.clear();
for (const ReplicationProperty &prop : properties) {
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
if (prop.spawn) {
spawn_props.push_back(prop.name);
}
switch (prop.mode) {
case REPLICATION_MODE_ALWAYS:
sync_props.push_back(prop.name);
break;
case REPLICATION_MODE_ON_CHANGE:
watch_props.push_back(prop.name);
break;
default:
break;
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
}
}
}
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
const List<NodePath> &SceneReplicationConfig::get_spawn_properties() {
if (dirty) {
_update();
}
return spawn_props;
}
const List<NodePath> &SceneReplicationConfig::get_sync_properties() {
if (dirty) {
_update();
}
return sync_props;
}
const List<NodePath> &SceneReplicationConfig::get_watch_properties() {
if (dirty) {
_update();
}
return watch_props;
}
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
void SceneReplicationConfig::_bind_methods() {
ClassDB::bind_method(D_METHOD("get_properties"), &SceneReplicationConfig::get_properties);
ClassDB::bind_method(D_METHOD("add_property", "path", "index"), &SceneReplicationConfig::add_property, DEFVAL(-1));
Improve MultiplayerSynchronizer editor usability * Add a button to add properties (which lets you select node and property) * Add ability to drag properties and drop them to the editor. * Made the editor transient (not always visible on the bottom) since its not needed most of the time. * Added the ability to pin the editor, in case dragging properties from other nodes is desired.
2022-05-23 08:24:14 +08:00
ClassDB::bind_method(D_METHOD("has_property", "path"), &SceneReplicationConfig::has_property);
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
ClassDB::bind_method(D_METHOD("remove_property", "path"), &SceneReplicationConfig::remove_property);
ClassDB::bind_method(D_METHOD("property_get_index", "path"), &SceneReplicationConfig::property_get_index);
ClassDB::bind_method(D_METHOD("property_get_spawn", "path"), &SceneReplicationConfig::property_get_spawn);
ClassDB::bind_method(D_METHOD("property_set_spawn", "path", "enabled"), &SceneReplicationConfig::property_set_spawn);
[MP] Make replication mode an enum + optimizations REPLICATION_MODE_ALWAYS (sync) and REPLICATION_MODE_ON_CHANGE (watch) are now mutually exclusive. Prevent invalid NodePath from being added to the config. Optimize the replication config loading by composing the lists on demand.
2023-08-27 17:35:56 +08:00
ClassDB::bind_method(D_METHOD("property_get_replication_mode", "path"), &SceneReplicationConfig::property_get_replication_mode);
ClassDB::bind_method(D_METHOD("property_set_replication_mode", "path", "mode"), &SceneReplicationConfig::property_set_replication_mode);
BIND_ENUM_CONSTANT(REPLICATION_MODE_NEVER);
BIND_ENUM_CONSTANT(REPLICATION_MODE_ALWAYS);
BIND_ENUM_CONSTANT(REPLICATION_MODE_ON_CHANGE);
// Deprecated.
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
ClassDB::bind_method(D_METHOD("property_get_sync", "path"), &SceneReplicationConfig::property_get_sync);
ClassDB::bind_method(D_METHOD("property_set_sync", "path", "enabled"), &SceneReplicationConfig::property_set_sync);
[MP] Implement "watched" properties. Checked at "delta_interval" (default = every frame), synchronized (reliably) if changes are detected.
2023-03-28 15:30:58 +08:00
ClassDB::bind_method(D_METHOD("property_get_watch", "path"), &SceneReplicationConfig::property_get_watch);
ClassDB::bind_method(D_METHOD("property_set_watch", "path", "enabled"), &SceneReplicationConfig::property_set_watch);
[Net] New replication interface, spawner and synchronizer nodes. Initial implementation of the MultiplayerReplicationInterface and its default implementation (SceneReplicationInterface). New MultiplayerSpawner node helps dealing with instantiation of scenes on remote peers (e.g. clients). It supports both custom spawns via a `_spawn_custom` virtual function, and optional auto-spawn of known scenes via a TypedArray<PackedScenes> property. New MultiplayerSynchornizer helps synchronizing states between the local and remote peers, supports both sync and spawn properties and is configured via a `SceneReplicationConfig` resource. It can also sync via path (i.e. without being spawned by a MultiplayerSpawner if both peers has it in tree, but will not send the spawn state in that case, only the sync one.
2021-10-08 20:13:06 +08:00
}
Reference in New Issue Copy Permalink