diff options
Diffstat (limited to 'doc/classes/Particles2D.xml')
| -rw-r--r-- | doc/classes/Particles2D.xml | 17 |
1 files changed, 8 insertions, 9 deletions
diff --git a/doc/classes/Particles2D.xml b/doc/classes/Particles2D.xml index f872552a49..91c1a0ca9b 100644 --- a/doc/classes/Particles2D.xml +++ b/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> @@ -33,28 +35,28 @@ Particle draw order. Uses [code]DRAW_ORDER_*[/code] values. Default value: [code]DRAW_ORDER_INDEX[/code]. </member> <member name="emitting" type="bool" setter="set_emitting" getter="is_emitting"> - If [code]true[/code] particles are being emitted. Default value: [code]true[/code]. + If [code]true[/code], particles are being emitted. Default value: [code]true[/code]. </member> <member name="explosiveness" type="float" setter="set_explosiveness_ratio" getter="get_explosiveness_ratio"> 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"> - </member> - <member name="h_frames" type="int" setter="set_h_frames" getter="get_h_frames"> - Number of horizontal frames in [code]texture[/code]. + 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]. </member> <member name="local_coords" type="bool" setter="set_use_local_coordinates" getter="get_use_local_coordinates"> - 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]. + 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]. + 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]. </member> <member name="preprocess" type="float" setter="set_pre_process_time" getter="get_pre_process_time"> Particle system starts as if it had already run for this many seconds. @@ -71,9 +73,6 @@ <member name="texture" type="Texture" setter="set_texture" getter="get_texture"> Particle texture. If [code]null[/code] particles will be squares. </member> - <member name="v_frames" type="int" setter="set_v_frames" getter="get_v_frames"> - Number of vertical frames in [code]texture[/code]. - </member> <member name="visibility_rect" type="Rect2" setter="set_visibility_rect" getter="get_visibility_rect"> Editor visibility helper. </member> |