LuaPrototypes

Provides read-only access to prototypes. It is accessible through the global object named prototypes.

Attributes

object_name

• Read: string
• Write: unknown
• Optional: false

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.

font

• Read: LuaCustomTable<string, LuaFontPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaFontPrototype indexed by name.

map_gen_preset

• Read: LuaCustomTable<string, MapGenPreset>
• Write: unknown
• Optional: false

A dictionary containing every MapGenPreset indexed by name.

A MapGenPreset is an exact copy of the prototype table provided from the data stage.

style

• Read: LuaCustomTable<string, string>
• Write: unknown
• Optional: false

A map of styles that LuaGuiElement can use.

Maps from the style's name to its type, as seen on StyleSpecification.

utility_constants

• Read: LuaCustomTable<string, AnyBasic>
• Write: unknown
• Optional: false

All utility constants.

See UtilityConstants for possible values.

entity

• Read: LuaCustomTable<string, LuaEntityPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaEntityPrototype indexed by name.

item

• Read: LuaCustomTable<string, LuaItemPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaItemPrototype indexed by name.

fluid

• Read: LuaCustomTable<string, LuaFluidPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaFluidPrototype indexed by name.

tile

• Read: LuaCustomTable<string, LuaTilePrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaTilePrototype indexed by name.

equipment

• Read: LuaCustomTable<string, LuaEquipmentPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaEquipmentPrototype indexed by name.

damage

• Read: LuaCustomTable<string, LuaDamagePrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaDamagePrototype indexed by name.

virtual_signal

• Read: LuaCustomTable<string, LuaVirtualSignalPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaVirtualSignalPrototype indexed by name.

equipment_grid

• Read: LuaCustomTable<string, LuaEquipmentGridPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaEquipmentGridPrototype indexed by name.

recipe

• Read: LuaCustomTable<string, LuaRecipePrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaRecipePrototype indexed by name.

technology

• Read: LuaCustomTable<string, LuaTechnologyPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaTechnologyPrototype indexed by name.

decorative

• Read: LuaCustomTable<string, LuaDecorativePrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaDecorativePrototype indexed by name.

particle

• Read: LuaCustomTable<string, LuaParticlePrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaParticlePrototype indexed by name.

autoplace_control

• Read: LuaCustomTable<string, LuaAutoplaceControlPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaAutoplaceControlPrototype indexed by name.

mod_setting

• Read: LuaCustomTable<string, LuaModSettingPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaModSettingPrototype indexed by name.

custom_input

• Read: LuaCustomTable<string, LuaCustomInputPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaCustomInputPrototype indexed by name.

ammo_category

• Read: LuaCustomTable<string, LuaAmmoCategoryPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaAmmoCategoryPrototype indexed by name.

named_noise_expression

• Read: LuaCustomTable<string, LuaNamedNoiseExpression>
• Write: unknown
• Optional: false

A dictionary containing every LuaNamedNoiseExpression indexed by name.

named_noise_function

• Read: LuaCustomTable<string, LuaNamedNoiseFunction>
• Write: unknown
• Optional: false

A dictionary containing every LuaNamedNoiseFunction indexed by name.

item_subgroup

• Read: LuaCustomTable<string, LuaGroup>
• Write: unknown
• Optional: false

A dictionary containing every ItemSubgroup indexed by name.

item_group

• Read: LuaCustomTable<string, LuaGroup>
• Write: unknown
• Optional: false

A dictionary containing every ItemGroup indexed by name.

fuel_category

• Read: LuaCustomTable<string, LuaFuelCategoryPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaFuelCategoryPrototype indexed by name.

resource_category

• Read: LuaCustomTable<string, LuaResourceCategoryPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaResourceCategoryPrototype indexed by name.

achievement

• Read: LuaCustomTable<string, LuaAchievementPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaAchievementPrototype indexed by name.

module_category

• Read: LuaCustomTable<string, LuaModuleCategoryPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaModuleCategoryPrototype indexed by name.

equipment_category

• Read: LuaCustomTable<string, LuaEquipmentCategoryPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaEquipmentCategoryPrototype indexed by name.

trivial_smoke

• Read: LuaCustomTable<string, LuaTrivialSmokePrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaTrivialSmokePrototype indexed by name.

shortcut

• Read: LuaCustomTable<string, LuaShortcutPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaShortcutPrototype indexed by name.

recipe_category

• Read: LuaCustomTable<string, LuaRecipeCategoryPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaRecipeCategoryPrototype indexed by name.

quality

• Read: LuaCustomTable<string, LuaQualityPrototype>
• Write: unknown
• Optional: false

surface_property

• Read: LuaCustomTable<string, LuaSurfacePropertyPrototype>
• Write: unknown
• Optional: false

space_location

• Read: LuaCustomTable<string, LuaSpaceLocationPrototype>
• Write: unknown
• Optional: false

space_connection

• Read: LuaCustomTable<string, LuaSpaceConnectionPrototype>
• Write: unknown
• Optional: false

custom_event

• Read: LuaCustomTable<string, LuaCustomEventPrototype>
• Write: unknown
• Optional: false

A dictionary containing every defined custom event, indexed by name.

active_trigger

• Read: LuaCustomTable<string, LuaActiveTriggerPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaActiveTriggerPrototype indexed by name.

asteroid_chunk

• Read: LuaCustomTable<string, LuaAsteroidChunkPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaAsteroidChunkPrototype indexed by name.

collision_layer

• Read: LuaCustomTable<string, LuaCollisionLayerPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaCollisionLayerPrototype indexed by name.

airborne_pollutant

• Read: LuaCustomTable<string, LuaAirbornePollutantPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaAirbornePollutantPrototype indexed by name.

burner_usage

• Read: LuaCustomTable<string, LuaBurnerUsagePrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaBurnerUsagePrototype indexed by name.

mod_data

• Read: LuaCustomTable<string, LuaModData>
• Write: unknown
• Optional: false

A dictionary containing every LuaModData indexed by name.

surface

• Read: LuaCustomTable<string, LuaSurfacePrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaSurfacePrototype indexed by name.

procession

• Read: LuaCustomTable<string, LuaProcessionPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaProcessionPrototype indexed by name.

procession_layer_inheritance_group

• Read: LuaCustomTable<string, LuaProcessionLayerInheritanceGroupPrototype>
• Write: unknown
• Optional: false

A dictionary containing every LuaProcessionLayerInheritanceGroupPrototype indexed by name.

max_force_distraction_distance

• Read: double
• Write: unknown
• Optional: false

max_force_distraction_chunk_distance

• Read: uint32
• Write: unknown
• Optional: false

max_electric_pole_supply_area_distance

• Read: float
• Write: unknown
• Optional: false

max_electric_pole_connection_distance

• Read: double
• Write: unknown
• Optional: false

max_beacon_supply_area_distance

• Read: uint32
• Write: unknown
• Optional: false

max_gate_activation_distance

• Read: double
• Write: unknown
• Optional: false

max_inserter_reach_distance

• Read: double
• Write: unknown
• Optional: false

max_pipe_to_ground_distance

• Read: uint8
• Write: unknown
• Optional: false

max_underground_belt_distance

• Read: uint8
• Write: unknown
• Optional: false

Methods

get_entity_filtered

LuaPrototypes.get_entity_filtered(filters: Array<EntityPrototypeFilter>) -> LuaCustomTable<string, LuaEntityPrototype>

Call As

prototypes.get_entity_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaEntityPrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<EntityPrototypeFilter>

Returns

• LuaCustomTable<string, LuaEntityPrototype>

get_item_filtered

LuaPrototypes.get_item_filtered(filters: Array<ItemPrototypeFilter>) -> LuaCustomTable<string, LuaItemPrototype>

Call As

prototypes.get_item_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaItemPrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<ItemPrototypeFilter>

Returns

• LuaCustomTable<string, LuaItemPrototype>

get_equipment_filtered

LuaPrototypes.get_equipment_filtered(filters: Array<EquipmentPrototypeFilter>) -> LuaCustomTable<string, LuaEquipmentPrototype>

Call As

prototypes.get_equipment_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaEquipmentPrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<EquipmentPrototypeFilter>

Returns

• LuaCustomTable<string, LuaEquipmentPrototype>

get_mod_setting_filtered

LuaPrototypes.get_mod_setting_filtered(filters: Array<ModSettingPrototypeFilter>) -> LuaCustomTable<string, LuaModSettingPrototype>

Call As

prototypes.get_mod_setting_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaModSettingPrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<ModSettingPrototypeFilter>

Returns

• LuaCustomTable<string, LuaModSettingPrototype>

get_achievement_filtered

LuaPrototypes.get_achievement_filtered(filters: Array<AchievementPrototypeFilter>) -> LuaCustomTable<string, LuaAchievementPrototype>

Call As

prototypes.get_achievement_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaAchievementPrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<AchievementPrototypeFilter>

Returns

• LuaCustomTable<string, LuaAchievementPrototype>

get_tile_filtered

LuaPrototypes.get_tile_filtered(filters: Array<TilePrototypeFilter>) -> LuaCustomTable<string, LuaTilePrototype>

Call As

prototypes.get_tile_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaTilePrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<TilePrototypeFilter>

Returns

• LuaCustomTable<string, LuaTilePrototype>

get_decorative_filtered

LuaPrototypes.get_decorative_filtered(filters: Array<DecorativePrototypeFilter>) -> LuaCustomTable<string, LuaDecorativePrototype>

Call As

prototypes.get_decorative_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaDecorativePrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<DecorativePrototypeFilter>

Returns

• LuaCustomTable<string, LuaDecorativePrototype>

get_fluid_filtered

LuaPrototypes.get_fluid_filtered(filters: Array<FluidPrototypeFilter>) -> LuaCustomTable<string, LuaFluidPrototype>

Call As

prototypes.get_fluid_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaFluidPrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<FluidPrototypeFilter>

Returns

• LuaCustomTable<string, LuaFluidPrototype>

get_recipe_filtered

LuaPrototypes.get_recipe_filtered(filters: Array<RecipePrototypeFilter>) -> LuaCustomTable<string, LuaRecipePrototype>

Call As

prototypes.get_recipe_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaRecipePrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<RecipePrototypeFilter>

Returns

• LuaCustomTable<string, LuaRecipePrototype>

get_technology_filtered

LuaPrototypes.get_technology_filtered(filters: Array<TechnologyPrototypeFilter>) -> LuaCustomTable<string, LuaTechnologyPrototype>

Call As

prototypes.get_technology_filtered(filters)

Call Convention

• takes_table: false
• table_optional: false

Returns a dictionary of all LuaTechnologyPrototypes that fit the given filters. The prototypes are indexed by name.

Parameters

• filters: Array<TechnologyPrototypeFilter>

Returns

• LuaCustomTable<string, LuaTechnologyPrototype>

get_history

LuaPrototypes.get_history(type: string, name: string) -> PrototypeHistory

Call As

prototypes.get_history(type, name)

Call Convention

• takes_table: false
• table_optional: false

Gets the prototype history for the given type and name.

Parameters

• type: string
• name: string

Returns

• PrototypeHistory