VisualScriptPropertyGet.xml 2.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualScriptPropertyGet" inherits="VisualScriptNode" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../../../doc/class.xsd">
  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. <methods>
  12. </methods>
  13. <members>
  14. <member name="base_script" type="String" setter="set_base_script" getter="get_base_script">
  15. The script to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE].
  16. </member>
  17. <member name="base_type" type="String" setter="set_base_type" getter="get_base_type" default="&quot;Object&quot;">
  18. The base type to be used when [member set_mode] is set to [constant CALL_MODE_INSTANCE].
  19. </member>
  20. <member name="basic_type" type="int" setter="set_basic_type" getter="get_basic_type" enum="Variant.Type">
  21. The type to be used when [member set_mode] is set to [constant CALL_MODE_BASIC_TYPE].
  22. </member>
  23. <member name="index" type="String" setter="set_index" getter="get_index">
  24. The indexed name of the property to retrieve. See [method Object.get_indexed] for details.
  25. </member>
  26. <member name="node_path" type="NodePath" setter="set_base_path" getter="get_base_path">
  27. The node path to use when [member set_mode] is set to [constant CALL_MODE_NODE_PATH].
  28. </member>
  29. <member name="property" type="String" setter="set_property" getter="get_property" default="&quot;&quot;">
  30. The name of the property to retrieve. Changing this will clear [member index].
  31. </member>
  32. <member name="set_mode" type="int" setter="set_call_mode" getter="get_call_mode" enum="VisualScriptPropertyGet.CallMode" default="0">
  33. [code]set_mode[/code] determines the target object from which the property will be retrieved. See [enum CallMode] for options.
  34. </member>
  35. </members>
  36. <constants>
  37. <constant name="CALL_MODE_SELF" value="0" enum="CallMode">
  38. The property will be retrieved from this [Object].
  39. </constant>
  40. <constant name="CALL_MODE_NODE_PATH" value="1" enum="CallMode">
  41. The property will be retrieved from the given [Node] in the scene tree.
  42. </constant>
  43. <constant name="CALL_MODE_INSTANCE" value="2" enum="CallMode">
  44. The property will be retrieved from an instanced node with the given type and script.
  45. </constant>
  46. <constant name="CALL_MODE_BASIC_TYPE" value="3" enum="CallMode">
  47. The property will be retrieved from a GDScript basic type (e.g. [Vector2]).
  48. </constant>
  49. </constants>
  50. </class>