summaryrefslogtreecommitdiff
path: root/doc/classes/TileData.xml
blob: b61ed1ea2899ab69ba63d2f790b32f0f3363d270 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TileData" inherits="Object" version="4.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="../class.xsd">
	<brief_description>
	</brief_description>
	<description>
	</description>
	<tutorials>
	</tutorials>
	<methods>
		<method name="add_collision_polygon">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<description>
				Adds a collision polygon to the tile on the given TileSet physics layer.
			</description>
		</method>
		<method name="get_collision_polygon_one_way_margin" qualifiers="const">
			<return type="float" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="polygon_index" type="int" />
			<description>
				Returns the one-way margin (for one-way platforms) of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="get_collision_polygon_points" qualifiers="const">
			<return type="PackedVector2Array" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="polygon_index" type="int" />
			<description>
				Returns the points of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="get_collision_polygons_count" qualifiers="const">
			<return type="int" />
			<param index="0" name="layer_id" type="int" />
			<description>
				Returns how many polygons the tile has for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="get_constant_angular_velocity" qualifiers="const">
			<return type="float" />
			<param index="0" name="layer_id" type="int" />
			<description>
				Returns the constant angular velocity applied to objects colliding with this tile.
			</description>
		</method>
		<method name="get_constant_linear_velocity" qualifiers="const">
			<return type="Vector2" />
			<param index="0" name="layer_id" type="int" />
			<description>
				Returns the constant linear velocity applied to objects colliding with this tile.
			</description>
		</method>
		<method name="get_custom_data" qualifiers="const">
			<return type="Variant" />
			<param index="0" name="layer_name" type="String" />
			<description>
				Returns the custom data value for custom data layer named [code]layer_name[/code].
			</description>
		</method>
		<method name="get_custom_data_by_layer_id" qualifiers="const">
			<return type="Variant" />
			<param index="0" name="layer_id" type="int" />
			<description>
				Returns the custom data value for custom data layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="get_navigation_polygon" qualifiers="const">
			<return type="NavigationPolygon" />
			<param index="0" name="layer_id" type="int" />
			<description>
				Returns the navigation polygon of the tile for the TileSet navigation layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="get_occluder" qualifiers="const">
			<return type="OccluderPolygon2D" />
			<param index="0" name="layer_id" type="int" />
			<description>
				Returns the occluder polygon of the tile for the TileSet occlusion layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="get_terrain_peering_bit" qualifiers="const">
			<return type="int" />
			<param index="0" name="peering_bit" type="int" enum="TileSet.CellNeighbor" />
			<description>
				Returns the tile's terrain bit for the given [code]peering_bit[/code] direction.
			</description>
		</method>
		<method name="is_collision_polygon_one_way" qualifiers="const">
			<return type="bool" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="polygon_index" type="int" />
			<description>
				Returns whether one-way collisions are enabled for the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="remove_collision_polygon">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="polygon_index" type="int" />
			<description>
				Removes the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="set_collision_polygon_one_way">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="polygon_index" type="int" />
			<param index="2" name="one_way" type="bool" />
			<description>
				Enables/disables one-way collisions on the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="set_collision_polygon_one_way_margin">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="polygon_index" type="int" />
			<param index="2" name="one_way_margin" type="float" />
			<description>
				Enables/disables one-way collisions on the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="set_collision_polygon_points">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="polygon_index" type="int" />
			<param index="2" name="polygon" type="PackedVector2Array" />
			<description>
				Sets the points of the polygon at index [code]polygon_index[/code] for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="set_collision_polygons_count">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="polygons_count" type="int" />
			<description>
				Sets the polygons count for TileSet physics layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="set_constant_angular_velocity">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="velocity" type="float" />
			<description>
				Sets the constant angular velocity. This does not rotate the tile. This angular velocity is applied to objects colliding with this tile.
			</description>
		</method>
		<method name="set_constant_linear_velocity">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="velocity" type="Vector2" />
			<description>
				Sets the constant linear velocity. This does not move the tile. This linear velocity is applied to objects colliding with this tile. This is useful to create conveyor belts.
			</description>
		</method>
		<method name="set_custom_data">
			<return type="void" />
			<param index="0" name="layer_name" type="String" />
			<param index="1" name="value" type="Variant" />
			<description>
				Sets the tile's custom data value for the TileSet custom data layer with name [code]layer_name[/code].
			</description>
		</method>
		<method name="set_custom_data_by_layer_id">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="value" type="Variant" />
			<description>
				Sets the tile's custom data value for the TileSet custom data layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="set_navigation_polygon">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="navigation_polygon" type="NavigationPolygon" />
			<description>
				Sets the navigation polygon for the TileSet navigation layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="set_occluder">
			<return type="void" />
			<param index="0" name="layer_id" type="int" />
			<param index="1" name="occluder_polygon" type="OccluderPolygon2D" />
			<description>
				Sets the occluder for the TileSet occlusion layer with index [code]layer_id[/code].
			</description>
		</method>
		<method name="set_terrain_peering_bit">
			<return type="void" />
			<param index="0" name="peering_bit" type="int" enum="TileSet.CellNeighbor" />
			<param index="1" name="terrain" type="int" />
			<description>
				Sets the tile's terrain bit for the given [code]peering_bit[/code] direction.
			</description>
		</method>
	</methods>
	<members>
		<member name="flip_h" type="bool" setter="set_flip_h" getter="get_flip_h" default="false">
		</member>
		<member name="flip_v" type="bool" setter="set_flip_v" getter="get_flip_v" default="false">
		</member>
		<member name="material" type="Material" setter="set_material" getter="get_material">
			The [Material] to use for this [TileData]. This can be a [CanvasItemMaterial] to use the default shader, or a [ShaderMaterial] to use a custom shader.
		</member>
		<member name="modulate" type="Color" setter="set_modulate" getter="get_modulate" default="Color(1, 1, 1, 1)">
		</member>
		<member name="probability" type="float" setter="set_probability" getter="get_probability" default="1.0">
		</member>
		<member name="terrain" type="int" setter="set_terrain" getter="get_terrain" default="-1">
		</member>
		<member name="terrain_set" type="int" setter="set_terrain_set" getter="get_terrain_set" default="-1">
		</member>
		<member name="texture_offset" type="Vector2i" setter="set_texture_offset" getter="get_texture_offset" default="Vector2i(0, 0)">
		</member>
		<member name="transpose" type="bool" setter="set_transpose" getter="get_transpose" default="false">
		</member>
		<member name="y_sort_origin" type="int" setter="set_y_sort_origin" getter="get_y_sort_origin" default="0">
		</member>
		<member name="z_index" type="int" setter="set_z_index" getter="get_z_index" default="0">
		</member>
	</members>
	<signals>
		<signal name="changed">
			<description>
			</description>
		</signal>
	</signals>
</class>