/**
 * @file transition.h
 *
 * @brief Level transitions.
 */
#ifndef TRANSITION_H
#define TRANSITION_H

#include "common.h"
#include <oid.h>

/**
 * @brief Transition flags.
*/
enum FTRANS {
    FTRANS_None = 0,
    FTRANS_Checkpoint = 1,
    FTRANS_RetryWorld = 2,
    FTRANS_ClearGame = 4,
    FTRANS_SameWorld = 8,
    FTRANS_ShowLives = 16
};

/**
 * @brief Transition flags integer type.
 */
typedef int GRFTRANS;

/**
 * @brief Transition data
 *
 * Responsible for holding data bout a level transition.
*/
struct TRANS
{
    uint fSet;
    struct LevelTableStruct *pchzWorld; // Current file thats loading struct
    OID oidWarp; // Checkpoint Warps
    OID oidWarpContet;
    GRFTRANS grftrans; // Lost all lives flags
};

/**
 * @brief Transition
*/
class CTransition
{
protected:
    char *m_pchzWorld;      // This is the ptr to enc level sector offset and size in memory
    OID   m_oidWarp;        // Which checkpoint you spawn at when you start a level
    OID   m_oidWarpContext;

public:
    GRFTRANS grftrans;       // Flags that affect level loading, one of them checks if you lost all lives when you die.
    char m_achzWorldCur[64]; // File description contents.
    int  m_fPending;         // Basically like a level pending flag.

    // Reloads the current level. The value of FTRANS affects the load.
    void ResetWorld(FTRANS ftrans);

    // Sets the conditions on the level if you died or loading a level
    void Set(char *pchzWorld, OID oidWarp, OID oidWarpContext, GRFTRANS grftrans);

    // Executes the conditions from CTransition::Set by setting some engine vaules to default and loading the level file
    void Execute();
};

#endif // TRANSITION_H