summaryrefslogtreecommitdiff
path: root/doc/classes/Physics2DDirectBodyState.xml
blob: a229ca494da84caeb1412d6fbe2b0abd40400e07 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Physics2DDirectBodyState" inherits="Object" category="Core" version="3.0-beta">
	<brief_description>
		Direct access object to a physics body in the [Physics2DServer].
	</brief_description>
	<description>
		Direct access object to a physics body in the [Physics2DServer]. This object is passed via the direct state callback of rigid/character bodies, and is intended for changing the direct state of that body.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_angular_velocity" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the angular velocity of the body.
			</description>
		</method>
		<method name="get_contact_collider" qualifiers="const">
			<return type="RID">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the [RID] of the collider.
			</description>
		</method>
		<method name="get_contact_collider_id" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the object id of the collider.
			</description>
		</method>
		<method name="get_contact_collider_object" qualifiers="const">
			<return type="Object">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the collider object, this depends on how it was created (will return a scene node if such was used to create it).
			</description>
		</method>
		<method name="get_contact_collider_position" qualifiers="const">
			<return type="Vector2">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the contact position in the collider.
			</description>
		</method>
		<method name="get_contact_collider_shape" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the collider shape index.
			</description>
		</method>
		<method name="get_contact_collider_shape_metadata" qualifiers="const">
			<return type="Variant">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the metadata of the collided shape. This metadata is different from [method Object.get_meta], and is set with [method Physics2DServer.shape_set_data].
			</description>
		</method>
		<method name="get_contact_collider_velocity_at_position" qualifiers="const">
			<return type="Vector2">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the linear velocity vector at contact point of the collider.
			</description>
		</method>
		<method name="get_contact_count" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Return the amount of contacts this body has with other bodies. Note that by default this returns 0 unless bodies are configured to log contacts.
			</description>
		</method>
		<method name="get_contact_local_normal" qualifiers="const">
			<return type="Vector2">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the local normal (of this body) of the contact point.
			</description>
		</method>
		<method name="get_contact_local_position" qualifiers="const">
			<return type="Vector2">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the local position (of this body) of the contact point.
			</description>
		</method>
		<method name="get_contact_local_shape" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="contact_idx" type="int">
			</argument>
			<description>
				Return the local shape index of the collision.
			</description>
		</method>
		<method name="get_inverse_inertia" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the inverse of the inertia of the body.
			</description>
		</method>
		<method name="get_inverse_mass" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the inverse of the mass of the body.
			</description>
		</method>
		<method name="get_linear_velocity" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Return the current linear velocity of the body.
			</description>
		</method>
		<method name="get_space_state">
			<return type="Physics2DDirectSpaceState">
			</return>
			<description>
				Return the current state of space, useful for queries.
			</description>
		</method>
		<method name="get_step" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the timestep (delta) used for the simulation.
			</description>
		</method>
		<method name="get_total_angular_damp" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the rate at which the body stops rotating, if there are not any other forces moving it.
			</description>
		</method>
		<method name="get_total_gravity" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Return the total gravity vector being currently applied to this body.
			</description>
		</method>
		<method name="get_total_linear_damp" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the rate at which the body stops moving, if there are not any other forces moving it.
			</description>
		</method>
		<method name="get_transform" qualifiers="const">
			<return type="Transform2D">
			</return>
			<description>
				Return the transform matrix of the body.
			</description>
		</method>
		<method name="integrate_forces">
			<return type="void">
			</return>
			<description>
				Call the built-in force integration code.
			</description>
		</method>
		<method name="is_sleeping" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Return true if this body is currently sleeping (not active).
			</description>
		</method>
		<method name="set_angular_velocity">
			<return type="void">
			</return>
			<argument index="0" name="velocity" type="float">
			</argument>
			<description>
				Change the angular velocity of the body.
			</description>
		</method>
		<method name="set_linear_velocity">
			<return type="void">
			</return>
			<argument index="0" name="velocity" type="Vector2">
			</argument>
			<description>
				Change the linear velocity of the body.
			</description>
		</method>
		<method name="set_sleep_state">
			<return type="void">
			</return>
			<argument index="0" name="enabled" type="bool">
			</argument>
			<description>
				Set the sleeping state of the body, only affects character/rigid bodies.
			</description>
		</method>
		<method name="set_transform">
			<return type="void">
			</return>
			<argument index="0" name="transform" type="Transform2D">
			</argument>
			<description>
				Change the transform matrix of the body.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>