NoiseModule

Interface for biome height and material generation

Summary
NoiseModuleInterface for biome height and material generation
INoiseHeightInterface for generation modules that produce height outputs
Functions
NKSetSourceModuleHeightSets the height source input of a INoiseHeight module
INoiseWeightInterface for generation module that weigh between source inputs
Functions
NKSetSourceWeightSets the height INoiseHeight source input of a module that takes a weight
NKSetShouldNormalizeTells the modules if it should normalize the weight input between min and max possible height values, or use raw height values
INoiseMaterialInterface for generation modules that output materials
Functions
NKSetSourceModuleMaterialSets the material source input of a INoiseMaterial module
MultiplyModuleModule that multiplies the two source inputs
AddModuleModule that adds the two source inputs
MaxModuleModule that takes the max value of the two source inputs
MinModuleModule that takes the min value of the two source inputs
AbsModuleModule that calculates the absolute value of the source input
NormalizeModuleModule that calculates the normalized value between the min and max possible heights
ClampModuleModule that clamps the source input between a min and max value
Functions
NKSetUpperBoundSets the max clamp value
NKSetLowerBoundSets the min clamp value
PowerModuleModule that raises the first source input to the power of the second source input
BlendModuleModule that LERPs between the first and second height inputs based upon the weight input
InvertModuleModule that flip the height around the center point between min and max heights
SelectModuleModule that selects either the first or second input based upon the weight value Ex.
Functions
NKSetFalloffSets the blending region between the transition between source inputs
NKSetBoundsSets the min and max selection range
AverageModuleModule that averages the values of the two source inputs
CurveModuleModule that maps the source input onto a cubic spline
Functions
NKAddControlPointAdds a 2d position to control the spline used for mapping the source input
NearestModuleSelects the nearest control point to the source input
Functions
NKAddControlPointAdds a control point height to be selected by value proximity to source input
TerraceModuleModule that maps the source input onto a blended step function
Functions
NKAddControlPointAdds a control point height to be interpolated between this control point and the next control point
MaterialModuleModule that returns a constant material value
Functions
NKSetMaterialNameSets the material name for this module to be returned later
SwitchModuleModule that switches between the first and second source inputs based on the weight input
Functions
NKSetThresholdSets the transition point between the two height inputs
NKSetFalloffSets the blending region between the transition between source inputs
NKSetMaterialThresholdSets the transition point between the two material inputs
ConstantModuleModule that returns a constant height value
Functions
NKSetValueSets the constant height value
SimplexModuleModule that returns the simplex noise value (range -1.0 to +1.0)
Functions
NKSetScaleSets the frequency of the noise
NKSetNumOctavesSets the number of noise layers averaged together
NKSetPersistenceSets the value that determines the amplitude of octaves
NKSetLacunaritySets the value that determines the frequency of octaves
GenerationTreeThe root module of all source noise modules
Functions
NKSetHeightRootSets the root height module
NKSetMaterialRootSets the root material module
BiomeModuleThe root module of a biome or sub-biome
Functions
NKSetNameSets the user-defined name of the biome
NKSetObjectsSets the user-defined object population rules
NKSetClustersSets the user-defined object cluster definitions
NKSetLighting

INoiseHeight

Interface for generation modules that produce height outputs

Summary
Functions
NKSetSourceModuleHeightSets the height source input of a INoiseHeight module

Functions

NKSetSourceModuleHeight

Sets the height source input of a INoiseHeight module

Parameters

intsource input index
INoiseHeightThe input module

INoiseWeight

Interface for generation module that weigh between source inputs

Summary
Functions
NKSetSourceWeightSets the height INoiseHeight source input of a module that takes a weight
NKSetShouldNormalizeTells the modules if it should normalize the weight input between min and max possible height values, or use raw height values

Functions

NKSetSourceWeight

Sets the height INoiseHeight source input of a module that takes a weight

Parameters

INoiseHeightThe input module

NKSetShouldNormalize

Tells the modules if it should normalize the weight input between min and max possible height values, or use raw height values

Parameters

booltrue if the values should be normalized

INoiseMaterial

Interface for generation modules that output materials

Summary
Functions
NKSetSourceModuleMaterialSets the material source input of a INoiseMaterial module

Functions

NKSetSourceModuleMaterial

Sets the material source input of a INoiseMaterial module

Parameters

intsource input index
INoiseMaterialThe input module

MultiplyModule

Module that multiplies the two source inputs

Inherits:

AddModule

Module that adds the two source inputs

Inherits:

MaxModule

Module that takes the max value of the two source inputs

Inherits:

MinModule

Module that takes the min value of the two source inputs

Inherits:

AbsModule

Module that calculates the absolute value of the source input

Inherits:

NormalizeModule

Module that calculates the normalized value between the min and max possible heights

Inherits:

ClampModule

Module that clamps the source input between a min and max value

Inherits:

Summary
Functions
NKSetUpperBoundSets the max clamp value
NKSetLowerBoundSets the min clamp value

Functions

NKSetUpperBound

Sets the max clamp value

Parameters

doublethe max value of the clamp

NKSetLowerBound

Sets the min clamp value

Parameters

doublethe min value of the clamp

PowerModule

Module that raises the first source input to the power of the second source input

Inherits:

BlendModule

Module that LERPs between the first and second height inputs based upon the weight input

Inherits:

InvertModule

Module that flip the height around the center point between min and max heights

Inherits:

SelectModule

Module that selects either the first or second input based upon the weight value Ex.  If the weight value is between the min and max bounds, the second source input is chosen, else the first is chosen

Inherits:

Summary
Functions
NKSetFalloffSets the blending region between the transition between source inputs
NKSetBoundsSets the min and max selection range

Functions

NKSetFalloff

Sets the blending region between the transition between source inputs

Parameters

doublethe weight falloff value (between 0 and 1, the higher the number the more gradual the blend)

NKSetBounds

Sets the min and max selection range

Parameters

doublethe min selection range
doublethe max selection range

AverageModule

Module that averages the values of the two source inputs

Inherits:

CurveModule

Module that maps the source input onto a cubic spline

Inherits:

Summary
Functions
NKAddControlPointAdds a 2d position to control the spline used for mapping the source input

Functions

NKAddControlPoint

Adds a 2d position to control the spline used for mapping the source input

Parameters

doublethe x coordinate of the control point
doublethe y coordinate of the control point

NearestModule

Selects the nearest control point to the source input

Inherits:

Summary
Functions
NKAddControlPointAdds a control point height to be selected by value proximity to source input

Functions

NKAddControlPoint

Adds a control point height to be selected by value proximity to source input

Parameters

doublethe height value

TerraceModule

Module that maps the source input onto a blended step function

Inherits:

Summary
Functions
NKAddControlPointAdds a control point height to be interpolated between this control point and the next control point

Functions

NKAddControlPoint

Adds a control point height to be interpolated between this control point and the next control point

Parameters

doublethe height value

MaterialModule

Module that returns a constant material value

Inherits:

Summary
Functions
NKSetMaterialNameSets the material name for this module to be returned later

Functions

NKSetMaterialName

Sets the material name for this module to be returned later

Parameters

stringthe material name specified in the material files

SwitchModule

Module that switches between the first and second source inputs based on the weight input

Inherits:

Summary
Functions
NKSetThresholdSets the transition point between the two height inputs
NKSetFalloffSets the blending region between the transition between source inputs
NKSetMaterialThresholdSets the transition point between the two material inputs

Functions

NKSetThreshold

Sets the transition point between the two height inputs

Parameters

doublenormalized transition point (range 0 to 1)

NKSetFalloff

Sets the blending region between the transition between source inputs

Parameters

doublethe weight falloff value (between 0 and 1, the higher the number the more gradual the blend)

NKSetMaterialThreshold

Sets the transition point between the two material inputs

Parameters

doublenormalized transition point (range 0 to 1)

ConstantModule

Module that returns a constant height value

Inherits:

Summary
Functions
NKSetValueSets the constant height value

Functions

NKSetValue

Sets the constant height value

Parameters

doublethe constant height value

SimplexModule

Module that returns the simplex noise value (range -1.0 to +1.0)

Inherits:

Summary
Functions
NKSetScaleSets the frequency of the noise
NKSetNumOctavesSets the number of noise layers averaged together
NKSetPersistenceSets the value that determines the amplitude of octaves
NKSetLacunaritySets the value that determines the frequency of octaves

Functions

NKSetScale

Sets the frequency of the noise

Parameters

floatthe noise frequency.  Smaller values are rougher, larger values change more gradually.  Always positive

NKSetNumOctaves

Sets the number of noise layers averaged together

Parameters

intnumber of octaves.  Lower octaves have less noise

NKSetPersistence

Sets the value that determines the amplitude of octaves

Parameters

floata scalar value for octaves.  Lower values create smoother noise

NKSetLacunarity

Sets the value that determines the frequency of octaves

Parameters

floata scalar value for octaves.  Lower values creates less noise

GenerationTree

The root module of all source noise modules

Summary
Functions
NKSetHeightRootSets the root height module
NKSetMaterialRootSets the root material module

Functions

NKSetHeightRoot

Sets the root height module

Parameters

INoiseHeightThe root height module in the generation tree

NKSetMaterialRoot

Sets the root material module

Parameters

INoiseMaterialThe root material module in the generation tree

BiomeModule

The root module of a biome or sub-biome

Inherits:

Summary
Functions
NKSetNameSets the user-defined name of the biome
NKSetObjectsSets the user-defined object population rules
NKSetClustersSets the user-defined object cluster definitions
NKSetLighting

Functions

NKSetName

Sets the user-defined name of the biome

Parameters

stringthe name of the biome

NKSetObjects

Sets the user-defined object population rules

Parameters

Tablea LUA table defining the objects to be populated in this biome with chance and density
["object by name"] = { density, chance, minScale, maxScale },
["object by name"] = { density, chance, minScale, maxScale },
["object by name"] = { density, chance, minScale, maxScale },
...

NKSetClusters

Sets the user-defined object cluster definitions

Parameters

Tablea LUA table defining the clusters of objects to be populated in this biome with chance and density
["cluster name"] = { density, chance, Objects { name, offset, minScale, maxScale } },
["cluster name"] = { density, chance, Objects { name, offset, minScale, maxScale } },
["cluster name"] = { density, chance, Objects { name, offset, minScale, maxScale } },
...

NKSetLighting

NYISets the user-defined biome lighting settings

Parameters

Tablea LUA table defining the lighting settings for this biome
vec3  AmbientColor - representing ambient lighting color
float Intensity    - scalar for lighting intensities
vec3  DayColor     - lighting color in the daytime of the biome
vec3  NightColor   - lighting color in the nightime of the biome
Interface for biome height and material generation
Interface for generation modules that produce height outputs
Interface for generation modules that output materials
Interface for generation module that weigh between source inputs
Close