Class ComboGraph
Combo Graph class
The ComboGraph will display the combos for a score on a graph.
Although, it's a bit more integrated with PlayerStageStats than one might desire...
A ComboGraph can be created directly with Def.ComboGraph.
Its primary use is in ScreenEvaluation.
This class inherits all methods from these classes: ActorFrame Actor
Methods
| combograph:Load (metricsGroup) | Initialize the ComboGraph using the given metrics group. |
| combograph:Set (stageStats, playerStageStats) | Load combo data into the ComboGraph from StageStats and PlayerStageStats. |
| combograph:SetWithoutStageStats (playerStageStats, lastSecond) | Load combo data into the ComboGraph from PlayerStageStats. |
| combograph:Clear () | Destroys all children which were loaded via Load, so you can use Load again. |
Methods
- combograph:Load (metricsGroup)
-
Initialize the ComboGraph using the given metrics group.
This is the way to customize a ComboGraph via metrics, creating a section as [groupName]. Children components are also loaded from Theme Graphics.
The children components are Actors named
<groupName> Backing<groupName> NormalCombo<groupName> MaxCombo. Another child component that must be a BitmapText is<groupName> ComboNumber. In metrics.ini, the metrics that must be defined areBodyWidthandBodyHeightunder the section [groupName].Parameters:
- metricsGroup string The group to load from metrics.ini and Theme Graphics.
Returns:
-
self
- combograph:Set (stageStats, playerStageStats)
-
Load combo data into the ComboGraph from StageStats and PlayerStageStats.
The StageStats is only used to determine the length of the song in question.
Otherwise, this is the same as SetWithoutStageStats.
Parameters:
- stageStats StageStats The StageStats for the current score
- playerStageStats PlayerStageStats The PlayerStageStats for the current score
Returns:
-
self
See also:
- combograph:SetWithoutStageStats (playerStageStats, lastSecond)
-
Load combo data into the ComboGraph from PlayerStageStats.
Parameters:
- playerStageStats PlayerStageStats The PlayerStageStats for the current score
- lastSecond number The last second of the current score, which is usually the length of the song.
Returns:
-
self
- combograph:Clear ()
-
Destroys all children which were loaded via Load, so you can use Load again.
If you fail to do this before running Load, then you can unintentionally orphan the children or have too many children.
Returns:
-
self