VisualInstance.xml 2.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374
  1. <?xml version="1.0" encoding="UTF-8" ?>
  2. <class name="VisualInstance" inherits="Spatial" category="Core" version="3.1.2">
  3. <brief_description>
  4. </brief_description>
  5. <description>
  6. </description>
  7. <tutorials>
  8. </tutorials>
  9. <methods>
  10. <method name="get_aabb" qualifiers="const">
  11. <return type="AABB">
  12. </return>
  13. <description>
  14. Returns the [AABB] (also known as the bounding box) for this VisualInstance.
  15. </description>
  16. </method>
  17. <method name="get_base" qualifiers="const">
  18. <return type="RID">
  19. </return>
  20. <description>
  21. </description>
  22. </method>
  23. <method name="get_instance" qualifiers="const">
  24. <return type="RID">
  25. </return>
  26. <description>
  27. </description>
  28. </method>
  29. <method name="get_layer_mask_bit" qualifiers="const">
  30. <return type="bool">
  31. </return>
  32. <argument index="0" name="layer" type="int">
  33. </argument>
  34. <description>
  35. </description>
  36. </method>
  37. <method name="get_transformed_aabb" qualifiers="const">
  38. <return type="AABB">
  39. </return>
  40. <description>
  41. Returns the transformed [AABB] (also known as the bounding box) for this VisualInstance.
  42. Transformed in this case means the [AABB] plus the position, rotation, and scale of the [Spatial]s [Transform]
  43. </description>
  44. </method>
  45. <method name="set_base">
  46. <return type="void">
  47. </return>
  48. <argument index="0" name="base" type="RID">
  49. </argument>
  50. <description>
  51. Sets the base of the VisualInstance, which changes how the engine handles the VisualInstance under the hood.
  52. It is recommended to only use set_base if you know what you're doing.
  53. </description>
  54. </method>
  55. <method name="set_layer_mask_bit">
  56. <return type="void">
  57. </return>
  58. <argument index="0" name="layer" type="int">
  59. </argument>
  60. <argument index="1" name="enabled" type="bool">
  61. </argument>
  62. <description>
  63. </description>
  64. </method>
  65. </methods>
  66. <members>
  67. <member name="layers" type="int" setter="set_layer_mask" getter="get_layer_mask">
  68. The render layer(s) this VisualInstance is drawn on.
  69. This object will only be visible for [Camera]s whose cull mask includes the render object this VisualInstance is set to.
  70. </member>
  71. </members>
  72. <constants>
  73. </constants>
  74. </class>