godot/doc/classes/StaticBody2D.xml

<?xml version="1.0" encoding="UTF-8" ?>
<class name="StaticBody2D" inherits="PhysicsBody2D" version="3.3">
	<brief_description>
		Static body for 2D physics.
	</brief_description>
	<description>
		Static body for 2D physics. A StaticBody2D is a body that is not intended to move. It is ideal for implementing objects in the environment, such as walls or platforms.
		Additionally, a constant linear or angular velocity can be set for the static body, which will affect colliding bodies as if it were moving (for example, a conveyor belt).
	</description>
	<tutorials>
	</tutorials>
	<methods>
	</methods>
	<members>
		<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">
			The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness).
			Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override].
		</member>
		<member name="constant_angular_velocity" type="float" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" default="0.0">
			The body's constant angular velocity. This does not rotate the body, but affects colliding bodies, as if it were rotating.
		</member>
		<member name="constant_linear_velocity" type="Vector2" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity" default="Vector2( 0, 0 )">
			The body's constant linear velocity. This does not move the body, but affects colliding bodies, as if it were moving.
		</member>
		<member name="friction" type="float" setter="set_friction" getter="get_friction">
			The body's friction. Values range from [code]0[/code] (no friction) to [code]1[/code] (full friction).
			Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override].
		</member>
		<member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override">
			The physics material override for the body.
			If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one.
		</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 20:42:36 +00:00			`<?xml version="1.0" encoding="UTF-8" ?>`
doc: Sync classref with 3.3 version bump 2021-03-23 12:40:34 +00:00			`<class name="StaticBody2D" inherits="PhysicsBody2D" version="3.3">`
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>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`Static body for 2D physics.`
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>`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`Static body for 2D physics. A StaticBody2D is a body that is not intended to move. It is ideal for implementing objects in the environment, such as walls or platforms.`
[DOCS] Update StaticBody2D class ref. 2017-09-23 16:28:16 +00:00			`Additionally, a constant linear or angular velocity can be set for the static body, which will affect colliding bodies as if it were moving (for example, a conveyor belt).`
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>`
			`</tutorials>`
			`<methods>`
			`</methods>`
			`<members>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-29 19:22:15 +00:00			`<member name="bounce" type="float" setter="set_bounce" getter="get_bounce">`
[DOCS] Update StaticBody2D class ref. 2017-09-23 16:28:16 +00:00			`The body's bounciness. Values range from [code]0[/code] (no bounce) to [code]1[/code] (full bounciness).`
doc: Mark PhysicsBody bounce/friction as deprecated 2019-06-30 11:07:32 +00:00			`Deprecated, use [member PhysicsMaterial.bounce] instead via [member physics_material_override].`
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			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="constant_angular_velocity" type="float" setter="set_constant_angular_velocity" getter="get_constant_angular_velocity" default="0.0">`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`The body's constant angular velocity. This does not rotate the body, but affects colliding bodies, as if it were rotating.`
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			`</member>`
doc: Add default values to all properties Thanks to @bojidar-bg's impressive work in #29380. 2019-06-29 10:38:01 +00:00			`<member name="constant_linear_velocity" type="Vector2" setter="set_constant_linear_velocity" getter="get_constant_linear_velocity" default="Vector2( 0, 0 )">`
Proofread and improve the whole class reference - Document a few more properties and methods - Add more information to many classes - Fix lots of typos and gramar mistakes - Use [code] tags for parameters consistently - Use [b] and [i] tags consistently - Put "Warning:" and "Note:" on their own line to be more visible, and make them always bold - Tweak formatting in code examples to be more readable - Use double quotes consistently - Add more links to third-party technologies 2019-06-21 23:04:47 +00:00			`The body's constant linear velocity. This does not move the body, but affects colliding bodies, as if it were moving.`
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			`</member>`
doc: Remove null default values that can't be determined Applying #30187. 2019-06-29 19:22:15 +00:00			`<member name="friction" type="float" setter="set_friction" getter="get_friction">`
[DOCS] Update StaticBody2D class ref. 2017-09-23 16:28:16 +00:00			`The body's friction. Values range from [code]0[/code] (no friction) to [code]1[/code] (full friction).`
doc: Mark PhysicsBody bounce/friction as deprecated 2019-06-30 11:07:32 +00:00			`Deprecated, use [member PhysicsMaterial.friction] instead via [member physics_material_override].`
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			`</member>`
doc: Sync classref with current source 2019-07-15 18:42:47 +00:00			`<member name="physics_material_override" type="PhysicsMaterial" setter="set_physics_material_override" getter="get_physics_material_override">`
[DOC] Add missing physics_material_override descriptions 2019-10-06 18:54:58 +00:00			`The physics material override for the body.`
			`If a material is assigned to this property, it will be used instead of any other physics material, such as an inherited one.`
doc: Sync classref with current source Fix various missing arguments in bindings. 2018-07-26 09:56:21 +00:00			`</member>`
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			`</members>`
			`<constants>`
			`</constants>`
			`</class>`