Factorio Runtime DocsVersion 2.0.58

ClassLuaModDataextendsLuaPrototypeBase

Arbitrary data provided by mods.

Inherits from LuaPrototypeBase

Members

get(key) AnyBasic?

Provides partial access to the data.

Provides partial access to the data.

data_type :: R string
data :: R dictionary[string → AnyBasic]

Provides full data of this prototype.

Provides full data of this prototype.

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

Methods

get(key) → AnyBasic?

Provides partial access to the data.

Parameters

key :: string

Attributes

data_type :: Read string  


data :: Read dictionary[string → AnyBasic]  

Provides full data of this prototype.


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.

Classes

Concepts

Events

Defines