class_room.rst 2.8 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162
  1. .. Generated automatically by doc/tools/makerst.py in Godot's source tree.
  2. .. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
  3. .. _class_Room:
  4. Room
  5. ====
  6. **Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
  7. **Category:** Core
  8. Brief Description
  9. -----------------
  10. Room data resource.
  11. Member Functions
  12. ----------------
  13. +--------------------------+---------------------------------------------------------------------------------------------------------------+
  14. | void | :ref:`compute_room_from_subtree<class_Room_compute_room_from_subtree>` **(** **)** |
  15. +--------------------------+---------------------------------------------------------------------------------------------------------------+
  16. | :ref:`Room<class_room>` | :ref:`get_room<class_Room_get_room>` **(** **)** const |
  17. +--------------------------+---------------------------------------------------------------------------------------------------------------+
  18. | :ref:`bool<class_bool>` | :ref:`is_simulating_acoustics<class_Room_is_simulating_acoustics>` **(** **)** const |
  19. +--------------------------+---------------------------------------------------------------------------------------------------------------+
  20. | void | :ref:`set_room<class_Room_set_room>` **(** :ref:`Room<class_room>` room **)** |
  21. +--------------------------+---------------------------------------------------------------------------------------------------------------+
  22. | void | :ref:`set_simulate_acoustics<class_Room_set_simulate_acoustics>` **(** :ref:`bool<class_bool>` enable **)** |
  23. +--------------------------+---------------------------------------------------------------------------------------------------------------+
  24. Description
  25. -----------
  26. Room contains the data to define the bounds of a scene (using a BSP Tree). It is instanced by a :ref:`VisualInstance<class_visualinstance>` node to create rooms. See that class documentation for more information about rooms.
  27. Member Function Description
  28. ---------------------------
  29. .. _class_Room_compute_room_from_subtree:
  30. - void **compute_room_from_subtree** **(** **)**
  31. .. _class_Room_get_room:
  32. - :ref:`Room<class_room>` **get_room** **(** **)** const
  33. .. _class_Room_is_simulating_acoustics:
  34. - :ref:`bool<class_bool>` **is_simulating_acoustics** **(** **)** const
  35. .. _class_Room_set_room:
  36. - void **set_room** **(** :ref:`Room<class_room>` room **)**
  37. .. _class_Room_set_simulate_acoustics:
  38. - void **set_simulate_acoustics** **(** :ref:`bool<class_bool>` enable **)**