Factorio API Docs

1.1.63 <>

Class LuaLazyLoadedValue

A lazily loaded value. For performance reasons, we sometimes return a custom lazily-loaded value type instead of the native Lua value. This custom type lazily constructs the necessary value when LuaLazyLoadedValue::get is called, therefore preventing its unnecessary construction in some cases.

An instance of LuaLazyLoadedValue is only valid during the event it was created from and cannot be saved.

get()
Any

Gets the value of this lazy loaded value.


help()
string

All methods and properties that this object supports.


:: boolean
[R]

Is this object valid?


:: string
[R]

The class name of this object.

Methods

get() → Any

Gets the value of this lazy loaded value.


help() → string

All methods and properties that this object supports.

Attributes

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

>|