Up to date

This page is up to date for Godot 4.2. If you still find outdated information, please open an issue.

SceneReplicationConfig

继承： Resource < RefCounted < Object

配置，能够让 MultiplayerSynchronizer 对属性进行同步。

方法

void	add_property ( NodePath path, int index=-1 )
NodePath[]	get_properties ( ) const
bool	has_property ( NodePath path ) const
int	property_get_index ( NodePath path ) const
ReplicationMode	property_get_replication_mode ( NodePath path )
bool	property_get_spawn ( NodePath path )
bool	property_get_sync ( NodePath path )
bool	property_get_watch ( NodePath path )
void	property_set_replication_mode ( NodePath path, ReplicationMode mode )
void	property_set_spawn ( NodePath path, bool enabled )
void	property_set_sync ( NodePath path, bool enabled )
void	property_set_watch ( NodePath path, bool enabled )
void	remove_property ( NodePath path )

---

枚举

enum ReplicationMode:

ReplicationMode REPLICATION_MODE_NEVER = 0

不要让给定的属性保持同步。

ReplicationMode REPLICATION_MODE_ALWAYS = 1

处理时复制给定的属性，会使用不可靠的传输模式持续发送更新。

ReplicationMode REPLICATION_MODE_ON_CHANGE = 2

处理时复制给定的属性，会使用可靠的传输模式在值发生变化时发送更新。

---

方法说明

void add_property ( NodePath path, int index=-1 )

将属性添加至同步属性列表，该属性由 path 指定，还可以传入索引 index。

注意：属性同步的限制详见 MultiplayerSynchronizer。

---

NodePath[] get_properties ( ) const

返回同步属性的 NodePath 列表。

---

bool has_property ( NodePath path ) const

返回给定的 path 是否配置为同步。

---

int property_get_index ( NodePath path ) const

查找给定 path 的索引。

---

ReplicationMode property_get_replication_mode ( NodePath path )

返回给定 path 标识的属性的复制模式。请参阅 ReplicationMode。

---

bool property_get_spawn ( NodePath path )

返回属性是否配置为在出生时同步，该属性由 path 指定。

---

bool property_get_sync ( NodePath path )

返回属性是否配置为在处理时同步，该属性由path 指定。

已废弃。请改用 property_get_replication_mode。

---

bool property_get_watch ( NodePath path )

返回属性是否配置为在处理中检测到变化时进行可靠同步，该属性由 path 指定。

已废弃。请改用 property_get_replication_mode。

---

void property_set_replication_mode ( NodePath path, ReplicationMode mode )

为路径为 path 的属性设置同步模式。见 ReplicationMode。

---

void property_set_spawn ( NodePath path, bool enabled )

设置是否将路径为 path 的属性配置为在出生时同步。

---

void property_set_sync ( NodePath path, bool enabled )

设置是否将路径为 path 的属性配置为在处理时同步。

已废弃。请改为使用 REPLICATION_MODE_ALWAYS 调用 property_set_replication_mode。

---

void property_set_watch ( NodePath path, bool enabled )

设置是否将路径为 path 的属性配置为在处理时检测到变化时进行可靠同步。

已废弃。请改为使用 REPLICATION_MODE_ON_CHANGE 调用 property_set_replication_mode。

---

void remove_property ( NodePath path )

从配置中移除属性，该属性由 path 指定。