Enforce Script profiling API

Data Structures
class	EnProfiler
	Set of methods for accessing script profiling data. More...

Typedefs
typedef Param2< float, typename >	EnProfilerTimeClassPair
typedef Param2< int, typename >	EnProfilerCountClassPair
typedef Param2< float, string >	EnProfilerTimeFuncPair
typedef Param2< int, string >	EnProfilerCountFuncPair

Enumerations
enum	EnProfilerFlags { NONE = 0, RESET, RECURSIVE, ALL }
	Flags that influences the behaviour of the EnProfiler API, applied through ...Flags functions. More...
enum	EnProfilerModule {   CORE, GAMELIB, GAME, WORLD,   MISSION, MISSION_CUSTOM, ERROR }
	Current base scripted modules. More...
enum	EnProfilerEnabledFlags { NONE = 0, DIAG, SCRP, SCRC }
	There are 3 states which can be toggled that governs whether script profiling is enabled or not. More...

Detailed Description

Warning

Only available on developer and diag builds

Typedef Documentation

EnProfilerCountClassPair

typedef Param2<int, typename> EnProfilerCountClassPair

Definition at line 56 of file enprofiler.c.

EnProfilerCountFuncPair

typedef Param2<int, string> EnProfilerCountFuncPair

Definition at line 59 of file enprofiler.c.

EnProfilerTimeClassPair

typedef Param2<float, typename> EnProfilerTimeClassPair

Definition at line 55 of file enprofiler.c.

EnProfilerTimeFuncPair

typedef Param2<float, string> EnProfilerTimeFuncPair

Definition at line 58 of file enprofiler.c.

Enumeration Type Documentation

EnProfilerEnabledFlags

enum EnProfilerEnabledFlags

There are 3 states which can be toggled that governs whether script profiling is enabled or not.

Note

The reason for this is because when it is enabled in debug menu, or through this API without 'immediate', it will only be enabled the next frame

Enumerator
NONE	No flags. No automatic destroying. Flags to pass to ParticleSource.StopParticle. Plain Effect base. No flags, has value 0, so will count as false in conditions. No flags
DIAG	Script profiling UI is enabled in WIN+ALT debug menu, when this is true, it will override SCRP.
SCRP	It has been set to being always enabled through EnProfiler (SCRipt Profiler)
SCRC	Whether profiling is currently truly happening (SCRipt Context)

Definition at line 43 of file enprofiler.c.

EnProfilerFlags

enum EnProfilerFlags

Flags that influences the behaviour of the EnProfiler API, applied through ...Flags functions.

Enumerator
NONE	No flags. No automatic destroying. Flags to pass to ParticleSource.StopParticle. Plain Effect base. No flags, has value 0, so will count as false in conditions. No flags
RESET	When present, will reset [PD] on sorting, otherwise will accumulate on top of it.
RECURSIVE	Whether to profile child modules.
ALL	All flags enabled.

Definition at line 8 of file enprofiler.c.

EnProfilerModule

enum EnProfilerModule

Current base scripted modules.

Enumerator
CORE	1_Core
GAMELIB	2_GameLib
GAME	3_Game
WORLD	4_World
MISSION	5_Mission
MISSION_CUSTOM	init.c
ERROR	Can be returned from some methods.

Definition at line 21 of file enprofiler.c.