fork/livesplit-core

git clone https://git.julia.blue/fork/livesplit-core

Christopher SerrAdd docsee16b86

v0.11.0
30.7 KiB615 linesraw
1<!doctype html>
2<html class="default no-js">
3<head>
4	<meta charset="utf-8">
5	<meta http-equiv="X-UA-Compatible" content="IE=edge">
6	<title>LayoutEditorRefMut | livesplit</title>
7	<meta name="description" content="">
8	<meta name="viewport" content="width=device-width, initial-scale=1">
9	<link rel="stylesheet" href="../assets/css/main.css">
10</head>
11<body>
12<header>
13	<div class="tsd-page-toolbar">
14		<div class="container">
15			<div class="table-wrap">
16				<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
17					<div class="field">
18						<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
19						<input id="tsd-search-field" type="text" />
20					</div>
21					<ul class="results">
22						<li class="state loading">Preparing search index...</li>
23						<li class="state failure">The search index is not available</li>
24					</ul>
25					<a href="../index.html" class="title">livesplit</a>
26				</div>
27				<div class="table-cell" id="tsd-widgets">
28					<div id="tsd-filter">
29						<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
30						<div class="tsd-filter-group">
31							<div class="tsd-select" id="tsd-filter-visibility">
32								<span class="tsd-select-label">All</span>
33								<ul class="tsd-select-list">
34									<li data-value="public">Public</li>
35									<li data-value="protected">Public/Protected</li>
36									<li data-value="private" class="selected">All</li>
37								</ul>
38							</div>
39							<input type="checkbox" id="tsd-filter-inherited" checked />
40							<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
41							<input type="checkbox" id="tsd-filter-externals" checked />
42							<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
43							<input type="checkbox" id="tsd-filter-only-exported" />
44							<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
45						</div>
46					</div>
47					<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
48				</div>
49			</div>
50		</div>
51	</div>
52	<div class="tsd-page-title">
53		<div class="container">
54			<ul class="tsd-breadcrumb">
55				<li>
56					<a href="../globals.html">Globals</a>
57				</li>
58				<li>
59					<a href="layouteditorrefmut.html">LayoutEditorRefMut</a>
60				</li>
61			</ul>
62			<h1>Class LayoutEditorRefMut</h1>
63		</div>
64	</div>
65</header>
66<div class="container container-main">
67	<div class="row">
68		<div class="col-8 col-content">
69			<section class="tsd-panel tsd-comment">
70				<div class="tsd-comment tsd-typography">
71					<div class="lead">
72						<p>The Layout Editor allows modifying Layouts while ensuring all the different
73							invariants of the Layout objects are upheld no matter what kind of
74							operations are being applied. It provides the current state of the editor as
75						state objects that can be visualized by any kind of User Interface.</p>
76					</div>
77				</div>
78			</section>
79			<section class="tsd-panel tsd-hierarchy">
80				<h3>Hierarchy</h3>
81				<ul class="tsd-hierarchy">
82					<li>
83						<a href="layouteditorref.html" class="tsd-signature-type">LayoutEditorRef</a>
84						<ul class="tsd-hierarchy">
85							<li>
86								<span class="target">LayoutEditorRefMut</span>
87								<ul class="tsd-hierarchy">
88									<li>
89										<a href="layouteditor.html" class="tsd-signature-type">LayoutEditor</a>
90									</li>
91								</ul>
92							</li>
93						</ul>
94					</li>
95				</ul>
96			</section>
97			<section class="tsd-panel-group tsd-index-group">
98				<h2>Index</h2>
99				<section class="tsd-panel tsd-index-panel">
100					<div class="tsd-index-content">
101						<section class="tsd-index-section tsd-is-inherited">
102							<h3>Constructors</h3>
103							<ul class="tsd-index-list">
104								<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><a href="layouteditorrefmut.html#constructor" class="tsd-kind-icon">constructor</a></li>
105							</ul>
106						</section>
107						<section class="tsd-index-section tsd-is-inherited">
108							<h3>Properties</h3>
109							<ul class="tsd-index-list">
110								<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><a href="layouteditorrefmut.html#ptr" class="tsd-kind-icon">ptr</a></li>
111							</ul>
112						</section>
113						<section class="tsd-index-section ">
114							<h3>Methods</h3>
115							<ul class="tsd-index-list">
116								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#addcomponent" class="tsd-kind-icon">add<wbr>Component</a></li>
117								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#duplicatecomponent" class="tsd-kind-icon">duplicate<wbr>Component</a></li>
118								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#layoutstateasjson" class="tsd-kind-icon">layout<wbr>State<wbr>AsJson</a></li>
119								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#movecomponent" class="tsd-kind-icon">move<wbr>Component</a></li>
120								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#movecomponentdown" class="tsd-kind-icon">move<wbr>Component<wbr>Down</a></li>
121								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#movecomponentup" class="tsd-kind-icon">move<wbr>Component<wbr>Up</a></li>
122								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#removecomponent" class="tsd-kind-icon">remove<wbr>Component</a></li>
123								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#select" class="tsd-kind-icon">select</a></li>
124								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#setcomponentsettingsvalue" class="tsd-kind-icon">set<wbr>Component<wbr>Settings<wbr>Value</a></li>
125								<li class="tsd-kind-method tsd-parent-kind-class"><a href="layouteditorrefmut.html#setgeneralsettingsvalue" class="tsd-kind-icon">set<wbr>General<wbr>Settings<wbr>Value</a></li>
126								<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><a href="layouteditorrefmut.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a></li>
127							</ul>
128						</section>
129					</div>
130				</section>
131			</section>
132			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
133				<h2>Constructors</h2>
134				<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
135					<a name="constructor" class="tsd-anchor"></a>
136					<h3>constructor</h3>
137					<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
138						<li class="tsd-signature tsd-kind-icon">new <wbr>Layout<wbr>Editor<wbr>Ref<wbr>Mut<span class="tsd-signature-symbol">(</span>ptr<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="layouteditorrefmut.html" class="tsd-signature-type">LayoutEditorRefMut</a></li>
139					</ul>
140					<ul class="tsd-descriptions">
141						<li class="tsd-description">
142							<aside class="tsd-sources">
143								<p>Inherited from <a href="layouteditorref.html">LayoutEditorRef</a>.<a href="layouteditorref.html#constructor">constructor</a></p>
144								<ul>
145									<li>Defined in livesplit_core.ts:3160</li>
146								</ul>
147							</aside>
148							<div class="tsd-comment tsd-typography">
149								<div class="lead">
150									<p>This constructor is an implementation detail. Do not use this.</p>
151								</div>
152							</div>
153							<h4 class="tsd-parameters-title">Parameters</h4>
154							<ul class="tsd-parameters">
155								<li>
156									<h5>ptr: <span class="tsd-signature-type">number</span></h5>
157								</li>
158							</ul>
159							<h4 class="tsd-returns-title">Returns <a href="layouteditorrefmut.html" class="tsd-signature-type">LayoutEditorRefMut</a></h4>
160						</li>
161					</ul>
162				</section>
163			</section>
164			<section class="tsd-panel-group tsd-member-group tsd-is-inherited">
165				<h2>Properties</h2>
166				<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
167					<a name="ptr" class="tsd-anchor"></a>
168					<h3>ptr</h3>
169					<div class="tsd-signature tsd-kind-icon">ptr<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span></div>
170					<aside class="tsd-sources">
171						<p>Inherited from <a href="layouteditorref.html">LayoutEditorRef</a>.<a href="layouteditorref.html#ptr">ptr</a></p>
172						<ul>
173							<li>Defined in livesplit_core.ts:3150</li>
174						</ul>
175					</aside>
176				</section>
177			</section>
178			<section class="tsd-panel-group tsd-member-group ">
179				<h2>Methods</h2>
180				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
181					<a name="addcomponent" class="tsd-anchor"></a>
182					<h3>add<wbr>Component</h3>
183					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
184						<li class="tsd-signature tsd-kind-icon">add<wbr>Component<span class="tsd-signature-symbol">(</span>component<span class="tsd-signature-symbol">: </span><a href="component.html" class="tsd-signature-type">Component</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
185					</ul>
186					<ul class="tsd-descriptions">
187						<li class="tsd-description">
188							<aside class="tsd-sources">
189								<ul>
190									<li>Defined in livesplit_core.ts:3206</li>
191								</ul>
192							</aside>
193							<div class="tsd-comment tsd-typography">
194								<div class="lead">
195									<p>Adds the component provided to the end of the layout. The newly added
196									component becomes the selected component.</p>
197								</div>
198							</div>
199							<h4 class="tsd-parameters-title">Parameters</h4>
200							<ul class="tsd-parameters">
201								<li>
202									<h5>component: <a href="component.html" class="tsd-signature-type">Component</a></h5>
203								</li>
204							</ul>
205							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
206						</li>
207					</ul>
208				</section>
209				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
210					<a name="duplicatecomponent" class="tsd-anchor"></a>
211					<h3>duplicate<wbr>Component</h3>
212					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
213						<li class="tsd-signature tsd-kind-icon">duplicate<wbr>Component<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
214					</ul>
215					<ul class="tsd-descriptions">
216						<li class="tsd-description">
217							<aside class="tsd-sources">
218								<ul>
219									<li>Defined in livesplit_core.ts:3261</li>
220								</ul>
221							</aside>
222							<div class="tsd-comment tsd-typography">
223								<div class="lead">
224									<p>Duplicates the currently selected component. The copy gets placed right
225									after the selected component and becomes the newly selected component.</p>
226								</div>
227							</div>
228							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
229						</li>
230					</ul>
231				</section>
232				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
233					<a name="layoutstateasjson" class="tsd-anchor"></a>
234					<h3>layout<wbr>State<wbr>AsJson</h3>
235					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
236						<li class="tsd-signature tsd-kind-icon">layout<wbr>State<wbr>AsJson<span class="tsd-signature-symbol">(</span>timer<span class="tsd-signature-symbol">: </span><a href="timerref.html" class="tsd-signature-type">TimerRef</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
237					</ul>
238					<ul class="tsd-descriptions">
239						<li class="tsd-description">
240							<aside class="tsd-sources">
241								<ul>
242									<li>Defined in livesplit_core.ts:3181</li>
243								</ul>
244							</aside>
245							<div class="tsd-comment tsd-typography">
246								<div class="lead">
247									<p>Encodes the layout&#39;s state as JSON based on the timer provided. You can use
248										this to visualize all of the components of a layout, while it is still being
249									edited by the Layout Editor.</p>
250								</div>
251							</div>
252							<h4 class="tsd-parameters-title">Parameters</h4>
253							<ul class="tsd-parameters">
254								<li>
255									<h5>timer: <a href="timerref.html" class="tsd-signature-type">TimerRef</a></h5>
256								</li>
257							</ul>
258							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
259						</li>
260					</ul>
261				</section>
262				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
263					<a name="movecomponent" class="tsd-anchor"></a>
264					<h3>move<wbr>Component</h3>
265					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
266						<li class="tsd-signature tsd-kind-icon">move<wbr>Component<span class="tsd-signature-symbol">(</span>dstIndex<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
267					</ul>
268					<ul class="tsd-descriptions">
269						<li class="tsd-description">
270							<aside class="tsd-sources">
271								<ul>
272									<li>Defined in livesplit_core.ts:3251</li>
273								</ul>
274							</aside>
275							<div class="tsd-comment tsd-typography">
276								<div class="lead">
277									<p>Moves the selected component to the index provided. You may not provide
278									an invalid index.</p>
279								</div>
280							</div>
281							<h4 class="tsd-parameters-title">Parameters</h4>
282							<ul class="tsd-parameters">
283								<li>
284									<h5>dstIndex: <span class="tsd-signature-type">number</span></h5>
285								</li>
286							</ul>
287							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
288						</li>
289					</ul>
290				</section>
291				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
292					<a name="movecomponentdown" class="tsd-anchor"></a>
293					<h3>move<wbr>Component<wbr>Down</h3>
294					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
295						<li class="tsd-signature tsd-kind-icon">move<wbr>Component<wbr>Down<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
296					</ul>
297					<ul class="tsd-descriptions">
298						<li class="tsd-description">
299							<aside class="tsd-sources">
300								<ul>
301									<li>Defined in livesplit_core.ts:3241</li>
302								</ul>
303							</aside>
304							<div class="tsd-comment tsd-typography">
305								<div class="lead">
306									<p>Moves the selected component down, unless the last component is
307									selected.</p>
308								</div>
309							</div>
310							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
311						</li>
312					</ul>
313				</section>
314				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
315					<a name="movecomponentup" class="tsd-anchor"></a>
316					<h3>move<wbr>Component<wbr>Up</h3>
317					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
318						<li class="tsd-signature tsd-kind-icon">move<wbr>Component<wbr>Up<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
319					</ul>
320					<ul class="tsd-descriptions">
321						<li class="tsd-description">
322							<aside class="tsd-sources">
323								<ul>
324									<li>Defined in livesplit_core.ts:3231</li>
325								</ul>
326							</aside>
327							<div class="tsd-comment tsd-typography">
328								<div class="lead">
329									<p>Moves the selected component up, unless the first component is selected.</p>
330								</div>
331							</div>
332							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
333						</li>
334					</ul>
335				</section>
336				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
337					<a name="removecomponent" class="tsd-anchor"></a>
338					<h3>remove<wbr>Component</h3>
339					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
340						<li class="tsd-signature tsd-kind-icon">remove<wbr>Component<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
341					</ul>
342					<ul class="tsd-descriptions">
343						<li class="tsd-description">
344							<aside class="tsd-sources">
345								<ul>
346									<li>Defined in livesplit_core.ts:3222</li>
347								</ul>
348							</aside>
349							<div class="tsd-comment tsd-typography">
350								<div class="lead">
351									<p>Removes the currently selected component, unless there&#39;s only one
352										component in the layout. The next component becomes the selected
353										component. If there&#39;s none, the previous component becomes the selected
354									component instead.</p>
355								</div>
356							</div>
357							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
358						</li>
359					</ul>
360				</section>
361				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
362					<a name="select" class="tsd-anchor"></a>
363					<h3>select</h3>
364					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
365						<li class="tsd-signature tsd-kind-icon">select<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
366					</ul>
367					<ul class="tsd-descriptions">
368						<li class="tsd-description">
369							<aside class="tsd-sources">
370								<ul>
371									<li>Defined in livesplit_core.ts:3196</li>
372								</ul>
373							</aside>
374							<div class="tsd-comment tsd-typography">
375								<div class="lead">
376									<p>Selects the component with the given index in order to modify its
377										settings. Only a single component is selected at any given time. You may
378									not provide an invalid index.</p>
379								</div>
380							</div>
381							<h4 class="tsd-parameters-title">Parameters</h4>
382							<ul class="tsd-parameters">
383								<li>
384									<h5>index: <span class="tsd-signature-type">number</span></h5>
385								</li>
386							</ul>
387							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
388						</li>
389					</ul>
390				</section>
391				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
392					<a name="setcomponentsettingsvalue" class="tsd-anchor"></a>
393					<h3>set<wbr>Component<wbr>Settings<wbr>Value</h3>
394					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
395						<li class="tsd-signature tsd-kind-icon">set<wbr>Component<wbr>Settings<wbr>Value<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, value<span class="tsd-signature-symbol">: </span><a href="settingvalue.html" class="tsd-signature-type">SettingValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
396					</ul>
397					<ul class="tsd-descriptions">
398						<li class="tsd-description">
399							<aside class="tsd-sources">
400								<ul>
401									<li>Defined in livesplit_core.ts:3275</li>
402								</ul>
403							</aside>
404							<div class="tsd-comment tsd-typography">
405								<div class="lead">
406									<p>Sets a setting&#39;s value of the selected component by its setting index
407									to the given value.</p>
408								</div>
409								<p>This panics if the type of the value to be set is not compatible with
410									the type of the setting&#39;s value. A panic can also occur if the index of
411								the setting provided is out of bounds.</p>
412							</div>
413							<h4 class="tsd-parameters-title">Parameters</h4>
414							<ul class="tsd-parameters">
415								<li>
416									<h5>index: <span class="tsd-signature-type">number</span></h5>
417								</li>
418								<li>
419									<h5>value: <a href="settingvalue.html" class="tsd-signature-type">SettingValue</a></h5>
420								</li>
421							</ul>
422							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
423						</li>
424					</ul>
425				</section>
426				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
427					<a name="setgeneralsettingsvalue" class="tsd-anchor"></a>
428					<h3>set<wbr>General<wbr>Settings<wbr>Value</h3>
429					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
430						<li class="tsd-signature tsd-kind-icon">set<wbr>General<wbr>Settings<wbr>Value<span class="tsd-signature-symbol">(</span>index<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, value<span class="tsd-signature-symbol">: </span><a href="settingvalue.html" class="tsd-signature-type">SettingValue</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
431					</ul>
432					<ul class="tsd-descriptions">
433						<li class="tsd-description">
434							<aside class="tsd-sources">
435								<ul>
436									<li>Defined in livesplit_core.ts:3293</li>
437								</ul>
438							</aside>
439							<div class="tsd-comment tsd-typography">
440								<div class="lead">
441									<p>Sets a setting&#39;s value of the general settings by its setting index to
442									the given value.</p>
443								</div>
444								<p>This panics if the type of the value to be set is not compatible with
445									the type of the setting&#39;s value. A panic can also occur if the index of
446								the setting provided is out of bounds.</p>
447							</div>
448							<h4 class="tsd-parameters-title">Parameters</h4>
449							<ul class="tsd-parameters">
450								<li>
451									<h5>index: <span class="tsd-signature-type">number</span></h5>
452								</li>
453								<li>
454									<h5>value: <a href="settingvalue.html" class="tsd-signature-type">SettingValue</a></h5>
455								</li>
456							</ul>
457							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
458						</li>
459					</ul>
460				</section>
461				<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
462					<a name="stateasjson" class="tsd-anchor"></a>
463					<h3>state<wbr>AsJson</h3>
464					<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
465						<li class="tsd-signature tsd-kind-icon">state<wbr>AsJson<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span></li>
466					</ul>
467					<ul class="tsd-descriptions">
468						<li class="tsd-description">
469							<aside class="tsd-sources">
470								<p>Inherited from <a href="layouteditorref.html">LayoutEditorRef</a>.<a href="layouteditorref.html#stateasjson">stateAsJson</a></p>
471								<ul>
472									<li>Defined in livesplit_core.ts:3154</li>
473								</ul>
474							</aside>
475							<div class="tsd-comment tsd-typography">
476								<div class="lead">
477									<p>Encodes the Layout Editor&#39;s state as JSON in order to visualize it.</p>
478								</div>
479							</div>
480							<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">any</span></h4>
481						</li>
482					</ul>
483				</section>
484			</section>
485		</div>
486		<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
487			<nav class="tsd-navigation primary">
488				<ul>
489					<li class="globals  ">
490						<a href="../globals.html"><em>Globals</em></a>
491					</li>
492				</ul>
493			</nav>
494			<nav class="tsd-navigation secondary menu-sticky">
495				<ul class="before-current">
496				</ul>
497				<ul class="current">
498					<li class="current tsd-kind-class">
499						<a href="layouteditorrefmut.html" class="tsd-kind-icon">Layout<wbr>Editor<wbr>Ref<wbr>Mut</a>
500						<ul>
501							<li class=" tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited">
502								<a href="layouteditorrefmut.html#constructor" class="tsd-kind-icon">constructor</a>
503							</li>
504							<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-inherited">
505								<a href="layouteditorrefmut.html#ptr" class="tsd-kind-icon">ptr</a>
506							</li>
507							<li class=" tsd-kind-method tsd-parent-kind-class">
508								<a href="layouteditorrefmut.html#addcomponent" class="tsd-kind-icon">add<wbr>Component</a>
509							</li>
510							<li class=" tsd-kind-method tsd-parent-kind-class">
511								<a href="layouteditorrefmut.html#duplicatecomponent" class="tsd-kind-icon">duplicate<wbr>Component</a>
512							</li>
513							<li class=" tsd-kind-method tsd-parent-kind-class">
514								<a href="layouteditorrefmut.html#layoutstateasjson" class="tsd-kind-icon">layout<wbr>State<wbr>AsJson</a>
515							</li>
516							<li class=" tsd-kind-method tsd-parent-kind-class">
517								<a href="layouteditorrefmut.html#movecomponent" class="tsd-kind-icon">move<wbr>Component</a>
518							</li>
519							<li class=" tsd-kind-method tsd-parent-kind-class">
520								<a href="layouteditorrefmut.html#movecomponentdown" class="tsd-kind-icon">move<wbr>Component<wbr>Down</a>
521							</li>
522							<li class=" tsd-kind-method tsd-parent-kind-class">
523								<a href="layouteditorrefmut.html#movecomponentup" class="tsd-kind-icon">move<wbr>Component<wbr>Up</a>
524							</li>
525							<li class=" tsd-kind-method tsd-parent-kind-class">
526								<a href="layouteditorrefmut.html#removecomponent" class="tsd-kind-icon">remove<wbr>Component</a>
527							</li>
528							<li class=" tsd-kind-method tsd-parent-kind-class">
529								<a href="layouteditorrefmut.html#select" class="tsd-kind-icon">select</a>
530							</li>
531							<li class=" tsd-kind-method tsd-parent-kind-class">
532								<a href="layouteditorrefmut.html#setcomponentsettingsvalue" class="tsd-kind-icon">set<wbr>Component<wbr>Settings<wbr>Value</a>
533							</li>
534							<li class=" tsd-kind-method tsd-parent-kind-class">
535								<a href="layouteditorrefmut.html#setgeneralsettingsvalue" class="tsd-kind-icon">set<wbr>General<wbr>Settings<wbr>Value</a>
536							</li>
537							<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-inherited">
538								<a href="layouteditorrefmut.html#stateasjson" class="tsd-kind-icon">state<wbr>AsJson</a>
539							</li>
540						</ul>
541					</li>
542				</ul>
543				<ul class="after-current">
544				</ul>
545			</nav>
546		</div>
547	</div>
548</div>
549<footer class="with-border-bottom">
550	<div class="container">
551		<h2>Legend</h2>
552		<div class="tsd-legend-group">
553			<ul class="tsd-legend">
554				<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
555				<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
556				<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
557				<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
558				<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
559				<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
560				<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
561			</ul>
562			<ul class="tsd-legend">
563				<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
564				<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
565				<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
566				<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
567			</ul>
568			<ul class="tsd-legend">
569				<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
570				<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
571				<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
572				<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
573				<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
574				<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
575			</ul>
576			<ul class="tsd-legend">
577				<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
578				<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
579				<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
580				<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
581				<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
582				<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
583				<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
584			</ul>
585			<ul class="tsd-legend">
586				<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
587				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
588				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
589				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
590			</ul>
591			<ul class="tsd-legend">
592				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
593				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
594				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
595			</ul>
596			<ul class="tsd-legend">
597				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
598				<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
599				<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
600			</ul>
601			<ul class="tsd-legend">
602				<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
603				<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
604			</ul>
605		</div>
606	</div>
607</footer>
608<div class="container tsd-generator">
609	<p>Generated using <a href="http://typedoc.org/" target="_blank">TypeDoc</a></p>
610</div>
611<div class="overlay"></div>
612<script src="../assets/js/main.js"></script>
613<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
614</body>
615</html>