HytaleDocs
Misc

AmbienceFXConditions

Never

If true, this Ambience will never conditionally trigger (but can be set server-side, for example).

Type information: Boolean defaults to: false

EnvironmentIds

Type information: (Nullable) Array of String

Reference to a Environment asset

EnvironmentTagPattern

A tag pattern to use for matching environments.

Type information:

(Nullable) Either String or TagPattern

Reference to a TagPattern asset

WeatherTagPattern

A tag pattern to use for matching weathers.

Type information:

(Nullable) Either String or TagPattern

Reference to a TagPattern asset

WeatherIds

Type information: (Nullable) Array of String

Reference to a Weather asset

FluidFXIds

Type information: (Nullable) Array of String

Reference to a FluidFX asset

SurroundingBlockSoundSets

Type information:

(Nullable) Array of the type:

AmbienceFXBlockSoundSet with the following properties:

KeyTypeDescription
BlockSoundSetIdString

Reference to a BlockSoundSet asset

Percent(Nullable)
Rangef

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

Altitude

Type information:

Range with the following properties:

KeyTypeDescription
MinInteger defaults to: 0
MaxInteger defaults to: 0

Walls

Type information:

Rangeb with the following properties:

KeyTypeDescription
MinInteger defaults to: 0
MaxInteger defaults to: 0

Roof

Deprecated: Use RoofState instead.

Type information: Boolean defaults to: false

RoofMaterialTagPattern

A tag pattern to use for matching roof material. If Roof is not required, will only be matched if a roof is present.

Type information:

(Nullable) Either String or TagPattern

Reference to a TagPattern asset

Floor

Type information: Boolean defaults to: false

SunLightLevel

Type information:

Rangeb with the following properties:

KeyTypeDescription
MinInteger defaults to: 0
MaxInteger defaults to: 0

TorchLightLevel

Type information:

Rangeb with the following properties:

KeyTypeDescription
MinInteger defaults to: 0
MaxInteger defaults to: 0

GlobalLightLevel

Type information:

Rangeb with the following properties:

KeyTypeDescription
MinInteger defaults to: 0
MaxInteger defaults to: 0

DayTime

Type information:

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

Space

The rough scale of the space to match.

Type information:

(Nullable) Array of the type: Any one of the following String:

NameDescription
"Any"
"Tiny"
"Small"
"Medium"
"Large"
"Unbounded"

Shelter

The rough amount of shelter from exterior elements to match.

Type information:

(Nullable) Array of the type: Any one of the following String:

NameDescription
"Any"
"Open"
"Partial"
"Sheltered"
"Enclosed"

Surfaces

Reflectivity of surfaces within the space to match.

Type information:

(Nullable) Array of the type: Any one of the following String:

NameDescription
"Any"
"Reflective"
"Mixed"
"Absorbent"

RoofState

Whether or not a roof must be present to match (or can be set to not care).

Type information:

(Nullable) Any one of the following String (defaults to Any):

NameDescription
"Any"
"Roofed"
"Unroofed"

SpaceScaleRange

Type information:

(Nullable)

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

SpaceScaleMinRange

Type information:

(Nullable)

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

SpaceScaleMaxRange

Type information:

(Nullable)

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

EscapedRayPercentRange

Type information:

(Nullable)

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

ReflectionCoeffRange

Type information:

(Nullable)

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

AbsorptionCoeffRange

Type information:

(Nullable)

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

RoofDistanceRange

Type information:

(Nullable)

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

SurfacePhysicalMaterials

Type information:

(Nullable) Array of the type:

AmbienceFXPhysicalMaterial with the following properties:

KeyTypeDescription
PhysicalMaterialIdString

Reference to a PhysicalMaterial asset

Percent
Rangef

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

SurfacePhysicalMaterialsMatchAny

When true, the SurfacePhysicalMaterials condition matches if any entry matches (OR semantics). By default all must much.

Type information: Boolean defaults to: false

ExteriorRoofPhysicalMaterials

The percentage ratios of the last physical material encountered before a probe ray escapes, i.e. the inferred "roof" materials.

Type information:

(Nullable) Array of the type:

AmbienceFXPhysicalMaterial with the following properties:

KeyTypeDescription
PhysicalMaterialIdString

Reference to a PhysicalMaterial asset

Percent
Rangef

Rangef with the following properties:

KeyTypeDescription
MinNumber defaults to: 0.0
MaxNumber defaults to: 0.0

ExteriorRoofPhysicalMaterialsMatchAny

When true, the ExteriorRoofPhysicalMaterials condition matches if any entry matches (OR semantics). By default all must match.

Type information: Boolean defaults to: false

On this page