BiomeSettings

Represents engine level biome settings that can be set from lua.  This class includes names for settings for sky color, fog, and cloud modifiers.  When objects of this type are received by lua during generation, they will already have been assigned a biome ID by the engine, and just need to be filled out with the required data via the various setter functions provided.  In the case one of these fields is not set in a specific BiomeSettings object, a default settings file will be used, as specified by the InitialSkySettings file.

Summary
BiomeSettingsRepresents engine level biome settings that can be set from lua.
Functions
NKGetBiomeIDReturns the ID assigned to this biome.
NKSetSkyColorsSets the name of the sky color settings to be used for this biome data.
NKSetFogSettingsSets the name of the fog settings to be used for this biome data.
NKAddCloudModifierAdds a cloud modifier by name to this biome data.

Functions

NKGetBiomeID

Returns the ID assigned to this biome.  Note that these biome IDs start at 1, not 0.

Returns

intThis settings’ biome ID.

NKSetSkyColors

Sets the name of the sky color settings to be used for this biome data.

Parameters

stringThe name of the settings to be used.

NKSetFogSettings

Sets the name of the fog settings to be used for this biome data.

Parameters

stringThe name of the settings to be used.

NKAddCloudModifier

Adds a cloud modifier by name to this biome data.  Note that you shouldn’t have multiple cloud modifiers that affect the same base layer on one biome, as behavior can be unpredictable in that case.

Parameters

stringThe name of the cloud modifier to add.
Close