diff options
| author | Max Hilbrunner <mhilbrunner@users.noreply.github.com> | 2020-05-13 02:19:36 +0200 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-05-13 02:19:36 +0200 |
| commit | a92f5f306166251ccb72666c516805d364ea4cdc (patch) | |
| tree | 01d2489b2dad1518fd1f475394a5416ba8eff739 | |
| parent | 2231673d42a9f20c8778b068102ae46261a6fb69 (diff) | |
| parent | bb9c104695cfce56d70b5b84d52658a04d15460b (diff) | |
| download | redot-engine-a92f5f306166251ccb72666c516805d364ea4cdc.tar.gz | |
Merge pull request #38693 from madmiraal/update-world-direct_space_state-doc
Make it clear that PhysicsDirectSpaceState is only available from within _physics_process().
| -rw-r--r-- | doc/classes/World2D.xml | 2 | ||||
| -rw-r--r-- | doc/classes/World3D.xml | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/doc/classes/World2D.xml b/doc/classes/World2D.xml index 2d8382b7e3..e66f21a0e7 100644 --- a/doc/classes/World2D.xml +++ b/doc/classes/World2D.xml @@ -16,7 +16,7 @@ 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"> - The state of this world's physics space. This allows arbitrary querying for collision. + 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 [PhysicsServer2D] for 2D physics, treating it as both a space and an area. diff --git a/doc/classes/World3D.xml b/doc/classes/World3D.xml index 4224a2a2c3..6d3b94794e 100644 --- a/doc/classes/World3D.xml +++ b/doc/classes/World3D.xml @@ -15,7 +15,7 @@ <member name="camera_effects" type="CameraEffects" setter="set_camera_effects" getter="get_camera_effects"> </member> <member name="direct_space_state" type="PhysicsDirectSpaceState3D" setter="" getter="get_direct_space_state"> - The World3D's physics direct space state, used for making various queries. Might be used only during [code]_physics_process[/code]. + Direct access to the world's physics 3D space state. Used for querying current and potential collisions. Must only be accessed from within [code]_physics_process(delta)[/code]. </member> <member name="environment" type="Environment" setter="set_environment" getter="get_environment"> The World3D's [Environment]. |