VisualInstance.xml 1.9 KB

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