biome


Playable when the biome at the current position of the player matches the specified parameters.

Accepts active_cooldown, biome_rainfall, biome_tag, biome_tag_matcher, biome_temperature, display_matcher, display_name, fade_in, fade_out, max_tracks, not, passive_persistence, persistence, play_when_paused, priority, rain_type, rainfall_greater_than, resource_matcher, resource_name, start_as_disabled, temperature_greater_than, ticks_before_active, ticks_before_audio, ticks_between_audio, toggle_inactive_playable, and toggle_save_status

Requires Parameters identifier AND ( biome_rainfall OR biome_tag OR biome_temperature OR display_name OR rain_type ORresource_name)

active_cooldown <default: 0>
    Determines the number of ticks that the trigger will not be able to
    activate for after being active and deactivating.

biome_rainfall <default: 1.4e-45f>
    The rainfall of the biome must pass a comparison with this number
    according to the rainfall_greater_than parameter.

biome_tag <default: [ any ]>
    The category or tag (depending on the version of the game) of the
    current biome must match one of the entries here according to the
    strategy specified by the biome_tag_matcher parameter.

biome_tag_matcher <default: exact>
    Determines the matching strategy for the biome_tag parameter. Accepts
    exact, partial, or regex.
    exact = The biome_tag must match exactly.
    partial = The biome_tag is allowed to partially match.
    regex = The biome_tag is treated as a regex expression.

biome_temperature <default: 1.4e-45f>
    The temperature of the biome must pass a comparison with this number
    according to the temperature_greater_than parameter.

display_matcher <default: exact>
    Determines the matching strategy for the display_name parameter. Accepts
    exact, partial, or regex.
    exact = The display_name must match exactly.
    partial = The display_name is allowed to partially match.
    regex = The display_name is treated as a regex expression.

display_name <default: [ any ]>
    The display name of the biome must match one of the entries here
    according to the strategy specified by the display_matcher parameter.

fade_in <default: 0>
    The number of ticks it will take the trigger to fade in after the trigger
    activates.

fade_out <default: 0>
    The number of ticks it will take the trigger to fade out when the trigger
    is no longer active.

max_tracks <default: 0>
    Determines the maximum number of audio tracks that will be able to play
    while the trigger is active. The counter is reset once the trigger is no
    longer active. Any value less than 1 will be treated as infinite.

not <default: false>
    Enabling this inverts the activation requirements meaning that the trigger
    will NOT be active when its parameters are met. Ignored by most time-based
    parameters.

passive_persistence <default: true>
    Determines whether the persistence parameter should be applied when the
    trigger is not active. When disabled, the trigger will ignore its
    persistence parameter if there is a higher priority trigger active.

persistence <default: 0>
    Determines the number of ticks after its parameters are no longer met that
    the trigger will be playable for.

play_when_paused <default: false>
    Determines whether the trigger is playable while the game is paused.
    Requires has_paused_music to be active for the channel.

priority <default: 600>
    The priority value of the trigger in regards to other triggers that are
    playable at the same time. By default the highest priority trigger always
    wins and will be active, but that can be changed via the debug config. See
    the independent_audio_pools and reverse_priority debug paremters for more
    info. For trigger combinations, nonspecific parameters like fade_out are
    taken from the highest priority trigger.

rain_type <default: any>
    The type of percipitation a biome must have where "any" means any type
    including none. Accepts any, none, rain, or snow.

rainfall_greater_than <default: true>
    Determines whether biome_rainfall will be the (inclusive) minimum or
    maximum value.

resource_matcher <default: partial>
    Determines the matching strategy for the resource_name parameter. Accepts
    exact, partial, or regex.
    exact = The resource_name must match exactly.
    partial = The resource_name is allowed to partially match.
    regex = The resource_name is treated as a regex expression.

resource_name <default: [ any ]>
    The resource name or ID of the biome must match one of the entries here
    according to the strategy specified by the resource_matcher parameter.

start_as_disabled <default: false>
    If this is true the trigger will be toggled off by default and must be
    toggled on by something else to be usable. Unless you know how toggles
    work it is recommended to leave this at its default value.

temperature_greater_than <default: true>
    Determines whether biome_emperature will be the (inclusive) minimum or maximum value.

ticks_before_active <default: 0>
    The number of ticks after the parameters are met before the trigger is
    active (or playable if not the highest priority).

ticks_before_audio <default: 0>
    The number of ticks after the trigger is active before audio can start
    playing.

ticks_between_audio <default: 0>
    The number of ticks after the audio finishes before the next entry in the
    pool can play.

toggle_inactive_playable <default: false>
    Determines whether the trigger should be toggled off when it is playable
    (all of its parameters and timers are met) but it is not the active
    (highest priority or in combination with the highest priority) trigger.
    Unless you have a good understanding of how toggles and trigger states
    work it is recommended to leave this at its default value.

toggle_save_status <default: false>
    Determines if and how the toggle status for the trigger is saved and set.
    Accepts integers from 0-2.
    0 = Nothing is saved or set. Toggle status will reset after a restart.
    1 = Toggle status will reset after the player logs out.
    2 = Toggle status will reset after the player logs out and be set when
        the player logs back in.