Răsfoiți Sursa

Added missing descriptions to Particles2D

Missing descriptions of property: normal_map, fract_delta, fixed_fps and method: restart(), capture_rect() of Particles2D were added
Aditya Banerjee 6 ani în urmă
părinte
comite
ead285bc7c
1 a modificat fișierele cu 5 adăugiri și 0 ștergeri
  1. 5 0
      doc/classes/Particles2D.xml

+ 5 - 0
doc/classes/Particles2D.xml

@@ -16,12 +16,14 @@
 			<return type="Rect2">
 			</return>
 			<description>
+				Returns a rectangle containing the positions of all existing particles.
 			</description>
 		</method>
 		<method name="restart">
 			<return type="void">
 			</return>
 			<description>
+				Restarts all the existing particles.
 			</description>
 		</method>
 	</methods>
@@ -39,8 +41,10 @@
 			How rapidly particles in an emission cycle are emitted. If greater than [code]0[/code], there will be a gap in emissions before the next cycle begins. Default value: [code]0[/code].
 		</member>
 		<member name="fixed_fps" type="int" setter="set_fixed_fps" getter="get_fixed_fps">
+			The particle system's frame rate is fixed to a value. For instance, changing the value to 2 will make the particles render at 2 frames per second. Note this does not slow down the particle system itself.
 		</member>
 		<member name="fract_delta" type="bool" setter="set_fractional_delta" getter="get_fractional_delta">
+			If [code]true[/code], results in fractional delta calculation which has a smoother particles display effect. Default value: [code]true[/code]
 		</member>
 		<member name="lifetime" type="float" setter="set_lifetime" getter="get_lifetime">
 			Amount of time each particle will exist. Default value: [code]1[/code].
@@ -49,6 +53,7 @@
 			If [code]true[/code], particles use the parent node's coordinate space. If [code]false[/code], they use global coordinates. Default value: [code]true[/code].
 		</member>
 		<member name="normal_map" type="Texture" setter="set_normal_map" getter="get_normal_map">
+			Normal map to be used for the [code]texture[/code] property.
 		</member>
 		<member name="one_shot" type="bool" setter="set_one_shot" getter="get_one_shot">
 			If [code]true[/code], only one emission cycle occurs. If set [code]true[/code] during a cycle, emission will stop at the cycle's end. Default value: [code]false[/code].