View source for Minecraft:Number provider

<!--#REDIRECT [[Minecraft:Loot table#Number provider]]-->
{{For|a similar data structure used in enchantments|Enchantment definition#Level-based value}}
{{Exclusive|Java}}
{{wip|Add history, better specify the uses, talk about how it depends on the [[Minecraft:loot context]] and how each use defines the context.}}
A '''number provider''' is a data structure used to provide a number, which can be simply a constant, a random number within a certain distribution, a number under a certain condition, etc. Number providers are used in [[Minecraft:loot table]]s, [[Minecraft:predicate]]s, [[Minecraft:item modifiers]], [[Minecraft:Villager_trade_definition|villager trade]], [[Minecraft:trade sets]], and in data components{{Upcoming|Java 26.3}} ({{DCL|compostable}}, {{DCL|cooking_fuel}}, and {{DCL|brewing_fuel}}).

== JSON definition == 
{{in development|Java|section=1||26.3}}

Number providers can be defined in [[Minecraft:data pack]]s, as part of the directory structure below.

<div class="treeview">
*{{File|archive|''data pack name''.zip}} or {{File|directory|''data pack name''}}
**{{File|file|[[#pack.mcmeta|pack.mcmeta]]}}
**{{File|directory|data}}
***{{File|directory|''namespace''}}
****{{File|directory|'''number_provider'''}}
*****{{File|file|'''{{ph|name}}.json'''}}
****[[Minecraft:Data pack#Folder_structure|More directories&hellip;]]
</div>

== Use ==

In most uses of number provider, it is used as an [[Minecraft:NBT]] object, within a larger structure. This includes all uses in [[Minecraft:loot table]]s, [[Minecraft:predicate]]s, [[Minecraft:item modifiers]], [[Minecraft:Villager_trade_definition|villager trade]], and [[Minecraft:trade sets]]. 

In Java 26.3, number provider [[Minecraft:registry]] can be used in the component {{DCL|compostable}} to define how many layers are added when using [[Minecraft:composter]]. In this case, only number providers are accepted, not line definitions.

=== Vanila registries ===
{{in development|Java|section=1||26.3}}

There are registry number providers used in vanilla [[Minecraft:data pack]].

{{File|directory|compostable}}: Number providers used in the default component {{DCL|compostable}}:
{{JSON file|always_add_one|1.0}}
{{JSON file|low|{
  "type": "minecraft:number_dispatcher",
  "cases": [
    {
      "condition": {
        "block": "minecraft:composter",
        "condition": "minecraft:block_state_property",
        "properties": {
          "level": "0"
        }
      },
      "number_provider": 1.0
    }
  ],
  "default": {
    "type": "minecraft:weighted_list",
    "distribution": [
      {
        "data": 1.0,
        "weight": 30
      },
      {
        "data": 0.0,
        "weight": 70
      }
    ]
  }
}
}}
{{JSON file|low_medium.json|{
  "type": "minecraft:number_dispatcher",
  "cases": [
    {
      "condition": {
        "block": "minecraft:composter",
        "condition": "minecraft:block_state_property",
        "properties": {
          "level": "0"
        }
      },
      "number_provider": 1.0
    }
  ],
  "default": {
    "type": "minecraft:weighted_list",
    "distribution": [
      {
        "data": 1.0,
        "weight": 50
      },
      {
        "data": 0.0,
        "weight": 50
      }
    ]
  }
}
}}
{{JSON file|medium|{
  "type": "minecraft:number_dispatcher",
  "cases": [
    {
      "condition": {
        "block": "minecraft:composter",
        "condition": "minecraft:block_state_property",
        "properties": {
          "level": "0"
        }
      },
      "number_provider": 1.0
    }
  ],
  "default": {
    "type": "minecraft:weighted_list",
    "distribution": [
      {
        "data": 1.0,
        "weight": 65
      },
      {
        "data": 0.0,
        "weight": 35
      }
    ]
  }
}
}}
{{JSON file|medium_high.json|{
  "type": "minecraft:number_dispatcher",
  "cases": [
    {
      "condition": {
        "block": "minecraft:composter",
        "condition": "minecraft:block_state_property",
        "properties": {
          "level": "0"
        }
      },
      "number_provider": 1.0
    }
  ],
  "default": {
    "type": "minecraft:weighted_list",
    "distribution": [
      {
        "data": 1.0,
        "weight": 85
      },
      {
        "data": 0.0,
        "weight": 15
      }
    ]
  }
}
}}

{{File|directory|cooking}}:  Number providers used in the default component {{DCL|cooking_fuel.burn_time}}, except {{cd|speed_default}}:
{{JSON file/cooking|speed_default|1.0|2.0|desc=: Used in the default components {{cd|cooking_fuel.speed_multiplier}} and {{DCL|brewing_fuel.speed_multiplier}}}}
{{JSON file/cooking|time_bamboo|50.0|25.0}}
{{JSON file/cooking|time_blaze|2400.0|1200.0}}
{{JSON file/cooking|boats|1200.0|600.0}}
{{JSON file/cooking|coal|1600.0|8000.0}}
{{JSON file/cooking|time_coal_block|16000.0|8000}}
{{JSON file/cooking|time_dried_kelp_block|4001.0|2000.5}}
{{JSON file/cooking|time_dry_plants|100.0|50.0}}
{{JSON file/cooking|time_hanging_signs|800.0|400.0}}
{{JSON file/cooking|time_lava_bucket|20000.0|10000.0}}
{{JSON file/cooking|time_roots|300.0|150.0}}
{{JSON file/cooking|time_wood_blocks|300.0|150.0}}
{{JSON file/cooking|time_wood_items_extra_small|100.0|50.0}}
{{JSON file/cooking|time_wood_items_large|200.0|100.0}}
{{JSON file/cooking|time_wood_items_small|300.0|150.0}}
{{JSON file/cooking|time_wood_slabs|150.0|75.0}}
{{JSON file/cooking|time_wool|100.0|50.0}}
{{JSON file/cooking|time_wool_carpets|67.0|33.5}}
{{JSON file/cooking|time_wool_slabs|50.0|25.0}}
{{File|directory|brewing}}: 
{{JSON file|speed_default|1.0|desc=: Not used}}
{{JSON file|uses_default|20.0|desc=: Used in the default component {{DCL|brewing_fuel.uses}}}}

See {{Slink|Composter|Composting}} for a list of items that use such number providers in the component {{cd|compostable}} by default.
<!--
=== [[Minecraft:Loot table]] ===

In the {{cd|rolls}} and {{cd|bonus_rolls}} fields of pool, a number provider is used. 

<div class="treeview">
* {{nbt|compound}} The root.
** {{nbt|int}}{{nbt|compound|rolls}}: Specifies the number of rolls on the pool.
** {{nbt|float}}{{nbt|compound|bonus_rolls}}: (Optional. Defaults to {{cd|0.0}}). Specifies the number of bonus rolls on the pool per level of luck (including [[Minecraft:Attributes#Attributes_for_players|luck attribute]] and [[Minecraft:Enchantment definition|fishing_luck_bonus]] on fishing tool). Rounded down after multiplying. [[Minecraft:Enchantment definition|Fishing_luck_bonus]] applies only to fishing. In vanilla games, luck attribute is from the [[Minecraft:Luck]] status effect, and [[Minecraft:Enchantment definition|fishing_luck_bonus]] is from the [[Minecraft:Luck of the Sea]] enchantment.
</div>

Loot tables also use fields with, for example, item predicates and item modifiers, which also use number provider.

{| class="wikitable"
! Register
! [[Minecraft:NBT path]]
! type
! Number format
! [[Minecraft:Loot context]]
! Default
! Use
|-
|rowspan="2"| [[Minecraft:Loot table]]
| pools[].rolls
| -
| {{nbt|int}} Int
| The same as the loot table.
| -
| Specifies the number of rolls on the pool.
|-
| pools[].bonus_rolls
| -
| {{nbt|int}} Int
| The same as the loot table.
| {{cd|0.0}}
| Specifies the number of bonus rolls on the pool per level of luck. 
{{cd|count {{=}} rolls + floor(bonusRolls &times; luck)}}
|-
|}

-->

== Format ==
A a number provider can be an {{nbt|int}} or {{nbt|float}}. They can either be defined as a constant value or as an object.

<div class="treeview">
* {{nbt|int}}{{nbt|float}}: Constant number provider.
</div>

Or:
<div class="treeview">
* {{nbt|compound}}: The root tag. Shorthand for a uniform distribution{{Until|Java 26.3}}.
** {{nbt|int}}{{nbt|float}}{{nbt|compound|min}}: Number provider. The minimum value.
** {{nbt|int}}{{nbt|float}}{{nbt|compound|max}}: Number provider. The maximum value.
</div>

Or:
<div class="treeview">
* {{nbt|string}}: Namespaced ID pointing to an element of number provider [[Minecraft:registry]]. See {{Slink||Vanila registries}}.{{Upcoming|JE 26.3}}
</div>

Or:
<div class="treeview">
* {{nbt|compound}}: The root tag.
** {{nbt|string|type}}: The number provider type as a [[Minecraft:resource location]]. It can be {{cd|binomial|constant|enchantment_level|environment_attribute|score|storage|sum|uniform|d=comma}},{{cd|conditional}}{{Upcoming|Java 26.3}}, {{cd|number_dispatcher}}{{Upcoming|Java 26.3}}, and {{cd|weighted_list}}{{Upcoming|Java 26.3}}.
** Extra fields of the number provider, described below.
</div>

=== Number providers types ===

{{past|n|copy={{nbt|string}}{{nbt|int}}{{nbt|float}}}}
Each type of number provider specifies the rules by which the number will be provided. To do this, they use associated extra contents, which function differently for each type.

The type values can omit or include the namespace {{cd|minecraft}}, for example using the type {{cd|uniform}} or {{cd|minecraft:uniform}} has the same effect.

Number provider types can ''not'' be customized via data packs.

==== Constant ====

A constant value.

<div class="treeview" id="constant" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|constant}}
** {{nbt|int}}{{nbt|float|value}}: The exact value.
</div>

==== Uniform ====

A random number following a uniform distribution between two values. The values are inclusive, meaning the provided number can be either {{cd|min}} or {{cd|max}}, except if the provided number is a float, in which case it must be strictly less than {{cd|max}}. If {{cd|max}} &le; {{cd|min}}, the provided number is {{cd|min}}.

<div class="treeview" id="uniform" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|uniform}}
** {{past|n}}{{nbt|compound|min}}: Number provider. The minimum value ({{cd|min}}).
** {{past|n}}{{nbt|compound|max}}: Number provider. The maximum value ({{cd|max}}).
</div>

==== Binomial ====

A random number following a [[Minecraft:w:Binomial distribution|binomial distribution]]. The returned float has the same value as the int.

<div class="treeview" id="binomial" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|binomial}} 
** {{past|n}}{{nbt|compound|n}}: Number provider. The amount of trials.
** {{past|n}}{{nbt|compound|p}}: Number provider. The probability of success on an individual trial.
</div>
==== Score ====

To query and use a [[Minecraft:scoreboard]] value. Return {{cd|0.0}} if the scoreboard cannot be calculated.
<div class="treeview" id="score" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|score}}
** {{nbt|compound|target}}: To choose which player name or entity UUID to query.
*** {{nbt|string|type}}: Set to {{cd|fixed}} to manually specify a player name or UUID. Set to {{cd|context}} to use an entity from loot context.
*** {{nbt|string|name}}: Included only if {{nbt|string|type}} is set to {{cd|fixed}}. Specifies the name of the player, or the entity's [[Minecraft:Universally unique identifier|UUID]] <small>(in hypenated hexadecimal format)</small> whose score to query.
*** {{nbt|string|target}}: Included only if {{nbt|string|type}} is set to {{cd|context}}. Specifies an entity from [[#Loot context types|loot context]] to query the score of. Can be {{Loot entity target}}
** {{nbt|string|score}}: The scoreboard objective to query on the selected player name or UUID.
** {{nbt|float|scale}}: (Optional. Default {{cd|1.0}}) Scale to multiply the score before returning it.
</div>

==== Storage ====

A value in [[Minecraft:command storage]].

<div class="treeview" id="storage" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|storage}} 
** {{nbt|string|storage}}: The [[Minecraft:resource location]] of the storage.
** {{nbt|string|path}}: The [[Minecraft:nbt path]] to the field in storage.
</div>

====  Enchantment level ====

A value dependent on the level of the [[Minecraft:loot context]] enchantment.

<div class="treeview" id="enchantment_level" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|enchantment_level}}
** {{nbt|string|amount}}: [[Minecraft:Level-based value]] calculating the value based on the enchantment.
</div>

====Sum====
The sum of multiple value providers

<div class="treeview" id="sum" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|sum}} 
** {{nbt|list|summands}}: List of number providers to sum.
</div>

==== Environment attribute ====
Fetches and provides the value of an [[Minecraft:environment attribute]] (that can be represented as a number).

This provider requires a context with an origin position set as long as the environment attribute can vary positionally.

<div class="treeview" id="environment_attribute" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|environment_attribute}} 
** {{nbt|string|attribute}}: An environment attribute ID to fetch.
</div>

==== Number dispatcher ====

Returns the first case which fulfills its condition or the default if none do.

<div class="treeview" id="number_dispatcher" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|number_dispatcher}}{{Upcoming|Java 26.3}}
** {{nbt|list|cases}}: A list of cases in the order that the dispatcher will try to execute them.
*** {{nbt|compound}}: A single case:
**** {{nbt|compound|condition}}: A '''[[Minecraft:predicate]]''' to be tested in this case.
**** {{past|n}}{{nbt|compound|number_provider}}: A number provider, which is executed if the {{nbt|compound|condition}} is fulfilled.
** {{past|n}}{{nbt|compound|default}}: (Optional. Default {{cd|0.0}}) A number provider, which runs if none of the conditions in {{nbt|list|cases}} is fulfilled.
</div>

==== Conditional ====

Returns the value from {{past|n}}{{nbt|compound|on_true}} if its {{nbt|compound|conditions}} or {{past|n}}{{nbt|compound|on_false}} if not.

<div class="treeview" id="conditional" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|conditional}}{{Upcoming|Java 26.3}}
** {{nbt|compound|conditions}}: A '''[[Minecraft:predicate]]''' to test which value will be returned.   
** {{past|n}}{{nbt|compound|on_true}}: A number provider, which runs if the {{nbt|compound|conditions}} is fulfilled.
** {{past|n}}{{nbt|compound|on_false}}: (Optional. Default {{cd|0.0}}) A number provider,  which runs if the {{nbt|compound|conditions}} is not fulfilled.
</div>

====Weighted list====

Returns a value from a distribution of weighted number providers.
<div class="treeview" id="weighted_list" style="margin-block-end: 1em;">
* {{nbt|compound}}
** {{nbt|string|type}}: {{cd|weighted_list}}{{Upcoming|Java 26.3}} 
** {{nbt|list|distribution}}: Returns a value from a distribution of weighted number providers.
*** {{nbt|compound}}: A single weighted number provider:
**** {{past|n}}{{nbt|compound|data}}: A number provider, which is executed if the weighted number provider is chosen.
**** {{nbt|int|weight}}: A positive integer. Determines how often this weighted number provider is chosen out of all data in the distribution. Weighted number provider with higher weights are used more often. The chance of an weighted number provider being chosen is [this weighted number provider's weight ÷ total weight of all weighted number provider in the distribution]. 
</div>

== History ==
{{info needed section|everything before 26.3, which I don't think is a lot}}
{{HistoryTable
|{{HistoryLine|upcoming java}}
|{{HistoryLine||26.3|dev=snap4|The {{cd|type}} field always needs to be specified explicitly when using an inline number provider (it was previously defaulting to {{cd|minecraft:uniform}}).|Added vanilla number providers: {{cd|minecraft:cooking/time_bamboo}}, {{cd|minecraft:cooking/time_blaze_rod}}, {{cd|minecraft:cooking/time_boats}}, {{cd|minecraft:cooking/time_coal}}, {{cd|minecraft:cooking/time_coal_block}}, {{cd|minecraft:cooking/time_dried_kelp_block}}, {{cd|minecraft:cooking/time_dry_plants}}, {{cd|minecraft:cooking/time_hanging_signs}}, {{cd|minecraft:cooking/time_lava_bucket}}, {{cd|minecraft:cooking/time_roots}}, {{cd|minecraft:cooking/time_wood_blocks}}, {{cd|minecraft:cooking/time_wood_items_extra_small}}, {{cd|minecraft:cooking/time_wood_items_large}}, {{cd|minecraft:cooking/time_wood_items_small}}, {{cd|minecraft:cooking/time_wood_slabs}}, {{cd|minecraft:cooking/time_wool}}, {{cd|minecraft:cooking/time_wool_carpets}}, {{cd|minecraft:cooking/time_wool_slabs}}, {{cd|minecraft:cooking/speed_default}}, {{cd|minecraft:brewing/speed_default}}, {{cd|minecraft:brewing/uses_default}}.}}
}}

== Navigation ==
{{Navbox Java Edition technical|datapack}}

[[Minecraft:fr:Fournisseur de nombre]]
[[Minecraft:ja:ナンバープロバイダー]]
[[Minecraft:zh:数值提供器]]