Attention: Here be dragons

This is the latest (unstable) version of this documentation, which may document features not available in or compatible with released stable versions of Godot.

SceneReplicationConfig

Hérite de : Resource < RefCounted < Object

Configuration pour les propriétés à synchroniser avec un MultiplayerSynchronizer.

Méthodes

void

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

Array[NodePath]

get_properties() const

bool

has_property(path: NodePath) const

int

property_get_index(path: NodePath) const

ReplicationMode

property_get_replication_mode(path: NodePath)

bool

property_get_spawn(path: NodePath)

bool

property_get_sync(path: NodePath)

bool

property_get_watch(path: NodePath)

void

property_set_replication_mode(path: NodePath, mode: ReplicationMode)

void

property_set_spawn(path: NodePath, enabled: bool)

void

property_set_sync(path: NodePath, enabled: bool)

void

property_set_watch(path: NodePath, enabled: bool)

void

remove_property(path: NodePath)


Énumérations

enum ReplicationMode: 🔗

ReplicationMode REPLICATION_MODE_NEVER = 0

Ne pas garder la propriété donnée synchronisée.

ReplicationMode REPLICATION_MODE_ALWAYS = 1

Répliquer la propriété donnée durant le traitement en envoyant constamment des mises à jour en utilisant un mode de transfert non fiable.

ReplicationMode REPLICATION_MODE_ON_CHANGE = 2

Répliquer la propriété donnée durant le traitement en envoyant des mises à jour en utilisant un mode de transfert fiable lorsque sa valeur change.


Descriptions des méthodes

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

Ajoute la propriété identifiée par le chemin path donné à la liste des propriétés synchronisées, en passant option un index.

Note : Pour plus de détails sur les restrictions et les limitations sur la synchronisation des propriétés, voir MultiplayerSynchronizer.


Array[NodePath] get_properties() const 🔗

Renvoie une liste de NodePaths des propriétés synchronisées.


bool has_property(path: NodePath) const 🔗

Renvoie true si le chemin path donné est configuré pour la synchronisation.


int property_get_index(path: NodePath) const 🔗

Trouve l'index du chemin path donné.


ReplicationMode property_get_replication_mode(path: NodePath) 🔗

Renvoie le mode de réplication de la propriété identifiée par le chemin path donné.


bool property_get_spawn(path: NodePath) 🔗

Renvoie true si la propriété identifiée par le chemin path donné est configurée pour être synchronisée lors de l'apparition.


bool property_get_sync(path: NodePath) 🔗

Obsolète : Use property_get_replication_mode() instead.

Renvoie true si la propriété identifiée par le chemin path donné est configurée pour être synchronisée lors du traitement.


bool property_get_watch(path: NodePath) 🔗

Obsolète : Use property_get_replication_mode() instead.

Renvoie true si la propriété identifiée par le chemin path donné est configurée pour être synchronisée de manière fiable lorsque des changements sont détectés lors du traitement.


void property_set_replication_mode(path: NodePath, mode: ReplicationMode) 🔗

Définit le mode de synchronisation de la propriété identifiée par le chemin path donné.


void property_set_spawn(path: NodePath, enabled: bool) 🔗

Définit si la propriété identifiée par le chemin path donné est configurée pour être synchronisée lors de l'apparition.


void property_set_sync(path: NodePath, enabled: bool) 🔗

Obsolète : Use property_set_replication_mode() with REPLICATION_MODE_ALWAYS instead.

Définit si la propriété identifiée par le chemin path donné est configurée pour être synchronisée lors du traitement.


void property_set_watch(path: NodePath, enabled: bool) 🔗

Obsolète : Use property_set_replication_mode() with REPLICATION_MODE_ON_CHANGE instead.

Définit si la propriété identifiée par le chemin path donné est configurée pour être synchronisée de manière fiable lorsque des changements sont détectés lors du traitement.


void remove_property(path: NodePath) 🔗

Retire la propriété identifiée par le chemin path donné de la configuration.