Class AtmosphereVolumeTemplate

Namespace

Nautilus.Assets.PrefabTemplates

Assembly

Nautilus.dll

A template for Atmosphere Volumes, which are basic invisible triggers for mini-biomes. Atmosphere volumes can affect fog, music, ambient sounds and even the player's swim speed.

public class AtmosphereVolumeTemplate : PrefabTemplate

Inheritance

object

PrefabTemplate

AtmosphereVolumeTemplate

Inherited Members

PrefabTemplate.info

PrefabTemplate.OnPrefabPostProcessor(GameObject)

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

JsonExtensions.LoadJson<T>(T, string, bool, params JsonConverter[])

JsonExtensions.SaveJson<T>(T, string, params JsonConverter[])

ReflectionHelper.CopyFields<T>(T, T, BindingFlags)

ReflectionHelper.GetInstanceField<T>(T, string, BindingFlags)

ReflectionHelper.GetInstanceMethod<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticField<T>(T, string, BindingFlags)

ReflectionHelper.GetStaticMethod<T>(T, string, BindingFlags)

ReflectionHelper.SetInstanceField<T>(T, string, object, BindingFlags)

ReflectionHelper.SetStaticField<T>(T, string, object, BindingFlags)

Constructors

AtmosphereVolumeTemplate(PrefabInfo, VolumeShape, string, int, CellLevel)

Creates a new prefab template for an asset bundle.

public AtmosphereVolumeTemplate(PrefabInfo info, AtmosphereVolumeTemplate.VolumeShape shape, string overrideBiome, int priority = 10, LargeWorldEntity.CellLevel cellLevel = CellLevel.Far)

Parameters

info PrefabInfo

The prefab info to base this template off of.

shape AtmosphereVolumeTemplate.VolumeShape

The shape of this atmosphere volume.

overrideBiome string

The biome type used by this atmosphere volume.

priority int

The priority of this atmosphere volume. Atmosphere volumes with higher priorities override those with lower priorities.

cellLevel LargeWorldEntity.CellLevel

Determines the loading distance of this atmosphere volume prefab. Although vanilla prefabs always use Batch for this, this does not work with our custom systems.

Properties

CanEnterWhileInsideVehicle

Whether this atmosphere volume can be entered while inside a vehicle or not. For unknown reasons, this is NOT true for base game volumes. However, in this template, it is true by default.

public bool CanEnterWhileInsideVehicle { get; set; }

Property Value

bool

CellLevel

Determines the loading distance of this atmosphere volume prefab. Default value is LargeWorldEntity.CellLevel.Far. Although vanilla prefabs always use Batch for this, this does not work with our custom systems.

public LargeWorldEntity.CellLevel CellLevel { get; set; }

Property Value

LargeWorldEntity.CellLevel

ModifyPrefab

Callback that will get called after the prefab is retrieved. Use this to modify or process your prefab further more.

public Action<GameObject> ModifyPrefab { get; set; }

Property Value

Action<GameObject>

ModifyPrefabAsync

Callback that will get called after the prefab is retrieved. Use this to modify or process your prefab further more asynchronously.

public Func<GameObject, IEnumerator> ModifyPrefabAsync { get; set; }

Property Value

Func<GameObject, IEnumerator>

OverrideBiome

The biome type used by this atmosphere volume.

public string OverrideBiome { get; set; }

Property Value

string

Priority

The priority of this atmosphere volume. Atmosphere volumes with higher priorities override those with lower priorities. The default priority is 10.

public int Priority { get; set; }

Property Value

int

Shape

The shape of this atmosphere volume.

public AtmosphereVolumeTemplate.VolumeShape Shape { get; set; }

Property Value

AtmosphereVolumeTemplate.VolumeShape

Methods

GetPrefabAsync(TaskResult<GameObject>)

Creates an atmosphere volume prefab.

public override IEnumerator GetPrefabAsync(TaskResult<GameObject> gameObject)

Parameters

gameObject TaskResult<GameObject>

Returns

IEnumerator