You cannot select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
1166 lines
56 KiB
HTML
1166 lines
56 KiB
HTML
2 years ago
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
|
||
|
|
<html xmlns="http://www.w3.org/1999/xhtml">
|
||
|
|
<head>
|
||
|
|
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
|
||
|
|
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
|
||
|
|
<meta name="generator" content="Doxygen 1.8.5"/>
|
||
|
|
<title>Otter: Otter.DataSaver Class Reference</title>
|
||
|
|
<link href="tabs.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="jquery.js"></script>
|
||
|
|
<script type="text/javascript" src="dynsections.js"></script>
|
||
|
|
<link href="navtree.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="resize.js"></script>
|
||
|
|
<script type="text/javascript" src="navtree.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(initResizable);
|
||
|
|
$(window).load(resizeHeight);
|
||
|
|
</script>
|
||
|
|
<link href="search/search.css" rel="stylesheet" type="text/css"/>
|
||
|
|
<script type="text/javascript" src="search/search.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function() { searchBox.OnSelectItem(0); });
|
||
|
|
</script>
|
||
|
|
<link href="doxygen.css" rel="stylesheet" type="text/css" />
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
|
||
|
|
<div id="titlearea">
|
||
|
|
<table cellspacing="0" cellpadding="0">
|
||
|
|
<tbody>
|
||
|
|
<tr style="height: 56px;">
|
||
|
|
<td id="projectlogo"><img alt="Logo" src="otterlogosmall.png"/></td>
|
||
|
|
<td style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">Otter
|
||
|
|
 <span id="projectnumber">0.9.8.91</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">2d Game Development Framework based on SFML.Net</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.8.5 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search');
|
||
|
|
</script>
|
||
|
|
<div id="navrow1" class="tabs">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="index.html"><span>Main Page</span></a></li>
|
||
|
|
<li><a href="namespaces.html"><span>Packages</span></a></li>
|
||
|
|
<li class="current"><a href="annotated.html"><span>Classes</span></a></li>
|
||
|
|
<li>
|
||
|
|
<div id="MSearchBox" class="MSearchBoxInactive">
|
||
|
|
<span class="left">
|
||
|
|
<img id="MSearchSelect" src="search/mag_sel.png"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
alt=""/>
|
||
|
|
<input type="text" id="MSearchField" value="Search" accesskey="S"
|
||
|
|
onfocus="searchBox.OnSearchFieldFocus(true)"
|
||
|
|
onblur="searchBox.OnSearchFieldFocus(false)"
|
||
|
|
onkeyup="searchBox.OnSearchFieldChange(event)"/>
|
||
|
|
</span><span class="right">
|
||
|
|
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
|
||
|
|
</span>
|
||
|
|
</div>
|
||
|
|
</li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
<div id="navrow2" class="tabs2">
|
||
|
|
<ul class="tablist">
|
||
|
|
<li><a href="annotated.html"><span>Class List</span></a></li>
|
||
|
|
<li><a href="classes.html"><span>Class Index</span></a></li>
|
||
|
|
<li><a href="hierarchy.html"><span>Class Hierarchy</span></a></li>
|
||
|
|
<li><a href="functions.html"><span>Class Members</span></a></li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
||
|
|
<div id="nav-tree">
|
||
|
|
<div id="nav-tree-contents">
|
||
|
|
<div id="nav-sync" class="sync"></div>
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
||
|
|
class="ui-resizable-handle">
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<script type="text/javascript">
|
||
|
|
$(document).ready(function(){initNavTree('class_otter_1_1_data_saver.html','');});
|
||
|
|
</script>
|
||
|
|
<div id="doc-content">
|
||
|
|
<!-- window showing the filter options -->
|
||
|
|
<div id="MSearchSelectWindow"
|
||
|
|
onmouseover="return searchBox.OnSearchSelectShow()"
|
||
|
|
onmouseout="return searchBox.OnSearchSelectHide()"
|
||
|
|
onkeydown="return searchBox.OnSearchSelectKey(event)">
|
||
|
|
<a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(0)"><span class="SelectionMark"> </span>All</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(1)"><span class="SelectionMark"> </span>Classes</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(2)"><span class="SelectionMark"> </span>Namespaces</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(3)"><span class="SelectionMark"> </span>Functions</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(4)"><span class="SelectionMark"> </span>Variables</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(5)"><span class="SelectionMark"> </span>Enumerations</a><a class="SelectItem" href="javascript:void(0)" onclick="searchBox.OnSelectItem(6)"><span class="SelectionMark"> </span>Properties</a></div>
|
||
|
|
|
||
|
|
<!-- iframe showing the search results (closed by default) -->
|
||
|
|
<div id="MSearchResultsWindow">
|
||
|
|
<iframe src="javascript:void(0)" frameborder="0"
|
||
|
|
name="MSearchResults" id="MSearchResults">
|
||
|
|
</iframe>
|
||
|
|
</div>
|
||
|
|
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#pub-types">Public Types</a> |
|
||
|
|
<a href="#pub-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
||
|
|
<a href="#properties">Properties</a> |
|
||
|
|
<a href="class_otter_1_1_data_saver-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Otter.DataSaver Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class that is used for storing strings, ints, floats, or bools with keys of enum or string. The saver can output data in an semi-encrypted format, and also an editable config file format.
|
||
|
|
<a href="class_otter_1_1_data_saver.html#details">More...</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-types"></a>
|
||
|
|
Public Types</h2></td></tr>
|
||
|
|
<tr class="memitem:ae50a827d69d1e640a45a5f87b485e6ff"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#ae50a827d69d1e640a45a5f87b485e6ff">DataExportMode</a> { <b>Data</b>,
|
||
|
|
<b>Config</b>
|
||
|
|
}</td></tr>
|
||
|
|
<tr class="memdesc:ae50a827d69d1e640a45a5f87b485e6ff"><td class="mdescLeft"> </td><td class="mdescRight">The export modes for the data. <a href="class_otter_1_1_data_saver.html#ae50a827d69d1e640a45a5f87b485e6ff">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ae50a827d69d1e640a45a5f87b485e6ff"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-methods"></a>
|
||
|
|
Public Member Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:aea8f69088e405dcf64e7b37654621375"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#aea8f69088e405dcf64e7b37654621375">DataSaver</a> (string defaultPath="")</td></tr>
|
||
|
|
<tr class="memdesc:aea8f69088e405dcf64e7b37654621375"><td class="mdescLeft"> </td><td class="mdescRight">Initializes a new instance of the <a class="el" href="class_otter_1_1_data_saver.html" title="Class that is used for storing strings, ints, floats, or bools with keys of enum or string...">DataSaver</a> class. <a href="#aea8f69088e405dcf64e7b37654621375">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aea8f69088e405dcf64e7b37654621375"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a8b77b81f689c23c23ab199ec84e0fde9"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a8b77b81f689c23c23ab199ec84e0fde9">Verify</a> (string stringData)</td></tr>
|
||
|
|
<tr class="memdesc:a8b77b81f689c23c23ab199ec84e0fde9"><td class="mdescLeft"> </td><td class="mdescRight">Verifies the specified string data. Only applies to DataExportMode.Data. <a href="#a8b77b81f689c23c23ab199ec84e0fde9">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a8b77b81f689c23c23ab199ec84e0fde9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5c40ceb78a377b7875167e6411feb0d3"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a5c40ceb78a377b7875167e6411feb0d3">ClearFile</a> (string filename="")</td></tr>
|
||
|
|
<tr class="memdesc:a5c40ceb78a377b7875167e6411feb0d3"><td class="mdescLeft"> </td><td class="mdescRight">Deletes the exported file for this save data. <a href="#a5c40ceb78a377b7875167e6411feb0d3">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5c40ceb78a377b7875167e6411feb0d3"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a49e6d43a67efd8955035d77243b971f2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a49e6d43a67efd8955035d77243b971f2">Clear</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a49e6d43a67efd8955035d77243b971f2"><td class="mdescLeft"> </td><td class="mdescRight">Clears the data. <a href="#a49e6d43a67efd8955035d77243b971f2">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a49e6d43a67efd8955035d77243b971f2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6fed90808d1015e2f0790a076a1c3a98"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a6fed90808d1015e2f0790a076a1c3a98">FileExists</a> (string filename="")</td></tr>
|
||
|
|
<tr class="memdesc:a6fed90808d1015e2f0790a076a1c3a98"><td class="mdescLeft"> </td><td class="mdescRight">Check if an exported file exists for this data. <a href="#a6fed90808d1015e2f0790a076a1c3a98">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6fed90808d1015e2f0790a076a1c3a98"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3810e74568549c43a234bceae3211900"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a3810e74568549c43a234bceae3211900">Import</a> (string filename="", bool verify=true)</td></tr>
|
||
|
|
<tr class="memdesc:a3810e74568549c43a234bceae3211900"><td class="mdescLeft"> </td><td class="mdescRight">Imports the data in the specified file. <a href="#a3810e74568549c43a234bceae3211900">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3810e74568549c43a234bceae3211900"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a38f3bc92779c76b6efd5231164a25b1d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a38f3bc92779c76b6efd5231164a25b1d">Export</a> (string filename="")</td></tr>
|
||
|
|
<tr class="memdesc:a38f3bc92779c76b6efd5231164a25b1d"><td class="mdescLeft"> </td><td class="mdescRight">Exports the data to the specified file. <a href="#a38f3bc92779c76b6efd5231164a25b1d">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a38f3bc92779c76b6efd5231164a25b1d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a980bb063dd4721d2a7222088f5def80c"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a980bb063dd4721d2a7222088f5def80c">GetFloat</a> (string key)</td></tr>
|
||
|
|
<tr class="memdesc:a980bb063dd4721d2a7222088f5def80c"><td class="mdescLeft"> </td><td class="mdescRight">Gets a float from the data. <a href="#a980bb063dd4721d2a7222088f5def80c">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a980bb063dd4721d2a7222088f5def80c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a31a1d65c7d76bb13696e93e60ab60f95"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a31a1d65c7d76bb13696e93e60ab60f95">GetFloat</a> (Enum key)</td></tr>
|
||
|
|
<tr class="memdesc:a31a1d65c7d76bb13696e93e60ab60f95"><td class="mdescLeft"> </td><td class="mdescRight">Gets a float from the data. <a href="#a31a1d65c7d76bb13696e93e60ab60f95">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a31a1d65c7d76bb13696e93e60ab60f95"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a12a412514ed22452fd2b4e0e55be1c99"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a12a412514ed22452fd2b4e0e55be1c99">GetFloatOrDefault</a> (string key, float defaultIfNotFound=default(float))</td></tr>
|
||
|
|
<tr class="memdesc:a12a412514ed22452fd2b4e0e55be1c99"><td class="mdescLeft"> </td><td class="mdescRight">Gets a float or a default float value. <a href="#a12a412514ed22452fd2b4e0e55be1c99">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a12a412514ed22452fd2b4e0e55be1c99"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:afaec0c0b4092b8b877c9abf06edc6c3f"><td class="memItemLeft" align="right" valign="top">float </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#afaec0c0b4092b8b877c9abf06edc6c3f">GetFloatOrDefault</a> (Enum key, float defaultIfNotFound=default(float))</td></tr>
|
||
|
|
<tr class="memdesc:afaec0c0b4092b8b877c9abf06edc6c3f"><td class="mdescLeft"> </td><td class="mdescRight">Gets a float or a default float value. <a href="#afaec0c0b4092b8b877c9abf06edc6c3f">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:afaec0c0b4092b8b877c9abf06edc6c3f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6777d9dae3d6d7ac26698fdb6ecc4b89"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a6777d9dae3d6d7ac26698fdb6ecc4b89">GetInt</a> (string key)</td></tr>
|
||
|
|
<tr class="memdesc:a6777d9dae3d6d7ac26698fdb6ecc4b89"><td class="mdescLeft"> </td><td class="mdescRight">Gets an int from the data. <a href="#a6777d9dae3d6d7ac26698fdb6ecc4b89">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6777d9dae3d6d7ac26698fdb6ecc4b89"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4ba7cf0db8e96b5b04e8fa522d526ddc"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a4ba7cf0db8e96b5b04e8fa522d526ddc">GetInt</a> (Enum key)</td></tr>
|
||
|
|
<tr class="memdesc:a4ba7cf0db8e96b5b04e8fa522d526ddc"><td class="mdescLeft"> </td><td class="mdescRight">Gets an int from the data. <a href="#a4ba7cf0db8e96b5b04e8fa522d526ddc">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a4ba7cf0db8e96b5b04e8fa522d526ddc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a93f50511ff7c54828be4be0fb7cc2d14"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a93f50511ff7c54828be4be0fb7cc2d14">GetIntOrDefault</a> (string key, int defaultIfNotFound=default(int))</td></tr>
|
||
|
|
<tr class="memdesc:a93f50511ff7c54828be4be0fb7cc2d14"><td class="mdescLeft"> </td><td class="mdescRight">Gets an int or a default int value. <a href="#a93f50511ff7c54828be4be0fb7cc2d14">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a93f50511ff7c54828be4be0fb7cc2d14"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4ce77267dd3b4c0c149ca72c1e064d8c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a4ce77267dd3b4c0c149ca72c1e064d8c">GetIntOrDefault</a> (Enum key, int defaultIfNotFound=default(int))</td></tr>
|
||
|
|
<tr class="memdesc:a4ce77267dd3b4c0c149ca72c1e064d8c"><td class="mdescLeft"> </td><td class="mdescRight">Gets an int or a default int value. <a href="#a4ce77267dd3b4c0c149ca72c1e064d8c">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a4ce77267dd3b4c0c149ca72c1e064d8c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a027b15358da2042824b30d65877dedaf"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a027b15358da2042824b30d65877dedaf">GetString</a> (string key)</td></tr>
|
||
|
|
<tr class="memdesc:a027b15358da2042824b30d65877dedaf"><td class="mdescLeft"> </td><td class="mdescRight">Gets a string from the data. <a href="#a027b15358da2042824b30d65877dedaf">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a027b15358da2042824b30d65877dedaf"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aabaa64df23c61b93076c120a671283be"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#aabaa64df23c61b93076c120a671283be">GetString</a> (Enum key)</td></tr>
|
||
|
|
<tr class="memdesc:aabaa64df23c61b93076c120a671283be"><td class="mdescLeft"> </td><td class="mdescRight">Gets a string from the data. <a href="#aabaa64df23c61b93076c120a671283be">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aabaa64df23c61b93076c120a671283be"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9c81255178b52b3a83f885116717b1fc"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a9c81255178b52b3a83f885116717b1fc">GetStringOrDefault</a> (string key, string defaultIfNotFound=default(string))</td></tr>
|
||
|
|
<tr class="memdesc:a9c81255178b52b3a83f885116717b1fc"><td class="mdescLeft"> </td><td class="mdescRight">Gets a string or a default string value. <a href="#a9c81255178b52b3a83f885116717b1fc">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a9c81255178b52b3a83f885116717b1fc"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad7e25c4ef504e6911d2d4d85684c6f37"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#ad7e25c4ef504e6911d2d4d85684c6f37">GetStringOrDefault</a> (Enum key, string defaultIfNotFound=default(string))</td></tr>
|
||
|
|
<tr class="memdesc:ad7e25c4ef504e6911d2d4d85684c6f37"><td class="mdescLeft"> </td><td class="mdescRight">Gets a string or a default string value. <a href="#ad7e25c4ef504e6911d2d4d85684c6f37">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ad7e25c4ef504e6911d2d4d85684c6f37"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4e1d7c5065d1597b9c636bd4e3757b34"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a4e1d7c5065d1597b9c636bd4e3757b34">GetBool</a> (string key)</td></tr>
|
||
|
|
<tr class="memdesc:a4e1d7c5065d1597b9c636bd4e3757b34"><td class="mdescLeft"> </td><td class="mdescRight">Gets a bool from the data. <a href="#a4e1d7c5065d1597b9c636bd4e3757b34">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a4e1d7c5065d1597b9c636bd4e3757b34"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4fc5ea0de3a323483cb824ff9f21c01a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a4fc5ea0de3a323483cb824ff9f21c01a">GetBool</a> (Enum key)</td></tr>
|
||
|
|
<tr class="memdesc:a4fc5ea0de3a323483cb824ff9f21c01a"><td class="mdescLeft"> </td><td class="mdescRight">Gets a bool from the data. <a href="#a4fc5ea0de3a323483cb824ff9f21c01a">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a4fc5ea0de3a323483cb824ff9f21c01a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aea17714a67961126af203e58ab207b22"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#aea17714a67961126af203e58ab207b22">GetBoolOrDefault</a> (string key, bool defaultIfNotFound=default(bool))</td></tr>
|
||
|
|
<tr class="memdesc:aea17714a67961126af203e58ab207b22"><td class="mdescLeft"> </td><td class="mdescRight">Gets a bool or a default bool value. <a href="#aea17714a67961126af203e58ab207b22">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aea17714a67961126af203e58ab207b22"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aed994eca853802675679afeef1343463"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#aed994eca853802675679afeef1343463">GetBoolOrDefault</a> (Enum key, bool defaultIfNotFound=default(bool))</td></tr>
|
||
|
|
<tr class="memdesc:aed994eca853802675679afeef1343463"><td class="mdescLeft"> </td><td class="mdescRight">Gets a bool or a default bool value. <a href="#aed994eca853802675679afeef1343463">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aed994eca853802675679afeef1343463"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a26485302d6fe0950d87753aa2c76a5e2"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a26485302d6fe0950d87753aa2c76a5e2">SetData</a> (string key, object obj)</td></tr>
|
||
|
|
<tr class="memdesc:a26485302d6fe0950d87753aa2c76a5e2"><td class="mdescLeft"> </td><td class="mdescRight">Sets the data. <a href="#a26485302d6fe0950d87753aa2c76a5e2">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a26485302d6fe0950d87753aa2c76a5e2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a07fb46fe53d192155e526900b7ce8f4e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a07fb46fe53d192155e526900b7ce8f4e">SetData</a> (Enum key, object obj)</td></tr>
|
||
|
|
<tr class="memdesc:a07fb46fe53d192155e526900b7ce8f4e"><td class="mdescLeft"> </td><td class="mdescRight">Sets the data. <a href="#a07fb46fe53d192155e526900b7ce8f4e">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a07fb46fe53d192155e526900b7ce8f4e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
|
||
|
|
Public Attributes</h2></td></tr>
|
||
|
|
<tr class="memitem:a9194c2d6216163b506e20ccd255577b1"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a9194c2d6216163b506e20ccd255577b1">KeyDelim</a> = "::OTTERK::"</td></tr>
|
||
|
|
<tr class="memdesc:a9194c2d6216163b506e20ccd255577b1"><td class="mdescLeft"> </td><td class="mdescRight">The string to use when delimiting key data in data exports. <a href="#a9194c2d6216163b506e20ccd255577b1">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a9194c2d6216163b506e20ccd255577b1"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a73cd5722f1a4aeada5212b26fe58cc78"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a73cd5722f1a4aeada5212b26fe58cc78">ValueDelim</a> = "::OTTERV::"</td></tr>
|
||
|
|
<tr class="memdesc:a73cd5722f1a4aeada5212b26fe58cc78"><td class="mdescLeft"> </td><td class="mdescRight">The string to use when delimiting value data in data exports. <a href="#a73cd5722f1a4aeada5212b26fe58cc78">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a73cd5722f1a4aeada5212b26fe58cc78"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a94e4408d1a567bee5e6481effad2b597"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a94e4408d1a567bee5e6481effad2b597">EncryptionSalt</a> = "otter"</td></tr>
|
||
|
|
<tr class="memdesc:a94e4408d1a567bee5e6481effad2b597"><td class="mdescLeft"> </td><td class="mdescRight">The phrase to use as a salt when encrypting the data exports. <a href="#a94e4408d1a567bee5e6481effad2b597">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a94e4408d1a567bee5e6481effad2b597"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a23c2b876c4e2d5c30359489692f51c7c"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a23c2b876c4e2d5c30359489692f51c7c">SaltGuide</a> = "{S}{D}{S}"</td></tr>
|
||
|
|
<tr class="memdesc:a23c2b876c4e2d5c30359489692f51c7c"><td class="mdescLeft"> </td><td class="mdescRight">The guide to salt the data string. {S} is the salt, {D} is the data. It is recommended to change this from the default for your game, but only if you really care about hacking save data. <a href="#a23c2b876c4e2d5c30359489692f51c7c">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a23c2b876c4e2d5c30359489692f51c7c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ac9bf53fee0a930c595765f241f7fd513"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#ac9bf53fee0a930c595765f241f7fd513">DefaultPath</a> = ""</td></tr>
|
||
|
|
<tr class="memdesc:ac9bf53fee0a930c595765f241f7fd513"><td class="mdescLeft"> </td><td class="mdescRight">The default path that the files will be imported from and exported to. <a href="#ac9bf53fee0a930c595765f241f7fd513">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ac9bf53fee0a930c595765f241f7fd513"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab679c6bf364529b3969870bc5dc6f0a0"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#ab679c6bf364529b3969870bc5dc6f0a0">DefaultFilename</a> = "data"</td></tr>
|
||
|
|
<tr class="memdesc:ab679c6bf364529b3969870bc5dc6f0a0"><td class="mdescLeft"> </td><td class="mdescRight">The default file name that the data will export as. <a href="#ab679c6bf364529b3969870bc5dc6f0a0">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ab679c6bf364529b3969870bc5dc6f0a0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa8cc42b5d5f02f64cbe92e83ace9a1f0"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_data_saver.html#ae50a827d69d1e640a45a5f87b485e6ff">DataExportMode</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#aa8cc42b5d5f02f64cbe92e83ace9a1f0">ExportMode</a> = DataExportMode.Data</td></tr>
|
||
|
|
<tr class="memdesc:aa8cc42b5d5f02f64cbe92e83ace9a1f0"><td class="mdescLeft"> </td><td class="mdescRight">The export mode for the data. Data: Semi-encrypted uneditable data. Config: Easy to hand edit unencrypted data. <a href="#aa8cc42b5d5f02f64cbe92e83ace9a1f0">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa8cc42b5d5f02f64cbe92e83ace9a1f0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table><table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
|
||
|
|
Properties</h2></td></tr>
|
||
|
|
<tr class="memitem:afce9bf3ac6f25f7b17e6b44207b404b9"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#afce9bf3ac6f25f7b17e6b44207b404b9">this[string key]</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:afce9bf3ac6f25f7b17e6b44207b404b9"><td class="mdescLeft"> </td><td class="mdescRight">Gets the string with the specified key. <a href="#afce9bf3ac6f25f7b17e6b44207b404b9">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:afce9bf3ac6f25f7b17e6b44207b404b9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a35217fab72cdd78aec230018b1a4e888"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_data_saver.html#a35217fab72cdd78aec230018b1a4e888">this[Enum key]</a><code> [get]</code></td></tr>
|
||
|
|
<tr class="memdesc:a35217fab72cdd78aec230018b1a4e888"><td class="mdescLeft"> </td><td class="mdescRight">Gets the string with the specified key. <a href="#a35217fab72cdd78aec230018b1a4e888">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a35217fab72cdd78aec230018b1a4e888"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>Class that is used for storing strings, ints, floats, or bools with keys of enum or string. The saver can output data in an semi-encrypted format, and also an editable config file format. </p>
|
||
|
|
</div><h2 class="groupheader">Member Enumeration Documentation</h2>
|
||
|
|
<a class="anchor" id="ae50a827d69d1e640a45a5f87b485e6ff"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">enum <a class="el" href="class_otter_1_1_data_saver.html#ae50a827d69d1e640a45a5f87b485e6ff">Otter.DataSaver.DataExportMode</a></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The export modes for the data. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a class="anchor" id="aea8f69088e405dcf64e7b37654621375"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Otter.DataSaver.DataSaver </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>defaultPath</em> = <code>""</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Initializes a new instance of the <a class="el" href="class_otter_1_1_data_saver.html" title="Class that is used for storing strings, ints, floats, or bools with keys of enum or string...">DataSaver</a> class. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">defaultPath</td><td>The default path.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a49e6d43a67efd8955035d77243b971f2"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.DataSaver.Clear </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Clears the data. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a5c40ceb78a377b7875167e6411feb0d3"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.DataSaver.ClearFile </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>filename</em> = <code>""</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Deletes the exported file for this save data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">filename</td><td>The filename to delete (usually you don't have to set this.)</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a38f3bc92779c76b6efd5231164a25b1d"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.DataSaver.Export </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>filename</em> = <code>""</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Exports the data to the specified file. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">filename</td><td>The filename.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6fed90808d1015e2f0790a076a1c3a98"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.DataSaver.FileExists </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>filename</em> = <code>""</code></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Check if an exported file exists for this data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">filename</td><td>The filename to check.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the exported file exists, and is verified for encrypted files.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a4e1d7c5065d1597b9c636bd4e3757b34"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.DataSaver.GetBool </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a bool from the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>An int from the specified key.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a4fc5ea0de3a323483cb824ff9f21c01a"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.DataSaver.GetBool </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a bool from the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>An int from the specified key.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aea17714a67961126af203e58ab207b22"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.DataSaver.GetBoolOrDefault </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>defaultIfNotFound</em> = <code>default(bool)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a bool or a default bool value. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultIfNotFound</td><td>The default if not found.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value or the default if the key is not found.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aed994eca853802675679afeef1343463"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.DataSaver.GetBoolOrDefault </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>defaultIfNotFound</em> = <code>default(bool)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a bool or a default bool value. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultIfNotFound</td><td>The default if not found.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value or the default if the key is not found.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a980bb063dd4721d2a7222088f5def80c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.DataSaver.GetFloat </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a float from the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>A float from the specified key.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a31a1d65c7d76bb13696e93e60ab60f95"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.DataSaver.GetFloat </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a float from the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>A float from the specified key.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a12a412514ed22452fd2b4e0e55be1c99"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.DataSaver.GetFloatOrDefault </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">float </td>
|
||
|
|
<td class="paramname"><em>defaultIfNotFound</em> = <code>default(float)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a float or a default float value. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultIfNotFound</td><td>The default if not found.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value or the default if a value is not found.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="afaec0c0b4092b8b877c9abf06edc6c3f"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">float Otter.DataSaver.GetFloatOrDefault </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">float </td>
|
||
|
|
<td class="paramname"><em>defaultIfNotFound</em> = <code>default(float)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a float or a default float value. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultIfNotFound</td><td>The default if not found.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value or the default if the key is not found.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6777d9dae3d6d7ac26698fdb6ecc4b89"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.DataSaver.GetInt </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets an int from the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>An int from the specified key.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a4ba7cf0db8e96b5b04e8fa522d526ddc"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.DataSaver.GetInt </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets an int from the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>An int from the specified key.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a93f50511ff7c54828be4be0fb7cc2d14"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.DataSaver.GetIntOrDefault </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>defaultIfNotFound</em> = <code>default(int)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets an int or a default int value. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultIfNotFound</td><td>The default if not found.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value or the default if the key is not found.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a4ce77267dd3b4c0c149ca72c1e064d8c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.DataSaver.GetIntOrDefault </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>defaultIfNotFound</em> = <code>default(int)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets an int or a default int value. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultIfNotFound</td><td>The default if not found.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value or the default if the key is not found.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a027b15358da2042824b30d65877dedaf"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.GetString </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a string from the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>An int from the specified key.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aabaa64df23c61b93076c120a671283be"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.GetString </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a string from the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>An int from the specified key.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a9c81255178b52b3a83f885116717b1fc"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.GetStringOrDefault </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>defaultIfNotFound</em> = <code>default(string)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a string or a default string value. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultIfNotFound</td><td>The default if not found.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value or the default if the key is not found.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ad7e25c4ef504e6911d2d4d85684c6f37"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.GetStringOrDefault </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>defaultIfNotFound</em> = <code>default(string)</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets a string or a default string value. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">defaultIfNotFound</td><td>The default if not found.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value or the default if the key is not found.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a3810e74568549c43a234bceae3211900"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.DataSaver.Import </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>filename</em> = <code>""</code>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">bool </td>
|
||
|
|
<td class="paramname"><em>verify</em> = <code>true</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Imports the data in the specified file. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">filename</td><td>The filename.</td></tr>
|
||
|
|
<tr><td class="paramname">verify</td><td>if set to true verify the data before importing.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a26485302d6fe0950d87753aa2c76a5e2"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.DataSaver.SetData </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">object </td>
|
||
|
|
<td class="paramname"><em>obj</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Sets the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">obj</td><td>The object.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a07fb46fe53d192155e526900b7ce8f4e"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.DataSaver.SetData </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>key</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">object </td>
|
||
|
|
<td class="paramname"><em>obj</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Sets the data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
<tr><td class="paramname">obj</td><td>The object.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a8b77b81f689c23c23ab199ec84e0fde9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.DataSaver.Verify </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>stringData</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Verifies the specified string data. Only applies to DataExportMode.Data. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">stringData</td><td>The string data.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>True if the data is successfully verified.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a class="anchor" id="ab679c6bf364529b3969870bc5dc6f0a0"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.DefaultFilename = "data"</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The default file name that the data will export as. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ac9bf53fee0a930c595765f241f7fd513"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.DefaultPath = ""</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The default path that the files will be imported from and exported to. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a94e4408d1a567bee5e6481effad2b597"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.EncryptionSalt = "otter"</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The phrase to use as a salt when encrypting the data exports. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa8cc42b5d5f02f64cbe92e83ace9a1f0"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_data_saver.html#ae50a827d69d1e640a45a5f87b485e6ff">DataExportMode</a> Otter.DataSaver.ExportMode = DataExportMode.Data</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The export mode for the data. Data: Semi-encrypted uneditable data. Config: Easy to hand edit unencrypted data. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a9194c2d6216163b506e20ccd255577b1"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.KeyDelim = "::OTTERK::"</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The string to use when delimiting key data in data exports. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a23c2b876c4e2d5c30359489692f51c7c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.SaltGuide = "{S}{D}{S}"</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The guide to salt the data string. {S} is the salt, {D} is the data. It is recommended to change this from the default for your game, but only if you really care about hacking save data. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a73cd5722f1a4aeada5212b26fe58cc78"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.ValueDelim = "::OTTERV::"</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The string to use when delimiting value data in data exports. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
|
<a class="anchor" id="a35217fab72cdd78aec230018b1a4e888"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.this[Enum key]</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">get</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets the string with the specified key. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The string data or null.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="afce9bf3ac6f25f7b17e6b44207b404b9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.DataSaver.this[string key]</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">get</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Gets the string with the specified key. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">key</td><td>The key.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The string data or null.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Utility/DataSaver.cs</li>
|
||
|
|
</ul>
|
||
|
|
</div><!-- contents -->
|
||
|
|
</div><!-- doc-content -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
||
|
|
<ul>
|
||
|
|
<li class="navelem"><a class="el" href="namespace_otter.html">Otter</a></li><li class="navelem"><a class="el" href="class_otter_1_1_data_saver.html">DataSaver</a></li>
|
||
|
|
<li class="footer">Generated on Thu May 12 2016 18:16:53 for Otter by
|
||
|
|
<a href="http://www.doxygen.org/index.html">
|
||
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.5 </li>
|
||
|
|
</ul>
|
||
|
|
</div>
|
||
|
|
</body>
|
||
|
|
</html>
|