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
FluidFXIds
Type information: (Nullable) Array of String
SurroundingBlockSoundSets
Type information:
(Nullable) Array of the type:
AmbienceFXBlockSoundSet with the following properties:
| Key | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| BlockSoundSetId | String | ||||||||||
| Percent | (Nullable)
Rangef
|
Altitude
Type information:
Range with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Integer defaults to: 0 | |
| Max | Integer defaults to: 0 |
Walls
Type information:
Rangeb with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Integer defaults to: 0 | |
| Max | Integer 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:
| Key | Type | Description |
|---|---|---|
| Min | Integer defaults to: 0 | |
| Max | Integer defaults to: 0 |
TorchLightLevel
Type information:
Rangeb with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Integer defaults to: 0 | |
| Max | Integer defaults to: 0 |
GlobalLightLevel
Type information:
Rangeb with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Integer defaults to: 0 | |
| Max | Integer defaults to: 0 |
DayTime
Type information:
Rangef with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Number defaults to: 0.0 | |
| Max | Number 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:
| Name | Description |
|---|---|
"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:
| Name | Description |
|---|---|
"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:
| Name | Description |
|---|---|
"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):
| Name | Description |
|---|---|
"Any" | |
"Roofed" | |
"Unroofed" |
SpaceScaleRange
Type information:
(Nullable)
Rangef with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Number defaults to: 0.0 | |
| Max | Number defaults to: 0.0 |
SpaceScaleMinRange
Type information:
(Nullable)
Rangef with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Number defaults to: 0.0 | |
| Max | Number defaults to: 0.0 |
SpaceScaleMaxRange
Type information:
(Nullable)
Rangef with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Number defaults to: 0.0 | |
| Max | Number defaults to: 0.0 |
EscapedRayPercentRange
Type information:
(Nullable)
Rangef with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Number defaults to: 0.0 | |
| Max | Number defaults to: 0.0 |
ReflectionCoeffRange
Type information:
(Nullable)
Rangef with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Number defaults to: 0.0 | |
| Max | Number defaults to: 0.0 |
AbsorptionCoeffRange
Type information:
(Nullable)
Rangef with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Number defaults to: 0.0 | |
| Max | Number defaults to: 0.0 |
RoofDistanceRange
Type information:
(Nullable)
Rangef with the following properties:
| Key | Type | Description |
|---|---|---|
| Min | Number defaults to: 0.0 | |
| Max | Number defaults to: 0.0 |
SurfacePhysicalMaterials
Type information:
(Nullable) Array of the type:
AmbienceFXPhysicalMaterial with the following properties:
| Key | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PhysicalMaterialId | String | ||||||||||
| Percent | Rangef
|
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:
| Key | Type | Description | |||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| PhysicalMaterialId | String | ||||||||||
| Percent | Rangef
|
ExteriorRoofPhysicalMaterialsMatchAny
When true, the ExteriorRoofPhysicalMaterials condition matches if any entry matches (OR semantics). By default all must match.
Type information: Boolean defaults to: false
