2
0

VisualScriptPropertyGet.xml 2.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptPropertyGet" inherits="VisualScriptNode" version="4.0">
  3. <brief_description>
  4. A Visual Script node returning a value of a property from an [Object].
  5. </brief_description>
  6. <description>
  7. [VisualScriptPropertyGet] can return a value of any property from the current object or other objects.
  8. </description>
  9. <tutorials>
  10. </tutorials>
  11. <members>
  12. <member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
  13. The script to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE].
  14. </member>
  15. <member name="base_type" type="StringName" setter="set_base_type" getter="get_base_type" default="&amp;&quot;Object&quot;">
  16. The base type to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE].
  17. </member>
  18. <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
  19. The type to be used when [member set_mode] is set to [constant CALL_MODE_BASIC_TYPE].
  20. </member>
  21. <member name="index" type="StringName" setter="set_index" getter="get_index">
  22. The indexed name of the property to retrieve. See [method Object.get_indexed] for details.
  23. </member>
  24. <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
  25. The node path to use when [member set_mode] is set to [constant CALL_MODE_NODE_PATH].
  26. </member>
  27. <member name="property" type="StringName" setter="set_property" getter="get_property" default="&amp;&quot;&quot;">
  28. The name of the property to retrieve. Changing this will clear [member index].
  29. </member>
  30. <member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode" default="0">
  31. [code]set_mode[/code] determines the target object from which the property will be retrieved. See [enum CallMode] for options.
  32. </member>
  33. </members>
  34. <constants>
  35. <constant name="CALL_MODE_SELF" value="0" enum="CallMode">
  36. The property will be retrieved from this [Object].
  37. </constant>
  38. <constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode">
  39. The property will be retrieved from the given [Node] in the scene tree.
  40. </constant>
  41. <constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
  42. The property will be retrieved from an instanced node with the given type and script.
  43. </constant>
  44. <constant name="CALL_MODE_BASIC_TYPE" value="3" enum="CallMode">
  45. The property will be retrieved from a GDScript basic type (e.g. [Vector2]).
  46. </constant>
  47. </constants>
  48. </class>