RemoteTransform2D.xml 2.0 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="RemoteTransform2D" inherits="Node2D" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
  3. <brief_description>
  4. RemoteTransform2D pushes its own [Transform2D] to another [CanvasItem] derived Node in the scene.
  5. </brief_description>
  6. <description>
  7. RemoteTransform2D pushes its own [Transform2D] to another [CanvasItem] derived Node (called the remote node) in the scene.
  8. It can be set to update another Node's position, rotation and/or scale. It can use either global or local coordinates.
  9. </description>
  10. <tutorials>
  11. </tutorials>
  12. <methods>
  13. <method name="force_update_cache">
  14. <return type="void" />
  15. <description>
  16. [RemoteTransform2D] caches the remote node. It may not notice if the remote node disappears; [method force_update_cache] forces it to update the cache again.
  17. </description>
  18. </method>
  19. </methods>
  20. <members>
  21. <member name="remote_path" type="NodePath" setter="set_remote_node" getter="get_remote_node" default="NodePath(&quot;&quot;)">
  22. The [NodePath] to the remote node, relative to the RemoteTransform2D's position in the scene.
  23. </member>
  24. <member name="update_position" type="bool" setter="set_update_position" getter="get_update_position" default="true">
  25. If [code]true[/code], the remote node's position is updated.
  26. </member>
  27. <member name="update_rotation" type="bool" setter="set_update_rotation" getter="get_update_rotation" default="true">
  28. If [code]true[/code], the remote node's rotation is updated.
  29. </member>
  30. <member name="update_scale" type="bool" setter="set_update_scale" getter="get_update_scale" default="true">
  31. If [code]true[/code], the remote node's scale is updated.
  32. </member>
  33. <member name="use_global_coordinates" type="bool" setter="set_use_global_coordinates" getter="get_use_global_coordinates" default="true">
  34. If [code]true[/code], global coordinates are used. If [code]false[/code], local coordinates are used.
  35. </member>
  36. </members>
  37. <constants>
  38. </constants>
  39. </class>