massive header file comment updating (top line only; some didn't have it before)
This commit is contained in:
AJ Kelly
@@ -1,3 +1,4 @@
|
||||
/* ActiveAttackList - Shows currently active player modifiers during gameplay. */
|
||||
#ifndef ACTIVE_ATTACK_LIST_H
|
||||
#define ACTIVE_ATTACK_LIST_H
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* ActorMultiTexture - A bitmap Actor that animates and moves around. */
|
||||
/* ActorMultiTexture - A texture created from multiple textures. */
|
||||
|
||||
#ifndef ACTOR_MULTI_TEXTURE_H
|
||||
#define ACTOR_MULTI_TEXTURE_H
|
||||
|
||||
+11
-13
@@ -1,12 +1,11 @@
|
||||
/* AdjustSync - Allows for adjusting the sync of a song. */
|
||||
#ifndef AdjustSync_H
|
||||
#define AdjustSync_H
|
||||
|
||||
/*
|
||||
* This class defines two ways of adjusting the sync of a song.
|
||||
* The first adjusts only the offset, "on the fly". It can adjust
|
||||
* either the song itself or the machine. The other style adjusts
|
||||
* both the BPM and the offset of the song, but it needs more data.
|
||||
*/
|
||||
/* This class defines two ways of adjusting the sync of a song.
|
||||
* The first adjusts only the offset, "on the fly". It can adjust either the
|
||||
* song itself or the machine. The other style adjusts both the BPM and the
|
||||
* offset of the song, but it needs more data. */
|
||||
|
||||
class TimingData;
|
||||
|
||||
@@ -15,16 +14,15 @@ class AdjustSync
|
||||
public:
|
||||
static TimingData *s_pTimingDataOriginal;
|
||||
static float s_fGlobalOffsetSecondsOriginal;
|
||||
/*
|
||||
* We only want to call the Reset methods before a song, not immediately after a song.
|
||||
* If we reset it at the end of a song, we have to carefully check the logic to make
|
||||
* sure we never reset it before the user gets a chance to save or revert the change.
|
||||
* Resetting at the start of the song is sufficient.
|
||||
*/
|
||||
/* We only want to call the Reset methods before a song, not immediately after
|
||||
* a song. If we reset it at the end of a song, we have to carefully check
|
||||
* the logic to make sure we never reset it before the user gets a chance to
|
||||
* save or revert the change. Resetting at the start of the song is
|
||||
* sufficient. */
|
||||
static void ResetOriginalSyncData();
|
||||
static void ResetAutosync();
|
||||
static bool IsSyncDataChanged();
|
||||
|
||||
|
||||
static void SaveSyncChanges();
|
||||
static void RevertSyncChanges();
|
||||
static void HandleAutosync( float fNoteOffBySeconds, float fStepTime );
|
||||
|
||||
+3
-5
@@ -10,9 +10,9 @@ class ArrowEffects
|
||||
public:
|
||||
static void Update();
|
||||
|
||||
// fYOffset is a vertical position in pixels relative to the center.
|
||||
// (positive if has not yet been stepped on, negative if has already passed).
|
||||
// The ArrowEffect and ScrollSpeed is applied in this stage.
|
||||
// fYOffset is a vertical position in pixels relative to the center
|
||||
// (positive if has not yet been stepped on, negative if has already passed).
|
||||
// The ArrowEffect and ScrollSpeed is applied in this stage.
|
||||
static float GetYOffset( const PlayerState* pPlayerState, int iCol, float fNoteBeat, float &fPeakYOffsetOut, bool &bIsPastPeakYOffset, bool bAbsolute=false );
|
||||
static float GetYOffset( const PlayerState* pPlayerState, int iCol, float fNoteBeat, bool bAbsolute=false )
|
||||
{
|
||||
@@ -54,12 +54,10 @@ public:
|
||||
// AppearanceType.
|
||||
static float GetAlpha( const PlayerState* pPlayerState, int iCol, float fYPos, float fPercentFadeToFail, float fYReverseOffsetPixels, float fDrawDistanceBeforeTargetsPixels, float fFadeInPercentOfDrawFar );
|
||||
|
||||
|
||||
// fAlpha is the transparency of the arrow. It depends on fYPos and the
|
||||
// AppearanceType.
|
||||
static float GetGlow( const PlayerState* pPlayerState, int iCol, float fYPos, float fPercentFadeToFail, float fYReverseOffsetPixels, float fDrawDistanceBeforeTargetsPixels, float fFadeInPercentOfDrawFar );
|
||||
|
||||
|
||||
// Depends on fYOffset.
|
||||
static float GetBrightness( const PlayerState* pPlayerState, float fNoteBeat );
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* AttackDisplay - A graphical display for attacks. */
|
||||
#ifndef AttackDisplay_H
|
||||
#define AttackDisplay_H
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
/* AutoKeysounds - handle playback of auto keysounds notes. */
|
||||
/* AutoKeysounds - handle playback of auto keysound notes. */
|
||||
|
||||
#ifndef AUTO_KEYSOUNDS_H
|
||||
#define AUTO_KEYSOUNDS_H
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
/* Banner - The song's banner displayed in SelectSong. */
|
||||
/* Banner - The song/course's banner displayed in SelectMusic/Course. */
|
||||
|
||||
#ifndef BANNER_H
|
||||
#define BANNER_H
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* BeginnerHelper - A dancing character that follows the steps of the song. */
|
||||
#ifndef BEGINNER_HELPER_H
|
||||
#define BEGINNER_HELPER_H
|
||||
|
||||
@@ -13,13 +14,13 @@ class BeginnerHelper : public ActorFrame
|
||||
public:
|
||||
BeginnerHelper();
|
||||
~BeginnerHelper();
|
||||
|
||||
|
||||
bool Initialize( int iDancePadType );
|
||||
bool IsInitialized() { return m_bInitialized; }
|
||||
static bool CanUse();
|
||||
void AddPlayer( PlayerNumber pn, const NoteData &nd );
|
||||
void ShowStepCircle( PlayerNumber pn, int CSTEP );
|
||||
bool m_bShowBackground;
|
||||
bool m_bShowBackground;
|
||||
|
||||
void Update( float fDeltaTime );
|
||||
virtual void DrawPrimitives();
|
||||
@@ -37,7 +38,7 @@ protected:
|
||||
|
||||
int m_iLastRowChecked;
|
||||
int m_iLastRowFlashed;
|
||||
bool m_bInitialized;
|
||||
bool m_bInitialized;
|
||||
};
|
||||
#endif
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* CharacterManager - Manage characters... */
|
||||
/* CharacterManager - Manage characters. */
|
||||
|
||||
#ifndef CHARACTER_MANAGER_H
|
||||
#define CHARACTER_MANAGER_H
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* ComboGraph - A bar displaying the player's combo on Evaluation. */
|
||||
#ifndef COMBO_GRAPH_H
|
||||
#define COMBO_GRAPH_H
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
/* Definitions of metrics that are in the "Common" group */
|
||||
/* CommonMetrics - Definitions of metrics that are in the "Common" group */
|
||||
|
||||
#ifndef COMMON_METRICS_H
|
||||
#define COMMON_METRICS_H
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* StepsDisplayList - Shows all available difficulties for a Song/Course. */
|
||||
#ifndef DIFFICULTY_LIST_H
|
||||
#define DIFFICULTY_LIST_H
|
||||
|
||||
@@ -60,13 +61,13 @@ private:
|
||||
m_fY = 0;
|
||||
m_bHidden = false;
|
||||
}
|
||||
|
||||
|
||||
const Steps *m_Steps;
|
||||
Difficulty m_dc;
|
||||
float m_fY;
|
||||
bool m_bHidden; // currently off screen
|
||||
};
|
||||
|
||||
|
||||
vector<Row> m_Rows;
|
||||
|
||||
};
|
||||
|
||||
+3
-1
@@ -1,4 +1,4 @@
|
||||
/* EditMenu - UI on Edit Menu screen. Create Steps, delete Steps, or launch Steps in editor. */
|
||||
/* EditMenu - UI on Edit Menu screen. Create Steps, delete Steps, or launch Steps in editor. */
|
||||
|
||||
#ifndef EDIT_MENU_H
|
||||
#define EDIT_MENU_H
|
||||
@@ -122,10 +122,12 @@ private:
|
||||
ThemeMetric1D<float> ARROWS_X;
|
||||
ThemeMetric<apActorCommands> ARROWS_ENABLED_COMMAND;
|
||||
ThemeMetric<apActorCommands> ARROWS_DISABLED_COMMAND;
|
||||
// todo: remove these next 4 metrics in favor of commands -aj
|
||||
ThemeMetric<float> SONG_BANNER_WIDTH;
|
||||
ThemeMetric<float> SONG_BANNER_HEIGHT;
|
||||
ThemeMetric<float> GROUP_BANNER_WIDTH;
|
||||
ThemeMetric<float> GROUP_BANNER_HEIGHT;
|
||||
// </todo>
|
||||
ThemeMetric<float> ROW_LABELS_X;
|
||||
ThemeMetric<apActorCommands> ROW_LABEL_ON_COMMAND;
|
||||
ThemeMetric1D<float> ROW_VALUE_X;
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* FontCharAliases - Provides support for nonstandard characters in text. */
|
||||
#ifndef FONT_CHAR_ALIASES
|
||||
#define FONT_CHAR_ALIASES
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* FontCharmaps - Defines common frame to character mappings for Fonts. */
|
||||
#ifndef FONT_CHARMAPS_H
|
||||
#define FONT_CHARMAPS_H
|
||||
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* Foreground - Foreground in front of notes while playing. */
|
||||
#ifndef FOREGROUND_H
|
||||
#define FOREGROUND_H
|
||||
|
||||
|
||||
+9
-9
@@ -11,16 +11,16 @@ class Style;
|
||||
|
||||
// PrimaryMenuButton and SecondaryMenuButton are used to support using
|
||||
// DeviceInputs that only navigate the menus.
|
||||
//
|
||||
|
||||
// A button being a primary menu button means that this GameButton will generate
|
||||
// a the corresponding MenuInput IF AND ONLY IF the GameButton corresponding to
|
||||
// the pimary input is not mapped.
|
||||
//
|
||||
|
||||
// Example 1: A user is using an arcade machine as their controller. Most
|
||||
// machines have MenuLeft, MenuStart, and MenuRight buttons on the cabinet, so
|
||||
// they should be used to navigate menus. The user will map these DeviceInputs
|
||||
// to the GameButtons "MenuLeft (optional)", "MenuStart", and "MenuRight (optional)".
|
||||
//
|
||||
|
||||
// Example 2: A user is using PlayStation dance pads to play. These controllers
|
||||
// don't have dedicated DeviceInputs for MenuLeft and MenuRight. The user maps
|
||||
// Up, Down, Left, and Right as normal. Since the Left and Right GameButtons
|
||||
@@ -41,16 +41,16 @@ public:
|
||||
{
|
||||
GameButtonType m_gbt;
|
||||
};
|
||||
/* Data for each Game-specific GameButton. This starts at GAME_BUTTON_NEXT. */
|
||||
// Data for each Game-specific GameButton. This starts at GAME_BUTTON_NEXT.
|
||||
PerButtonInfo m_PerButtonInfo[NUM_GameButton];
|
||||
const PerButtonInfo *GetPerButtonInfo( GameButton gb ) const;
|
||||
|
||||
TapNoteScore MapTapNoteScore( TapNoteScore tns ) const;
|
||||
TapNoteScore m_mapW1To;
|
||||
TapNoteScore m_mapW2To;
|
||||
TapNoteScore m_mapW3To;
|
||||
TapNoteScore m_mapW4To;
|
||||
TapNoteScore m_mapW5To;
|
||||
TapNoteScore m_mapW1To;
|
||||
TapNoteScore m_mapW2To;
|
||||
TapNoteScore m_mapW3To;
|
||||
TapNoteScore m_mapW4To;
|
||||
TapNoteScore m_mapW5To;
|
||||
|
||||
// Lua
|
||||
void PushSelf( lua_State *L );
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* GraphDisplay - A graph of the player's life over the course of Gameplay, used on Evaluation. */
|
||||
#ifndef GRAPH_DISPLAY_H
|
||||
#define GRAPH_DISPLAY_H
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
/* GrooveRadar - The song's GrooveRadar displayed in SelectSong. */
|
||||
/* GrooveRadar - The song's GrooveRadar displayed in SelectMusic. */
|
||||
|
||||
#ifndef GROOVE_RADAR_H
|
||||
#define GROOVE_RADAR_H
|
||||
|
||||
@@ -1,3 +1,4 @@
|
||||
/* GroupList - Displays a list of groups for SelectGroup. (An old holdover.) */
|
||||
#ifndef GROUP_LIST_H
|
||||
#define GROUP_LIST_H
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* LifeMeterBar - The player's life represented as a bar. */
|
||||
|
||||
#ifndef LIFEMETERBAR_H
|
||||
#define LIFEMETERBAR_H
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
/* LifeMeterTime - Battery life meter used in Oni. */
|
||||
/* LifeMeterTime - Battery life meter used in Survival. */
|
||||
|
||||
#ifndef LifeMeterTime_H
|
||||
#define LifeMeterTime_H
|
||||
|
||||
@@ -1,4 +1,5 @@
|
||||
/* LyricDisplay - Displays lyrics along with the song on Gameplay. */
|
||||
|
||||
#ifndef LYRIC_DISPLAY_H
|
||||
#define LYRIC_DISPLAY_H
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* MemoryCardDisplay - A graphic displaying the state of memory cards. */
|
||||
|
||||
#ifndef MEMORY_CARD_DISPLAY_H
|
||||
#define MEMORY_CARD_DISPLAY_H
|
||||
|
||||
|
||||
+6
-1
@@ -1,4 +1,5 @@
|
||||
/* MeterDisplay - */
|
||||
/* MeterDisplay - Display position in a song. */
|
||||
|
||||
#ifndef METER_DISPLAY_H
|
||||
#define METER_DISPLAY_H
|
||||
|
||||
@@ -15,6 +16,10 @@ public:
|
||||
virtual MeterDisplay *Copy() const;
|
||||
|
||||
void SetPercent( float fPercent );
|
||||
void SetStreamWidth( float fStreamWidth );
|
||||
|
||||
// Lua
|
||||
void PushSelf( lua_State *L );
|
||||
|
||||
private:
|
||||
float m_fStreamWidth;
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
/* MusicList - now an artifact from ScreenSelectGroup. */
|
||||
/* MusicList - Displays all the songs in a given group. (An artifact from SelectGroup.) */
|
||||
#ifndef MUSIC_LIST_H
|
||||
#define MUSIC_LIST_H
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* MusicWheelItem - An item on the music wheel. */
|
||||
/* MusicWheelItem - An item on the MusicWheel. */
|
||||
|
||||
#ifndef MUSIC_WHEEL_ITEM_H
|
||||
#define MUSIC_WHEEL_ITEM_H
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* BMSLoader - reads a Song from a set of .BMS files. */
|
||||
/* PMSLoader - reads a Song from a set of .PMS files. */
|
||||
|
||||
#ifndef NOTES_LOADER_PMS_H
|
||||
#define NOTES_LOADER_PMS_H
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* Microphone - */
|
||||
/* Microphone - Holdover from incomplete karaoke mode. */
|
||||
|
||||
#ifndef Microphone_H
|
||||
#define Microphone_H
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* PitchDetectionTestUtil - */
|
||||
/* PitchDetectionTestUtil - Holdover from incomplete karaoke mode. */
|
||||
|
||||
#ifndef PitchDetectionTestUtil_H
|
||||
#define PitchDetectionTestUtil_H
|
||||
|
||||
@@ -6,9 +6,7 @@
|
||||
#include "EnumHelper.h"
|
||||
|
||||
|
||||
//
|
||||
// Player number stuff
|
||||
//
|
||||
enum PlayerNumber
|
||||
{
|
||||
PLAYER_1 = 0,
|
||||
|
||||
+2
-1
@@ -1,4 +1,4 @@
|
||||
/* Profile - Player data that persists between sessions. Can be stored on a local disk or on a memory card. */
|
||||
/* Profile - Player data that persists between sessions. Can be stored on a local disk or on a memory card. */
|
||||
|
||||
#ifndef Profile_H
|
||||
#define Profile_H
|
||||
@@ -96,6 +96,7 @@ public:
|
||||
RString m_sCharacterID;
|
||||
RString m_sLastUsedHighScoreName; // this doesn't really belong in "editable", but we need it in the smaller editable file so that it can be ready quickly.
|
||||
int m_iWeightPounds; // 0 == not set
|
||||
//RString m_sProfileImageName; // todo: add a default image -aj
|
||||
|
||||
// General data
|
||||
static RString MakeGuid();
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* RageSurface_Load_GIF - (non-animated) GIF file loader */
|
||||
|
||||
#ifndef RAGE_SURFACE_LOAD_GIF_H
|
||||
#define RAGE_SURFACE_LOAD_GIF_H
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* RageSurface_Load_JPEG - JPEG file loader */
|
||||
|
||||
#ifndef RAGE_SURFACE_LOAD_JPEG_H
|
||||
#define RAGE_SURFACE_LOAD_JPEG_H
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* RageSurface_Load_PNG - PNG file loader */
|
||||
|
||||
#ifndef RAGE_SURFACE_LOAD_PNG_H
|
||||
#define RAGE_SURFACE_LOAD_PNG_H
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* RageSurface_Load_XPM - XPM file loader */
|
||||
|
||||
#ifndef RAGE_SURFACE_LOAD_XPM_H
|
||||
#define RAGE_SURFACE_LOAD_XPM_H
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* RageSurface_Save_BMP - Save a RageSurface to a BMP. */
|
||||
|
||||
#ifndef RAGE_SURFACE_SAVE_BMP_H
|
||||
#define RAGE_SURFACE_SAVE_BMP_H
|
||||
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* RageSurface_Save_JPEG - Save a RageSurface to a JPEG. */
|
||||
|
||||
#ifndef RAGE_SURFACE_SAVE_JPEG_H
|
||||
#define RAGE_SURFACE_SAVE_JPEG_H
|
||||
|
||||
|
||||
@@ -1,4 +1,4 @@
|
||||
/* RageTextureManager - Interface for loading textures. */
|
||||
/* RageTextureManager - Interface for loading textures. */
|
||||
|
||||
#ifndef RAGE_TEXTURE_MANAGER_H
|
||||
#define RAGE_TEXTURE_MANAGER_H
|
||||
@@ -74,12 +74,12 @@ public:
|
||||
|
||||
// call this between Screens
|
||||
void DeleteCachedTextures() { GarbageCollect( screen_changed ); }
|
||||
|
||||
|
||||
// call this on switch theme
|
||||
void DoDelayedDelete() { GarbageCollect( delayed_delete ); }
|
||||
|
||||
|
||||
void InvalidateTextures();
|
||||
|
||||
|
||||
void AdjustTextureID( RageTextureID &ID ) const;
|
||||
void DiagnosticOutput() const;
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
/* RageUtil - Miscellaneous helper macros and functions. */
|
||||
/* RageUtil - Miscellaneous helper macros and functions. */
|
||||
|
||||
#ifndef RAGE_UTIL_H
|
||||
#define RAGE_UTIL_H
|
||||
|
||||
@@ -1,3 +1,5 @@
|
||||
/* RoomInfoDisplay: Shows information about an online game room. */
|
||||
|
||||
#ifndef ROOM_INFO_DISPLAY_H
|
||||
#define ROOM_INFO_DISPLAY_H
|
||||
|
||||
|
||||
+1
-1
@@ -1,4 +1,4 @@
|
||||
/* ScreenAttract - Base class for all attraction screens. This class handles input and coin logic. */
|
||||
/* ScreenAttract - Base class for all attraction screens. This class handles input and coin logic. */
|
||||
|
||||
#ifndef ScreenAttract_H
|
||||
#define ScreenAttract_H
|
||||
|
||||
Reference in New Issue
Block a user