help

ItsMeBrianD · ItsMeBrianD · commit 5d3977be30e1 · 2025-09-12T16:46:24.000-05:00
diff --git a/lang/constructs/block_states/BlockState.go b/lang/constructs/block_states/BlockState.go
@@ -8,6 +8,13 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.BlockStateContext](
+		func(state traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Defines a Minecraft [block state](https://minecraft.wiki/w/Block_states).<br/>Currently *only has support for block name*.<br/>Example: `Block(minecraft:stone)`"
+			return &out
+		},
+	)
+
 	traversal.Register(
 		func(state *grammar.BlockStateContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			nameCtx := state.ResourceReference()
diff --git a/lang/constructs/primitives/VerticalAnchor.go b/lang/constructs/primitives/VerticalAnchor.go
@@ -11,6 +11,11 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.VerticalAnchorContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Defines a vertical anchor, which can be absolute, above the bottom, or below the top.<br/>Absolute: `100`<br/>Above bottom: `~-100`<br/>Below top: `~100`"
+			return &out
+		})
 	traversal.Register(
 		func(anchor *grammar.VerticalAnchorContext, _ string, _ *traversal.Scope) traversal.Construct {
 			if anchor.Identifier() != nil {
diff --git a/lang/constructs/worldgen/density_functions/ClampFn.go b/lang/constructs/worldgen/density_functions/ClampFn.go
@@ -14,7 +14,7 @@ import (
 func init() {
 	traversal.RegisterHelp[*grammar.DensityFn_ClampContext](
 		func(construct traversal.Construct, s traversal.Symbol, location traversal.TextLocation) *string {
-			help := `Clamps the input density function to the specified range`
+			help := "Clamps the input density function to the specified range.<br/> `.Min(float)` and `.Max(float)` are required.<br/>Example: `Clamp(_densityFn_).Min(0).Max(1))`"
 			return &help
 		},
 	)
diff --git a/lang/constructs/worldgen/density_functions/DualInput.go b/lang/constructs/worldgen/density_functions/DualInput.go
@@ -17,6 +17,18 @@ const (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.DensityFn_DualInputContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			var out string
+			switch construct.(DualInputDensityFn).Kind {
+			case DensityFn_Min:
+				out = "Takes the minimum of 2 density functions.<br/>Functions must be separated by `,`.<br/>Example: `Min(1, 2)`"
+			case DensityFn_Max:
+				out = "Takes the maximum of 2 density functions.<br/>Functions must be separated by `,`.<br/>Example: `Max(1, 2)`"
+			}
+			return &out
+		},
+	)
 	traversal.Register(
 		func(densityFn *grammar.DensityFn_DualInputContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			out := &DualInputDensityFn{}
diff --git a/lang/constructs/worldgen/density_functions/OldNoiseFn.go b/lang/constructs/worldgen/density_functions/OldNoiseFn.go
@@ -11,6 +11,12 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.DensityFn_OldBlendedNoiseContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "References a defined noise function.<br/>Uses .XzScale( float ), .YScale( float ), .XzFactor( float ), .YFactor( float ) and .Smear( float ) to scale the noise function."
+			return &out
+		},
+	)
 	traversal.Register(
 		func(densityFn *grammar.DensityFn_OldBlendedNoiseContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			noiseFnBuilder := builder_chain.NewBuilderChain(
diff --git a/lang/constructs/worldgen/density_functions/RangeChoiceFn.go b/lang/constructs/worldgen/density_functions/RangeChoiceFn.go
@@ -12,6 +12,13 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.DensityFn_RangeChoiceContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			help := "Defines a range choice density function that returns different values based on whether the input is within a specified range.<br/>Required: `.Min(float)`, `.Max(float)`, `.InRange(densityFn)`, `.OutRange(densityFn)`.<br/>Example: `RangeChoice(densityFn).Min(-1).Max(1).InRange(densityFn).OutRange(densityFn)`"
+			return &help
+		},
+	)
+
 	traversal.Register(
 		func(densityFn *grammar.DensityFn_RangeChoiceContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			rangeChoiceBuilder := builder_chain.NewBuilderChain[RangeChoiceDensityFn](
diff --git a/lang/constructs/worldgen/density_functions/ShiftedNoiseFn.go b/lang/constructs/worldgen/density_functions/ShiftedNoiseFn.go
@@ -11,6 +11,13 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.DensityFn_ShiftedNoiseContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			help := "Shifts noise using .ShiftX( densityFn ), .ShiftY( densityFn ) and .ShiftZ( densityFn ).<br/>Uses .XZScale( float ) and .YScale( float ) to scale the noise function."
+			return &help
+		},
+	)
+
 	traversal.Register(
 		func(densityFn *grammar.DensityFn_ShiftedNoiseContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			shiftedNoiseBuilder := builder_chain.NewBuilderChain[ShiftedNoiseDensityFn](
diff --git a/lang/constructs/worldgen/density_functions/SingleInput.go b/lang/constructs/worldgen/density_functions/SingleInput.go
@@ -26,6 +26,38 @@ const (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.DensityFn_SingleInputContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			c := construct.(*SingleInputDensityFn)
+			var out string
+			switch c.Kind {
+			case DensityFn_Interpolated:
+				out = "Interpolates at each block in one cell based on the input density function value of some cells around. The size of each cell is size_horizontal * 4 and size_vertical * 4. Used often in combination with flat_cache."
+			case DensityFn_FlatCache:
+				out = "Calculate the value per 4×4 column (Value at each block in one column is the same). And it is calculated only once per column, at Y=0. Used often in combination with interpolated."
+			case DensityFn_Abs:
+				out = "Modifies input function by taking the absolute value.<br/>Example: `Abs(1)`"
+			case DensityFn_Cube:
+				out = "Modifies input function by taking the cube of the value. (x^3)<br/>Example: `Cube(1)`"
+			case DensityFn_Square:
+				out = "Modifies input function by taking the square of the value. (x^2)<br/>Example: `Square(1)`"
+			case DensityFn_HalfNeg:
+				out = "If the input is negative, returns half of the input. Otherwise returns the input. (x < 0 ? x/2 : x)"
+			case DensityFn_QuarterNeg:
+				out = "If the input is negative, returns a quarter of the input. Otherwise returns the input. (x < 0 ? x/4 : x)"
+			case DensityFn_Squeeze:
+				out = "First clamps the input between −1 and 1, then transforms it using x/2 - x*x*x/24."
+			case DensityFn_Shift:
+				out = "Samples a noise at (x/4, y/4, z/4), then multiplies it by 4."
+			case DensityFn_ShiftA:
+				out = "Samples a noise at (x/4, 0, z/4), then multiplies it by 4."
+			case DensityFn_ShiftB:
+				out = "Samples a noise at (z/4, x/4, 0), then multiplies it by 4."
+			}
+
+			return &out
+		},
+	)
 	traversal.Register(
 		func(densityFn *grammar.DensityFn_SingleInputContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			out := &SingleInputDensityFn{}
diff --git a/lang/constructs/worldgen/density_functions/SplineFn.go b/lang/constructs/worldgen/density_functions/SplineFn.go
@@ -61,6 +61,12 @@ func buildSplinePoint(point *grammar.DensityFn_SplinePointContext, currentNamesp
 }
 
 func init() {
+	traversal.RegisterHelp[*grammar.DensityFn_SplineFnContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Defines a cubic spline"
+			return &out
+		},
+	)
 	traversal.Register(
 		func(densityFn *grammar.DensityFn_SplineFnContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			splineDef := densityFn.DensityFn_Spline()
diff --git a/lang/constructs/worldgen/density_functions/WeirdScaledSamplerFn.go b/lang/constructs/worldgen/density_functions/WeirdScaledSamplerFn.go
@@ -10,8 +10,13 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.DensityFn_WierdScaledSamplerContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "According to the input value, scales and enhances (or weakens) some regions of the specified noise, and then returns the absolute value.\n\n"
+			return &out
+		},
+	)
 	traversal.Register(
-
 		func(densityFn *grammar.DensityFn_WierdScaledSamplerContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			out := &WeirdScaledSamplerFn{}
 
diff --git a/lang/constructs/worldgen/density_functions/YClampedGradientFn.go b/lang/constructs/worldgen/density_functions/YClampedGradientFn.go
@@ -12,6 +12,12 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.DensityFn_YClampedGradientContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Creates a gradient that runs from a specified y-coordinate to another.<br/>.`Top(int)` and `.Max(float)` define the upper elevation and value, while `.Bottom(int)` and `.Min(float)` define the lower elevation and value.<br/>Example: `YClampedGradient(densityFn).Top(100).Max(0).Bottom(-100).Max(1)"
+			return &out
+		},
+	)
 	traversal.Register(
 		func(densityFn *grammar.DensityFn_YClampedGradientContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			rangeChoiceBuilder := builder_chain.NewBuilderChain[YClampedGradientDensityFn](
diff --git a/lang/constructs/worldgen/noise/Noise.go b/lang/constructs/worldgen/noise/Noise.go
@@ -12,6 +12,12 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.NoiseDefinitionContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Defines a noise function.<br/>`FirstOctave(int)` is required.<br/>`Amplitudes(float)` is required.<br/>Example: `Noise(FirstOctave(100), Amplitudes(0.5, 0.5))`"
+			return &out
+		},
+	)
 	traversal.Register(func(blockCtx *grammar.NoiseBlockContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 		for _, child := range blockCtx.GetChildren() {
 			if rule, ok := child.(antlr.ParserRuleContext); ok {
@@ -21,53 +27,53 @@ func init() {
 		return nil
 	})
 	traversal.Register(func(declaration *grammar.NoiseDeclarationContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
-			noise := declaration.Noise()
-			if noise == nil {
-				// TODO: Diagnose?
-				return nil
-			}
-			noiseDef := noise.NoiseDefinition()
-			if noiseDef == nil {
-				// TODO: Diagnose?
-				return nil
-			}
-			s := traversal.ProcessDeclaration(declaration.Declare(), noiseDef, scope, currentNamespace, "Noise")
-			if s == nil {
-				return nil
-			}
- 		return s.GetValue()
-		})
+		noise := declaration.Noise()
+		if noise == nil {
+			// TODO: Diagnose?
+			return nil
+		}
+		noiseDef := noise.NoiseDefinition()
+		if noiseDef == nil {
+			// TODO: Diagnose?
+			return nil
+		}
+		s := traversal.ProcessDeclaration(declaration.Declare(), noiseDef, scope, currentNamespace, "Noise")
+		if s == nil {
+			return nil
+		}
+		return s.GetValue()
+	})
 	traversal.Register(func(noise *grammar.NoiseDefinitionContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
-			out := &Noise{
-				Amplitudes: make([]float64, 0),
-			}
+		out := &Noise{
+			Amplitudes: make([]float64, 0),
+		}
 
-			builder_chain.Builder_GetInt(
-				noise, func(i int) { out.FirstOctave = i }, scope, "FirstOctave",
-			)
+		builder_chain.Builder_GetInt(
+			noise, func(i int) { out.FirstOctave = i }, scope, "FirstOctave",
+		)
 
-			for _, r := range noise.AllNoise_Builder() {
-				if amplitudes := r.Builder_Amplitudes(); amplitudes != nil {
-					for _, amplitude := range amplitudes.AllNumber() {
-						if amplitude != nil {
-							val, err := strconv.ParseFloat(amplitude.GetText(), 64)
-							if err != nil {
-								scope.DiagnoseSemanticError(
-									"Invalid amplitude value",
-									amplitude,
-								)
-							} else {
-								out.Amplitudes = append(out.Amplitudes, val)
-							}
+		for _, r := range noise.AllNoise_Builder() {
+			if amplitudes := r.Builder_Amplitudes(); amplitudes != nil {
+				for _, amplitude := range amplitudes.AllNumber() {
+					if amplitude != nil {
+						val, err := strconv.ParseFloat(amplitude.GetText(), 64)
+						if err != nil {
+							scope.DiagnoseSemanticError(
+								"Invalid amplitude value",
+								amplitude,
+							)
+						} else {
+							out.Amplitudes = append(out.Amplitudes, val)
 						}
 					}
-				} else {
-					scope.DiagnoseSemanticError("Missing amplitudes value", r)
 				}
+			} else {
+				scope.DiagnoseSemanticError("Missing amplitudes value", r)
 			}
+		}
 
-			return out
-		},
+		return out
+	},
 	)
 }
 
diff --git a/lang/constructs/worldgen/surface_rules/Condition_AboveSurface.go b/lang/constructs/worldgen/surface_rules/Condition_AboveSurface.go
@@ -9,6 +9,12 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.SurfaceCondition_AboveSurfaceContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Checks if the current position is above the preliminary surface level, which is a Y-level usually a few blocks below the main surface, ignoring noise caves. This is used to prevent grass blocks from being placed in noise caves."
+			return &out
+		},
+	)
 	traversal.Register(func(ctx *grammar.SurfaceCondition_AboveSurfaceContext, _ string, _ *traversal.Scope) traversal.Construct {
 		return &AboveSurfaceCondition{}
 	})
diff --git a/lang/constructs/worldgen/surface_rules/Condition_AboveWater.go b/lang/constructs/worldgen/surface_rules/Condition_AboveWater.go
@@ -12,6 +12,12 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.SurfaceCondition_AboveWaterContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Checks if the current position is above water, based on terrain depth."
+			return &out
+		},
+	)
 	traversal.Register(
 		func(aboveWater *grammar.SurfaceCondition_AboveWaterContext, namespace string, scope *traversal.Scope) traversal.Construct {
 			waterBuildChain := builder_chain.NewBuilderChain[AboveWaterCondition](
diff --git a/lang/constructs/worldgen/surface_rules/Condition_Biome.go b/lang/constructs/worldgen/surface_rules/Condition_Biome.go
@@ -9,6 +9,12 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.SurfaceCondition_BiomeContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Checks the biome at the current position."
+			return &out
+		},
+	)
 	traversal.Register(
 		func(ctx *grammar.SurfaceCondition_BiomeContext, namespace string, scope *traversal.Scope) traversal.Construct {
 			refs := make([]traversal.Reference, 0)
diff --git a/lang/constructs/worldgen/surface_rules/Condition_Compound_And.go b/lang/constructs/worldgen/surface_rules/Condition_Compound_And.go
@@ -9,6 +9,12 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.SurfaceCondition_AndContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Combines multiple conditions with AND. <br/> Under the hood, each condition is handled as a minecraft:condition rule, this is just a convenience."
+			return &out
+		},
+	)
 	traversal.Register(
 		func(compound *grammar.SurfaceCondition_AndContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			conditions := make([]traversal.Construct, 0)
diff --git a/lang/constructs/worldgen/surface_rules/Condition_Compound_Or.go b/lang/constructs/worldgen/surface_rules/Condition_Compound_Or.go
@@ -9,6 +9,13 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.SurfaceCondition_OrContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Combines multiple conditions with OR. <br/> Under the hood, this creates a minecraft:sequence, with each condition as a direct child, and the result of this OR is the pass rule for all conditions in the sequence"
+			return &out
+		},
+	)
+
 	traversal.Register(
 		func(compound *grammar.SurfaceCondition_OrContext, currentNamespace string, scope *traversal.Scope) traversal.Construct {
 			conditions := make([]traversal.Construct, 0)
diff --git a/lang/constructs/worldgen/surface_rules/Condition_Freezing.go b/lang/constructs/worldgen/surface_rules/Condition_Freezing.go
@@ -9,6 +9,13 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.SurfaceCondition_FreezingContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Passes if the current position is in a biome where water can freeze"
+			return &out
+		},
+	)
+
 	traversal.Register(
 		func(_ *grammar.SurfaceCondition_FreezingContext, _ string, _ *traversal.Scope) traversal.Construct {
 			return &FreezingCondition{}
diff --git a/lang/constructs/worldgen/surface_rules/Condition_Hole.go b/lang/constructs/worldgen/surface_rules/Condition_Hole.go
@@ -9,6 +9,13 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.SurfaceCondition_HoleContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Passes if the current position is in a hole"
+			return &out
+		},
+	)
+
 	traversal.Register(
 		func(_ *grammar.SurfaceCondition_HoleContext, _ string, _ *traversal.Scope) traversal.Construct {
 			return &HoleCondition{}
diff --git a/lang/constructs/worldgen/surface_rules/Condition_Noise.go b/lang/constructs/worldgen/surface_rules/Condition_Noise.go
@@ -13,6 +13,13 @@ import (
 )
 
 func init() {
+	traversal.RegisterHelp[*grammar.SurfaceCondition_NoiseThresholdContext](
+		func(construct traversal.Construct, symbol traversal.Symbol, location traversal.TextLocation) *string {
+			out := "Passes based on the noise value of the current position. Value must be between .Min() and .Max(). <br/> .Min() and .Max() are required."
+			return &out
+		},
+	)
+
 	traversal.Register(
 		func(noise *grammar.SurfaceCondition_NoiseThresholdContext, namespace string, scope *traversal.Scope) traversal.Construct {
 			noiseBuildChain := builder_chain.NewBuilderChain[NoiseCondition](
diff --git a/lang/constructs/worldgen/surface_rules/Condition_Steep.go b/lang/constructs/worldgen/surface_rules/Condition_Steep.go
diff --git a/lang/constructs/worldgen/surface_rules/Condition_StoneDepth.go b/lang/constructs/worldgen/surface_rules/Condition_StoneDepth.go
diff --git a/lang/constructs/worldgen/surface_rules/Condition_VerticalGradient.go b/lang/constructs/worldgen/surface_rules/Condition_VerticalGradient.go
diff --git a/lang/constructs/worldgen/surface_rules/Condition_YAbove.go b/lang/constructs/worldgen/surface_rules/Condition_YAbove.go
diff --git a/lang/constructs/worldgen/surface_rules/Rule_Bandlands.go b/lang/constructs/worldgen/surface_rules/Rule_Bandlands.go
diff --git a/lang/constructs/worldgen/surface_rules/Rule_Block.go b/lang/constructs/worldgen/surface_rules/Rule_Block.go
diff --git a/lang/constructs/worldgen/surface_rules/Rule_If.go b/lang/constructs/worldgen/surface_rules/Rule_If.go

Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@ import (`
`14`	`14`	`func init() {`
`15`	`15`	`traversal.RegisterHelp[*grammar.DensityFn_ClampContext](`
`16`	`16`	`func(construct traversal.Construct, s traversal.Symbol, location traversal.TextLocation) *string {`
`17`		- help := `Clamps the input density function to the specified range`
	`17`	+ help := "Clamps the input density function to the specified range.<br/> `.Min(float)` and `.Max(float)` are required.<br/>Example: `Clamp(_densityFn_).Min(0).Max(1))`"
`18`	`18`	`return &help`
`19`	`19`	`},`
`20`	`20`	`)`