ZScript: Z3 Style Magic Mirror (v0.2.4, Tested, Working)

///////////////////////
/// Z3 Magic Mirror ///
/// v0.2.4          ///
/// 22-Nov-2016     ///
/// By: ZoriaRPG    ///
///////////////////////////////////////
/// Partial Rewrite of the Original ///
/// WarpFunctions.zh b1.1 from 2014 ///
/// originally made by request for  ///
/// Obderhode and used in the quest ///
/// 'The Three Whistles'            ///
///////////////////////////////////////

//! To-Do
//! Add in freeze flags and ghost suspension

/// Global Array
int Mirror[214747];

const int TEST_MIRROR_SPARKLE = 0;
const int MIRROR_SPARKLE_BEFORE_WAITDRAW = 0;

//Moon Pearl Goodies
const int I_MIRROR = 160;
const int I_MOONPEARL = 200;
const int I_BUNNYRING = 201; //A wisp ring twith a LTM for Bunny Sprites

//Options
const int WARP_RETURNS_ON_INJURY        = 1;
const int REQUIRE_MOON_PEARL            = 1;
const int MIRROR_RETURNS_TO_DUNGEON_ENTRANCE    = 1; //This requires placing a warp return square on dungeon entrance screens.

const int MIRROR_POST_WARP_TIMER_NUM_FRAMES = 75; // Number of frames afer warping, before Link may use a warp return sparkle.

const int POST_WARP_LINK_IS_INVINCIBLE      = 0;     //If se tto '1', Link->CollDetection will be disabled for a number of
                        //frames equal to:

const int WARP_INVULNERABILITY_FRAMES       = 90; //Number of frames that Link is invulnerable after warping.

//!! Caution: This may conflict with other items that grant invulnerability!


///Constants for Array Indices of Mirror[]

const int IS_WARPING        = 0;
const int AFTER_WARP        = 1;
const int RETURN_WARP       = 2;
const int AFTER_RETURN_WARP     = 3;

const int WARP_SPARKLE          = 10;
const int WARP_SPARKLE_DMAP         = 11;
const int WARP_SPARKLE_SCREEN       = 12;
const int WARP_SPARKLE_X        = 13;
const int WARP_SPARKLE_Y        = 14;
const int WARP_SPARKLE_RETURN_DMAP  = 15;

const int WARP_LINK_X           = 20;
const int WARP_LINK_Y           = 21;
const int WARP_LINK_Z           = 22;
const int WARP_LINK_HP          = 23;
const int WARP_LINK_TEMP_INVULNERABILITY = 24;

const int MIRROR_SPARKLE_COMBO_FRAME = 30; //Mirror array index
const int MIRROR_POST_WARP_TIMER = 40;



//Settings

//Sounds
const int SFX_WARP_ERROR    = 67;
const int SFX_WARP      = 73;
const int SFX_WARP_DUNGEON  = 16;

const int WARP_WAVE_DUR     = 100; //Duration of warp wavy animation (overworld)
const int WARP_WAVE_DUR_DUNGEON = 100; //Duration of warp wavy animation (inside dungeons)

const int WARP_DUR      = 60;
const int POST_WARP_DELAY   = 15;



//Mirror Sparkle Settings
const int MIRROR_SPARKLE_COMBO      = 32596; // COmbo of sparkle or other warp return effect.
const int MIRROR_SPARKLE_COMBO_LAYER    = 2;
const int MIRROR_SPARKLE_COMBO_W    = 1;
const int MIRROR_SPARKLE_COMBO_H    = 1;
const int MIRROR_SPARKLE_COMBO_CSET     = 0;
const int MIRROR_SPARKLE_COMBO_XSCALE   = -1;
const int MIRROR_SPARKLE_COMBO_YSCALE   = -1;
const int MIRROR_SPARKLE_COMBO_RX   = 0;
const int MIRROR_SPARKLE_COMBO_RY   = 0;
const int MIRROR_SPARKLE_COMBO_RANGLE   = 0;

const int MIRROR_SPARKLE_COMBO_FLIP     = 0;
const int MIRROR_SPARKLE_COMBO_OPACITY  = 64;

const int MIRROR_SPARKLE_COMBO_NUM_FRAMES = 4;
const int MIRROR_SPARKLE_COMBO_INIT_FRAME = 1;




//Accessors
int IsWarping(){ return Mirror[IS_WARPING]; }
void IsWarping(bool state){ if ( state ) Mirror[IS_WARPING] = 1; else Mirror[IS_WARPING] = 0; }

int AfterWarp(){ return Mirror[AFTER_WARP]; }
void AfterWarp(bool state){ if ( state ) Mirror[AFTER_WARP] = 1; else Mirror[AFTER_WARP] = 0; }

int IsReturnWarping(){ return Mirror[RETURN_WARP]; }
void IsReturnWarping(bool state){ if ( state ) Mirror[RETURN_WARP] = 1; else Mirror[RETURN_WARP] = 0; }

int AfterReturnWarp(){ return Mirror[AFTER_RETURN_WARP]; }
void AfterReturnWarp(bool state){ if ( state ) Mirror[AFTER_RETURN_WARP] = 1; else Mirror[AFTER_RETURN_WARP] = 0; }

int WarpSparkle(){ return Mirror[WARP_SPARKLE]; }
void WarpSparkle(bool state){ if ( state ) Mirror[WARP_SPARKLE] = 1; else Mirror[WARP_SPARKLE] = 0; }

int WarpSparkleReturn(){ return Mirror[WARP_SPARKLE_RETURN_DMAP]; }
void WarpSparkleReturn(int dmap){ Mirror[WARP_SPARKLE_RETURN_DMAP] = dmap; }

int WarpSparkleDMap(){ return Mirror[WARP_SPARKLE_DMAP]; }
void WarpSparkleDMap(int dmap){ Mirror[WARP_SPARKLE_DMAP] = dmap; }

int WarpSparkleX(){ return Mirror[WARP_SPARKLE_X]; }
void WarpSparkleX(int x){ Mirror[WARP_SPARKLE_X] = x; }

int WarpSparkleY(){ return Mirror[WARP_SPARKLE_Y]; }
void WarpSparkleY(int y){ Mirror[WARP_SPARKLE_Y] = y; }

int WarpSparkleScreen(){ return Mirror[WARP_SPARKLE_SCREEN]; }
void WarpSparkleScreen(int screen){ Mirror[WARP_SPARKLE_SCREEN] = screen; }

//The following four functions are used to manipulate,a nd check the post-warp timer,
//that prevents Link from being sent back by a sparkle as soon as he finishes warping.

int WarpReturnWait(){ return Mirror[MIRROR_POST_WARP_TIMER]; }
void ReducePostWarpTimer(){ if ( Mirror[MIRROR_POST_WARP_TIMER] > 0 ) Mirror[MIRROR_POST_WARP_TIMER]--; }
void SetPostWarpTimer(){ Mirror[MIRROR_POST_WARP_TIMER] = MIRROR_POST_WARP_TIMER_NUM_FRAMES + WARP_WAVE_DUR + POST_WARP_DELAY; }
void ClearPostWarpTimer(){ Mirror[MIRROR_POST_WARP_TIMER] = 0; }


//Functions

//Checks the present DMap and returns irts counterpart.
//!! You must set up the arrays inside this function, for it to work.
int GetOtherworldlyDMap(int dmap){
    int q[4];
    int LightWorldDMaps[]={3,-1,-1,-1,-1}; //Populate these two arrays with the IDs of your light and dark world dmaps
    int DarkWorldDMaps[]={8,-1,-1,-1,-1}; //in matched pairs.
    for ( q[0] = 0; q[0] < SizeOfArray(LightWorldDMaps); q[0]++ ) {
        q[1] = LightWorldDMaps[ q[0] ];
        q[2] = DarkWorldDMaps[ q[0] ];
        if ( dmap == q[1] ) return DarkWorldDMaps[ q[0] ];
        if ( dmap == q[2] ) return LightWorldDMaps[ q[0] ];
    }
    return -1;
}

//Returns if the present dmap is a dark world dmap
//!! You must set up the arrays inside this function, for it to work.
bool IsDarkWorld(){
    int DarkWorldDMaps[]={8,-1,-1,-1,-1};
    for ( int q = 0; q < SizeOfArray(DarkWorldDMaps); q++ ) {
        if ( Game->GetCurDMap() == DarkWorldDMaps[q] ) return true;
    }
    return false;
}

//Generates coordinates for the warp return sparkle.
//this is set when we use the mirror.
void SetWarpReturn(){
    WarpSparkle(true);
    WarpSparkleX(Link->X);
    WarpSparkleY(Link->Y);
    WarpSparkleDMap( GetOtherworldlyDMap( Game->GetCurDMap() ) );
    WarpSparkleScreen(Game->GetCurScreen());
    WarpSparkleReturn(Game->GetCurDMap());
}

//Removes the warp sparkle, after using it.
void ClearWarpSparkle(){
    WarpSparkle(false);
    WarpSparkleX(-100);
    WarpSparkleY(-100);
    WarpSparkleDMap(-1);
    WarpSparkleScreen(-1);
    WarpSparkleReturn(-1);
}

//Returns if Link is in a dungeon based on the array dungeonDMaps[]
//!! You must set up the array inside this function, for it to work.
bool IsDungeonDMap(){
    int dungeonDMaps[]={20,21,22};//List all dungeon DMaps here
    for ( int q = 0; q < SizeOfArray(dungeonDMaps); q++ ) {
        if ( Game->GetCurDMap() == dungeonDMaps[q] ) return true;
        return false;
    }
}

//Returns if the warp destination is solid, prior to warping.
bool WarpDestSolid(int x, int y, int screen, int map){
    return ( Game->GetComboSolid(map, screen, ComboAt(x,y)) );
}

//! Main Functions to Call before Waitdraw()

//Handles the initial warp routines.
void MirrorWarpLink() {
    if ( IsWarping() ){
        SetPostWarpTimer();
        NoAction();
        Game->PlaySound(SFX_WARP);
        Screen->Wavy = WARP_WAVE_DUR;
        //Freeze all enemies and ghost scripts
        for(int q = WARP_WAVE_DUR + POST_WARP_DELAY; q > 0; q--){
            NoAction();
            Waitframe();
        }
        //resume npcs and ghost scripts
        Link->PitWarp(GetOtherworldlyDMap(Game->GetCurDMap()), Game->GetCurScreen());
        IsWarping(false);
        AfterWarp(true);
    }

    if (IsReturnWarping() ){
        Mirror[WARP_LINK_HP] = Link->HP;
        Link->X = WarpSparkleX();
        Link->Y = WarpSparkleY();
        NoAction();
        Game->PlaySound(SFX_WARP);
        Screen->Wavy = WARP_WAVE_DUR;
        //Freeze all enemies and ghost scripts
        for(int q = WARP_WAVE_DUR + POST_WARP_DELAY; q > 0; q--){
            NoAction();
            Waitframe();
        }
        //resume npcs and ghost scripts
        Link->PitWarp(WarpSparkleReturn(), WarpSparkleScreen());
        IsReturnWarping(false);
        AfterReturnWarp(true);
    }
}

//Post-warp cleanup, and bounce.
void WarpFinish() {
    if (AfterWarp()){
        if ( Link->Action == LA_GOTHURTLAND || Link->Action == LA_GOTHURTWATER ) Link->HitDir = -1;
        //SetWarpReturn();
        //If the destination is solid, send Link back.
        if ( Screen->ComboS[ ComboAt(Link->X, Link->Y) ] ) {
            Game->PlaySound(SFX_WARP);
            Screen->Wavy = WARP_WAVE_DUR;
            //freeze all enemies and ghost scripts.
            for (int q = WARP_WAVE_DUR + POST_WARP_DELAY; q > 0; q--){
                NoAction();
                Waitframe();
            }
            //resume npcs and ghost scripts
            Link->X = Mirror[WARP_LINK_X];
            Link->Y = Mirror[WARP_LINK_Y];
            Link->PitWarp(WarpSparkleReturn(), Game->GetCurScreen());

            AfterWarp(false);
        }
        if ( Link->HP < Mirror[WARP_LINK_HP] && WARP_RETURNS_ON_INJURY) { //If Link is injured, send him back.
            Link->HP = Mirror[WARP_LINK_HP];
            Game->PlaySound(SFX_WARP);
            Screen->Wavy = WARP_WAVE_DUR;
            //freeze all enemies and ghost scripts.
            for(int q = WARP_WAVE_DUR + POST_WARP_DELAY; q > 0; q--){
                NoAction();
                Waitframe();
            }
            //resume npcs and ghost scripts
            Link->X = Mirror[WARP_LINK_X];
            Link->Y = Mirror[WARP_LINK_Y];
            Link->PitWarp(WarpSparkleReturn(), Game->GetCurScreen());

            Link->X = Mirror[WARP_LINK_X];
            Link->Y = Mirror[WARP_LINK_Y];
            Link->HP = Mirror[WARP_LINK_HP];

            AfterWarp(false);
        }
        else {
            Link->X = Mirror[WARP_LINK_X];
            Link->Y = Mirror[WARP_LINK_Y];
            Mirror[WARP_INVULNERABILITY_FRAMES] = WARP_INVULNERABILITY_FRAMES;
        }
    }

    if (AfterReturnWarp()){
        if ( Link->Action == LA_GOTHURTLAND || Link->Action == LA_GOTHURTWATER ) Link->HitDir = -1;
        ClearWarpSparkle();
        Mirror[WARP_INVULNERABILITY_FRAMES] = WARP_INVULNERABILITY_FRAMES;
        AfterReturnWarp(false);
        //ClearPostWarpTimer();

    }

    if ( POST_WARP_LINK_IS_INVINCIBLE ) {
        if ( Mirror[WARP_INVULNERABILITY_FRAMES] ) {
            Link->CollDetection = false;
            Mirror[WARP_INVULNERABILITY_FRAMES]--;
        }
        if ( !Mirror[WARP_INVULNERABILITY_FRAMES] ) Link->CollDetection = true;
    }
}


//Creates the mirror return sparkle.
void MirrorSparkle(){
    if ( Game->GetCurDMap() == WarpSparkleDMap() && Game->GetCurScreen() == WarpSparkleScreen() ) {
        Screen->DrawCombo(  MIRROR_SPARKLE_COMBO_LAYER, WarpSparkleX(), WarpSparkleY(),
            MIRROR_SPARKLE_COMBO, MIRROR_SPARKLE_COMBO_H, MIRROR_SPARKLE_COMBO_W, MIRROR_SPARKLE_COMBO_CSET,
            MIRROR_SPARKLE_COMBO_XSCALE, MIRROR_SPARKLE_COMBO_YSCALE, MIRROR_SPARKLE_COMBO_RX,
            MIRROR_SPARKLE_COMBO_RY, MIRROR_SPARKLE_COMBO_RANGLE, Mirror[MIRROR_SPARKLE_COMBO_FRAME],
            MIRROR_SPARKLE_COMBO_FLIP, true, MIRROR_SPARKLE_COMBO_OPACITY) ; //Mirror sparkle

        //Reduce the frames
        if ( Mirror[MIRROR_SPARKLE_COMBO_FRAME] >= MIRROR_SPARKLE_COMBO_NUM_FRAMES ) Mirror[MIRROR_SPARKLE_COMBO_FRAME] = MIRROR_SPARKLE_COMBO_INIT_FRAME;
        else Mirror[MIRROR_SPARKLE_COMBO_FRAME]++;

        if ( !WarpReturnWait() && RectCollision( Mirror[WARP_SPARKLE_X], Mirror[WARP_SPARKLE_Y], Mirror[WARP_SPARKLE_X]+16, Mirror[WARP_SPARKLE_Y]+16, Link->X+Link->HitXOffset+Link->DrawXOffset, Link->Y+Link->HitYOffset+Link->DrawYOffset, Link->X+Link->HitXOffset+Link->DrawXOffset+Link->HitWidth, Link->Y+Link->HitYOffset+Link->DrawYOffset+Link->HitHeight)
            || Distance(CenterLinkX(), CenterLinkY(), Mirror[WARP_SPARKLE_X]+8, Mirror[WARP_SPARKLE_Y]+8) < 8)
        {
            //Reurn Link via the portal
            IsReturnWarping(true);
        }
    }
}

void TestSparkle(){
    int x = WarpSparkleX();
    int y = WarpSparkleY();
    if ( x < 0 ) x = 0;
    if ( y < 0 ) y = 0;
    Screen->DrawCombo(  MIRROR_SPARKLE_COMBO_LAYER, x, y,
            MIRROR_SPARKLE_COMBO, MIRROR_SPARKLE_COMBO_H, MIRROR_SPARKLE_COMBO_W, MIRROR_SPARKLE_COMBO_CSET,
            MIRROR_SPARKLE_COMBO_XSCALE, MIRROR_SPARKLE_COMBO_YSCALE, MIRROR_SPARKLE_COMBO_RX,
            MIRROR_SPARKLE_COMBO_RY, MIRROR_SPARKLE_COMBO_RANGLE, Mirror[MIRROR_SPARKLE_COMBO_FRAME],
            MIRROR_SPARKLE_COMBO_FLIP, true, MIRROR_SPARKLE_COMBO_OPACITY) ; //Mirror sparkle

        //Reduce the frames
        if ( Mirror[MIRROR_SPARKLE_COMBO_FRAME] >= MIRROR_SPARKLE_COMBO_NUM_FRAMES ) Mirror[MIRROR_SPARKLE_COMBO_FRAME] = MIRROR_SPARKLE_COMBO_INIT_FRAME;
        else Mirror[MIRROR_SPARKLE_COMBO_FRAME]++;
}


//Runs the moon pearl bunny sprite change, and halts using any item other than the mirror.
void MoonPearl(){
    if ( IsDarkWorld() && !Link->Item[I_MOONPEARL] && !Link->Item[I_BUNNYRING] ) Link->Item[I_BUNNYRING] = true;
    if ( !IsDarkWorld() && Link->Item[I_BUNNYRING] ) Link->Item[I_BUNNYRING] = false;
    if ( IsDarkWorld() && Link->Item[I_MOONPEARL] && Link->Item[I_BUNNYRING] ) Link->Item[I_BUNNYRING] = false;
    if ( Link->Item[I_BUNNYRING] ) {
        if ( Link->PressA && GetEquipmentA() != I_MIRROR ) Link->PressA = false;
        if ( Link->PressB && GetEquipmentB() != I_MIRROR ) Link->PressB = false;
    }
}

/// Items

item script Mirror{
    void run(){
        if ( IsDungeonDMap() && MIRROR_RETURNS_TO_DUNGEON_ENTRANCE ) {
            //Warp to dungeon entrance.
            Game->PlaySound(SFX_WARP_DUNGEON);
            Screen->Wavy = WARP_WAVE_DUR_DUNGEON;
            Link->Warp(Game->GetCurDMap(), Game->DMapContinue[Game->GetCurDMap()]);
        }
        else {
            if ( IsDarkWorld() ) {
                //SetPostWarpTimer();
                SetWarpReturn();
                IsWarping(true);
            }
            //Warp to other world
            if ( !IsDarkWorld() && SFX_WARP_ERROR ) Game->PlaySound(SFX_WARP_ERROR);
        }
    }
}

//Global Script Example

global script Z3_Mirror{
    void run(){
        while(true){
            if ( REQUIRE_MOON_PEARL ) MoonPearl();
            ReducePostWarpTimer();
            MirrorWarpLink();

            //if ( TEST_MIRROR_SPARKLE ) TestSparkle();
            //if ( MIRROR_SPARKLE_BEFORE_WAITDRAW ) MirrorSparkle();
            Waitdraw();
            WarpFinish();
            //if ( !MIRROR_SPARKLE_BEFORE_WAITDRAW ) MirrorSparkle();
            if ( WarpSparkle() ) MirrorSparkle(); //Call only if it exists.
            Waitframe();
        }
    }
}

//Deprecated

//bool TouchingSolid(int x, int y) {
  //  if ( Screen->isSolid(x,y) ||
  //  Screen->isSolid(x + SOLIDITY_CHECK_DISTANCE, y) ||
  //  Screen->isSolid(x + SOLIDITY_CHECK_DISTANCE, y+SOLIDITY_CHECK_DISTANCE) ||
  //  Screen->isSolid(x + SOLIDITY_CHECK_DISTANCE, y-SOLIDITY_CHECK_DISTANCE) ||
  //  Screen->isSolid(x - SOLIDITY_CHECK_DISTANCE, y) ||
  //  Screen->isSolid(x - SOLIDITY_CHECK_DISTANCE, y+SOLIDITY_CHECK_DISTANCE) ||
  //  Screen->isSolid(x - SOLIDITY_CHECK_DISTANCE, y-SOLIDITY_CHECK_DISTANCE) ) {
  //      return true;
  //  }
  //  else {
   //     return false;
  //  }
//}