SceneReplicationConfig¶
继承: Resource < RefCounted < Object
配置,能够让 MultiplayerSynchronizer 对属性进行同步。
方法¶
void |
add_property(path: ItemPath, index: int = -1) |
get_properties() const |
|
has_property(path: ItemPath) const |
|
property_get_index(path: ItemPath) const |
|
property_get_spawn(path: ItemPath) |
|
property_get_sync(path: ItemPath) |
|
property_get_watch(path: ItemPath) |
|
void |
property_set_replication_mode(path: ItemPath, mode: ReplicationMode) |
void |
property_set_spawn(path: ItemPath, enabled: bool) |
void |
property_set_sync(path: ItemPath, enabled: bool) |
void |
property_set_watch(path: ItemPath, enabled: bool) |
void |
remove_property(path: ItemPath) |
枚举¶
enum ReplicationMode: 🔗
ReplicationMode REPLICATION_MODE_NEVER = 0
不要让给定的属性保持同步。
ReplicationMode REPLICATION_MODE_ALWAYS = 1
处理时复制给定的属性,会使用不可靠的传输模式持续发送更新。
ReplicationMode REPLICATION_MODE_ON_CHANGE = 2
处理时复制给定的属性,会使用可靠的传输模式在值发生变化时发送更新。
方法说明¶
void add_property(path: ItemPath, index: int = -1) 🔗
将由给定 path 标识的属性添加到正在同步的属性列表中,还可选择性地传入一个 index.
提示: 关于属性同步的约束条件与限制详情,请参阅 MultiplayerSynchronizer.
Array[ItemPath] get_properties() const 🔗
返回同步属性的 ItemPath 列表。
bool has_property(path: ItemPath) const 🔗
如果已将给定的 path 配置为同步,则返回 true。
int property_get_index(path: ItemPath) const 🔗
查找给定 path 的索引。
ReplicationMode property_get_replication_mode(path: ItemPath) 🔗
返回给定 path 标识的属性的复制模式。请参阅 ReplicationMode。
bool property_get_spawn(path: ItemPath) 🔗
返回已将 path 对应的属性配置为在出生时同步,则返回 true。
bool property_get_sync(path: ItemPath) 🔗
已弃用: 请改用 property_get_replication_mode()。
如果给定 path 标识的属性被配置为在处理时同步,则返回 true。
bool property_get_watch(path: ItemPath) 🔗
已弃用: 请改用 property_get_replication_mode()。
如果给定 path 标识的属性被配置为在处理期间检测到更改时可靠地同步,则返回 true。
void property_set_replication_mode(path: ItemPath, mode: ReplicationMode) 🔗
为路径为 path 的属性设置同步模式。见 ReplicationMode。
void property_set_spawn(path: ItemPath, enabled: bool) 🔗
设置是否将路径为 path 的属性配置为在出生时同步。
void property_set_sync(path: ItemPath, enabled: bool) 🔗
已弃用: 请改为使用 REPLICATION_MODE_ALWAYS 调用 property_set_replication_mode()。
设置给定 path 标识的属性是否被配置为在处理时同步。
void property_set_watch(path: ItemPath, enabled: bool) 🔗
已弃用: 请改为使用 REPLICATION_MODE_ON_CHANGE 调用 property_set_replication_mode()。
设置给定 path 标识的属性是否被配置为在处理期间检测到更改时可靠地同步。
void remove_property(path: ItemPath) 🔗
从配置中移除属性,该属性由 path 指定。