<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE html>
<html xmlns="http://www.w3.org/1999/xhtml"><head>
<script type="text/javascript" language="JavaScript">
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">
< !-- div.WebHelpPopupMenu {
position: absolute;
left: 0px;
top: 0px;
z-index: 4;
visibility: hidden;
}
p.WebHelpNavBar {
text-align: right;
}
-->
</style>
<script type="text/javascript">
gRootRelPath = "../../..";
gCommonRootRelPath = "../../..";
gTopicId = "9.2.3.0_5";
<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>game_end</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="This page outlines the function game_end"/>
<meta name="rh-index-keywords" content="game_end"/>
<meta name="search-keywords" content="game_end"/>
</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="game_end">
<span>game_end</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>
<h1>game_end</h1>
<p>With this function you can end the game (and the <a href="../../../The_Asset_Editors/Object_Properties/Other_Events.htm">Game End Event</a> will be triggered). This will not happen instantaneously, but rather at the end of the current step, so any code
you have in the same step after this function has been called will still run. Please note that this function has the following restrictions:</p>
<ul class="colour">
<li>On Android (and Amazon Fire) devices, calling <tt>game_end()</tt> will push the app into the background, but it will <i>not</i> close the app. This must be done by the user.</li>
<li>On iOS it will do nothing and silently fail.</li>
<li>On UWP, XBoxOne, PS4 and Nintendo Switch it may crash the game (or at least fail silently) and so <i>must not be used</i>.</li>
<li>On HTML5 it will end the game, but leave the user staring at a blank draw canvas on the web page, and as such it isn't recommended that it be used on that target platform.</li>
<li>On Windows, Linux and Mac the function simply ends the game and closes the game window ( a <a href="../../../The_Asset_Editors/Object_Properties/Other_Events.htm">Game End Event</a> will be triggered).</li>
<br/>
</ul>
<p> </p>
<h4>Syntax:</h4>
<p class="code">game_end();</p>
<p> </p>
<h4>Returns:</h4>
<p class="code">N/A</p>
<p> </p>
<h4>Example:</h4>
<p class="code">if keyboard_check_pressed(vk_escape) game_end();</p>
<p>This would end the game if the player presses the "escape" key.</p>
<p> </p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="General_Game_Control.htm">General Game Control</a></div>
<div style="float:right">Next: <a href="game_restart.htm">game_restart</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>