Factorio Runtime Docs

Class LuaParticlePrototype

Prototype of an optimized particle.

Members

help()  → string

All methods and properties that this object supports.

All methods and properties that this object supports.

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
regular_trigger_effect [R] :: TriggerEffectItem
ended_in_water_trigger_effect [R] :: TriggerEffectItem
render_layer [R] :: RenderLayer
render_layer_when_on_ground [R] :: RenderLayer
life_time [R] :: uint
regular_trigger_effect_frequency [R] :: uint
movement_modifier_when_on_ground [R] :: float
movement_modifier [R] :: float
mining_particle_frame_speed [R] :: float
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.

Methods

help()  → string

All methods and properties that this object supports.

Attributes

name :: string Read

Name of this prototype.


order :: string Read

The string used to alphabetically sort these prototypes. It is a simple string that has no additional semantic meaning.


localised_name :: LocalisedString Read


localised_description :: LocalisedString Read


regular_trigger_effect :: TriggerEffectItem Read


ended_in_water_trigger_effect :: TriggerEffectItem Read


render_layer :: RenderLayer Read


render_layer_when_on_ground :: RenderLayer Read


life_time :: uint Read


regular_trigger_effect_frequency :: uint Read


movement_modifier_when_on_ground :: float Read


movement_modifier :: float Read


mining_particle_frame_speed :: float Read


valid :: boolean Read

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 :: string Read

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.

Classes

Events

Concepts

Defines

Builtin types

>|