:github_url: hide .. DO NOT EDIT THIS FILE!!! .. Generated automatically from Godot engine sources. .. Generator: https://github.com/godotengine/godot/tree/master/doc/tools/make_rst.py. .. XML source: https://github.com/godotengine/godot/tree/master/stag-toolkit/sphinx/gen/gdextension/IslandBuilder.xml. .. _class_IslandBuilder: IslandBuilder ============= **Inherits:** ``Node3D`` .. container:: contribute There is currently no description for this class. Please help us by `contributing one `__! .. rst-class:: classref-reftable-group Properties ---------- .. table:: :widths: auto +-----------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+ | ``NodePath`` | :ref:`output_to` | ``NodePath(".")`` | +-----------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+ | ``bool`` | :ref:`realtime_preview` | ``false`` | +-----------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+ | :ref:`IslandBuilderSettings` | :ref:`settings` | ``null`` | +-----------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+ | :ref:`IslandBuilderSettingsTweaks` | :ref:`tweaks` | ``null`` | +-----------------------------------------------------------------------+------------------------------------------------------------------------+-------------------+ .. rst-class:: classref-reftable-group Methods ------- .. table:: :widths: auto +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`all_bake`\ (\ builders\: :ref:`Array`\[:ref:`IslandBuilder`\]\ ) |static| | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[:ref:`IslandBuilder`\] | :ref:`all_builders`\ (\ tree\: ``SceneTree``\ ) |static| | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`all_destroy_bakes`\ (\ builders\: :ref:`Array`\[:ref:`IslandBuilder`\]\ ) |static| | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_collision_hulls`\ (\ hulls\: :ref:`Array`\[``ConvexPolygonShape3D``\], volume\: ``float``\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_mesh`\ (\ mesh\: ``ArrayMesh``\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_navigation_properties`\ (\ props\: :ref:`NavIslandProperties`\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_settings`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`apply_tweaks`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`build`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`clear_cache`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`destroy_bakes`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`IslandBuilderSettings` | :ref:`fetch_settings`\ (\ ) |const| | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``ArrayMesh`` | :ref:`generate_baked_mesh`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`Array`\[``ConvexPolygonShape3D``\] | :ref:`generate_collision_hulls`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | :ref:`NavIslandProperties` | :ref:`generate_navigation_properties`\ (\ ) |const| | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``ArrayMesh`` | :ref:`generate_preview_mesh`\ (\ recycle_mesh\: ``ArrayMesh``\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``AABB`` | :ref:`get_aabb`\ (\ ) |const| | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``int`` | :ref:`get_shape_count`\ (\ ) |const| | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``float`` | :ref:`get_volume`\ (\ ) |const| | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`serialize`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``Node`` | :ref:`target`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | ``MeshInstance3D`` | :ref:`target_mesh`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | |void| | :ref:`update_preview`\ (\ ) | +------------------------------------------------------------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Property Descriptions --------------------- .. _class_IslandBuilder_property_output_to: .. rst-class:: classref-property ``NodePath`` **output_to** = ``NodePath(".")`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_output_to**\ (\ value\: ``NodePath``\ ) - ``NodePath`` **get_output_to**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_property_realtime_preview: .. rst-class:: classref-property ``bool`` **realtime_preview** = ``false`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_realtime_preview**\ (\ value\: ``bool``\ ) - ``bool`` **get_realtime_preview**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_property_settings: .. rst-class:: classref-property :ref:`IslandBuilderSettings` **settings** = ``null`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_settings**\ (\ value\: :ref:`IslandBuilderSettings`\ ) - :ref:`IslandBuilderSettings` **get_settings**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_property_tweaks: .. rst-class:: classref-property :ref:`IslandBuilderSettingsTweaks` **tweaks** = ``null`` :ref:`🔗` .. rst-class:: classref-property-setget - |void| **set_tweaks**\ (\ value\: :ref:`IslandBuilderSettingsTweaks`\ ) - :ref:`IslandBuilderSettingsTweaks` **get_tweaks**\ (\ ) .. container:: contribute There is currently no description for this property. Please help us by `contributing one `__! .. rst-class:: classref-section-separator ---- .. rst-class:: classref-descriptions-group Method Descriptions ------------------- .. _class_IslandBuilder_method_all_bake: .. rst-class:: classref-method |void| **all_bake**\ (\ builders\: :ref:`Array`\[:ref:`IslandBuilder`\]\ ) |static| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_all_builders: .. rst-class:: classref-method :ref:`Array`\[:ref:`IslandBuilder`\] **all_builders**\ (\ tree\: ``SceneTree``\ ) |static| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_all_destroy_bakes: .. rst-class:: classref-method |void| **all_destroy_bakes**\ (\ builders\: :ref:`Array`\[:ref:`IslandBuilder`\]\ ) |static| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_apply_collision_hulls: .. rst-class:: classref-method |void| **apply_collision_hulls**\ (\ hulls\: :ref:`Array`\[``ConvexPolygonShape3D``\], volume\: ``float``\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_apply_mesh: .. rst-class:: classref-method |void| **apply_mesh**\ (\ mesh\: ``ArrayMesh``\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_apply_navigation_properties: .. rst-class:: classref-method |void| **apply_navigation_properties**\ (\ props\: :ref:`NavIslandProperties`\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_apply_settings: .. rst-class:: classref-method |void| **apply_settings**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_apply_tweaks: .. rst-class:: classref-method |void| **apply_tweaks**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_build: .. rst-class:: classref-method |void| **build**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_clear_cache: .. rst-class:: classref-method |void| **clear_cache**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_destroy_bakes: .. rst-class:: classref-method |void| **destroy_bakes**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_fetch_settings: .. rst-class:: classref-method :ref:`IslandBuilderSettings` **fetch_settings**\ (\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_generate_baked_mesh: .. rst-class:: classref-method ``ArrayMesh`` **generate_baked_mesh**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_generate_collision_hulls: .. rst-class:: classref-method :ref:`Array`\[``ConvexPolygonShape3D``\] **generate_collision_hulls**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_generate_navigation_properties: .. rst-class:: classref-method :ref:`NavIslandProperties` **generate_navigation_properties**\ (\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_generate_preview_mesh: .. rst-class:: classref-method ``ArrayMesh`` **generate_preview_mesh**\ (\ recycle_mesh\: ``ArrayMesh``\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_get_aabb: .. rst-class:: classref-method ``AABB`` **get_aabb**\ (\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_get_shape_count: .. rst-class:: classref-method ``int`` **get_shape_count**\ (\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_get_volume: .. rst-class:: classref-method ``float`` **get_volume**\ (\ ) |const| :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_serialize: .. rst-class:: classref-method |void| **serialize**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_target: .. rst-class:: classref-method ``Node`` **target**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_target_mesh: .. rst-class:: classref-method ``MeshInstance3D`` **target_mesh**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. rst-class:: classref-item-separator ---- .. _class_IslandBuilder_method_update_preview: .. rst-class:: classref-method |void| **update_preview**\ (\ ) :ref:`🔗` .. container:: contribute There is currently no description for this method. Please help us by `contributing one `__! .. |virtual| replace:: :abbr:`virtual (This method should typically be overridden by the user to have any effect.)` .. |required| replace:: :abbr:`required (This method is required to be overridden when extending its base class.)` .. |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.)` .. |bitfield| replace:: :abbr:`BitField (This value is an integer composed as a bitmask of the following flags.)` .. |void| replace:: :abbr:`void (No return value.)`