HytaleDocs
WorldGen

UniquePrefabs

Asset path: Server/WorldGen/UniquePrefabs/*.json

Parent

When set this asset will inherit properties from the named asset.

When inheriting from another UniquePrefabAsset most properties will simply be copied from the parent asset to this asset. In the case where both child and parent provide a field the child field will simply replace the value provided by the parent, in the case of nested structures this will apply to the fields within the structure. In some cases the field may decide to act differently, for example: by merging the parent and child fields together.

Type information: String

Tags

Tags are a general way to describe an asset that can be interpreted by other systems in a way they see fit.

For example you could tag something with a Material tag with the values Solid and Stone, And another single tag Ore.

Tags will be expanded into a single list of tags automatically. Using the above example with Material and Ore the end result would be the following list of tags: Ore, Material, Solid, Stone, Material=Solid and Material=Stone.

Type information:

(Nullable) Map of the following:

KeyType
any StringArray of String

Zones

The inherited zone placements. An explicit array replaces all inherited memberships. Repeated parents declare separate occurrences.

Type information:

(Nullable) Array of the type:

UniquePrefabZoneMembership with the following properties:

KeyTypeDescription
SeedIndexInteger

The nonnegative legacy seed index. It is honored only when ConvertedPin is true.

Name(Nullable) String defaults to: NO_NAME_GIVEN

The diagnostic name of this unique-prefab entry. The default is NO_NAME_GIVEN.

Category(Nullable) String

The prefab category used for placement. The default is UNIQUE.

Prefabs(Nullable) Array of the type:
WeightedPrefabValue

WeightedPrefabValue with the following properties:

KeyTypeDescription
Prefab(Nullable) String defaults to:

The prefab reference or pattern resolved by this entry.

WeightNumber defaults to: 1.0

The relative selection weight before resolved suppliers are divided. The default is 1.

The weighted prefab references available to this entry.

Config(Nullable) UniquePrefabConfigurationValue

The placement configuration for this unique-prefab entry.

Zone(Nullable) String that matches the pattern: [^\s] and is at least 1 characters long defaults to:

Reference to a ZoneAsset asset

The required exact ZoneAsset key for this placement.

OrderInteger

The nonnegative converter position within this parent. It is honored only when ConvertedPin is true.

ConvertedPinBoolean defaults to: false

Whether Order and SeedIndex preserve converted placement identities. The default is false.

On this page