summaryrefslogtreecommitdiff
path: root/doc/classes/Physics2DShapeQueryParameters.xml
blob: 78d12e0b7321d1087a9fc84c14c4db4b346f5c44 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="Physics2DShapeQueryParameters" inherits="Reference" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Parameters to be sent to a 2D shape physics query.
	</brief_description>
	<description>
		This class contains the shape and other parameters for intersection/collision queries.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_collision_layer" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Return the physics layer the shape belongs to.
			</description>
		</method>
		<method name="get_exclude" qualifiers="const">
			<return type="Array">
			</return>
			<description>
				Return the list of objects, or object [RID]\ s, that will be excluded from collisions.
			</description>
		</method>
		<method name="get_margin" qualifiers="const">
			<return type="float">
			</return>
			<description>
				Return the collision margin for the shape.
			</description>
		</method>
		<method name="get_motion" qualifiers="const">
			<return type="Vector2">
			</return>
			<description>
				Return the current movement speed of the shape.
			</description>
		</method>
		<method name="get_object_type_mask" qualifiers="const">
			<return type="int">
			</return>
			<description>
				Return the type of object the shape belongs to.
			</description>
		</method>
		<method name="get_shape_rid" qualifiers="const">
			<return type="RID">
			</return>
			<description>
				Return the [RID] of the shape queried.
			</description>
		</method>
		<method name="get_transform" qualifiers="const">
			<return type="Transform2D">
			</return>
			<description>
				Return the transform matrix of the shape queried.
			</description>
		</method>
		<method name="set_collision_layer">
			<return type="void">
			</return>
			<argument index="0" name="collision_layer" type="int">
			</argument>
			<description>
				Set the physics layer the shape belongs to.
			</description>
		</method>
		<method name="set_exclude">
			<return type="void">
			</return>
			<argument index="0" name="exclude" type="Array">
			</argument>
			<description>
				Set the list of objects, or object [RID]\ s, that will be excluded from collisions.
			</description>
		</method>
		<method name="set_margin">
			<return type="void">
			</return>
			<argument index="0" name="margin" type="float">
			</argument>
			<description>
				Set the collision margin for the shape. A collision margin is an amount (in pixels) that the shape will grow when computing collisions, to account for numerical imprecision.
			</description>
		</method>
		<method name="set_motion">
			<return type="void">
			</return>
			<argument index="0" name="motion" type="Vector2">
			</argument>
			<description>
				Set the current movement speed of the shape.
			</description>
		</method>
		<method name="set_object_type_mask">
			<return type="void">
			</return>
			<argument index="0" name="object_type_mask" type="int">
			</argument>
			<description>
				Set the type of object the shape belongs to (see Physics2DDirectSpaceState.TYPE_MASK_*).
			</description>
		</method>
		<method name="set_shape">
			<return type="void">
			</return>
			<argument index="0" name="shape" type="Resource">
			</argument>
			<description>
				Set the [Shape2D] that will be used for collision/intersection queries.
			</description>
		</method>
		<method name="set_shape_rid">
			<return type="void">
			</return>
			<argument index="0" name="shape" type="RID">
			</argument>
			<description>
				Set the [RID] of the shape to be used in queries.
			</description>
		</method>
		<method name="set_transform">
			<return type="void">
			</return>
			<argument index="0" name="transform" type="Transform2D">
			</argument>
			<description>
				Set the transormation matrix of the shape. This is necessary to set its position/rotation/scale.
			</description>
		</method>
	</methods>
	<constants>
	</constants>
</class>