Terminology
To make the most out of RNGNeeds, it's essential to understand the key terms and concepts used within the plugin. This page provides definitions for the primary terms you'll encounter.
- Name
Probability List
- Type
- Description
- A Probability List is a collection of
Probability Items
, each representing a potential value that can be selected. This list defines a set of possible outcomes, each associated with its own probability.
- Name
Probability Item
- Type
- Description
- A Probability Item is an individual entry within a
Probability List
. It encapsulates a user-defined value (either a value type or a reference type) and associates it with a particular Base Probability. The item also stores additional information, such as enabled or locked states.
- Name
Base Probability
- Type
- Description
- Base Probability refers to the initial probability assigned to a
Probability Item
. This value can be manually adjusted but does not directly influence the selection process. It serves as a reference point for further adjustments and calculations.
- Name
Probability
- Type
- Description
- Probability refers to the adjusted likelihood of a
Probability Item
being selected. It's a calculated value derived from the Base Probability and any influences or adjustments. This probability is used during the selection process.
- Name
Enabled Probability
- Type
- Description
- Enabled Probability refers to the accumulated probability of all enabled
Probability Items
in a list. Disabled items are not considered in this calculation. The Enabled Probability value is used during the selection process.
- Name
Unlocked Probability
- Type
- Description
- Unlocked Probability refers to the total probability of all unlocked
Probability Items
in a list. Unlocked probabilities can change as other items' probabilities are adjusted. This value is considered during probability normalization or recalculation when designing the list.
- Name
Depletable List
- Type
- Description
- A Probability List that allows Depletable Items to consume units upon selection. Depleted items will no longer be selectable and will behave similarly to disabled items until their units are refilled.
- Name
Depletable Item
- Type
- Description
- A Probability Item which, when contained in a Depletable List, will have its units consumed with each pick. Once the units are depleted, the item will not be selectable until its units are refilled.
- Name
Units
- Type
- Description
- In depletable items, units refer to the number of times an item can be selected. Each selection will consume one unit.
- Name
Max Units
- Type
- Description
- In depletable items, maximum units refer to the upper limit of units an item can have. Units are reset to this maximum when the item is refilled.
- Name
Refill
- Type
- Description
- A term used to describe the process of resetting the units of a Depletable Item to its defined maximum.
- Name
Selectable Item
- Type
- Description
- A Probability Item is considered selectable if it is enabled and either non-depletable (infinite) or, for depletable items, if it has at least one available unit.
- Name
Selection Method
- Type
- Description
- Selection Method refers to the algorithm or process used to pick an item from the
Probability List
. Different selection methods may yield almost identical results but can differ in performance depending on the size of the list and thePick Count
.
- Name
Pick Count
- Type
- Description
- Pick Count is the number of items to be selected from the
Probability List
in a single operation. ThePick Count
can be a fixed value or a range, offering flexibility for different scenarios.
- Name
Repeat Prevention
- Type
- Description
- Repeat Prevention is a feature that avoids consecutive selection of the same
Probability Item
. This feature enhances variety in selections, particularly useful in scenarios where repeated outcomes are undesirable.
- Name
Influence Provider
- Type
- Description
- A script inheriting from
IProbabilityInfluenceProvider
interface, defining an influence applied to probability of an item.
- Name
Influenced List
- Type
- Description
- The list is considered as
influenced
if any of its items has anInfluence Provider
assigned, or if any item itself is a provider.
- Name
Influenced Probability
- Type
- Description
- Influenced Probability refers to the Base Probability of a
Probability Item
after the application of an external influence, if one is configured via aProbability Influence Provider
.