common.h

Go to the documentation of this file.

#ifndef COMMON_H
#define COMMON_H
 
#include "custom_types.h"
#include "vector.h"
 
//~~~~~~~~~~~~~~~~~~~~~~~~
//Constants/Magic Numbers
//~~~~~~~~~~~~~~~~~~~~~~~~
 
#define SCREEN_LEFT_EDGE 0x0
#define SCREEN_RIGHT_EDGE 0x200
#define SCREEN_TOP_EDGE 0x0
#define SCREEN_BOTTOM_EDGE 0xE8
 
#define FPS 30
 
#define WORLD_UNIT 4096
#define GAME_UNIT 64
 
typedef enum Direction
{
    LEFT,
    RIGHT
}Direction;
 
typedef enum Buttons
{
    X_BUTTON = 0x0040,
    SQUARE_BUTTON = 0x0080,
    CIRCLE_BUTTON = 0x0020,
    TRIANGLE_BUTTON = 0x0010,
 
    UP_BUTTON = 0x1000,
    RIGHT_BUTTON = 0x2000,
    DOWN_BUTTON = 0x4000,
    LEFT_BUTTON = 0x8000,
 
    SELECT_BUTTON = 0x0100,
    START_BUTTON = 0x0800,
 
    R1_BUTTON = 0x0008,
    L1_BUTTON = 0x0004,
    R2_BUTTON = 0x0002,
    L2_BUTTON = 0x0001,
 
    L3_BUTTON = 0x0200,
    R3_BUTTON = 0x0400
}Buttons;
 
typedef enum GameState
{
    GAMESTATE_GAMEPLAY = 0,
    GAMESTATE_LOADING = 0x1,
    GAMESTATE_PAUSED = 0x2,
    GAMESTATE_INVENTORY = 0x3,
    GAMESTATE_DEATH = 0x4,
    GAMESTATE_GAME_OVER = 0x5,
    GAMESTATE_BETA_DRAGON_TEXTBOX_MAYBE = 0x6,
    GAMESTATE_FLIGHT_LEVEL_MENU = 0x7,
    GAMESTATE_DRAGON_STATE = 0x8,
    GAMESTATE_FLY_IN = 0x9,
    GAMESTATE_EXITING_LEVEL = 0xA,
    GAMESTATE_DRAGON_FAIRY_TEXTBOX = 0xB,
    GAMESTATE_BALLOONIST = 0xC,
    GAMESTATE_TITLE_SCREEN = 0xD,
    GAMESTATE_CUTSCENE = 0xE,
    GAMESTATE_CREDITS = 0xF
}GameState;
 
typedef enum SpyroHealthStates
{
    YELLOW_SPARX = 3,
    BLUE_SPARX = 2,
    GREEN_SPARX = 1,
    NO_SPARX = 0
}SpyroHealthStates;
 
typedef enum LevelIDS
{
    ARTISANS_ID = 0xA,
    STONE_HILL_ID = 0xB,
    TOWN_SQUARE_ID = 0xD,
    DARK_HALLOW_ID = 0xC,
    TOASTY_ID = 0xE,
    SUNNY_FLIGHT_ID = 0xF,
 
    PEACE_KEEPERS_ID = 0x14,
    DRY_CANYON_ID = 0x15,
    CLIFF_TOWN_ID = 0x16,
    ICE_CAVERN_ID = 0x17,
    SHEMP_ID = 0x18,
    NIGHT_FLIGHT_ID = 0x19,
 
    MAGIC_CRAFTERS_ID = 0x1E,
    ALPINE_RIDGE_ID = 0x1F,
    HIGH_CAVES_ID = 0x20,
    WIZARD_PEAK_ID = 0x21,
    BLOWHARD_ID = 0x22,
    CRYSTAL_FLIGHT_ID = 0x23,
 
    BEAST_MAKERS_ID = 0x28,
    TERRACE_VILLAGE_ID = 0x29,
    MISTY_BOG_ID = 0x2A,
    TREE_TOPS_ID = 0x2B,
    METALHEAD_ID = 0x2C,
    WILD_FLIGHT_ID = 0x2C,
 
    DREAM_WEAVERS_ID = 0x32,
    HAUNTED_TOWERS_ID = 0x35,
    DARK_PASSAGE_ID = 0x33,
    LOFTY_CASTLE_ID = 0x34,
    JACQUES_ID = 0x36,
    ICY_FLIGHT_ID = 0x37,
 
    GNASTYS_WORLD_ID = 0x3C,
    GNORC_COVE_ID = 0x3D,
    TWILIGHT_HARBOR_ID = 0x3E,
    GNASTY_GNORC_ID = 0x3F,
    GNASTYS_LOOT_ID = 0x40
}LevelIDS;
 
typedef enum InventoryMenuSelections
{
    ARTISANS_MENU = 0,
    PEACE_KEEPERS_MENU = 1,
    MAGIC_CRAFTERS_MENU = 2,
    BEAST_MAKERS_MENU = 3,
    DREAM_WEAVERS_MENU = 4,
    GNASTYS_WORLD_MENU = 5
}InventoryMenuSelections;
 
typedef enum StartMenuSelections
{
    STARTMENU_CONTINUE = 0,
    STARTMENU_OPTIONS = 1,
    STARTMENU_INVENTORY = 2,
    STARTMENU_EXIT_LEVEL = 3,
    STARTMENU_QUIT_GAME = 3
 
}StartMenuSelections;
 
typedef enum MovementSubStates
{
    MOVEMENT_SUBSTATE_LOADING = 0x8,
    MOVEMENT_SUBSTATE_EXIT_PORTAL = 0x9,
    MOVEMENT_SUBSTATE_FLY_IN_LOOP = 0xA,
    MOVEMENT_SUBSTATE_FLY_IN_CAMERA_180 = 0xA
}MovementSubStates;
 
typedef enum BalloonistStates
{
    BALLOONIST_STATE_NEVER_TALKED_TO_BALLOONIST = 0x0,
    BALLOONIST_STATE_TEXTBOX = 0x1,
    BALLOONIST_STATE_JUMPING_ONTO_BALLOON = 0x2,
    BALLOONIST_STATE_BALLOON_RISING = 0x3,
    BALLOONIST_STATE_BALLOON_LOADING_PART_1 = 0x4,
    BALLOONIST_STATE_BALLOON_LOADING_PART_2 = 0x5,
    BALLOONIST_STATE_BALLOON_LOWERING = 0x6,
    BALLOONIST_STATE_JUMPING_OUT_OF_BALLOON = 0x7
 
}BalloonistStates;
 
 
typedef enum LevelFlyInAnimations
{
    FACING_LEFT = 0xCA6C,
    FACING_RIGHT = 0xCA3C,
    FACING_FORWARD = 0xCA24,
    FACING_BACKWARDS = 0xCA84,
    FACING_DIAGONAL = 0xCA9C,   // wizard peak specific
    RETURNING_HOME = 0xCA54
}LevelFlyInAnimations;
 
 
//~~~~~~~
//Structs
//~~~~~~~
 
typedef struct RECT 
{
    short x, y, w, h;
}RECT;
 
typedef struct RGBA_u8
{
    unsigned char R;
    unsigned char G;
    unsigned char B;
    unsigned char opacity;
}RGBA_u8;
 
typedef struct RGB_u8
{
    unsigned char R;
    unsigned char G;
    unsigned char B;
}RGB_u8;
 
typedef struct BGR_u8
{
    unsigned char B;
    unsigned char G;
    unsigned char R;
}BGR_u8;
 
 
//*~~~~~~~~~~~~~~~~~~~~~~~~
//*        SYMBOLS
//*~~~~~~~~~~~~~~~~~~~~~~~~
 
 
 
//*~~~~~~~~~~~~~~~~~~
//*In game Functions
//*~~~~~~~~~~~~~~~~~~
 
int printf (const char * format, ...);
int sprintf(char *output, const char *format, ...);
void memset(void *str, int c, int n);
int rand();
void srand(int seed); // end of psyq_functions
 
 
void Maybe_ArrayCopy(int *outputArray,int *inputArray,int arrayLength);                                       //? This function copies one array to another
 
void RenderShadedMobys();
 
void RenderNormalMobys();
 
void RenderAllObjects();
 
void PrimitiveAlphaHack(void* param_1, int param_2, int param_3, short colorSpace, int param_5);
 
void CopyHudToShaded();
 
void DrawLine(int point1X, int point1Y, int point2X, int point2Y);                                      //? This function draws a yellow line.
 
void FillScreenColor(int colorSpace, char r, char g, char b);                                           //? Fills the screen with a specific color.
 
void PlayIntroCutscenes();                                                                              //? This function is related to the intro cutscenes.
 
void TheAdventureBegins();                                                                              //? This function calls the "The Adventure Begins" start sequence in the game.
void TheAdventureContinues();
 
void LockCameraToSpyro(void);
 
void Vec3IntToShortDiv4(short *Vec3ShortPTR,int *Vec3PTR);                                              //? This function takes an int vector, divides it by 4, then stores it as a short. Some things in spyro need to refer to position as a short rather than an int, like particles, this is where you'd convert them.
 
char* GetNextParticleSlot(char param_1);                                                                //? param_1 might be storing its subtype. It affects the way the particle looks ratio wise? It also stores the param value you pass into param_1 into the 1st element of the particle struct. NOT THE 0th.
 
void CreateParticle(int param_1, int param_2, int **ptrToMoby, int *param_4);                           //? This function creates a particle. param_1 amount of particles, param_2 Is the Particle ID, param_3 is a Vec3 to its Initial Spawn Position, param_4 Vec3 of Amount of Units to Travel from Inital POS
 
void UpdateMobyCollision(int param_1, unsigned int param_2);                                            //? Research this more.
 
int PlaySoundEffect(int soundEffectID, int ptrToMoby, int playbackMode, char *param_4);
 
void PlayMusicTrack(int track_number, int flags);
 
int LoadImageOrTexture(RECT *rect, int *p);
 
int DrawSync(int mode);
 
void Maybe_ResetHudTimers(void); // end of labeled_functions
 
 
//*~~~~~~~~~~~~~~~~~
//*In Game Variables
//*~~~~~~~~~~~~~~~~~
// Booleans
 
extern bool _isPastTitleScreen;  
 
extern bool _isLoading;  
 
extern bool _isInsideOptionsMenu;
 
extern bool _canFlyIn; 
 
// Timers
 
extern int _globalTimer;
 
extern int _pausedTimer;   
 
extern int _loadingTimer;
 
extern int _levelTimerWhenActive;   
 
extern int _levelTimer_60fps; 
 
extern int _vSyncTimer_60fps;
 
extern int _wobbleAndOpacityTimer;
 
 
// Important Stuff
 
extern int _gameState;
 
extern unsigned short _currentButtonsHeld;
 
extern unsigned short _currentButtonsPressed;
 
extern int _secondController; 
 
extern int _movementSubState;
 
extern int _isInPortal; 
                                                          
extern short _globalGemCount;
 
extern int _globalDragonCount; 
 
extern int _globalEggCount;
 
 
extern int _levelID;
 
extern char _portalToExitFromInHW;   
 
extern short _flyInAnimation;                 
 
extern Vec3 _cameraPosition;
 
extern CameraAngle _cameraAngle;
 
extern short _cameraRotationMatrix[3][3];
extern short _cameraPureRotationMatrix[3][3];
 
extern short _sinArray[256];
 
extern char _mainMenuState;
 
extern int _balloonistState;
 
extern int _startMenuSelection;
 
extern int _inventoryMenuScreen;
 
extern char _whichCutscene;
 
extern char _effect_ScreenFadeIn;
 
extern char _effect_ScreenLetterBox;
 
extern char _collectablesStateFlags[1231];
 
extern int* _ptr_levelMobys;
 
extern int* _ptr_dynamicLevelMobys;
 
extern int* _ptr_levelMobySpecialData;
 
// #define _ptr_levelMobySpecialData _ptr_endDynamicMobys //0x80075930        //? Just giving it another name, since it also could be used to indicate the end of dynamic mobys, instead of just being used to indicate the start of levelMobyData.
 
 
 
extern int* _ptr_primitivesArray; //0x800757b0                //? Not too sure.
extern int* _ptr_arrayGraphicsRelatedPointers; //0x8007581c   //? Ptr the the array of primitives structs to be drawn every frame
extern int _ptrTextUnk; //0x800720f4                          //? Not too sure.
extern char* _ptr_hudMobys; //0x80075710                      //? A pointer to a dynamic downwards growing array of moby structs to render that gets rendered to the hud every frame.
 
extern char* _ptr_particleLinkedList; //0x80075738           //? This is a pointer to the next available particle slot.
 
extern char _hudChestState;  //0x80077FA8
extern char _hudDragonState; //0x80077FA9
extern char _hudLivesState;  //0x80077FAA
extern char _hudEggsState;   //0x80077FAB
extern char _hudAnimationState;   //0x80077FAC
 
extern int _hudElementsSpinTimer; //0x80077fe4
extern int _unk_spinRelated;    //0x8006cc78
extern char* _localSoundEffects; //0x800761D4
 
extern int _musicLevelTrack;  //0x0x800774b0
 
extern int* _maybe_ptr_levelTextureRelated; //0x800785f0
 
extern byte _cdStatus; //0x80074e44 // end of labeled_global_variables
 
#endif /* COMMON_H */