asgardius/virtualx-engine
1
0
Fork 0
Code Issues Pull requests Projects Releases 1 Packages Wiki Activity Actions

Document how to change the default gravity at runtime

Browse source 
Changing the default gravity at runtime isn't exactly obvious,
so it makes sense to add a code sample.
This commit is contained in:
Hugo Locurcio 2020-01-24 22:14:22 +01:00
parent 4dce3427ef
commit 1b9b07e658
No known key found for this signature in database
GPG key ID: 39E8F8BE30B0A49C
1 changed files with 24 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
doc/classes/ProjectSettings.xml
View file

@ -749,8 +749,20 @@
<member name="physics/2d/default_angular_damp" type="float" setter="" getter="" default="1.0"> <member name="physics/2d/default_angular_damp" type="float" setter="" getter="" default="1.0">
</member> </member>
<member name="physics/2d/default_gravity" type="int" setter="" getter="" default="98"> <member name="physics/2d/default_gravity" type="int" setter="" getter="" default="98">
The default gravity strength in 2D.
[b]Note:[/b] This property is only read when the project starts. To change the default gravity at runtime, use the following code sample:
[codeblock]
# Set the default gravity strength to 98.
Physics2DServer.area_set_param(get_viewport().find_world_2d().get_space(), Physics2DServer.AREA_PARAM_GRAVITY, 98)
[/codeblock]
</member> </member>
<member name="physics/2d/default_gravity_vector" type="Vector2" setter="" getter="" default="Vector2( 0, 1 )"> <member name="physics/2d/default_gravity_vector" type="Vector2" setter="" getter="" default="Vector2( 0, 1 )">
The default gravity direction in 2D.
[b]Note:[/b] This property is only read when the project starts. To change the default gravity vector at runtime, use the following code sample:
[codeblock]
# Set the default gravity direction to `Vector2(0, 1)`.
Physics2DServer.area_set_param(get_viewport().find_world_2d().get_space(), Physics2DServer.AREA_PARAM_GRAVITY_VECTOR, Vector2(0, 1))
[/codeblock]
</member> </member>
<member name="physics/2d/default_linear_damp" type="float" setter="" getter="" default="0.1"> <member name="physics/2d/default_linear_damp" type="float" setter="" getter="" default="0.1">
</member> </member>
@ -772,8 +784,20 @@
<member name="physics/3d/default_angular_damp" type="float" setter="" getter="" default="0.1"> <member name="physics/3d/default_angular_damp" type="float" setter="" getter="" default="0.1">
</member> </member>
<member name="physics/3d/default_gravity" type="float" setter="" getter="" default="9.8"> <member name="physics/3d/default_gravity" type="float" setter="" getter="" default="9.8">
The default gravity strength in 3D.
[b]Note:[/b] This property is only read when the project starts. To change the default gravity at runtime, use the following code sample:
[codeblock]
# Set the default gravity strength to 9.8.
PhysicsServer.area_set_param(get_viewport().find_world().get_space(), PhysicsServer.AREA_PARAM_GRAVITY, 9.8)
[/codeblock]
</member> </member>
<member name="physics/3d/default_gravity_vector" type="Vector3" setter="" getter="" default="Vector3( 0, -1, 0 )"> <member name="physics/3d/default_gravity_vector" type="Vector3" setter="" getter="" default="Vector3( 0, -1, 0 )">
The default gravity direction in 3D.
[b]Note:[/b] This property is only read when the project starts. To change the default gravity vector at runtime, use the following code sample:
[codeblock]
# Set the default gravity direction to `Vector3(0, -1, 0)`.
PhysicsServer.area_set_param(get_viewport().find_world().get_space(), PhysicsServer.AREA_PARAM_GRAVITY_VECTOR, Vector3(0, -1, 0))
[/codeblock]
</member> </member>
<member name="physics/3d/default_linear_damp" type="float" setter="" getter="" default="0.1"> <member name="physics/3d/default_linear_damp" type="float" setter="" getter="" default="0.1">
</member> </member>