#region Namespaces
using System;
#endregion

namespace ScriptCode {
    /// <summary>
    /// Indicator scripts are used for calculating a series of numerical values.
    /// 
    /// This script can be used in several ways:
    /// (1) It can be used on a chart.
    /// (2) It can be used from another script.
    /// (3) It can be used as a script column in a watchlist.
    /// </summary>
    public partial class MyIndicator : IndicatorScriptBase // NEVER CHANGE THE CLASS NAME
    {
#region Variables
        // Use for the underlying symbol index on which to calculate the indicator script.
        private int _symbolIndex;
        // Use for the minimum tick size.
        private double _MTV;
#endregion

#region OnInitialize
        /// <summary>
        /// This function accepts the user parameters for the script and is called when a new indicator instance is created. 
        /// One of the parameters accepted by it must be that of a symbol or another script that is
        /// based on a symbol (drawing, indicator, pattern or signal). This symbol will be used as the underlying symbol for the indicator.
        /// 
        /// The parameter values can be specified from the user interface (UI) or from another script, depending on usage.
        /// </summary>
        /// --------------------------------------------------------------------------------------------------
        ///                                 INSTRUCTIONS - PLEASE READ CAREFULLY
        /// --------------------------------------------------------------------------------------------------
        /// YOU MUST SET A PARAM TAG FOR EACH PARAMETER ACCEPTED BY THIS FUNCTION.
        /// ALL PARAM TAGS SHOULD BE SET IN THE 'OnInitialize' REGION, RIGHT ABOVE THE 'OnInitialize' FUNCTION.
        /// THE ORDER OF THE TAGS MUST MATCH THE ORDER OF THE ACTUAL PARAMETERS.

        /// REQUIRED ATTRIBUTES:
        /// (1) name: The exact parameter name.
        /// (2) type: The type of data to collect from the user: 
        /// Set to "Integer" when the data type is 'int'
        /// Set to "IntegerArray" when the data type is 'int[]'
        /// Set to "DateTime" when the data type is 'long' (The 'long' data type can only be used for date/time representation)
        /// Set to "DateTimeArray" when the data type is 'long[]' (The 'long' data type can only be used for date/time representation)
        /// Set to "Boolean" when the data type is 'bool'
        /// Set to "BooleanArray" when the data type is 'bool[]'
        /// Set to "Double" when the data type is 'double'
        /// Set to "DoubleArray" when the data type is 'double[]'
        /// Set to "String" when the data type is 'string'
        /// Set to "StringArray" when the data type is 'string[]'
        /// Set to "Indicator" when the data type is 'Indicator'
        /// Set to "Pattern" when the data type is 'Pattern'
        /// Set to "Signal" when the data type is 'Signal'
        /// Set to "Drawing" when the data type is 'Drawing'
        /// Set to "Symbol" when the data type is 'int' representing a symbol index.

        /// OPTIONAL ATTRIBUTES:
        /// (3) default: The default parameter value is only valid when the type is Integer, Boolean, Double or String. 
        /// (4) min: The minimum parameter value is only valid when the type is Integer or Double.
        /// (5) max: The maximum parameter value is only valid when the type is Integer or Double.

        /// EXAMPLE: <param name="" type="" default="" min="" max="">Enter the parameter description here.</param> 
        /// --------------------------------------------------------------------------------------------------
        /// <param name="symbolIndex" type="Symbol">Use for the underlying symbol index on which to calculate the indicator script.</param>
        public void OnInitialize(
            int symbolIndex) {
            // Set the symbol index.
            _symbolIndex = symbolIndex;
            // Set the MTV value.
            _MTV = SymbolTick(symbolIndex);
        }
#endregion

#region OnValue
        /// <summary>
        /// This function is used for calculating the indicator value for the latest bar (see the Indicator functions).
        /// </summary>
        /// <returns>The indicator value for the latest bar.</returns>
        public override double OnValue() {
            // Check whether the two consecutive closing prices have moved more than one tick.
            if (BarClose(_symbolIndex, 0) - BarClose(_symbolIndex, 1) > _MTV)
                return this[1] + BarVolume(_symbolIndex, 0);
            else
                return this[1] - BarVolume(_symbolIndex, 0);
        }
#endregion

#region OnRegisterPens
        /// <summary>
        /// This function is used for registering the indicator pens (see the IndicatorRegisterPen function).
        /// </summary>
        public override void OnRegisterPens() {
            // Register a pen.
            IndicatorRegisterPen(0, "Pen", IQ_Color.MIDNIGHT_BLUE, IQ_DashStyle.SOLID, 1);
        }
#endregion

#region OnSelectPen
        /// <summary>
        /// This function is used for selecting a registered indicator pen with which to color the latest indicator value.
        /// Call the IndicatorRegisterPen function from the OnRegisterPens function in order to register an indicator pen.
        /// </summary>
        /// <returns>The indicator pen index to use for coloring the latest indicator value.</returns>
        public override byte OnSelectPen() {
            // Color the indicator value with the zero pen.
            return 0;
        }
#endregion
    }
}