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.
754 lines
43 KiB
HTML
754 lines
43 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.OgmoProject 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_ogmo_project.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-methods">Public Member Functions</a> |
|
||
|
|
<a href="#pub-attribs">Public Attributes</a> |
|
||
|
|
<a href="#properties">Properties</a> |
|
||
|
|
<a href="class_otter_1_1_ogmo_project-members.html">List of all members</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">Otter.OgmoProject Class Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>Class used for importing <a class="el" href="class_otter_1_1_ogmo_project.html" title="Class used for importing OgmoProject files quickly, and loading levels created in Ogmo Editor (http:/...">OgmoProject</a> files quickly, and loading levels created in Ogmo Editor (<a href="http://ogmoeditor.com">http://ogmoeditor.com</a>) Currently OgmoProjects must export in XML Co-ords for Tiles and Entities, and Bitstring for Grids.
|
||
|
|
<a href="class_otter_1_1_ogmo_project.html#details">More...</a></p>
|
||
|
|
<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:a45e8477effecec346cce3a50bf345498"><td class="memItemLeft" align="right" valign="top"> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a45e8477effecec346cce3a50bf345498">OgmoProject</a> (string source, string imagePath="")</td></tr>
|
||
|
|
<tr class="memdesc:a45e8477effecec346cce3a50bf345498"><td class="mdescLeft"> </td><td class="mdescRight">Create an <a class="el" href="class_otter_1_1_ogmo_project.html" title="Class used for importing OgmoProject files quickly, and loading levels created in Ogmo Editor (http:/...">OgmoProject</a> from a source .oep file. <a href="#a45e8477effecec346cce3a50bf345498">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a45e8477effecec346cce3a50bf345498"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a3ff56862b495bf383dbc7d73210e76a9"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a3ff56862b495bf383dbc7d73210e76a9">RemapAsset</a> (string searchPath, string replacement)</td></tr>
|
||
|
|
<tr class="memdesc:a3ff56862b495bf383dbc7d73210e76a9"><td class="mdescLeft"> </td><td class="mdescRight">Assign a replacement asset for a <a class="el" href="class_otter_1_1_tilemap.html" title="Graphic used for loading and rendering a tilemap. Renders tiles using a vertex array. ">Tilemap</a> when LoadLevel is called. <a href="#a3ff56862b495bf383dbc7d73210e76a9">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a3ff56862b495bf383dbc7d73210e76a9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5f16b7b7a679edf768e967f7c5938987"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a5f16b7b7a679edf768e967f7c5938987">GetValue< T ></a> (string name, string data="")</td></tr>
|
||
|
|
<tr class="memdesc:a5f16b7b7a679edf768e967f7c5938987"><td class="mdescLeft"> </td><td class="mdescRight">Get a value from an Ogmo level. <a href="#a5f16b7b7a679edf768e967f7c5938987">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5f16b7b7a679edf768e967f7c5938987"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a7288a5b8345ffc168d9ee6da91708ea9"><td class="memItemLeft" align="right" valign="top">T </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a7288a5b8345ffc168d9ee6da91708ea9">GetValue< T ></a> (Enum name, string source="")</td></tr>
|
||
|
|
<tr class="memdesc:a7288a5b8345ffc168d9ee6da91708ea9"><td class="mdescLeft"> </td><td class="mdescRight">Get a value from an Ogmo level. <a href="#a7288a5b8345ffc168d9ee6da91708ea9">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a7288a5b8345ffc168d9ee6da91708ea9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa23e670ea98dca8c3f583f851a33aa74"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="aa23e670ea98dca8c3f583f851a33aa74"></a>
|
||
|
|
T </td><td class="memItemRight" valign="bottom"><b>GetValueFromFile< T ></b> (string name, string path)</td></tr>
|
||
|
|
<tr class="separator:aa23e670ea98dca8c3f583f851a33aa74"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a10547f198d9ba29a3ab8b30dc48ce752"><td class="memItemLeft" align="right" valign="top"><a class="anchor" id="a10547f198d9ba29a3ab8b30dc48ce752"></a>
|
||
|
|
string </td><td class="memItemRight" valign="bottom"><b>GetLayerData</b> (string name, string data="")</td></tr>
|
||
|
|
<tr class="separator:a10547f198d9ba29a3ab8b30dc48ce752"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a220e42122d23f8c41ba2517c4a60a02e"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a220e42122d23f8c41ba2517c4a60a02e">LoadLevel</a> (string data, <a class="el" href="class_otter_1_1_scene.html">Scene</a> scene)</td></tr>
|
||
|
|
<tr class="memdesc:a220e42122d23f8c41ba2517c4a60a02e"><td class="mdescLeft"> </td><td class="mdescRight">Load level data from a string into a <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a>. <a href="#a220e42122d23f8c41ba2517c4a60a02e">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a220e42122d23f8c41ba2517c4a60a02e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ad1f6705440412048fd65427c27f1e431"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#ad1f6705440412048fd65427c27f1e431">LoadLevelFromFile</a> (string path, <a class="el" href="class_otter_1_1_scene.html">Scene</a> scene)</td></tr>
|
||
|
|
<tr class="memdesc:ad1f6705440412048fd65427c27f1e431"><td class="mdescLeft"> </td><td class="mdescRight">Load data into a <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> from a source .oel file. <a href="#ad1f6705440412048fd65427c27f1e431">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ad1f6705440412048fd65427c27f1e431"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a759e9b5c0a5531884ea0c5efcd368b4d"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a759e9b5c0a5531884ea0c5efcd368b4d">RegisterTag</a> (int tag, string layerName)</td></tr>
|
||
|
|
<tr class="memdesc:a759e9b5c0a5531884ea0c5efcd368b4d"><td class="mdescLeft"> </td><td class="mdescRight">Register a collision tag on a grid layer loaded from the oel file. <a href="#a759e9b5c0a5531884ea0c5efcd368b4d">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a759e9b5c0a5531884ea0c5efcd368b4d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a867d8f1b09432e056d860843c1364856"><td class="memItemLeft" align="right" valign="top">void </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a867d8f1b09432e056d860843c1364856">RegisterTag</a> (Enum tag, string layerName)</td></tr>
|
||
|
|
<tr class="memdesc:a867d8f1b09432e056d860843c1364856"><td class="mdescLeft"> </td><td class="mdescRight">Register a collision tag on a grid layer loaded from the oel file. <a href="#a867d8f1b09432e056d860843c1364856">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a867d8f1b09432e056d860843c1364856"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a5cb8899814f45f8562718f8f126ac6b9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_entity.html">Entity</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a5cb8899814f45f8562718f8f126ac6b9">GetEntityFromLayerName</a> (string layerName)</td></tr>
|
||
|
|
<tr class="memdesc:a5cb8899814f45f8562718f8f126ac6b9"><td class="mdescLeft"> </td><td class="mdescRight">Get the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that was created for a specific Ogmo layer. <a href="#a5cb8899814f45f8562718f8f126ac6b9">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a5cb8899814f45f8562718f8f126ac6b9"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0ce8e5981d9cddd63eea2a9a58921241"><td class="memItemLeft" align="right" valign="top">List< string > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a0ce8e5981d9cddd63eea2a9a58921241">GetLayerNames</a> ()</td></tr>
|
||
|
|
<tr class="memdesc:a0ce8e5981d9cddd63eea2a9a58921241"><td class="mdescLeft"> </td><td class="mdescRight">Get a list of all the known layer names from the .oep file. <a href="#a0ce8e5981d9cddd63eea2a9a58921241">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a0ce8e5981d9cddd63eea2a9a58921241"><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:a6c0779d58ced9b8ec2a6788d4525357c"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a6c0779d58ced9b8ec2a6788d4525357c">DisplayGrids</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:a6c0779d58ced9b8ec2a6788d4525357c"><td class="mdescLeft"> </td><td class="mdescRight">Determines if grid layers will render in the game. Only applies at loading time. <a href="#a6c0779d58ced9b8ec2a6788d4525357c">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6c0779d58ced9b8ec2a6788d4525357c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a4efdfb771a7b8ebe0636583b8673ccf0"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a4efdfb771a7b8ebe0636583b8673ccf0">ImagePath</a></td></tr>
|
||
|
|
<tr class="memdesc:a4efdfb771a7b8ebe0636583b8673ccf0"><td class="mdescLeft"> </td><td class="mdescRight">The default image path to search for tilemaps in. <a href="#a4efdfb771a7b8ebe0636583b8673ccf0">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a4efdfb771a7b8ebe0636583b8673ccf0"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a84685b51c292ca9981ca8d9391a14ca5"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a84685b51c292ca9981ca8d9391a14ca5">UseCameraBounds</a> = true</td></tr>
|
||
|
|
<tr class="memdesc:a84685b51c292ca9981ca8d9391a14ca5"><td class="mdescLeft"> </td><td class="mdescRight">Determines if loaded levels will use camera bounds in the <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a>. <a href="#a84685b51c292ca9981ca8d9391a14ca5">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a84685b51c292ca9981ca8d9391a14ca5"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab4e0b9bb40c758a0b21e6797b08c268a"><td class="memItemLeft" align="right" valign="top">bool </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#ab4e0b9bb40c758a0b21e6797b08c268a">UseAtlas</a></td></tr>
|
||
|
|
<tr class="memdesc:ab4e0b9bb40c758a0b21e6797b08c268a"><td class="mdescLeft"> </td><td class="mdescRight">Determines if tilemaps are located in an <a class="el" href="class_otter_1_1_atlas.html" title="Class used for loading textures from an Atlas, or a set of Atlases. This class is built to support at...">Atlas</a>. <a href="#ab4e0b9bb40c758a0b21e6797b08c268a">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ab4e0b9bb40c758a0b21e6797b08c268a"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a894bf388a155c6b6042d5e15ff97a6fe"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_color.html">Color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a894bf388a155c6b6042d5e15ff97a6fe">BackgroundColor</a></td></tr>
|
||
|
|
<tr class="memdesc:a894bf388a155c6b6042d5e15ff97a6fe"><td class="mdescLeft"> </td><td class="mdescRight">The default background color of the Ogmo Project. <a href="#a894bf388a155c6b6042d5e15ff97a6fe">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a894bf388a155c6b6042d5e15ff97a6fe"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a08d95a186253e743a92848b2be78caef"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_otter_1_1_color.html">Color</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a08d95a186253e743a92848b2be78caef">GridColor</a></td></tr>
|
||
|
|
<tr class="memdesc:a08d95a186253e743a92848b2be78caef"><td class="mdescLeft"> </td><td class="mdescRight">The default background grid color of the Ogmo Project. <a href="#a08d95a186253e743a92848b2be78caef">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a08d95a186253e743a92848b2be78caef"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa36b090feb6f01ea174f2caa32323fb4"><td class="memItemLeft" align="right" valign="top">Dictionary< string, <a class="el" href="class_otter_1_1_ogmo_layer.html">OgmoLayer</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#aa36b090feb6f01ea174f2caa32323fb4">Layers</a> = new Dictionary<string, <a class="el" href="class_otter_1_1_ogmo_layer.html">OgmoLayer</a>>()</td></tr>
|
||
|
|
<tr class="memdesc:aa36b090feb6f01ea174f2caa32323fb4"><td class="mdescLeft"> </td><td class="mdescRight">The known layers loaded from the Ogmo Editor oep file. <a href="#aa36b090feb6f01ea174f2caa32323fb4">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aa36b090feb6f01ea174f2caa32323fb4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a65cb07abe121ae5747da6216e8fbba35"><td class="memItemLeft" align="right" valign="top">Dictionary< string, string > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a65cb07abe121ae5747da6216e8fbba35">TileMaps</a> = new Dictionary<string, string>()</td></tr>
|
||
|
|
<tr class="memdesc:a65cb07abe121ae5747da6216e8fbba35"><td class="mdescLeft"> </td><td class="mdescRight">Mapping the tile layers to file paths. <a href="#a65cb07abe121ae5747da6216e8fbba35">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a65cb07abe121ae5747da6216e8fbba35"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a16d63c6fab9db0e51013e5acd0b89f40"><td class="memItemLeft" align="right" valign="top">Dictionary< string, <a class="el" href="class_otter_1_1_entity.html">Entity</a> > </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a16d63c6fab9db0e51013e5acd0b89f40">Entities</a> = new Dictionary<string, <a class="el" href="class_otter_1_1_entity.html">Entity</a>>()</td></tr>
|
||
|
|
<tr class="memdesc:a16d63c6fab9db0e51013e5acd0b89f40"><td class="mdescLeft"> </td><td class="mdescRight">The entities stored to create tilemaps and grids. Cleared every time LoadLevel is called. <a href="#a16d63c6fab9db0e51013e5acd0b89f40">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a16d63c6fab9db0e51013e5acd0b89f40"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acdb277b212eb24fa9fcbacefa9545ca4"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#acdb277b212eb24fa9fcbacefa9545ca4">CreationMethodName</a> = "CreateFromXml"</td></tr>
|
||
|
|
<tr class="memdesc:acdb277b212eb24fa9fcbacefa9545ca4"><td class="mdescLeft"> </td><td class="mdescRight">The name of the method to use for creating Entities when loading an .oel file into a <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a>. <a href="#acdb277b212eb24fa9fcbacefa9545ca4">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:acdb277b212eb24fa9fcbacefa9545ca4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae7db0af93d7e8e0adb85f8dca65ecf3e"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#ae7db0af93d7e8e0adb85f8dca65ecf3e">BaseTileDepth</a></td></tr>
|
||
|
|
<tr class="memdesc:ae7db0af93d7e8e0adb85f8dca65ecf3e"><td class="mdescLeft"> </td><td class="mdescRight">The drawing layer to place the first loaded tile map on. <a href="#ae7db0af93d7e8e0adb85f8dca65ecf3e">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:ae7db0af93d7e8e0adb85f8dca65ecf3e"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aaf1a849d992ba287032255858fad449c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#aaf1a849d992ba287032255858fad449c">TileDepthIncrement</a> = 100</td></tr>
|
||
|
|
<tr class="memdesc:aaf1a849d992ba287032255858fad449c"><td class="mdescLeft"> </td><td class="mdescRight">Determines the drawing layers for each subsequently loaded tile map. For example, the first tilemap will be at Layer 0, the second at Layer 100, the third at Layer 200, etc. <a href="#aaf1a849d992ba287032255858fad449c">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:aaf1a849d992ba287032255858fad449c"><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:a6568d9eb89e57a5d0e0837cff9312b4b"><td class="memItemLeft" align="right" valign="top">string </td><td class="memItemRight" valign="bottom"><a class="el" href="class_otter_1_1_ogmo_project.html#a6568d9eb89e57a5d0e0837cff9312b4b">CurrentLevel</a><code> [get, set]</code></td></tr>
|
||
|
|
<tr class="memdesc:a6568d9eb89e57a5d0e0837cff9312b4b"><td class="mdescLeft"> </td><td class="mdescRight">The level data last loaded with <a class="el" href="class_otter_1_1_ogmo_project.html#a220e42122d23f8c41ba2517c4a60a02e" title="Load level data from a string into a Scene. ">LoadLevel()</a> <a href="#a6568d9eb89e57a5d0e0837cff9312b4b">More...</a><br/></td></tr>
|
||
|
|
<tr class="separator:a6568d9eb89e57a5d0e0837cff9312b4b"><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 used for importing <a class="el" href="class_otter_1_1_ogmo_project.html" title="Class used for importing OgmoProject files quickly, and loading levels created in Ogmo Editor (http:/...">OgmoProject</a> files quickly, and loading levels created in Ogmo Editor (<a href="http://ogmoeditor.com">http://ogmoeditor.com</a>) Currently OgmoProjects must export in XML Co-ords for Tiles and Entities, and Bitstring for Grids. </p>
|
||
|
|
</div><h2 class="groupheader">Constructor & Destructor Documentation</h2>
|
||
|
|
<a class="anchor" id="a45e8477effecec346cce3a50bf345498"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Otter.OgmoProject.OgmoProject </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>source</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>imagePath</em> = <code>""</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Create an <a class="el" href="class_otter_1_1_ogmo_project.html" title="Class used for importing OgmoProject files quickly, and loading levels created in Ogmo Editor (http:/...">OgmoProject</a> from a source .oep file. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">source</td><td>The path to the .oep file.</td></tr>
|
||
|
|
<tr><td class="paramname">imagePath</td><td>The default image path to use for loading tilemaps.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Function Documentation</h2>
|
||
|
|
<a class="anchor" id="a5cb8899814f45f8562718f8f126ac6b9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_entity.html">Entity</a> Otter.OgmoProject.GetEntityFromLayerName </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>layerName</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get the <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> that was created for a specific Ogmo layer. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">layerName</td><td>The name of the layer to find.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The <a class="el" href="class_otter_1_1_entity.html" title="Class used for a game object. The bread and butter of your game. Entities are added to Scenes which a...">Entity</a> created for that layer.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a0ce8e5981d9cddd63eea2a9a58921241"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">List<string> Otter.OgmoProject.GetLayerNames </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get a list of all the known layer names from the .oep file. </p>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd></dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a5f16b7b7a679edf768e967f7c5938987"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">T Otter.OgmoProject.GetValue< T > </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>name</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>data</em> = <code>""</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get a value from an Ogmo level. </p>
|
||
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||
|
|
<table class="tparams">
|
||
|
|
<tr><td class="paramname">T</td><td>The type of value.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">name</td><td>The name of the value.</td></tr>
|
||
|
|
<tr><td class="paramname">data</td><td>The level data to use. If left blank will use the CurrentLevel.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value cast to type T.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a7288a5b8345ffc168d9ee6da91708ea9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">T Otter.OgmoProject.GetValue< T > </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>name</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>source</em> = <code>""</code> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Get a value from an Ogmo level. </p>
|
||
|
|
<dl class="tparams"><dt>Template Parameters</dt><dd>
|
||
|
|
<table class="tparams">
|
||
|
|
<tr><td class="paramname">T</td><td>The type of value.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">name</td><td>The name of the value.</td></tr>
|
||
|
|
<tr><td class="paramname">source</td><td>The level data to use. If left blank will use the CurrentLevel.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>The value cast to type T.</dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a220e42122d23f8c41ba2517c4a60a02e"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.OgmoProject.LoadLevel </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>data</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="class_otter_1_1_scene.html">Scene</a> </td>
|
||
|
|
<td class="paramname"><em>scene</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Load level data from a string into a <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a>. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">data</td><td>The level data to load.</td></tr>
|
||
|
|
<tr><td class="paramname">scene</td><td>The <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> to load into.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ad1f6705440412048fd65427c27f1e431"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.OgmoProject.LoadLevelFromFile </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>path</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype"><a class="el" href="class_otter_1_1_scene.html">Scene</a> </td>
|
||
|
|
<td class="paramname"><em>scene</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Load data into a <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> from a source .oel file. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">path</td><td>The oel to load.</td></tr>
|
||
|
|
<tr><td class="paramname">scene</td><td>The <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a> to load into.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a759e9b5c0a5531884ea0c5efcd368b4d"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.OgmoProject.RegisterTag </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">int </td>
|
||
|
|
<td class="paramname"><em>tag</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>layerName</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Register a collision tag on a grid layer loaded from the oel file. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">tag</td><td>The tag to use.</td></tr>
|
||
|
|
<tr><td class="paramname">layerName</td><td>The layer name that should use the tag.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a867d8f1b09432e056d860843c1364856"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.OgmoProject.RegisterTag </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">Enum </td>
|
||
|
|
<td class="paramname"><em>tag</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>layerName</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Register a collision tag on a grid layer loaded from the oel file. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">tag</td><td>The enum tag to use. (Casts to int!)</td></tr>
|
||
|
|
<tr><td class="paramname">layerName</td><td>The layer name that should use the tag.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a3ff56862b495bf383dbc7d73210e76a9"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">void Otter.OgmoProject.RemapAsset </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>searchPath</em>, </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">string </td>
|
||
|
|
<td class="paramname"><em>replacement</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Assign a replacement asset for a <a class="el" href="class_otter_1_1_tilemap.html" title="Graphic used for loading and rendering a tilemap. Renders tiles using a vertex array. ">Tilemap</a> when LoadLevel is called. </p>
|
||
|
|
<dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">searchPath</td><td>The asset path to find (searches at the end of the string!)</td></tr>
|
||
|
|
<tr><td class="paramname">replacement</td><td>The full path to replace the matching asset with.</td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Member Data Documentation</h2>
|
||
|
|
<a class="anchor" id="a894bf388a155c6b6042d5e15ff97a6fe"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_color.html">Color</a> Otter.OgmoProject.BackgroundColor</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The default background color of the Ogmo Project. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ae7db0af93d7e8e0adb85f8dca65ecf3e"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.OgmoProject.BaseTileDepth</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The drawing layer to place the first loaded tile map on. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="acdb277b212eb24fa9fcbacefa9545ca4"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.OgmoProject.CreationMethodName = "CreateFromXml"</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The name of the method to use for creating Entities when loading an .oel file into a <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a6c0779d58ced9b8ec2a6788d4525357c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.OgmoProject.DisplayGrids = true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Determines if grid layers will render in the game. Only applies at loading time. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a16d63c6fab9db0e51013e5acd0b89f40"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Dictionary<string, <a class="el" href="class_otter_1_1_entity.html">Entity</a>> Otter.OgmoProject.Entities = new Dictionary<string, <a class="el" href="class_otter_1_1_entity.html">Entity</a>>()</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The entities stored to create tilemaps and grids. Cleared every time LoadLevel is called. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a08d95a186253e743a92848b2be78caef"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname"><a class="el" href="class_otter_1_1_color.html">Color</a> Otter.OgmoProject.GridColor</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The default background grid color of the Ogmo Project. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a4efdfb771a7b8ebe0636583b8673ccf0"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.OgmoProject.ImagePath</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The default image path to search for tilemaps in. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aa36b090feb6f01ea174f2caa32323fb4"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Dictionary<string, <a class="el" href="class_otter_1_1_ogmo_layer.html">OgmoLayer</a>> Otter.OgmoProject.Layers = new Dictionary<string, <a class="el" href="class_otter_1_1_ogmo_layer.html">OgmoLayer</a>>()</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The known layers loaded from the Ogmo Editor oep file. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="aaf1a849d992ba287032255858fad449c"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int Otter.OgmoProject.TileDepthIncrement = 100</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Determines the drawing layers for each subsequently loaded tile map. For example, the first tilemap will be at Layer 0, the second at Layer 100, the third at Layer 200, etc. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a65cb07abe121ae5747da6216e8fbba35"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">Dictionary<string, string> Otter.OgmoProject.TileMaps = new Dictionary<string, string>()</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Mapping the tile layers to file paths. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="ab4e0b9bb40c758a0b21e6797b08c268a"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.OgmoProject.UseAtlas</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Determines if tilemaps are located in an <a class="el" href="class_otter_1_1_atlas.html" title="Class used for loading textures from an Atlas, or a set of Atlases. This class is built to support at...">Atlas</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a class="anchor" id="a84685b51c292ca9981ca8d9391a14ca5"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">bool Otter.OgmoProject.UseCameraBounds = true</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Determines if loaded levels will use camera bounds in the <a class="el" href="class_otter_1_1_scene.html" title="Class used to manage Entities. The active Game should update the active Scene, which then updates all...">Scene</a>. </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<h2 class="groupheader">Property Documentation</h2>
|
||
|
|
<a class="anchor" id="a6568d9eb89e57a5d0e0837cff9312b4b"></a>
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="mlabels">
|
||
|
|
<tr>
|
||
|
|
<td class="mlabels-left">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">string Otter.OgmoProject.CurrentLevel</td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</td>
|
||
|
|
<td class="mlabels-right">
|
||
|
|
<span class="mlabels"><span class="mlabel">get</span><span class="mlabel">set</span></span> </td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>The level data last loaded with <a class="el" href="class_otter_1_1_ogmo_project.html#a220e42122d23f8c41ba2517c4a60a02e" title="Load level data from a string into a Scene. ">LoadLevel()</a> </p>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<hr/>The documentation for this class was generated from the following file:<ul>
|
||
|
|
<li>Otter/Utility/OgmoProject.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_ogmo_project.html">OgmoProject</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>
|