Factorio Runtime Docs

Class LuaDecorativePrototype

Prototype of an optimized decorative.

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
collision_box [R] :: BoundingBox

The bounding box used for collision checking.

The bounding box used for collision checking.

collision_mask [R] :: CollisionMask

The collision masks this decorative uses

The collision masks this decorative uses

collision_mask_with_flags [R] :: CollisionMaskWithFlags
autoplace_specification [R] :: AutoplaceSpecification?

Autoplace specification for this decorative prototype, if any.

Autoplace specification for this decorative prototype, if any.

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


collision_box :: BoundingBox Read

The bounding box used for collision checking.


collision_mask :: CollisionMask Read

The collision masks this decorative uses


collision_mask_with_flags :: CollisionMaskWithFlags Read


autoplace_specification :: AutoplaceSpecification? Read

Autoplace specification for this decorative prototype, if any.


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

>|