<?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_22";
<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_begin</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_begin"/>
<meta name="rh-index-keywords" content="buffer_async_group_begin"/>
<meta name="search-keywords" content="buffer_async_group_begin"/>
</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_begin">
<span>buffer_async_group_begin</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_begin</h1>
<p>This function is called when you want to begin the saving out of multiple buffers to multiple files. The "groupname" is a string and will be used as the directory name for where the files will be saved, and should be used as part of the file
path when loading the files back into the IDE later (using any of the <a href="buffer_load.htm"><tt>buffer_load()</tt></a> functions). This function is <i>only</i> for use with the <a href="buffer_save_async.htm"><tt>buffer_save_async()</tt></a> function
and you must also finish the save definition by calling <a href="buffer_async_group_end.htm"><tt>buffer_async_group_end()</tt></a> function otherwise the files will not be saved out.</p>
<p>Note that for the console platforms (like PS4 for example), the "groupname" will be used as the save slot description, and using this function can help you avoid having the UI show for every file that is being saved out. Also note that when
using UWP you can roam your save games between native XBox and Microsoft store windows by creating a group that is the same as an ERA Xbox group, for example:</p>
<p class="code">if os_type == os_uwp<br/> {
<br/> buffer_async_group_begin("root/yourgroupname");
<br/> }
<br/> else
<br/> {
<br/> buffer_async_group_begin("yourgroupname");
<br/> }
</p>
<p> </p>
<h4>Syntax:</h4>
<p class="code">buffer_async_group_begin(groupname);</p>
<table>
<tbody>
<tr>
<th>Argument</th>
<th>Description</th>
</tr>
<tr>
<td>groupname</td>
<td>The name of the group (as a string).</td>
</tr>
</tbody>
</table>
<p> </p>
<h4>Returns:</h4>
<p class="code">N/A</p>
<p> </p>
<h4>Example:</h4>
<p class="code">buffer_async_group_begin("SaveGame");<br/> save1 = buffer_save_async(buff1, "Player_Save1.sav", 0, 16384);<br/> save2 = buffer_save_async(buff2, "Player_Save2.sav", 0, 16384);<br/> save3 = buffer_save_async(buff3, "Player_Save3.sav",
0, 16384);<br/> save4 = buffer_save_async(buff4, "Player_Save4.sav", 0, 16384);<br/> buffer_async_group_end();
</p>
<p>The above code starts a buffer group then sets it to save out 4 files 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_option.htm">buffer_async_group_option</a></div>
</div>
</div>
<h5>© Copyright YoYo Games Ltd. 2020 All Rights Reserved</h5>
</div>
</body></html>