pandemonium_engine/doc/classes/World3D.xml

40 lines
1.8 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="World3D" inherits="Resource" version="4.5">
<brief_description>
Class that has everything pertaining to a world.
</brief_description>
<description>
Class that has everything pertaining to a world. A physics space, a visual scenario, a navigation map and a sound space. Spatial nodes register their resources into the current world.
</description>
<tutorials>
<link>$DOCS_URL/tutorials/physics/ray-casting.md</link>
</tutorials>
<methods>
</methods>
<members>
<member name="direct_space_state" type="PhysicsDirectSpaceState" setter="" getter="get_direct_space_state">
Direct access to the world's physics 3D space state. Used for querying current and potential collisions.
</member>
<member name="environment" type="Environment3D" setter="set_environment" getter="get_environment">
The World's [Environment3D].
</member>
<member name="fallback_environment" type="Environment3D" setter="set_fallback_environment" getter="get_fallback_environment">
The World's fallback_environment will be used if the World's [Environment3D] fails or is missing.
</member>
<member name="navigation_map" type="RID" setter="" getter="get_navigation_map">
The [RID] of this world's navigation map. Used by the [NavigationServer].
</member>
<member name="scenario" type="RID" setter="" getter="get_scenario">
The World's visual scenario.
</member>
<member name="space" type="RID" setter="" getter="get_space">
The World's physics space.
</member>
<member name="vertex_lights_3d_map" type="RID" setter="" getter="get_vertex_lights_3d_map">
The [RID] of this world's vertex light 3d space resource. Used by the [VertexLights3DServer] for static 3D lights. If the vertex lights 3d module is not enabled this will just return an empty RID.
</member>
</members>
<constants>
</constants>
</class>