Struct LuaProfiler 

pub struct LuaProfiler;

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.

Implementations

impl LuaProfiler

pub fn object_name(&self) -> &str

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.

pub fn valid(&self) -> bool

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.

pub fn add(&self, other: LuaProfiler)

Add the duration of another timer to this timer. Useful to reduce start/stop overhead when accumulating time onto many timers at once.

If other is running, the time to now will be added.

pub fn divide(&self, number: f64)

Divides the current duration by a set value. Useful for calculating the average of many iterations.

Does nothing if this isn’t stopped.

pub fn reset(&self)

Resets the clock, also restarting it.

pub fn restart(&self)

Start the clock again, without resetting it.

pub fn stop(&self)

Stops the clock.

Trait Implementations

impl Clone for LuaProfiler

fn clone(&self) -> LuaProfiler

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Copy for LuaProfiler

impl Debug for LuaProfiler

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for LuaProfiler

fn default() -> LuaProfiler

Returns the “default value” for a type.

impl Eq for LuaProfiler

impl From<LuaProfiler> for LuaAny

fn from(_: LuaProfiler) -> Self

Converts to this type from the input type.

impl LuaObject for LuaProfiler

impl PartialEq for LuaProfiler

fn eq(&self, other: &LuaProfiler) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl StructuralPartialEq for LuaProfiler