FYFY 2.3
Loading...
Searching...
No Matches
FYFY.FSystem Class Referenceabstract

Base class every FYFY system derives from. More...

Inheritance diagram for FYFY.FSystem:
FYFY_plugins.Monitoring.ActionsManager

Public Attributes

double avgExecDuration = 0
 Gets the average execution time taken by onProcess.
 
double maxExecDuration = 0
 Gets the maximum execution time taken by onProcess.
 
bool showFamilies = false
 Show families used in this system inside Unity Inspector.
 

Protected Member Functions

virtual void onStart ()
 Function called when this FYFY.FSystem started. All families are populated and can be parsed.
 
virtual void onPause (int currentFrame)
 Function called when this FYFY.FSystem paused.
 
virtual void onResume (int currentFrame)
 Function called when this FYFY.FSystem resumed.
 
virtual void onProcess (int familiesUpdateCount)
 Function called each time when FYFY enter in the update block where this FYFY.FSystem is.
 

Properties

bool Pause [get, set]
 Gets or sets a value indicating whether this FYFY.FSystem is paused.
 

Detailed Description

Base class every FYFY system derives from.

FYFY systems have to be setted in the Unity Editor in a MainLoop's block of update.

Member Function Documentation

◆ onPause()

virtual void FYFY.FSystem.onPause ( int currentFrame)
protectedvirtual

Function called when this FYFY.FSystem paused.

Parameters
currentFrameThe Unity frame number when this function is called.

◆ onProcess()

virtual void FYFY.FSystem.onProcess ( int familiesUpdateCount)
protectedvirtual

Function called each time when FYFY enter in the update block where this FYFY.FSystem is.

Called only if this FYFY.FSystem is active.

Parameters
familiesUpdateCountNumber of times the families have been updated.

Reimplemented in FYFY_plugins.Monitoring.ActionsManager.

◆ onResume()

virtual void FYFY.FSystem.onResume ( int currentFrame)
protectedvirtual

Function called when this FYFY.FSystem resumed.

Parameters
currentFrameThe Unity frame number when this function is called.

◆ onStart()

virtual void FYFY.FSystem.onStart ( )
protectedvirtual

Function called when this FYFY.FSystem started. All families are populated and can be parsed.

Reimplemented in FYFY_plugins.Monitoring.ActionsManager.


The documentation for this class was generated from the following file: