| 1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283 |
- :github_url: hide
- .. Generated automatically by doc/tools/make_rst.py in Godot's source tree.
- .. DO NOT EDIT THIS FILE, but the OccluderInstance3D.xml source instead.
- .. The source is found in doc/classes or modules/<name>/doc_classes.
- .. _class_OccluderInstance3D:
- OccluderInstance3D
- ==================
- **Inherits:** :ref:`Node3D<class_Node3D>` **<** :ref:`Node<class_Node>` **<** :ref:`Object<class_Object>`
- Properties
- ----------
- +-------------------------------------+---------------------------------------------------------------+----------------+
- | :ref:`int<class_int>` | :ref:`bake_mask<class_OccluderInstance3D_property_bake_mask>` | ``4294967295`` |
- +-------------------------------------+---------------------------------------------------------------+----------------+
- | :ref:`Occluder3D<class_Occluder3D>` | :ref:`occluder<class_OccluderInstance3D_property_occluder>` | |
- +-------------------------------------+---------------------------------------------------------------+----------------+
- Methods
- -------
- +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | :ref:`bool<class_bool>` | :ref:`get_bake_mask_value<class_OccluderInstance3D_method_get_bake_mask_value>` **(** :ref:`int<class_int>` layer_number **)** |const| |
- +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
- | void | :ref:`set_bake_mask_value<class_OccluderInstance3D_method_set_bake_mask_value>` **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)** |
- +-------------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------+
- Property Descriptions
- ---------------------
- .. _class_OccluderInstance3D_property_bake_mask:
- - :ref:`int<class_int>` **bake_mask**
- +-----------+----------------------+
- | *Default* | ``4294967295`` |
- +-----------+----------------------+
- | *Setter* | set_bake_mask(value) |
- +-----------+----------------------+
- | *Getter* | get_bake_mask() |
- +-----------+----------------------+
- ----
- .. _class_OccluderInstance3D_property_occluder:
- - :ref:`Occluder3D<class_Occluder3D>` **occluder**
- +----------+---------------------+
- | *Setter* | set_occluder(value) |
- +----------+---------------------+
- | *Getter* | get_occluder() |
- +----------+---------------------+
- Method Descriptions
- -------------------
- .. _class_OccluderInstance3D_method_get_bake_mask_value:
- - :ref:`bool<class_bool>` **get_bake_mask_value** **(** :ref:`int<class_int>` layer_number **)** |const|
- Returns whether or not the specified layer of the :ref:`bake_mask<class_OccluderInstance3D_property_bake_mask>` is enabled, given a ``layer_number`` between 1 and 20.
- ----
- .. _class_OccluderInstance3D_method_set_bake_mask_value:
- - void **set_bake_mask_value** **(** :ref:`int<class_int>` layer_number, :ref:`bool<class_bool>` value **)**
- Based on ``value``, enables or disables the specified layer in the :ref:`bake_mask<class_OccluderInstance3D_property_bake_mask>`, given a ``layer_number`` between 1 and 20.
- .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)`
- .. |const| replace:: :abbr:`const (This method has no side effects. It doesn't modify any of the instance's member variables.)`
- .. |vararg| replace:: :abbr:`vararg (This method accepts any number of arguments after the ones described here.)`
- .. |constructor| replace:: :abbr:`constructor (This method is used to construct a type.)`
- .. |static| replace:: :abbr:`static (This method doesn't need an instance to be called, so it can be called directly using the class name.)`
- .. |operator| replace:: :abbr:`operator (This method describes a valid operator to use with this type as left-hand operand.)`
|
