[Module] ShowInteractiveAreas

// Script header for module 'ShowInteractiveAreas', v1.3
//
// Author: Billbis
//
// Abstract:
//
//  While Space Bar is pressed, this module displays a mouse cursor over each
//  interactive areas. This function is present in most modern Point & Click. It helps
//  players not to miss an object / hotspot / character. Ojects, characters and hotspots
//  coordinates are automtically determined.
//
// Dependencies:
//
//  AGS version required:  build for AGS 3.2.1, not sure if it works with older versions.
//
//  AGS setting required: No particular configuration is needed.
//
// Configuration:
//
//  Optional:
//
//    sia_HOTSPOT_LIMIT might be leave as it is or be adjust to your highest Hotspot number
//    to optimize (a very little bit) calculation time.
//
//    sia_SHOOTING_POINT_N is the number of points that will be randomly shot at screen to
//    determine hotspot coordinates. Empirically determined by me. Increasing this number will
//    improve accruacy, decreasing this number will improve calculation time. You may decrease
//    this number if your game resolution is smaller than 1024*768.
//
//    Two bools are available, sia_CheatEnable and sia_EnableHere to set up this module
//    as optional and to deactivate it in certain rooms or situations.
//
//    Other customizations are possible by editing ShowInteractiveArea.asc directly.
//
// Caveats:
//
//  This module uses ONE overlay, which can perturb your game if you already use 20
//  of them at some point in your game (20 Overlays max display at a same time,
//  AGS limitation).
//
//  Due to probabilistic determination of hotspots coordinates, very small hotspots might not
//  be correctly detected. For sia_SHOOTING_POINT_N = 10000 and 1024*768 resolutions, hotspots
//  with a total area of 55 pixels will be miss half of the time on first key press. But only
//  one time over four on second key press, etc. No problems with small objects or characters. 
//
//  Fragmented areas or weird shapes of hotspots / objects / characters can lead to bad cursor
//  positionning.
//
// Revision history:
//  version 1.3: 07/04/2013
//      Non-enabled hotspots won't be display anymore.
//  version 1.2: 07/04/2013
//      Non-clickable objects won't be display anymore.
//  version 1.1: 03/20/2013
//      The module now works when player is moving.
//  version 1.0: 11/30/2012
//      Improve hotspot detection (algorythm now remember hotspots it previously found).
//  version beta 0.2: 11/24/2012
//      *NEW* Automatic detections of hotspot coordinates.
//  version beta 0.1: 11/23/2012
//      First release.
// 
// Licence:
//
//  ShowInteractiveAreas AGS script module is publish under the terms of the
//  Do What The Fuck You Want To Public License, Version 2
//
// This program is free software. It comes without any warranty, to
// the extent permitted by applicable law. You can redistribute it
// and/or modify it under the terms of the Do What The Fuck You Want
// To Public License, Version 2, as published by Sam Hocevar. See
// http://sam.zoy.org/wtfpl/COPYING for more details.
//
// Thanks:
//
//  Pidem and Kitai
//
// Defines
#define sia_HOTSPOT_LIMIT  50
#define sia_SHOOTING_POINT_N 10000
// Imports
import bool sia_CheatEnable, sia_EnableHere;

// ShowInteractiveAreas script

//General definitions

// Three arrays that will be needed to calculate Hotspot center coordinates.
int siaHotspotX[];
int siaHotspotY[];
int siaHotspotN[];

bool sia_CheatEnable = true; // Use this bool if you want to create an option to set this module optional.
bool sia_EnableHere = true; // Use this bool in situations or rooms you do not want this module to be active.

function on_event(EventType siaevent, int siadata) {
  if (siaevent == eEventEnterRoomBeforeFadein) {
      siaHotspotX = new int[sia_HOTSPOT_LIMIT]; //Each time player change room, this erase old hotspot coordinates.
      siaHotspotY = new int[sia_HOTSPOT_LIMIT];
      siaHotspotN = new int[sia_HOTSPOT_LIMIT];
  }
}

//When player hits SpaceBar
function on_key_press(eKeyCode keycode) {
  if (keycode == eKeySpace){//Change eKeySpace by the key you want to use.
    if (sia_CheatEnable && sia_EnableHere && !IsGamePaused ()) {
      PauseGame();
    //Screening for Hotspots.
      Hotspot *h;
      int index = 0;
      int x, y;
      while (index < sia_SHOOTING_POINT_N) { //We randomly shoot sia_SHOOTING_POINT_N points, and calculate the barycenter of each point that fall on the same Hotspot.
        x = Random(System.ViewportWidth - 1);
        y = Random(System.ViewportHeight - 1);
        h = Hotspot.GetAtScreenXY(x, y);
        if (h.ID > 0) { //Hotspot 0 is not a hotspot.
          siaHotspotX[h.ID] = (siaHotspotN[h.ID]*siaHotspotX[h.ID] + x + GetViewportX()) / (siaHotspotN[h.ID] + 1) + Random(1); //Barycenter calculation
          siaHotspotY[h.ID] = (siaHotspotN[h.ID]*siaHotspotY[h.ID] + y + GetViewportY()) / (siaHotspotN[h.ID] + 1) + Random(1); //Random(1) corrects AGS int rounding
          siaHotspotN[h.ID] = siaHotspotN[h.ID] + 1;
        }
        index++;
      }   
      DynamicSprite *siasprite = DynamicSprite.Create(System.ViewportWidth, System.ViewportHeight); // Technical stuff to create a drawing surface
      DrawingSurface *siasurface = siasprite.GetDrawingSurface();     
      index = 1; //Hotspot 0 is not a hotspot.
      while (index < sia_HOTSPOT_LIMIT) {
        if (siaHotspotX[index] !=0 && siaHotspotY[index] !=0 && hotspot[index].Enabled) {
          //If an hotspot have coordinates, we draw a mouse cursor on it.
          //Alternatively, you can repalce
          //    Mouse.GetModeGraphic(eModeInteract)
          //by
          //    42
          //to use your favourite sprite number 42.
          siasurface.DrawImage(siaHotspotX[index] - GetViewportX(), siaHotspotY[index] - GetViewportY(), Mouse.GetModeGraphic(eModeInteract));
        }
        index++;
      }
      //Calclucalting Objects positions and drawing cursors.
      if (Room.ObjectCount > 0) {
        int siaObjectX,  siaObjectY;
        Object *o;
        index = 0;
        while (index < Room.ObjectCount) {
          o = object[index];
          if (o.Visible && o.Clickable) {
            siaObjectX = o.X + Game.SpriteWidth[o.Graphic]/2;
            siaObjectY = o.Y - Game.SpriteHeight[o.Graphic]/2;
            //If an object is Visible, we draw a mouse cursor on it.
            //Alternatively, you can repalce
            //    Mouse.GetModeGraphic(eModeInteract)
            //by
            //    42
            //to use your favourite sprite number 42.
            siasurface.DrawImage(siaObjectX - GetViewportX(), siaObjectY - GetViewportY(), Mouse.GetModeGraphic(eModeInteract));
          }
          index++;
        }
      }
      //Calclucalting Characters positions and drawing cursors.
      if (Game.CharacterCount > 0) {
        int siaCharacterX,  siaCharacterY;
        Character *c;
        index = 0;
        while (index < Game.CharacterCount) {
          c = character[index];
          if (c.Room == player.Room && c.Clickable) {
            ViewFrame *siacharcatervf = Game.GetViewFrame(c.View, c.Loop, c.Frame);
            siaCharacterX = c.x;
            siaCharacterY = c.y - Game.SpriteHeight[siacharcatervf.Graphic]*c.Scaling/2*100;
            //If a character is clickable, then we draw a mouse cursor on it
            //Alternatively, you can repalce
            //    Mouse.GetModeGraphic(eModeTalkto)
            //by
            //    42
            //to use your favourite sprite number 42.
            siasurface.DrawImage(siaCharacterX - GetViewportX(), siaCharacterY - GetViewportY(), Mouse.GetModeGraphic(eModeTalkto));
          }
          index++;
        }
      }
      siasurface.Release();  // Technical stuff to display the beautiful overlay we have drawn.
      Overlay *siaoverlay = Overlay.CreateGraphical(0, 0, siasprite.Graphic, true);
      while (IsKeyPressed(eKeySpace)) Wait(1); //While Key is pressed, overlay is display.
      siaoverlay.Remove(); //Cleaning a little bit behind us.
      siasprite.Delete();
      siaoverlay = null ;
      UnPauseGame();
    }
  }
}

export sia_CheatEnable, sia_EnableHere; //Do not forget to import these bools in global script header if you want to use them.

// Script header for module 'ShowInteractiveAreas', v1.3 *Alternative Edition*
//
// Author: Billbis
//
// Abstract:
//
//  While Space Bar is pressed, this module displays a mouse cursor over each
//  interactive areas. This function is present in most modern Point & Click. It helps
//  players not to miss an object / hotspot / character. Ojects and characters coordinates
//  are automtically determined. Hotspot coordinates must be entered via two custom properties.
//
// Dependencies:
//
//  AGS version required:  build for AGS 3.2.1, not sure if it works with older versions.
//
//  AGS setting required: You MUST creates two custom properties : sia_PropX and sia_PropY
//  that aplied to Objects, Characters and Hostpots, with a numeric default value of -1.
//  For each hotspot, you need to feed sia_PropX and sia_PropY with the room coordinates you want
//  the cursor to be drawn.
//
// Configuration:
//
//  Optional:
//
//    sia_HOTSPOT_LIMIT might be leave as it is or be adjust to your highest Hotspot number
//    to optimize (a very little bit) calculation time.
//
//    Two bools are available, sia_CheatEnable and sia_EnableHere to set up this module
//    as optional and to deactivate it in certain rooms or situations.
//
//    You can feed sia_PropX and sia_PropY with the room coordinates for (imobile) chracter and
//    object: cursor will be drawn at these positions in priority. If left to -1 (defalut value),
//    objects and characters coordinates will be automaticly determined.
//
//    Other customizations are possible by editing ShowInteractiveArea.asc directly.
//
// Caveats:
//
//  This module uses ONE overlay, which can perturb your game if you already use 20
//  of them at some point in your game (20 Overlays max display at a same time,
//  AGS limitation).
// 
//  Fragmented areas or weird shapes of objects / characters can lead to bad cursor
//  positionning.
//
// Revision history:
//  version 1.3: 2013/07/04
//      First release of SIA *alternative edition*.
// 
// Licence:
//
//  ShowInteractiveAreas AGS script module is publish under the terms of the
//  Do What The Fuck You Want To Public License, Version 2
//
// This program is free software. It comes without any warranty, to
// the extent permitted by applicable law. You can redistribute it
// and/or modify it under the terms of the Do What The Fuck You Want
// To Public License, Version 2, as published by Sam Hocevar. See
// http://sam.zoy.org/wtfpl/COPYING for more details.
//
// Thanks:
//
//  Pidem and Kitai
//
// Defines
#define sia_HOTSPOT_LIMIT  50
// Imports
import bool sia_CheatEnable, sia_EnableHere;

// ShowInteractiveAreas script

//General definitions

bool sia_CheatEnable = true; // Use this bool if you want to create an option to set this module optional.
bool sia_EnableHere = true; // Use this bool in situations or rooms you do not want this module to be active.

//When player hits SpaceBar
function on_key_press(eKeyCode keycode) {
  if (keycode == eKeySpace){//Change eKeySpace by the key you want to use.
    if (sia_CheatEnable && sia_EnableHere && !IsGamePaused ()) {
      PauseGame();
      DynamicSprite *siasprite = DynamicSprite.Create(System.ViewportWidth, System.ViewportHeight); // Technical stuff to create a drawing surface
      DrawingSurface *siasurface = siasprite.GetDrawingSurface();
      Hotspot *h;
      int index = 1; //Hotspot 0 is not a hotspot.
      while (index < sia_HOTSPOT_LIMIT) {
        h = hotspot[index];
        if (h.Enabled && h.GetProperty("sia_PropX") != -1 && h.GetProperty("sia_PropY") != -1) {
          //If an hotspot have non default coordinates, we draw a mouse cursor on it.
          //Alternatively, you can repalce
          //    Mouse.GetModeGraphic(eModeInteract)
          //by
          //    42
          //to use your favourite sprite number 42.
          siasurface.DrawImage(h.GetProperty("sia_PropX") - GetViewportX(), h.GetProperty("sia_PropY") - GetViewportY(), Mouse.GetModeGraphic(eModeInteract));
        }
        index++;
      }
      //Calclucalting Objects positions and drawing cursors.
      if (Room.ObjectCount > 0) {
        int siaObjectX,  siaObjectY;
        Object *o;
        index = 0;
        while (index < Room.ObjectCount) {
          o = object[index];
          if (o.Visible && o.Clickable) {
            if (o.GetProperty("sia_PropX") != -1 && o.GetProperty("sia_PropY") != -1) {
              siaObjectX = o.GetProperty("sia_PropX");
              siaObjectY = o.GetProperty("sia_PropY");
            } else {
              siaObjectX = o.X + Game.SpriteWidth[o.Graphic]/2;
              siaObjectY = o.Y - Game.SpriteHeight[o.Graphic]/2;
            }
            //If an object is Visible, we draw a mouse cursor on it.
            //Alternatively, you can repalce
            //    Mouse.GetModeGraphic(eModeInteract)
            //by
            //    42
            //to use your favourite sprite number 42.
            siasurface.DrawImage(siaObjectX - GetViewportX(), siaObjectY - GetViewportY(), Mouse.GetModeGraphic(eModeInteract));
          }
          index++;
        }
      }
      //Calclucalting Characters positions and drawing cursors.
      if (Game.CharacterCount > 0) {
        int siaCharacterX,  siaCharacterY;
        Character *c;
        index = 0;
        while (index < Game.CharacterCount) {
          c = character[index];
          if (c.Room == player.Room && c.Clickable) {
            if (c.GetProperty("sia_PropX") != -1 && c.GetProperty("sia_PropY") != -1) {
              siaCharacterX = c.GetProperty("sia_PropX");
              siaCharacterY = c.GetProperty("sia_PropY");
            } else {
              ViewFrame *siacharcatervf = Game.GetViewFrame(c.View, c.Loop, c.Frame);
              siaCharacterX = c.x;
              siaCharacterY = c.y - Game.SpriteHeight[siacharcatervf.Graphic]*c.Scaling/2*100;
            }
            //If a character is clickable, then we draw a mouse cursor on it
            //Alternatively, you can repalce
            //    Mouse.GetModeGraphic(eModeTalkto)
            //by
            //    42
            //to use your favourite sprite number 42.
            siasurface.DrawImage(siaCharacterX - GetViewportX(), siaCharacterY - GetViewportY(), Mouse.GetModeGraphic(eModeTalkto));
          }
          index++;
        }
      }
      siasurface.Release();  // Technical stuff to display the beautiful overlay we have drawn.
      Overlay *siaoverlay = Overlay.CreateGraphical(0, 0, siasprite.Graphic, true);
      while (IsKeyPressed(eKeySpace)) Wait(1); //While Key is pressed, overlay is display.
      siaoverlay.Remove(); //Cleaning a little bit behind us.
      siasprite.Delete();
      siaoverlay = null ;
      UnPauseGame();
    }
  }
}

export sia_CheatEnable, sia_EnableHere; //Do not forget to import these bools in global script header if you want to use them.