SceneReplicationConfig.xml 2.9 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="SceneReplicationConfig" inherits="Resource" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  3. <brief_description>
  4. Configuration for properties to synchronize with a [MultiplayerSynchronizer].
  5. </brief_description>
  6. <description>
  7. </description>
  8. <tutorials>
  9. </tutorials>
  10. <methods>
  11. <method name="add_property">
  12. <return type="void" />
  13. <param index="0" name="path" type="NodePath" />
  14. <param index="1" name="index" type="int" default="-1" />
  15. <description>
  16. Adds the property identified by the given [code]path[/code] to the list of the properties being synchronized, optionally passing an [code]index[/code].
  17. </description>
  18. </method>
  19. <method name="get_properties" qualifiers="const">
  20. <return type="NodePath[]" />
  21. <description>
  22. Returns a list of synchronized property [NodePath]s.
  23. </description>
  24. </method>
  25. <method name="has_property" qualifiers="const">
  26. <return type="bool" />
  27. <param index="0" name="path" type="NodePath" />
  28. <description>
  29. Returns whether the given [code]path[/code] is configured for synchronization.
  30. </description>
  31. </method>
  32. <method name="property_get_index" qualifiers="const">
  33. <return type="int" />
  34. <param index="0" name="path" type="NodePath" />
  35. <description>
  36. Finds the index of the given [code]path[/code].
  37. </description>
  38. </method>
  39. <method name="property_get_spawn">
  40. <return type="bool" />
  41. <param index="0" name="path" type="NodePath" />
  42. <description>
  43. Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn.
  44. </description>
  45. </method>
  46. <method name="property_get_sync">
  47. <return type="bool" />
  48. <param index="0" name="path" type="NodePath" />
  49. <description>
  50. Returns whether the property identified by the given [code]path[/code] is configured to be synchronized on process.
  51. </description>
  52. </method>
  53. <method name="property_set_spawn">
  54. <return type="void" />
  55. <param index="0" name="path" type="NodePath" />
  56. <param index="1" name="enabled" type="bool" />
  57. <description>
  58. Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on spawn.
  59. </description>
  60. </method>
  61. <method name="property_set_sync">
  62. <return type="void" />
  63. <param index="0" name="path" type="NodePath" />
  64. <param index="1" name="enabled" type="bool" />
  65. <description>
  66. Sets whether the property identified by the given [code]path[/code] is configured to be synchronized on process.
  67. </description>
  68. </method>
  69. <method name="remove_property">
  70. <return type="void" />
  71. <param index="0" name="path" type="NodePath" />
  72. <description>
  73. Removes the property identified by the given [code]path[/code] from the configuration.
  74. </description>
  75. </method>
  76. </methods>
  77. </class>