virtualx-engine/doc/classes/World2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="World2D" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		A resource that holds all components of a 2D world, such as a canvas and a physics space.
	</brief_description>
	<description>
		Class that has everything pertaining to a 2D world: A physics space, a canvas, and a sound space. 2D nodes register their resources into the current 2D world.
	</description>
	<tutorials>
		<link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link>
	</tutorials>
	<members>
		<member name="canvas" type="RID" setter="" getter="get_canvas">
			The [RID] of this world's canvas resource. Used by the [RenderingServer] for 2D drawing.
		</member>
		<member name="direct_space_state" type="PhysicsDirectSpaceState2D" setter="" getter="get_direct_space_state">
			Direct access to the world's physics 2D space state. Used for querying current and potential collisions. When using multi-threaded physics, access is limited to [method Node._physics_process] in the main thread.
		</member>
		<member name="navigation_map" type="RID" setter="" getter="get_navigation_map">
			The [RID] of this world's navigation map. Used by the [NavigationServer2D].
		</member>
		<member name="space" type="RID" setter="" getter="get_space">
			The [RID] of this world's physics space resource. Used by the [PhysicsServer2D] for 2D physics, treating it as both a space and an area.
		</member>
	</members>
</class>