/** @noSelfInFile */

import { Handle } from "./handle";
import { Rectangle } from "./rect";

export class WeatherEffect extends Handle<weathereffect> {
  /** @deprecated use `WeatherEffect.create` instead. */
  constructor(where: Rectangle, effectID: number) {
    if (Handle.initFromHandle()) {
      super();
      return;
    }
    const handle = AddWeatherEffect(where.handle, effectID);
    if (handle === undefined) {
      Error("w3ts failed to create unit handle.");
    }
    super(handle);
  }

  /**
   * Adds a weather effect.
   * @param where The rect to apply the WeatherEffect to.
   * @param effectID Which effect to apply.
   * @note To understand more about weather effects nature, I advise to read
   * Ammorth's article about weather effects: [http://www.wc3c.net/showthread.php?t=91176](https://web.archive.org/web/20180130202056/http://www.wc3c.net/showthread.php?t=91176).
   * @note To get an idea on how to add your own weather effects, you may read
   * CryoniC's article about custom weather effects: [http://www.wc3c.net/showthread.php?t=67949](https://web.archive.org/web/20180507060112/http://www.wc3c.net/showthread.php?t=67949).
   */
  public static create(where: Rectangle, effectID: number): WeatherEffect | undefined {
    const handle = AddWeatherEffect(where.handle, effectID);
    if (handle !== undefined) {
      const obj = this.getObject(handle) as WeatherEffect;

      const values: Record<string, unknown> = {};
      values.handle = handle;

      return Object.assign(obj, values);
    }
    return undefined;
  }

  public destroy() {
    RemoveWeatherEffect(this.handle);
  }

  public enable(flag: boolean) {
    EnableWeatherEffect(this.handle, flag);
  }

  public static fromHandle(handle: weathereffect): WeatherEffect {
    return this.getObject(handle);
  }
}