Conf.example, settingtypes: Improve mgfractal documentation

minetest · Nov 6, 2015 · 2ec1eee · 2ec1eee
1 parent 5e507c9
commit 2ec1eee
Show file tree

Hide file tree

Showing 2 changed files with 33 additions and 31 deletions.
diff --git a/builtin/settingtypes.txt b/builtin/settingtypes.txt
@@ -936,52 +936,58 @@ mgv7_np_cave2 (Mapgen v7 cave2 noise parameters) noise_params 0, 12, (100, 100,
 #    Flags starting with "no" are used to explicitly disable them.
 mgfractal_spflags (Mapgen fractal flags) flags nojulia julia,nojulia
 
-#    Mandelbrot set: iterations of recursive function.
+#    Mandelbrot set: Iterations of the recursive function.
 #    Controls scale of finest detail.
 mgfractal_m_iterations (Mapgen fractal mandelbrot iterations) int 9
 
-#    Mandelbrot set: Approximate scale in nodes.
-#    Format is 3 numbers separated by commas, inside brackets.
+#    Mandelbrot set: Approximate (X,Y,Z) scales in nodes.
+#    Format is 3 numbers separated by commas and inside brackets.
 mgfractal_m_scale (Mapgen fractal mandelbrot scale) string (1024.0, 256.0, 1024.0)
-#    'string' is currently used for a v3f argument.
+#    Type 'string' is currently used for a v3f.
 
-#    Mandelbrot set: Offsets the fractal from world centre.
-#    Format is 3 numbers separated by commas, inside brackets.
-#    Range -2 to 2, multiply by m_scale for actual offset in nodes.
+#    Mandelbrot set: (X,Y,Z) offsets from world centre.
+#    Format is 3 numbers separated by commas and inside brackets.
+#    Range roughly -2 to 2, multiply by m_scale for offsets in nodes.
 mgfractal_m_offset (Mapgen fractal mandelbrot offset) string (1.75, 0.0, 0.0)
-#    'string' is currently used for a v3f argument.
+#    Type 'string' is currently used for a v3f.
 
 #    Mandelbrot set: W co-ordinate of the generated 3D slice of the 4D shape.
+#    Range roughly -2 to 2.
 mgfractal_m_slice_w (Mapgen fractal mandelbrot slice w) float 0.0
 
-#    Julia set: iterations of recursive function.
+#    Julia set: Iterations of the recursive function.
 #    Controls scale of finest detail.
 mgfractal_j_iterations (Mapgen fractal julia iterations) int 9
 
-#    Julia set: Approximate scale in nodes.
-#    Format is 3 numbers separated by commas, inside brackets.
+#    Julia set: Approximate (X,Y,Z) scales in nodes.
+#    Format is 3 numbers separated by commas and inside brackets.
 mgfractal_j_scale (Mapgen fractal julia scale) string (2048.0, 512.0, 2048.0)
-#    'string' is currently used for a v3f argument.
+#    Type 'string' is currently used for a v3f.
 
-#    Julia set: Offsets the fractal from world centre.
-#    Format is 3 numbers separated by commas, inside brackets.
-#    Range -2 to 2, multiply by j_scale for actual offset in nodes.
+#    Julia set: (X,Y,Z) offsets from world centre.
+#    Format is 3 numbers separated by commas and inside brackets.
+#    Range roughly -2 to 2, multiply by j_scale for offsets in nodes.
 mgfractal_j_offset (Mapgen fractal julia offset) string (0.0, 1.0, 0.0)
-#    'string' is currently used for a v3f argument.
+#    Type 'string' is currently used for a v3f.
 
 #    Julia set: W co-ordinate of the generated 3D slice of the 4D shape.
+#    Range roughly -2 to 2.
 mgfractal_j_slice_w (Mapgen fractal julia slice w) float 0.0
 
 #    Julia set: X value determining the 4D shape.
+#    Range roughly -2 to 2.
 mgfractal_julia_x (Mapgen fractal julia x) float 0.33
 
 #    Julia set: Y value determining the 4D shape.
+#    Range roughly -2 to 2.
 mgfractal_julia_y (Mapgen fractal julia y) float 0.33
 
 #    Julia set: Z value determining the 4D shape.
+#    Range roughly -2 to 2.
 mgfractal_julia_z (Mapgen fractal julia z) float 0.33
 
 #    Julia set: W value determining the 4D shape.
+#    Range roughly -2 to 2.
 mgfractal_julia_w (Mapgen fractal julia w) float 0.33
 
 mgfractal_np_seabed (Mapgen fractal seabed noise parameters) noise_params -14, 9, (600, 600, 600), 41900, 5, 0.6, 2.0

diff --git a/minetest.conf.example b/minetest.conf.example
@@ -1188,54 +1188,50 @@
 #    type: flags possible values: julia, nojulia
 # mgfractal_spflags = nojulia
 
-#    Mandelbrot set: iterations of recursive function.
+#    Mandelbrot set: Iterations of the recursive function.
 #    Controls scale of finest detail.
 #    type: int
 # mgfractal_m_iterations = 9
 
-#    Mandelbrot set: Approximate scale in nodes.
+#    Mandelbrot set: Approximate (X,Y,Z) scales in nodes.
 #    type: v3f
 # mgfractal_m_scale = (1024.0, 256.0, 1024.0)
 
-#    Mandelbrot set: Offsets the fractal from world centre.
-#    Range -2 to 2, multiply by m_scale for actual offset in nodes.
+#    Mandelbrot set: (X,Y,Z) offsets from world centre.
+#    Range roughly -2 to 2, multiply by m_scale for offsets in nodes.
 #    type: v3f
 # mgfractal_m_offset = (1.75, 0.0, 0.0)
 
 #    Mandelbrot set: W co-ordinate of the generated 3D slice of the 4D shape.
+#    Range roughly -2 to 2.
 #    type: float
 # mgfractal_m_slice_w = 0.0
 
-#    Julia set: iterations of recursive function.
+#    Julia set: Iterations of the recursive function.
 #    Controls scale of finest detail.
 #    type: int
 # mgfractal_j_iterations = 9
 
-#    Julia set: Approximate scale in nodes.
+#    Julia set: Approximate (X,Y,Z) scales in nodes.
 #    type: v3f
 # mgfractal_j_scale = (2048.0, 512.0, 2048.0)
 
-#    Julia set: Offsets the fractal from world centre.
-#    Range -2 to 2, multiply by j_scale for actual offset in nodes.
+#    Julia set: (X,Y,Z) offsets from world centre.
+#    Range roughly -2 to 2, multiply by j_scale for offsets in nodes.
 #    type: v3f
 # mgfractal_j_offset = (0.0, 1.0, 0.0)
 
 #    Julia set: W co-ordinate of the generated 3D slice of the 4D shape.
+#    Range roughly -2 to 2.
 #    type: float
 # mgfractal_j_slice_w = 0.0
 
 #    Julia set: The following 4 values determine the 4D shape.
-#    Range -2 to 2.
+#    Range roughly -2 to 2.
 #    type: float
 # mgfractal_julia_x = 0.33
-
-#    type: float
 # mgfractal_julia_y = 0.33
-
-#    type: float
 # mgfractal_julia_z = 0.33
-
-#    type: float
 # mgfractal_julia_w = 0.33
 
 #    type: noise_params