summaryrefslogtreecommitdiff
path: root/doc/classes/TextureProgress.xml
blob: 0a6ffcdeb8782ea8edc6f67493cc071c9c87fc10 (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
<?xml version="1.0" encoding="UTF-8" ?>
<class name="TextureProgress" inherits="Range" category="Core" version="3.0.alpha.custom_build">
	<brief_description>
		Textured progress bar.
	</brief_description>
	<description>
		A [ProgressBar] that uses textures to display fill percentage. Can be set to linear or radial mode.
	</description>
	<tutorials>
	</tutorials>
	<demos>
	</demos>
	<methods>
		<method name="get_fill_degrees">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_fill_mode">
			<return type="int">
			</return>
			<description>
			</description>
		</method>
		<method name="get_nine_patch_stretch" qualifiers="const">
			<return type="bool">
			</return>
			<description>
				Returns true if textures are stretched as nine-patches or false otherwise.
			</description>
		</method>
		<method name="get_over_texture" qualifiers="const">
			<return type="Texture">
			</return>
			<description>
			</description>
		</method>
		<method name="get_progress_texture" qualifiers="const">
			<return type="Texture">
			</return>
			<description>
			</description>
		</method>
		<method name="get_radial_center_offset">
			<return type="Vector2">
			</return>
			<description>
			</description>
		</method>
		<method name="get_radial_initial_angle">
			<return type="float">
			</return>
			<description>
			</description>
		</method>
		<method name="get_stretch_margin" qualifiers="const">
			<return type="int">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<description>
				Return nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
			</description>
		</method>
		<method name="get_under_texture" qualifiers="const">
			<return type="Texture">
			</return>
			<description>
			</description>
		</method>
		<method name="set_fill_degrees">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_fill_mode">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="int">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_nine_patch_stretch">
			<return type="void">
			</return>
			<argument index="0" name="stretch" type="bool">
			</argument>
			<description>
				Set if textures should be stretched as nine-patches.
			</description>
		</method>
		<method name="set_over_texture">
			<return type="void">
			</return>
			<argument index="0" name="tex" type="Texture">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_progress_texture">
			<return type="void">
			</return>
			<argument index="0" name="tex" type="Texture">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_radial_center_offset">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="Vector2">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_radial_initial_angle">
			<return type="void">
			</return>
			<argument index="0" name="mode" type="float">
			</argument>
			<description>
			</description>
		</method>
		<method name="set_stretch_margin">
			<return type="void">
			</return>
			<argument index="0" name="margin" type="int" enum="Margin">
			</argument>
			<argument index="1" name="value" type="int">
			</argument>
			<description>
				Set nine-patch texture offset for a given margin (MARGIN_LEFT, MARGIN_TOP, MARGIN_RIGHT, MARGIN_BOTTOM).
			</description>
		</method>
		<method name="set_under_texture">
			<return type="void">
			</return>
			<argument index="0" name="tex" type="Texture">
			</argument>
			<description>
			</description>
		</method>
	</methods>
	<members>
		<member name="fill_mode" type="int" setter="set_fill_mode" getter="get_fill_mode">
			The fill direction. Uses FILL_* constants.
		</member>
		<member name="nine_patch_stretch" type="bool" setter="set_nine_patch_stretch" getter="get_nine_patch_stretch">
			If [code]true[/code] textures will be stretched as [NinePatchRect]. Uses [code]stretch_margin[/code] properties (see below). Default value: [code]false[/code]
		</member>
		<member name="radial_center_offset" type="Vector2" setter="set_radial_center_offset" getter="get_radial_center_offset">
			The offset amount for radial mode.
		</member>
		<member name="radial_fill_degrees" type="float" setter="set_fill_degrees" getter="get_fill_degrees">
			The amount of the texture to use for radial mode.
		</member>
		<member name="radial_initial_angle" type="float" setter="set_radial_initial_angle" getter="get_radial_initial_angle">
			Start angle for radial mode.
		</member>
		<member name="stretch_margin_bottom" type="int" setter="set_stretch_margin" getter="get_stretch_margin">
			Nine-patch texture offset for bottom margin.
		</member>
		<member name="stretch_margin_left" type="int" setter="set_stretch_margin" getter="get_stretch_margin">
			Nine-patch texture offset for left margin.
		</member>
		<member name="stretch_margin_right" type="int" setter="set_stretch_margin" getter="get_stretch_margin">
			Nine-patch texture offset for right margin.
		</member>
		<member name="stretch_margin_top" type="int" setter="set_stretch_margin" getter="get_stretch_margin">
			Nine-patch texture offset for top margin.
		</member>
		<member name="texture_over" type="Texture" setter="set_over_texture" getter="get_over_texture">
			The [Texture] that will be drawn over the progress bar.
		</member>
		<member name="texture_progress" type="Texture" setter="set_progress_texture" getter="get_progress_texture">
			The [Texture] used to display [code]value[/code].
		</member>
		<member name="texture_under" type="Texture" setter="set_under_texture" getter="get_under_texture">
			The [Texture] that will be drawn under the progress bar.
		</member>
	</members>
	<constants>
		<constant name="FILL_LEFT_TO_RIGHT" value="0">
		</constant>
		<constant name="FILL_RIGHT_TO_LEFT" value="1">
		</constant>
		<constant name="FILL_TOP_TO_BOTTOM" value="2">
		</constant>
		<constant name="FILL_BOTTOM_TO_TOP" value="3">
		</constant>
		<constant name="FILL_CLOCKWISE" value="4">
		</constant>
		<constant name="FILL_COUNTER_CLOCKWISE" value="5">
		</constant>
	</constants>
</class>