An object used to measure script performance.
Since performance is non-deterministic, these objects don't allow reading the raw time values from Lua. They can be used anywhere a LocalisedString is used, except for LuaGuiElement::add's LocalisedString arguments, LuaSurface::create_entity's
text argument, and LuaEntity::add_market_item.
Add the duration of another timer to this timer. Useful to reduce start/stop overhead when accumulating time onto many timers at once.
The timer to add to this timer.
If other is running, the time to now will be added.
Divides the current duration by a set value. Useful for calculating the average of many iterations.
The number to divide by. Must be > 0.
Does nothing if this isn't stopped.
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.