Basalt2/docs/references/plugins/benchmark_BaseElement.md

BaseElement

Functions

Method	Returns	Description
BaseElement:benchmark	BaseElement	Enables performance measurement for a method
BaseElement:endProfile	BaseElement	Ends timing a method call and records statistics
BaseElement:getBenchmarkStats	table?	Retrieves benchmark statistics for a method
BaseElement:logBenchmark	BaseElement	Logs benchmark statistics for a method
BaseElement:startProfile	BaseElement	Starts timing a method call
BaseElement:stopBenchmark	BaseElement	Disables performance measurement for a method

BaseElement:benchmark(methodName)

Enables benchmarking for a method

Parameters

• methodName string The name of the method to benchmark

Returns

• BaseElement self The element instance

Usage

element:benchmark("render")

BaseElement:endProfile(methodName)

Ends profiling a method

Parameters

• methodName string The name of the method to stop profiling

Returns

• BaseElement self The element instance

BaseElement:getBenchmarkStats(methodName)

Gets benchmark statistics for a method

Parameters

• methodName string The name of the method to get statistics for

Returns

• table? stats The benchmark statistics or nil

BaseElement:logBenchmark(methodName)

Logs benchmark statistics for a method

Parameters

• methodName string The name of the method to log

Returns

• BaseElement self The element instance

BaseElement:startProfile(methodName)

Starts profiling a method

Parameters

• methodName string The name of the method to profile

Returns

• BaseElement self The element instance

BaseElement:stopBenchmark(methodName)

Stops benchmarking for a method

Parameters

• methodName string The name of the method to stop benchmarking

Returns

• BaseElement self The element instance