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.20.0_10";
  
//]]></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>show_debug_message</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="Reference page for show_debug_message"/>
  <meta name="rh-index-keywords" content="show_debug_message"/>
  <meta name="search-keywords" content="show_debug_message"/>
</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="show_debug_message">
        <span>show_debug_message</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>show_debug_message</h1>
  <p>This function will create a custom debug message that is shown in the compiler window at runtime. Note that the message can be <i>either</i> a string or a real number, but if you need both then the number will have to be converted to string first using
    the <a href="../Strings/Strings.htm"><tt>string()</tt></a> function (see the example below) and that if the number has more than two decimal places then you should use <a href="../Strings/string_format.htm"><tt>string_format()</tt></a> to show them
    as by default decimals are rounded to the nearest two decimal places (so &quot;1.2468&quot; would show as &quot;1.25&quot; in the output window).</p>
  <p>Debug messages shown with this function will be shown in the <a href="../../../Introduction/The_Output_Window.htm">Compiler Output Window</a> at the bottom of the IDE as well as in the <a href="../../../IDE_Tools/The_Debugger.htm">Graph View</a> of
    the debugger when running the game in Debug Mode. If you only want to see messages in Debug Mode then you should probably be using <a href="debug_event.htm"><tt>debug_event()</tt></a> instead.</p>
  <p> </p>
  <h4>Syntax:</h4>
  <p class="code">show_debug_message(string);</p>
  <table>
    <tbody>
      <tr>
        <th>Argument</th>
        <th>Description</th>
      </tr>
      <tr>
        <td>string</td>
        <td>The custom debug message to show.</td>
      </tr>
    </tbody>
  </table>
  <p> </p>
  <h4>Returns:</h4>
  <p class="code">N/A</p>
  <p> </p>
  <h4><b>Example:</b></h4>
  <p class="code">if !instance_exists(obj_Exit)<br/>    {
    <br/>    show_debug_message(&quot;Exit not created!&quot;);<br/>    show_debug_message(&quot;Error Num: &quot; + string(global.error));<br/>    game_end();
    <br/>    }
  </p>
  <p>The above code checks to see if an instance exists and if it does not, a debug message is shown in the compile window and the game is ended.</p>
  <p> </p>
  <p> </p>
  <p> </p>
  <div class="footer">
    <div class="buttons">
      <div class="clear">
        <div style="float:left">Back: <a href="Debugging.htm">Debugging</a></div>
        <div style="float:right">Next: <a href="show_debug_overlay.htm">show_debug_overlay</a></div>
      </div>
    </div>
    <h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
  </div>
  <!-- KEYWORDS
show_debug_message
-->
  <!-- TAGS
show_debug_message
-->

</body></html>