Class BiomeHandler

Namespace

Nautilus.Handlers

Assembly

Nautilus.dll

A handler class for registering new biome types.

public static class BiomeHandler

Inheritance

object

BiomeHandler

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Methods

AddBiomeAmbience(string, FMODAsset, InteriorState)

Adds an ambient sound that plays in the given biome(s). The sound emitter is played when the given conditions are ended, until those conditions are no longer true, and then a fadeout is allowed.

public static void AddBiomeAmbience(string biomeName, FMODAsset ambienceAsset, FMODGameParams.InteriorState interiorState)

Parameters

biomeName string

The name of the biome that this ambient sound can play in. Prefix matching and case insensitive, so using "canyon" for this value would affect biomes named "canyon_one" and "canyon_TWO".

ambienceAsset FMODAsset

The sound asset that plays in this biome.

interiorState FMODGameParams.InteriorState

Determines how this sound is affected by being indoors or outside.

AddBiomeMusic(string, FMODAsset, InteriorState)

Adds music that plays in the given biome(s). The sound emitter is played when the given conditions are ended, until those conditions are no longer true, and then a fadeout is allowed.

public static void AddBiomeMusic(string biomeName, FMODAsset musicAsset, FMODGameParams.InteriorState interiorState = InteriorState.Always)

Parameters

biomeName string

The name of the biome that this music can play in. Prefix matching and case insensitive, so using "canyon" for this value would affect biomes named "canyon_one" and "canyon_TWO".

musicAsset FMODAsset

The sound asset that plays in this biome.

interiorState FMODGameParams.InteriorState

Determines how this sound is affected by being indoors or outside.

RegisterBiome(string, Settings, SkyReference)

Registers a new biome type into the game.

public static void RegisterBiome(string name, WaterscapeVolume.Settings settings, BiomeHandler.SkyReference sky)

Parameters

name string

The name of the biome, as seen in the F1 menu.

settings WaterscapeVolume.Settings

The fog settings of the biome. See CreateBiomeSettings(Vector3, float, Color, float, Color, float, float, float, float, float).

sky BiomeHandler.SkyReference

The Sky of the biome, which determines reflections and general lighting.