LuaQualityPrototype - Runtime Docs

ClassLuaQualityPrototypeextendsLuaPrototypeBasechanged

Prototype of a quality.

Members

roll_quality(quality_effect, quality_seed, force?) new	→ LuaQualityPrototype	Performs quality roll
Performs quality roll
color	:: R Color	The color of the prototype
The color of the prototype
level	:: R uint32	Level basically specifies the stat-increasing value of this quality level.
Level basically specifies the stat-increasing value of this quality level.
next	:: R LuaQualityPrototype	The next higher level of the quality
The next higher level of the quality
next_probability	:: R double	The probability multiplier of getting the next level of quality.
The probability multiplier of getting the next level of quality.
chain_probability new	:: R double	Probability of additional quality increase happening after quality was increased to reach this quality in the same crafting/mining operation.
Probability of additional quality increase happening after quality was increased to reach this quality in the same crafting/mining operation.
previous new	:: R LuaQualityPrototype
previous_probability new	:: R double	The probability multiplier of getting the previous level of quality.
The probability multiplier of getting the previous level of quality.
previous_chain_probability new	:: R double	Probability of additional quality decrease happening after quality was decreased to reach this quality in the same crafting/mining operation.
Probability of additional quality decrease happening after quality was decreased to reach this quality in the same crafting/mining operation.
draw_sprite_by_default	:: R boolean
beacon_power_usage_multiplier	:: R float
mining_drill_resource_drain_multiplier	:: R float
science_pack_drain_multiplier	:: R float
default_multiplier	:: R double
inserter_speed_multiplier	:: R double
fluid_wagon_capacity_multiplier	:: R double
inventory_size_multiplier	:: R double
cargo_wagon_inventory_size_multiplier new	:: R double
locomotive_power_multiplier new	:: R double
rolling_stock_max_speed_multiplier new	:: R double
lab_research_speed_multiplier	:: R double
crafting_machine_speed_multiplier	:: R double
crafting_machine_energy_usage_multiplier	:: R double
logistic_cell_charging_energy_multiplier	:: R double
tool_durability_multiplier	:: R double
accumulator_capacity_multiplier	:: R double
flying_robot_max_energy_multiplier	:: R double
range_multiplier	:: R double
equipment_grid_width_bonus	:: R int16
equipment_grid_height_bonus	:: R int16
electric_pole_wire_reach_bonus	:: R float
electric_pole_supply_area_distance_bonus	:: R float
beacon_supply_area_distance_bonus	:: R float
mining_drill_mining_radius_bonus	:: R float
module_consumption_multiplier new	:: R float
module_speed_multiplier new	:: R float
module_productivity_multiplier new	:: R float
module_pollution_multiplier new	:: R float
module_quality_multiplier new	:: R float
spoil_ticks_multiplier new	:: R float
logistic_cell_charging_station_count_bonus	:: R uint32
asteroid_collector_collection_radius_bonus	:: R uint32
beacon_module_slots_bonus	:: R ItemStackIndex
crafting_machine_module_slots_bonus	:: R ItemStackIndex
mining_drill_module_slots_bonus	:: R ItemStackIndex
lab_module_slots_bonus	:: R ItemStackIndex
valid	:: R boolean	Is this object valid? [...]
Is this object valid? [...]
object_name	:: R string	The class name of this object. [...]
The class name of this object. [...]

Inherited from LuaPrototypeBase

type	:: R string	Type of this prototype.
Type of this prototype.
name	:: R string	Name of this prototype.
Name of this prototype.
order	:: R string	The string used to alphabetically sort these prototypes. [...]
The string used to alphabetically sort these prototypes. [...]
localised_name	:: R LocalisedString
localised_description	:: R LocalisedString
factoriopedia_description	:: R LocalisedString	Provides additional description used in factoriopedia.
Provides additional description used in factoriopedia.
group	:: R LuaGroup	Group of this prototype.
Group of this prototype.
subgroup	:: R LuaGroup	Subgroup of this prototype.
Subgroup of this prototype.
hidden	:: R boolean
hidden_in_factoriopedia	:: R boolean
parameter	:: R boolean
custom_tooltip_fields	:: R array[CustomTooltipField] ?	Extra description items in the tooltip and Factoriopedia.
Extra description items in the tooltip and Factoriopedia.

Methods

roll_quality(quality_effect, quality_seed, force?) → LuaQualityPrototypenew

Performs quality roll

Parameters

quality_effect	:: EffectValue	Strength of quality effect. Larger value makes it easier to roll better qualities.
Strength of quality effect. Larger value makes it easier to roll better qualities.
quality_seed	:: double	Random value in [0, 1) used to select result quality.
Random value in [0, 1) used to select result quality.
force	:: ForceID?	Force which is doing the quality roll. Used to select unlocked qualities. If not provided, all qualities are considered unlocked.
Force which is doing the quality roll. Used to select unlocked qualities. If not provided, all qualities are considered unlocked.

Attributes

color :: Read Color

The color of the prototype

level :: Read uint32

Level basically specifies the stat-increasing value of this quality level.

next :: Read LuaQualityPrototype

The next higher level of the quality

next_probability :: Read double

The probability multiplier of getting the next level of quality.

chain_probability :: Read doublenew

Probability of additional quality increase happening after quality was increased to reach this quality in the same crafting/mining operation.

previous :: Read LuaQualityPrototypenew

previous_probability :: Read doublenew

The probability multiplier of getting the previous level of quality.

previous_chain_probability :: Read doublenew

Probability of additional quality decrease happening after quality was decreased to reach this quality in the same crafting/mining operation.

draw_sprite_by_default :: Read boolean

beacon_power_usage_multiplier :: Read float

mining_drill_resource_drain_multiplier :: Read float

science_pack_drain_multiplier :: Read float

default_multiplier :: Read double

inserter_speed_multiplier :: Read double

fluid_wagon_capacity_multiplier :: Read double

inventory_size_multiplier :: Read double

cargo_wagon_inventory_size_multiplier :: Read doublenew

locomotive_power_multiplier :: Read doublenew

rolling_stock_max_speed_multiplier :: Read doublenew

lab_research_speed_multiplier :: Read double

crafting_machine_speed_multiplier :: Read double

crafting_machine_energy_usage_multiplier :: Read double

logistic_cell_charging_energy_multiplier :: Read double

tool_durability_multiplier :: Read double

accumulator_capacity_multiplier :: Read double

flying_robot_max_energy_multiplier :: Read double

range_multiplier :: Read double

equipment_grid_width_bonus :: Read int16

equipment_grid_height_bonus :: Read int16

electric_pole_wire_reach_bonus :: Read float

electric_pole_supply_area_distance_bonus :: Read float

beacon_supply_area_distance_bonus :: Read float

mining_drill_mining_radius_bonus :: Read float

module_consumption_multiplier :: Read floatnew

module_speed_multiplier :: Read floatnew

module_productivity_multiplier :: Read floatnew

module_pollution_multiplier :: Read floatnew

module_quality_multiplier :: Read floatnew

spoil_ticks_multiplier :: Read floatnew

logistic_cell_charging_station_count_bonus :: Read uint32

asteroid_collector_collection_radius_bonus :: Read uint32

beacon_module_slots_bonus :: Read ItemStackIndex

crafting_machine_module_slots_bonus :: Read ItemStackIndex

mining_drill_module_slots_bonus :: Read ItemStackIndex

lab_module_slots_bonus :: Read ItemStackIndex

valid :: Read boolean

Is this object valid? This Lua object holds a reference to an object within the game engine. It is possible that the game-engine object is removed whilst a mod still holds the corresponding Lua object. If that happens, the object becomes invalid, i.e. this attribute will be false. Mods are advised to check for object validity if any change to the game state might have occurred between the creation of the Lua object and its access.

object_name :: Read string

The class name of this object. Available even when valid is false. For LuaStruct objects it may also be suffixed with a dotted path to a member of the struct.

Class used in

Factorio Runtime DocsVersion 2.1.12