v1.3.0 - docs

bengreenier · Mar 25, 2017 · 50898f7 · 50898f7
1 parent 4aa8d19
commit 50898f7
Show file tree

Hide file tree

Showing 11 changed files with 69 additions and 4 deletions.
diff --git a/docs/class_menu_stack_1_1_menu-members.html b/docs/class_menu_stack_1_1_menu-members.html
@@ -71,7 +71,9 @@
 
 <p>This is the complete list of members for <a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#ac823c8fdd919cbbd05cef3525e3b6c14">CustomName</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a">AlwaysUseInitialSelected</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#ac823c8fdd919cbbd05cef3525e3b6c14">CustomName</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39">InitialSelected</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#a0a3c946e6f59d62544a7b612566ff124">Interactable</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#af67e28d7803349cec9df96f340dfe157">InteractableType</a> enum name</td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#a2c253f93e3bd6023098efcbe53efee4c">InteractionType</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>

diff --git a/docs/class_menu_stack_1_1_menu.html b/docs/class_menu_stack_1_1_menu.html
@@ -112,6 +112,12 @@
 <tr class="memitem:a2c253f93e3bd6023098efcbe53efee4c"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_menu_stack_1_1_menu.html#af67e28d7803349cec9df96f340dfe157">Menu.InteractableType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu.html#a2c253f93e3bd6023098efcbe53efee4c">InteractionType</a> = <a class="el" href="class_menu_stack_1_1_menu.html#af67e28d7803349cec9df96f340dfe157ada5dc8dc3e94d4dbd78addf1e37d7d79">InteractableType.SelectableInteractive</a></td></tr>
 <tr class="memdesc:a2c253f93e3bd6023098efcbe53efee4c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how we handle interactivity for this menu  <a href="#a2c253f93e3bd6023098efcbe53efee4c">More...</a><br /></td></tr>
 <tr class="separator:a2c253f93e3bd6023098efcbe53efee4c"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aee3140d0907c1552efa3c2140bb5ec39"><td class="memItemLeft" align="right" valign="top">Selectable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39">InitialSelected</a> = null</td></tr>
+<tr class="memdesc:aee3140d0907c1552efa3c2140bb5ec39"><td class="mdescLeft">&#160;</td><td class="mdescRight">The initially selected Selectable when this <a class="el" href="class_menu_stack_1_1_menu.html" title="Represents any menu (a logical grouping of ui elements) within a MenuRoot ">Menu</a> is <a class="el" href="class_menu_stack_1_1_menu.html#a664d271465e0e710e9aebaf0ab09c0a3" title="Indicates if this menu is visible ">Visible</a>  <a href="#aee3140d0907c1552efa3c2140bb5ec39">More...</a><br /></td></tr>
+<tr class="separator:aee3140d0907c1552efa3c2140bb5ec39"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:acbda1c597ecef4c2a67ed934c705e72a"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a">AlwaysUseInitialSelected</a> = false</td></tr>
+<tr class="memdesc:acbda1c597ecef4c2a67ed934c705e72a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if we use initially selected Selectable when returning to the menu after the first time  <a href="#acbda1c597ecef4c2a67ed934c705e72a">More...</a><br /></td></tr>
+<tr class="separator:acbda1c597ecef4c2a67ed934c705e72a"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="properties"></a>
 Properties</h2></td></tr>
@@ -230,6 +236,23 @@ <h2 class="memtitle"><span class="permalink"><a href="#ab1807ed16badd5b4f0c600d0
 </div>
 </div>
 <h2 class="groupheader">Member Data Documentation</h2>
+<a id="acbda1c597ecef4c2a67ed934c705e72a"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#acbda1c597ecef4c2a67ed934c705e72a">&#9670;&nbsp;</a></span>AlwaysUseInitialSelected</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">bool MenuStack.Menu.AlwaysUseInitialSelected = false</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>Determines if we use initially selected Selectable when returning to the menu after the first time </p>
+<p>If this is <code>false</code> we'll instead keep history and return to the last selected Selectable </p>
+
+</div>
+</div>
 <a id="ac823c8fdd919cbbd05cef3525e3b6c14"></a>
 <h2 class="memtitle"><span class="permalink"><a href="#ac823c8fdd919cbbd05cef3525e3b6c14">&#9670;&nbsp;</a></span>CustomName</h2>
 
@@ -245,6 +268,22 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac823c8fdd919cbbd05cef352
 <p>A custom name for this menu </p>
 <p>Overrides the default <a class="el" href="class_menu_stack_1_1_menu.html#aee81a1f11823976cb1007d04e371617f" title="The runtime name for this menu ">Name</a> </p>
 
+</div>
+</div>
+<a id="aee3140d0907c1552efa3c2140bb5ec39"></a>
+<h2 class="memtitle"><span class="permalink"><a href="#aee3140d0907c1552efa3c2140bb5ec39">&#9670;&nbsp;</a></span>InitialSelected</h2>
+
+<div class="memitem">
+<div class="memproto">
+      <table class="memname">
+        <tr>
+          <td class="memname">Selectable MenuStack.Menu.InitialSelected = null</td>
+        </tr>
+      </table>
+</div><div class="memdoc">
+
+<p>The initially selected Selectable when this <a class="el" href="class_menu_stack_1_1_menu.html" title="Represents any menu (a logical grouping of ui elements) within a MenuRoot ">Menu</a> is <a class="el" href="class_menu_stack_1_1_menu.html#a664d271465e0e710e9aebaf0ab09c0a3" title="Indicates if this menu is visible ">Visible</a> </p>
+
 </div>
 </div>
 <a id="a2c253f93e3bd6023098efcbe53efee4c"></a>

diff --git a/docs/class_menu_stack_1_1_menu_root.html b/docs/class_menu_stack_1_1_menu_root.html
@@ -124,7 +124,7 @@
 </table><table class="memberdecls">
 <tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-static-attribs"></a>
 Static Public Attributes</h2></td></tr>
-<tr class="memitem:ac5e5e5a465dbb232da8631851d64dad1"><td class="memItemLeft" align="right" valign="top">static readonly Version&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu_root.html#ac5e5e5a465dbb232da8631851d64dad1">Version</a> = new Version(1, 2, 0)</td></tr>
+<tr class="memitem:ac5e5e5a465dbb232da8631851d64dad1"><td class="memItemLeft" align="right" valign="top">static readonly Version&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu_root.html#ac5e5e5a465dbb232da8631851d64dad1">Version</a> = new Version(1, 3, 0)</td></tr>
 <tr class="memdesc:ac5e5e5a465dbb232da8631851d64dad1"><td class="mdescLeft">&#160;</td><td class="mdescRight">The current Unity-MenuStack version  <a href="#ac5e5e5a465dbb232da8631851d64dad1">More...</a><br /></td></tr>
 <tr class="separator:ac5e5e5a465dbb232da8631851d64dad1"><td class="memSeparator" colspan="2">&#160;</td></tr>
 </table><table class="memberdecls">
@@ -340,7 +340,7 @@ <h2 class="memtitle"><span class="permalink"><a href="#ac5e5e5a465dbb232da863185
   <td class="mlabels-left">
       <table class="memname">
         <tr>
-          <td class="memname">readonly Version MenuStack.MenuRoot.Version = new Version(1, 2, 0)</td>
+          <td class="memname">readonly Version MenuStack.MenuRoot.Version = new Version(1, 3, 0)</td>
         </tr>
       </table>
   </td>

diff --git a/docs/class_menu_stack_1_1_overlay_menu-members.html b/docs/class_menu_stack_1_1_overlay_menu-members.html
@@ -71,7 +71,9 @@
 
 <p>This is the complete list of members for <a class="el" href="class_menu_stack_1_1_overlay_menu.html">MenuStack.OverlayMenu</a>, including all inherited members.</p>
 <table class="directory">
-  <tr class="even"><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#ac823c8fdd919cbbd05cef3525e3b6c14">CustomName</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a">AlwaysUseInitialSelected</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
+  <tr><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#ac823c8fdd919cbbd05cef3525e3b6c14">CustomName</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
+  <tr class="even"><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39">InitialSelected</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#a0a3c946e6f59d62544a7b612566ff124">Interactable</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
   <tr class="even"><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#af67e28d7803349cec9df96f340dfe157">InteractableType</a> enum name</td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>
   <tr><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html#a2c253f93e3bd6023098efcbe53efee4c">InteractionType</a></td><td class="entry"><a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td><td class="entry"></td></tr>

diff --git a/docs/class_menu_stack_1_1_overlay_menu.html b/docs/class_menu_stack_1_1_overlay_menu.html
@@ -105,6 +105,12 @@
 <tr class="memitem:a2c253f93e3bd6023098efcbe53efee4c inherit pub_attribs_class_menu_stack_1_1_menu"><td class="memItemLeft" align="right" valign="top"><a class="el" href="class_menu_stack_1_1_menu.html#af67e28d7803349cec9df96f340dfe157">Menu.InteractableType</a>&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu.html#a2c253f93e3bd6023098efcbe53efee4c">InteractionType</a> = <a class="el" href="class_menu_stack_1_1_menu.html#af67e28d7803349cec9df96f340dfe157ada5dc8dc3e94d4dbd78addf1e37d7d79">InteractableType.SelectableInteractive</a></td></tr>
 <tr class="memdesc:a2c253f93e3bd6023098efcbe53efee4c inherit pub_attribs_class_menu_stack_1_1_menu"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines how we handle interactivity for this menu  <a href="class_menu_stack_1_1_menu.html#a2c253f93e3bd6023098efcbe53efee4c">More...</a><br /></td></tr>
 <tr class="separator:a2c253f93e3bd6023098efcbe53efee4c inherit pub_attribs_class_menu_stack_1_1_menu"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:aee3140d0907c1552efa3c2140bb5ec39 inherit pub_attribs_class_menu_stack_1_1_menu"><td class="memItemLeft" align="right" valign="top">Selectable&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39">InitialSelected</a> = null</td></tr>
+<tr class="memdesc:aee3140d0907c1552efa3c2140bb5ec39 inherit pub_attribs_class_menu_stack_1_1_menu"><td class="mdescLeft">&#160;</td><td class="mdescRight">The initially selected Selectable when this <a class="el" href="class_menu_stack_1_1_menu.html" title="Represents any menu (a logical grouping of ui elements) within a MenuRoot ">Menu</a> is <a class="el" href="class_menu_stack_1_1_menu.html#a664d271465e0e710e9aebaf0ab09c0a3" title="Indicates if this menu is visible ">Visible</a>  <a href="class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39">More...</a><br /></td></tr>
+<tr class="separator:aee3140d0907c1552efa3c2140bb5ec39 inherit pub_attribs_class_menu_stack_1_1_menu"><td class="memSeparator" colspan="2">&#160;</td></tr>
+<tr class="memitem:acbda1c597ecef4c2a67ed934c705e72a inherit pub_attribs_class_menu_stack_1_1_menu"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a">AlwaysUseInitialSelected</a> = false</td></tr>
+<tr class="memdesc:acbda1c597ecef4c2a67ed934c705e72a inherit pub_attribs_class_menu_stack_1_1_menu"><td class="mdescLeft">&#160;</td><td class="mdescRight">Determines if we use initially selected Selectable when returning to the menu after the first time  <a href="class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a">More...</a><br /></td></tr>
+<tr class="separator:acbda1c597ecef4c2a67ed934c705e72a inherit pub_attribs_class_menu_stack_1_1_menu"><td class="memSeparator" colspan="2">&#160;</td></tr>
 <tr class="inherit_header properties_class_menu_stack_1_1_menu"><td colspan="2" onclick="javascript:toggleInherit('properties_class_menu_stack_1_1_menu')"><img src="closed.png" alt="-"/>&#160;Properties inherited from <a class="el" href="class_menu_stack_1_1_menu.html">MenuStack.Menu</a></td></tr>
 <tr class="memitem:aee81a1f11823976cb1007d04e371617f inherit properties_class_menu_stack_1_1_menu"><td class="memItemLeft" align="right" valign="top">string&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="class_menu_stack_1_1_menu.html#aee81a1f11823976cb1007d04e371617f">Name</a><code> [get]</code></td></tr>
 <tr class="memdesc:aee81a1f11823976cb1007d04e371617f inherit properties_class_menu_stack_1_1_menu"><td class="mdescLeft">&#160;</td><td class="mdescRight">The runtime name for this menu  <a href="class_menu_stack_1_1_menu.html#aee81a1f11823976cb1007d04e371617f">More...</a><br /></td></tr>

diff --git a/docs/functions.html b/docs/functions.html
@@ -63,6 +63,9 @@
 <div class="textblock">Here is a list of all documented class members with links to the class documentation for each member:</div>
 
 <h3><a id="index_a"></a>- a -</h3><ul>
+<li>AlwaysUseInitialSelected
+: <a class="el" href="class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a">MenuStack.Menu</a>
+</li>
 <li>AnimationLayer
 : <a class="el" href="class_menu_stack_1_1_animation_1_1_menu_animator.html#a0e6884b7af7397c0031e80c2b2a6bfd1">MenuStack.Animation.MenuAnimator</a>
 </li>
@@ -116,6 +119,9 @@ <h3><a id="index_g"></a>- g -</h3><ul>
 
 
 <h3><a id="index_i"></a>- i -</h3><ul>
+<li>InitialSelected
+: <a class="el" href="class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39">MenuStack.Menu</a>
+</li>
 <li>Interactable
 : <a class="el" href="class_menu_stack_1_1_menu.html#a0a3c946e6f59d62544a7b612566ff124">MenuStack.Menu</a>
 </li>

diff --git a/docs/functions_vars.html b/docs/functions_vars.html
@@ -61,6 +61,9 @@
 
 <div class="contents">
 &#160;<ul>
+<li>AlwaysUseInitialSelected
+: <a class="el" href="class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a">MenuStack.Menu</a>
+</li>
 <li>AnimationLayer
 : <a class="el" href="class_menu_stack_1_1_animation_1_1_menu_animator.html#a0e6884b7af7397c0031e80c2b2a6bfd1">MenuStack.Animation.MenuAnimator</a>
 </li>
@@ -76,6 +79,9 @@
 <li>DisableRuntimeMenuTagging
 : <a class="el" href="class_menu_stack_1_1_menu_root.html#a547c2b72a5875518fad4f42082b068e9">MenuStack.MenuRoot</a>
 </li>
+<li>InitialSelected
+: <a class="el" href="class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39">MenuStack.Menu</a>
+</li>
 <li>InteractionType
 : <a class="el" href="class_menu_stack_1_1_menu.html#a2c253f93e3bd6023098efcbe53efee4c">MenuStack.Menu</a>
 </li>

diff --git a/docs/search/all_0.js b/docs/search/all_0.js
@@ -1,4 +1,5 @@
 var searchData=
 [
+  ['alwaysuseinitialselected',['AlwaysUseInitialSelected',['../class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a',1,'MenuStack::Menu']]],
   ['animationlayer',['AnimationLayer',['../class_menu_stack_1_1_animation_1_1_menu_animator.html#a0e6884b7af7397c0031e80c2b2a6bfd1',1,'MenuStack::Animation::MenuAnimator']]]
 ];
diff --git a/docs/search/all_6.js b/docs/search/all_6.js
@@ -2,6 +2,7 @@ var searchData=
 [
   ['inavigator',['INavigator',['../interface_menu_stack_1_1_navigation_1_1_i_navigator.html',1,'MenuStack::Navigation']]],
   ['inavigatormethodnames',['INavigatorMethodNames',['../namespace_menu_stack_1_1_navigation.html#abe4f5a2cb0181c4053075b93da994456',1,'MenuStack::Navigation']]],
+  ['initialselected',['InitialSelected',['../class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39',1,'MenuStack::Menu']]],
   ['interactable',['Interactable',['../class_menu_stack_1_1_menu.html#a0a3c946e6f59d62544a7b612566ff124',1,'MenuStack::Menu']]],
   ['interactabletype',['InteractableType',['../class_menu_stack_1_1_menu.html#af67e28d7803349cec9df96f340dfe157',1,'MenuStack::Menu']]],
   ['interactiontype',['InteractionType',['../class_menu_stack_1_1_menu.html#a2c253f93e3bd6023098efcbe53efee4c',1,'MenuStack::Menu']]]

diff --git a/docs/search/variables_0.js b/docs/search/variables_0.js
@@ -1,4 +1,5 @@
 var searchData=
 [
+  ['alwaysuseinitialselected',['AlwaysUseInitialSelected',['../class_menu_stack_1_1_menu.html#acbda1c597ecef4c2a67ed934c705e72a',1,'MenuStack::Menu']]],
   ['animationlayer',['AnimationLayer',['../class_menu_stack_1_1_animation_1_1_menu_animator.html#a0e6884b7af7397c0031e80c2b2a6bfd1',1,'MenuStack::Animation::MenuAnimator']]]
 ];
diff --git a/docs/search/variables_3.js b/docs/search/variables_3.js
@@ -1,4 +1,5 @@
 var searchData=
 [
+  ['initialselected',['InitialSelected',['../class_menu_stack_1_1_menu.html#aee3140d0907c1552efa3c2140bb5ec39',1,'MenuStack::Menu']]],
   ['interactiontype',['InteractionType',['../class_menu_stack_1_1_menu.html#a2c253f93e3bd6023098efcbe53efee4c',1,'MenuStack::Menu']]]
 ];