mirror of
https://github.com/stan220/godot-docs.git
synced 2026-09-08 20:29:03 +00:00
62 lines
2.8 KiB
ReStructuredText
62 lines
2.8 KiB
ReStructuredText
.. Generated automatically by doc/tools/makerst.py in Godot's source tree.
|
|
.. DO NOT EDIT THIS FILE, but the doc/base/classes.xml source instead.
|
|
|
|
.. _class_Room:
|
|
|
|
Room
|
|
====
|
|
|
|
**Inherits:** :ref:`VisualInstance<class_visualinstance>` **<** :ref:`Spatial<class_spatial>` **<** :ref:`Node<class_node>` **<** :ref:`Object<class_object>`
|
|
|
|
**Category:** Core
|
|
|
|
Brief Description
|
|
-----------------
|
|
|
|
Room data resource.
|
|
|
|
Member Functions
|
|
----------------
|
|
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`compute_room_from_subtree<class_Room_compute_room_from_subtree>` **(** **)** |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`Room<class_room>` | :ref:`get_room<class_Room_get_room>` **(** **)** const |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------+
|
|
| :ref:`bool<class_bool>` | :ref:`is_simulating_acoustics<class_Room_is_simulating_acoustics>` **(** **)** const |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_room<class_Room_set_room>` **(** :ref:`Room<class_room>` room **)** |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------+
|
|
| void | :ref:`set_simulate_acoustics<class_Room_set_simulate_acoustics>` **(** :ref:`bool<class_bool>` enable **)** |
|
|
+--------------------------+---------------------------------------------------------------------------------------------------------------+
|
|
|
|
Description
|
|
-----------
|
|
|
|
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.
|
|
|
|
Member Function Description
|
|
---------------------------
|
|
|
|
.. _class_Room_compute_room_from_subtree:
|
|
|
|
- void **compute_room_from_subtree** **(** **)**
|
|
|
|
.. _class_Room_get_room:
|
|
|
|
- :ref:`Room<class_room>` **get_room** **(** **)** const
|
|
|
|
.. _class_Room_is_simulating_acoustics:
|
|
|
|
- :ref:`bool<class_bool>` **is_simulating_acoustics** **(** **)** const
|
|
|
|
.. _class_Room_set_room:
|
|
|
|
- void **set_room** **(** :ref:`Room<class_room>` room **)**
|
|
|
|
.. _class_Room_set_simulate_acoustics:
|
|
|
|
- void **set_simulate_acoustics** **(** :ref:`bool<class_bool>` enable **)**
|
|
|
|
|