godot/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>
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Doctool: Remove version attribute from XML header We don't use that info for anything, and it generates unnecessary diffs every time we bump the minor version (and CI failures if we forget to sync some files from opt-in modules (mono, text_server_fb). 2023-07-06 08:08:05 +00:00			`<class name="World2D" inherits="Resource" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`<brief_description>`
Overhaul the top sections of the class reference (Core classes) 2023-04-27 23:35:33 +00:00			`A resource that holds all components of a 2D world, such as a canvas and a physics space.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</brief_description>`
			`<description>`
Overhaul the top sections of the class reference (Core classes) 2023-04-27 23:35:33 +00:00			`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.`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 09:43:07 +00:00			`<link title="Ray-casting">$DOCS_URL/tutorials/physics/ray-casting.html</link>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</tutorials>`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`<members>`
			`<member name="canvas" type="RID" setter="" getter="get_canvas">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`The [RID] of this world's canvas resource. Used by the [RenderingServer] for 2D drawing.`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`</member>`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`<member name="direct_space_state" type="PhysicsDirectSpaceState2D" setter="" getter="get_direct_space_state">`
World3D.direct_space_state add multithreaded warning 2022-09-24 11:46:06 +00:00			`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.`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`</member>`
Remove Navigation2D/3D nodes, and move the navigation map to the world resource 2021-03-08 08:47:18 +00:00			`<member name="navigation_map" type="RID" setter="" getter="get_navigation_map">`
			`The [RID] of this world's navigation map. Used by the [NavigationServer2D].`
			`</member>`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`<member name="space" type="RID" setter="" getter="get_space">`
doc: Update classref with node renames A few extra renames for classes which were missed in last week's PRs. 2020-03-30 16:22:57 +00:00			`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.`
Update docs [ci skip] 2018-01-11 22:38:35 +00:00			`</member>`
			`</members>`
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will recognize them. 2017-09-12 20:42:36 +00:00			`</class>`