Class LocationConfig

Configuration class for adding custom locations.
Use this in a constructor of CustomLocation and

Inheritance

System.Object

LocationConfig

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Jotunn.Configs

Assembly: Jotunn.dll

Syntax

public class LocationConfig

Constructors

| Improve this Doc View Source

LocationConfig()

Create a new LocationConfig

Declaration

public LocationConfig()

| Improve this Doc View Source

LocationConfig(ZoneSystem.ZoneLocation)

Create a copy of the

Declaration

public LocationConfig(ZoneSystem.ZoneLocation zoneLocation)

Parameters

Type	Name	Description
ZoneSystem.ZoneLocation	zoneLocation	ZoneLocation to copy

Properties

| Improve this Doc View Source

Biome

Biome to spawn in, multiple Biomes can be allowed with AnyBiomeOf(Heightmap.Biome[])

Declaration

public Heightmap.Biome Biome { get; set; }

Property Value

Type	Description
Heightmap.Biome

| Improve this Doc View Source

BiomeArea

BiomeArea to spawn in, defaults to Everything

Declaration

public Heightmap.BiomeArea BiomeArea { get; set; }

Property Value

Type	Description
Heightmap.BiomeArea

| Improve this Doc View Source

CenterFirst

Attempt to place in the central zone first

Declaration

public bool CenterFirst { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

ChanceToSpawn

Unused in Valheim, but available in case that changes in the future

Declaration

[Obsolete("This property is unused by Valheim.")]
public float ChanceToSpawn { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

ClearArea

Enable to forbid Vegetation from spawning inside the circle defined by ExteriorRadius

Declaration

public bool ClearArea { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

ExteriorRadius

Radius of the location. Terrain delta is calculated within this circle.

Declaration

public float ExteriorRadius { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

ForestTrasholdMax

Maximum value of the forest fractal: 0 - 1: inside the forest 1: forest edge 1 - infinity: outside the forest

Declaration

public float ForestTrasholdMax { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

ForestTresholdMin

Minimum value of the forest fractal: 0 - 1: inside the forest 1: forest edge 1 - infinity: outside the forest

Declaration

public float ForestTresholdMin { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Group

Group of the location. Used with MinDistanceFromSimilar

Declaration

public string Group { get; set; }

Property Value

Type	Description
System.String

| Improve this Doc View Source

HasInterior

Enable to

Declaration

public bool HasInterior { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IconAlways

Always show the associated icon on the minimap

Declaration

public bool IconAlways { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

IconPlaced

Enable if the location places an icon to push the location icons

Declaration

public bool IconPlaced { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

InForest

Enable to check forest thresholds against the forest fractal.

Declaration

public bool InForest { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

InteriorRadius

Radius of the interior attached to the location

Declaration

public float InteriorRadius { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Location

Associated Location component

Declaration

public Location Location { get; }

Property Value

Type	Description
Location

| Improve this Doc View Source

MaxAltitude

Maximum altitude of the location

Declaration

public float MaxAltitude { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

MaxDistance

Maximum distance from the center of the map of the location

Declaration

public float MaxDistance { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

MaxTerrainDelta

Maximum terrain delta (difference between min and max height) in the circle defined by ExteriorRadius

Declaration

public float MaxTerrainDelta { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

MinAltitude

Minimal altitude of the location

Declaration

public float MinAltitude { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

MinDistance

Minimum distance from the center of the map of the location

Declaration

public float MinDistance { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

MinDistanceFromSimilar

Minimum distance to a similar location, either the same location or a location with the same Group

Declaration

public float MinDistanceFromSimilar { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

MinTerrainDelta

Minimum terrain delta (difference between min and max height) in the circle defined by ExteriorRadius

Declaration

public float MinTerrainDelta { get; set; }

Property Value

Type	Description
System.Single

| Improve this Doc View Source

Priotized

Enable to place this kind of location first, and make it twice as likely that the objects will all be placed (random samples increase from 100,000 to 200,000)

Declaration

public bool Priotized { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Quantity

Upper limit on how many of these locations will be placed in the world

Declaration

public int Quantity { get; set; }

Property Value

Type	Description
System.Int32

| Improve this Doc View Source

RandomRotation

Randomize location rotation when placing

Declaration

public bool RandomRotation { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

SlopeRotation

Rotate towards the average slope of the terrain in the circle defined by ExteriorRadius

Declaration

public bool SlopeRotation { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

SnapToWater

Place at water level

Declaration

public bool SnapToWater { get; set; }

Property Value

Type	Description
System.Boolean

| Improve this Doc View Source

Unique

Enable to make this location unique, it will not be replaced when locations change

Declaration

public bool Unique { get; set; }

Property Value

Type	Description
System.Boolean

Methods

| Improve this Doc View Source

GetZoneLocation()

Converts the LocationConfig to a Valheim style .

Declaration

public ZoneSystem.ZoneLocation GetZoneLocation()

Returns

Type	Description
ZoneSystem.ZoneLocation	The Valheim

Extension Methods

PrefabExtension.FixReferences(Object)