Răsfoiți Sursa

[DOCS] Update TextureProgress class ref

Chris Bradfield 8 ani în urmă
părinte
comite
bbed82de29
1 a modificat fișierele cu 14 adăugiri și 2 ștergeri
  1. 14 2
      doc/classes/TextureProgress.xml

+ 14 - 2
doc/classes/TextureProgress.xml

@@ -1,10 +1,10 @@
 <?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 implementation.
+		Textured progress bar.
 	</brief_description>
 	<description>
-		[ProgressBar] implementation that is easier to theme (by just passing a few textures).
+		A [ProgressBar] that uses textures to display fill percentage. Can be set to linear or radial mode.
 	</description>
 	<tutorials>
 	</tutorials>
@@ -148,28 +148,40 @@
 	</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>