virtualx-engine/doc/classes/World2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="World2D" inherits="Resource" version="3.5" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
		Class that has everything pertaining to a 2D world.
	</brief_description>
	<description>
		Class that has everything pertaining to a 2D world. A physics space, a visual scenario, a navigation map and a sound space. 2D nodes register their resources into the current 2D world.
	</description>
	<tutorials>
		<link>$DOCS_URL/tutorials/physics/ray-casting.html</link>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="canvas" type="RID" setter="" getter="get_canvas">
			The [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing.
		</member>
		<member name="direct_space_state" type="Physics2DDirectSpaceState" 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 [code]_physics_process(delta)[/code] 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 [Navigation2DServer].
		</member>
		<member name="space" type="RID" setter="" getter="get_space">
			The [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area.
		</member>
	</members>
	<constants>
	</constants>
</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 22:42:36 +02:00			`<?xml version="1.0" encoding="UTF-8" ?>`
Add an XML schema for documentation This makes it easier to spot syntax errors when editing the class reference. The schema is referenced locally so validation can still work offline. Each class XML's schema conformance is also checked on GitHub Actions. 2022-03-16 23:01:02 +01:00			`<class name="World2D" inherits="Resource" version="3.5" 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 22:42:36 +02:00			`<brief_description>`
			`Class that has everything pertaining to a 2D world.`
			`</brief_description>`
			`<description>`
[3.5] Update NavigationServer backport Backports features and bugfixes from current Godot 4.0 to 3.5 and brings functions and codebase of both version largely in sync to make tutorials more compatible and future backports easier. 2022-06-13 15:51:23 +02:00			`Class that has everything pertaining to a 2D world. A physics space, a visual scenario, a navigation map 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 22:42:36 +02:00			`</description>`
			`<tutorials>`
Replace Godot docs URL with `$DOCS_URL` in XML class reference 2021-11-15 17:11:20 +01:00			`<link>$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 22:42:36 +02:00			`</tutorials>`
			`<methods>`
			`</methods>`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`<members>`
			`<member name="canvas" type="RID" setter="" getter="get_canvas">`
			`The [RID] of this world's canvas resource. Used by the [VisualServer] for 2D drawing.`
			`</member>`
			`<member name="direct_space_state" type="Physics2DDirectSpaceState" setter="" getter="get_direct_space_state">`
Remove the unnecessary sync() and the restrictions it imposes on 3D Physics. 2020-09-18 11:24:57 +02: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 [code]_physics_process(delta)[/code] in the main thread.`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`</member>`
Backport default World navigation maps Backports default navigation maps created with each World or World2D. 2022-06-09 11:39:23 +02:00			`<member name="navigation_map" type="RID" setter="" getter="get_navigation_map">`
			`The [RID] of this world's navigation map. Used by the [Navigation2DServer].`
			`</member>`
Update docs [ci skip] 2018-01-11 23:38:35 +01:00			`<member name="space" type="RID" setter="" getter="get_space">`
			`The [RID] of this world's physics space resource. Used by the [Physics2DServer] for 2D physics, treating it as both a space and an area.`
			`</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 22:42:36 +02:00			`<constants>`
			`</constants>`
			`</class>`