From a386af67ec6807e2647cce66a6db78517783f1a3 Mon Sep 17 00:00:00 2001 From: Hugo Locurcio Date: Wed, 19 Sep 2018 20:05:55 +0200 Subject: [PATCH] Improve SimplexNoise documentation and fix typos Spaces were added after code blocks to ensure correct rendering on the online class reference. --- .../opensimplex/doc_classes/SimplexNoise.xml | 32 +++++++++---------- 1 file changed, 16 insertions(+), 16 deletions(-) diff --git a/modules/opensimplex/doc_classes/SimplexNoise.xml b/modules/opensimplex/doc_classes/SimplexNoise.xml index a5a01d88a7..5c633492e7 100644 --- a/modules/opensimplex/doc_classes/SimplexNoise.xml +++ b/modules/opensimplex/doc_classes/SimplexNoise.xml @@ -15,12 +15,12 @@ noise.octaves = 4 noise.period = 20.0 noise.persistance = 0.8 - - #Sample + + # Sample print("Values:") - print(noise.get_noise_2d(1.0,1.0)) - print(noise.get_noise_3d(0.5,3.0,15.0)) - print(noise.get_noise_3d(0.5,1.9,4.7,0.0)) + print(noise.get_noise_2d(1.0, 1.0)) + print(noise.get_noise_3d(0.5, 3.0, 15.0)) + print(noise.get_noise_3d(0.5, 1.9, 4.7, 0.0)) [/codeblock] @@ -47,7 +47,7 @@ - 2D noise value [-1,1] at position [code]x[/code],[code]y[/code]. + Returns the 2D noise value [-1,1] at the given position. @@ -56,7 +56,7 @@ - 2D noise value [-1,1] at position [code]pos.x[/code],[code]pos.y[/code]. + Returns the 2D noise value [-1,1] at the given position. @@ -69,7 +69,7 @@ - 3D noise value [-1,1] at position [code]x[/code],[code]y[/code],[code]z[/code]. + Returns the 3D noise value [-1,1] at the given position. @@ -78,7 +78,7 @@ - 3D noise value [-1,1] at position [code]pos.x[/code],[code]pos.y[/code],[code]pos.z[/code]. + Returns the 3D noise value [-1,1] at the given position. @@ -93,7 +93,7 @@ - 4D noise value [-1,1] at position [code]x[/code],[code]y[/code],[code]z[/code],[code]w[/code]. + Returns the 4D noise value [-1,1] at the given position. @@ -102,8 +102,8 @@ - Generate a tileable noise image, based on the current noise parameters. - Generated seamless images are always square ([code]size[/code]x[code]size[/code]). + Generate a tileable noise image, based on the current noise parameters. + Generated seamless images are always square ([code]size[/code] x [code]size[/code]). @@ -112,14 +112,14 @@ Difference in period between [member octaves]. - Number of Simplex Noise layers that are sampled to get the fractal noise. + Number of Simplex noise layers that are sampled to get the fractal noise. - Period of the base octave. - A lower period results in a higher frequancy noise (more value changes across the same distance). + Period of the base octave. + A lower period results in a higher-frequency noise (more value changes across the same distance). - Contribuiton factor of the different octaves. + Contribution factor of the different octaves. A [code]persistance[/code] value of 1 means all the octaves have the same contribution, a value of 0.5 means each octave contributes half as much as the previous one.