gm-docs-parser 1.0.0

A collection of typings for GameMaker Studio 2 manual pages
Documentation
<?xml version="1.0" encoding="utf-8" ?>

<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head>

  <script type="text/javascript" language="JavaScript">
    //<![CDATA[
    function reDo() {
      if (innerWidth != origWidth || innerHeight != origHeight)
        location.reload();
    }
    if ((parseInt(navigator.appVersion) == 4) && (navigator.appName == "Netscape")) {
      origWidth = innerWidth;
      origHeight = innerHeight;
      onresize = reDo;
    }
    onerror = null;
  //]]>
  </script>
  <style type="text/css">/*<![CDATA[*/

    < !-- div.WebHelpPopupMenu {
      position: absolute;
      left: 0px;
      top: 0px;
      z-index: 4;
      visibility: hidden;
    }

    p.WebHelpNavBar {
      text-align: right;
    }

    -->
  
/*]]>*/</style>

  <script type="text/javascript">//<![CDATA[

    gRootRelPath = "../../..";
    gCommonRootRelPath = "../../..";
    gTopicId = "9.2.1.0_17";
  
//]]></script>

  <script type="text/javascript" src="../../../template/scripts/rh.min.js"></script>
  <script type="text/javascript" src="../../../template/scripts/common.min.js"></script>
  <script type="text/javascript" src="../../../template/scripts/topic.min.js"></script>
  <script type="text/javascript" src="../../../template/scripts/topicwidgets.min.js"></script>
<script type="text/javascript" src="../../../whxdata/projectsettings.js"></script>
  <link rel="stylesheet" type="text/css" href="../../../template/styles/topic.min.css"/>
  <link rel="stylesheet" type="text/css" href="../../../template/Charcoal_Grey/topicheader.css"/>
  <meta name="topic-status" content="Draft"/>

  <meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
  <title>array_equals</title>
  <meta name="generator" content="Adobe RoboHelp 2019"/>
  <link rel="stylesheet" href="../../../assets/css/default.css" type="text/css"/>
  <meta name="rh-authors" content="Mark Alexander"/>
  <meta name="topic-comment" content="Page explaining the function array_equals"/>
  <meta name="rh-index-keywords" content="array_equals"/>
  <meta name="search-keywords" content="array_equals"/>
</head>

<body>
  <div class="topic-header rh-hide" id="rh-topic-header" onclick="rh._.goToFullLayout()">
    <div class="logo">
    </div>
    <div class="nav">
      <div class="title" title="array_equals">
        <span>array_equals</span>
      </div>
      <div class="gotohome" title="Click here to see this page in full context">
        <span>Click here to see this page in full context</span>
      </div>
    </div>
  </div>
  <div class="topic-header-shadow rh-hide" id="rh-topic-header-shadow"></div>



  <!--<div class="body-scroll" style="top: 150px;">-->
  <h1>array_equals</h1>
  <p>With this function you can check to see if two arrays are equal (equivalent or the same). You give the two arrays to check, and the function will return <tt>true</tt> if they are equal (either equivalent or the same) or <tt>false</tt> if
    they are not. Note that this is <i>not</i> the same as checking if two arrays are the same using ==, which will not check to see if the two arrays hold equivalent values, but only to see if the arrays are referencing the
    same initial array. For example:</p>
  <p class="code">var a = [1,2,3,4];<br/> var b = [1,2,3,4];<br/> if (a == b)<br/>    {
    <br/>    show_debug_message( &quot;This will never fire, as a and b do not reference the SAME array&quot; );<br/>    }
    <br/> if (array_equals(a, b))<br/>    {
    <br/>    show_debug_message( &quot;This will fire now&quot; );<br/>    }
  </p>
  <p> </p>
  <h4>Syntax:</h4>
  <p class="code">array_equals(var1, var2);</p>
  
    <table>
      <tbody>
        <tr>
          <th>Argument</th>
          <th>Description</th>
        </tr>
        <tr>
          <td>var1</td>
          <td>The index of the first array.</td>
        </tr>
        <tr>
          <td>var2</td>
          <td>The index of the second array.</td>
        </tr>
      </tbody>
    </table>
  
  <p> </p>
  <h4>Returns:</h4>
  <p class="code">Boolean</p>
  <p> </p>
  <h4>Example:</h4>
  <p class="code">if !array_equals(inventory_array, item_array)<br/>    {
    <br/>    var len = array_length(inventory_array);<br/>    array_copy(item_array, 0, inventory_array, 0, len);<br/>    }
  </p>
  <p>The above code will check two arrays to see if they hold equivalent values, and if they do not then the code will copy the entire contents of the array &quot;inventory_array&quot; to the array &quot;item_array&quot;.</p>
  <p> </p>
  <p> </p>
  <p> </p>
  <div class="footer">
    <div class="buttons">
      <div class="clear">
        <div style="float:left">Back: <a href="Variable_Functions.htm">Variable Functions</a></div>
        <div style="float:right">Next: <a href="array_get.htm">array_get</a></div>
      </div>
    </div>
    <h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
  </div>
  <!-- KEYWORDS
array_equals
-->
  <!-- TAGS
array_equals
-->

</body></html>