virtualx-engine/doc/classes/World2D.xml
Marcel Admiraal dd7f9b1c08 Make it clear that PhysicsDirectSpaceState is only available from
within _physics_process().

(cherry picked from commit bb9c104695)
2020-05-13 16:13:47 +02:00

27 lines
1.3 KiB
XML

<?xml version="1.0" encoding="UTF-8" ?>
<class name="World2D" inherits="Resource" version="3.2">
<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 and a sound space. 2D nodes register their resources into the current 2D world.
</description>
<tutorials>
<link>https://docs.godotengine.org/en/latest/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. Must only be accessed from the main thread within [code]_physics_process(delta)[/code].
</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>