<?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.17.0_23";
<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>buffer_async_group_option</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 buffer_async_group_option"/>
<meta name="rh-index-keywords" content="buffer_async_group_option"/>
<meta name="search-keywords" content="buffer_async_group_option"/>
</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="buffer_async_group_option">
<span>buffer_async_group_option</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>buffer_async_group_option</h1>
<p>With this function you can set some platform specific options for the buffer group being saved. The options available are as follows:</p>
<ul class="colour">
<li>"<b>subtitle</b>" or "<b>slottitle</b>" - The value for this option would be a string, which will be shown to the user when managing their save data in the OS. This is only important when saving data, not when loading again.</li>
<li>"<b>showdialog</b>" - The value for this option is a boolean <tt>true</tt> or <tt>false</tt>. If set to <tt>true</tt>, when you save <i>or</i> load GameMaker Studio 2 will show the System UI, otherwise it will do a quicksave/quickload
with no UI shown. You normally only need this if you're supporting multiple save slots to allow the user to pick a slot, but if you just support one slot per user, set this to <tt>false</tt>.</li>
<li>"<b>savepadindex</b>" - For this option you would specify the <i>pad index</i> of the player who is saving <i>or</i> loading and the system will write data to and read data from this player's save folder.</li>
<li>"<b>saveslotsize</b>" - This option requires that you specify the actual size in bytes you want to save (so you can do a <a href="buffer_seek.htm"><tt>buffer_seek()</tt></a> and <a href="buffer_tell.htm"><tt>buffer_tell()</tt></a> to get
that, for example). Note that it is not obligatory to supply this value as all saves are pre-assigned a minimum space, which is normally about 10MB or so.</li>
</ul>
<p class="note"><b>IMPORTANT!</b> This function is currently only valid for the PSVita, PS4 and XBox One target modules. On all the other targets it will do nothing.</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">buffer_async_group_option(option, value);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>option</td>
<td>The option to set.</td>
</tr>
<tr>
<td>value</td>
<td>The value to set (can be string or real, depending on the option).</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p>N/A</p>
<p> </p>
<h4>Example:</h4>
<p class="code">buffer_async_group_begin("save_folder_name");<br/> buffer_async_group_option("showdialog", false);<br/> buffer_async_group_option("slottitle", "Catch The Haggis Save");<br/> buffer_async_group_option("subtitle",
"All your haggis are saved here!");<br/> save = buffer_save_async(buff, "Player_Save.sav", 0, 16384);<br/> buffer_async_group_end();
</p>
<p>The above code starts a buffer group then sets the group options before it sets 4 files to save asynchronously. The group definition is then ended (at which point saving will begin).</p>
<p> </p>
<p> </p>
<p> </p>
<div class="footer">
<div class="buttons">
<div class="clear">
<div style="float:left">Back: <a href="Buffers.htm">Buffers</a></div>
<div style="float:right">Next: <a href="buffer_async_group_end.htm">buffer_async_group_end</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>