uLua-docs/classu_lua_1_1_lua_expose_sequencer.html at main · antunity/uLua-docs · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>uLua: uLua.LuaExposeSequencer 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="navtreedata.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></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 id="projectrow">
  <td id="projectalign">
   <div id="projectname">uLua<span id="projectnumber">&#160;v3.1.0</span>
   </div>
   <div id="projectbrief">A Lua Modding Framework for Unity.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></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">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(document).ready(function(){initNavTree('classu_lua_1_1_lua_expose_sequencer.html',''); initResizable(); });
/* @license-end */
</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)">
</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> &#124;
<a href="#properties">Properties</a> &#124;
<a href="classu_lua_1_1_lua_expose_sequencer-members.html">List of all members</a>  </div>
  <div class="headertitle"><div class="title">uLua.LuaExposeSequencer Class Reference</div></div>
</div><!--header-->
<div class="contents">

<p>A sequencing class to control the order in which objects are exposed to Lua.
 <a href="classu_lua_1_1_lua_expose_sequencer.html#details">More...</a></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="pub-methods" name="pub-methods"></a>
Public Member Functions</h2></td></tr>
<tr class="memitem:a84909505f63ffb002bd9eb261112f3af"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_expose_sequencer.html#a84909505f63ffb002bd9eb261112f3af">AddExposeInstruction</a> (<a class="el" href="namespaceu_lua.html#a1f80e2b75fa116855258258b8870cc3f">ExposeTarget</a> exposeTarget, MonoBehaviour targetMonoBehaviour, string luaName, <a class="el" href="classu_lua_1_1_lua_object.html">LuaObject</a> luaParent=null, bool enableObjectScript=false)</td></tr>
<tr class="memdesc:a84909505f63ffb002bd9eb261112f3af"><td class="mdescLeft">&#160;</td><td class="mdescRight">Adds an expose instruction to the sequencer. <a href="classu_lua_1_1_lua_expose_sequencer.html#a84909505f63ffb002bd9eb261112f3af">More...</a><br /></td></tr>
<tr class="separator:a84909505f63ffb002bd9eb261112f3af"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8c21f011080447bf4bf603464f178070"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_expose_sequencer.html#a8c21f011080447bf4bf603464f178070">RemoveExposeInstruction</a> (MonoBehaviour targetMonoBehaviour)</td></tr>
<tr class="memdesc:a8c21f011080447bf4bf603464f178070"><td class="mdescLeft">&#160;</td><td class="mdescRight">Removes an expose instruction from the sequencer. <a href="classu_lua_1_1_lua_expose_sequencer.html#a8c21f011080447bf4bf603464f178070">More...</a><br /></td></tr>
<tr class="separator:a8c21f011080447bf4bf603464f178070"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a85f1ef5d58c3ad30dff16c35f2811c3a"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="classu_lua_1_1_lua_expose_sequencer.html#a85f1ef5d58c3ad30dff16c35f2811c3a">ExecuteExposeSequence</a> (<a class="el" href="namespaceu_lua.html#a1f80e2b75fa116855258258b8870cc3f">ExposeTarget</a> exposeTarget)</td></tr>
<tr class="memdesc:a85f1ef5d58c3ad30dff16c35f2811c3a"><td class="mdescLeft">&#160;</td><td class="mdescRight">Executes the expose instructions for a specific target event. <a href="classu_lua_1_1_lua_expose_sequencer.html#a85f1ef5d58c3ad30dff16c35f2811c3a">More...</a><br /></td></tr>
<tr class="separator:a85f1ef5d58c3ad30dff16c35f2811c3a"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="properties" name="properties"></a>
Properties</h2></td></tr>
<tr class="memitem:a25f0f27c78a32745a69b0ea27b1171cf"><td class="memItemLeft" align="right" valign="top"><a id="a25f0f27c78a32745a69b0ea27b1171cf" name="a25f0f27c78a32745a69b0ea27b1171cf"></a>
int&#160;</td><td class="memItemRight" valign="bottom"><b>Count</b><code> [get]</code></td></tr>
<tr class="memdesc:a25f0f27c78a32745a69b0ea27b1171cf"><td class="mdescLeft">&#160;</td><td class="mdescRight">Returns the number of expose instructions in the sequencer.<br /></td></tr>
<tr class="separator:a25f0f27c78a32745a69b0ea27b1171cf"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p >A sequencing class to control the order in which objects are exposed to Lua.</p>
</div><h2 class="groupheader">Member Function Documentation</h2>
<a id="a84909505f63ffb002bd9eb261112f3af" name="a84909505f63ffb002bd9eb261112f3af"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a84909505f63ffb002bd9eb261112f3af">&#9670;&nbsp;</a></span>AddExposeInstruction()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void uLua.LuaExposeSequencer.AddExposeInstruction </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceu_lua.html#a1f80e2b75fa116855258258b8870cc3f">ExposeTarget</a>&#160;</td>
          <td class="paramname"><em>exposeTarget</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">MonoBehaviour&#160;</td>
          <td class="paramname"><em>targetMonoBehaviour</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">string&#160;</td>
          <td class="paramname"><em>luaName</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="classu_lua_1_1_lua_object.html">LuaObject</a>&#160;</td>
          <td class="paramname"><em>luaParent</em> = <code>null</code>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype">bool&#160;</td>
          <td class="paramname"><em>enableObjectScript</em> = <code>false</code>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Adds an expose instruction to the sequencer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">exposeTarget</td><td>The target event to expose the MonoBehaviour on.</td></tr>
    <tr><td class="paramname">targetMonoBehaviour</td><td>The MonoBehaviour to expose.</td></tr>
    <tr><td class="paramname">luaName</td><td>The Lua name to expose the MonoBehaviour as.</td></tr>
    <tr><td class="paramname">luaParent</td><td>The Lua parent of the MonoBehaviour, if any.</td></tr>
    <tr><td class="paramname">enableObjectScript</td><td>If true, the object script will be enabled after exposure.</td></tr>
  </table>
  </dd>
</dl>
<p >This method allows you to queue up MonoBehaviours to be exposed to Lua at specific points in the Unity lifecycle. The <code>exposeTarget</code> parameter determines when the MonoBehaviour will be exposed (e.g., Awake, Start, OnEnable, SceneLoaded). </p>

</div>
</div>
<a id="a85f1ef5d58c3ad30dff16c35f2811c3a" name="a85f1ef5d58c3ad30dff16c35f2811c3a"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a85f1ef5d58c3ad30dff16c35f2811c3a">&#9670;&nbsp;</a></span>ExecuteExposeSequence()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void uLua.LuaExposeSequencer.ExecuteExposeSequence </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="namespaceu_lua.html#a1f80e2b75fa116855258258b8870cc3f">ExposeTarget</a>&#160;</td>
          <td class="paramname"><em>exposeTarget</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Executes the expose instructions for a specific target event.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">exposeTarget</td><td>The target event to execute expose instructions for.</td></tr>
  </table>
  </dd>
</dl>

</div>
</div>
<a id="a8c21f011080447bf4bf603464f178070" name="a8c21f011080447bf4bf603464f178070"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8c21f011080447bf4bf603464f178070">&#9670;&nbsp;</a></span>RemoveExposeInstruction()</h2>

<div class="memitem">
<div class="memproto">
<table class="mlabels">
  <tr>
  <td class="mlabels-left">
      <table class="memname">
        <tr>
          <td class="memname">void uLua.LuaExposeSequencer.RemoveExposeInstruction </td>
          <td>(</td>
          <td class="paramtype">MonoBehaviour&#160;</td>
          <td class="paramname"><em>targetMonoBehaviour</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
  </td>
  <td class="mlabels-right">
<span class="mlabels"><span class="mlabel">inline</span></span>  </td>
  </tr>
</table>
</div><div class="memdoc">

<p>Removes an expose instruction from the sequencer.</p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">targetMonoBehaviour</td><td>The MonoBehaviour whose expose instruction should be removed.</td></tr>
  </table>
  </dd>
</dl>
<p >This method allows you to remove a specific MonoBehaviour's exposure instruction from the sequencer if it is no longer needed or if the MonoBehaviour has been destroyed. </p>

</div>
</div>
</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="namespaceu_lua.html">uLua</a></li><li class="navelem"><a class="el" href="classu_lua_1_1_lua_expose_sequencer.html">LuaExposeSequencer</a></li>
    <li class="footer">Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4 </li>
  </ul>
</div>
</body>
</html>