GROOVIE: Added documentation for the GameSpeed enum

This commit is contained in:
Filippos Karapetis 2012-11-15 18:26:15 +02:00
parent 29efcce7c0
commit 542b99bfe7

View File

@ -72,6 +72,13 @@ enum DebugLevels {
// the current limitation is 32 debug levels (1 << 31 is the last one)
};
/**
* This enum reflects the available movie speed settings:
* - Normal: both movies and 'teeth' animations are played at a normal speed
* - Tweaked: movies are played at a normal speed, 'teeth' animations at
increased speed
* - iOS: both movies and 'teeth' animations are played at increased speed
*/
enum GameSpeed {
kGroovieSpeedNormal,
kGroovieSpeediOS,