322 lines
6.9 KiB
HTML
322 lines
6.9 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<head>
|
|
<meta charset='UTF-8'>
|
|
<title>CoffeeScript API Documentation</title>
|
|
<script src='../javascript/application.js'></script>
|
|
<script src='../javascript/search.js'></script>
|
|
<link rel='stylesheet' href='../stylesheets/application.css' type='text/css'>
|
|
</head>
|
|
<body>
|
|
<div id='base' data-path='../'></div>
|
|
<div id='header'>
|
|
<div id='menu'>
|
|
<a href='../extra/README.md.html' title='Yatta'>
|
|
Yatta
|
|
</a>
|
|
»
|
|
<a href='../alphabetical_index.html' title='Index'>
|
|
Index
|
|
</a>
|
|
»
|
|
<span class='title'>Engine</span>
|
|
</div>
|
|
</div>
|
|
<div id='content'>
|
|
<h1>
|
|
Class:
|
|
Engine
|
|
</h1>
|
|
<table class='box'>
|
|
<tr>
|
|
<td>Defined in:</td>
|
|
<td>lib/Engine.coffee</td>
|
|
</tr>
|
|
</table>
|
|
<h2>Overview</h2>
|
|
<div class='docstring'>
|
|
<p>The Engine handles how and in which order to execute operations and add operations to the HistoryBuffer.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
<h2>Instance Method Summary</h2>
|
|
<ul class='summary'>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#parseOperation-dynamic'>
|
|
#
|
|
(void)
|
|
<b>parseOperation</b><span>(json)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Parses an operatio from the json format.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#applyOpsBundle-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyOpsBundle</b><span>(ops_json)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Apply a set of operations.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#applyOpsCheckDouble-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyOpsCheckDouble</b><span>(ops_json)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Same as applyOps but operations that are already in the HB are not applied.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#applyOps-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyOps</b><span>(ops_json)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Apply a set of operations.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#applyOp-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyOp</b><span>(op_json)</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Apply an operation that you received from another peer.
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='signature'>
|
|
<a href='#tryUnprocessed-dynamic'>
|
|
#
|
|
(void)
|
|
<b>tryUnprocessed</b><span>()</span>
|
|
</a>
|
|
</span>
|
|
<span class='desc'>
|
|
Call this method when you applied a new operation.
|
|
</span>
|
|
</li>
|
|
</ul>
|
|
<h2>Constructor Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='constructor-dynamic'>
|
|
#
|
|
(void)
|
|
<b>constructor</b><span>(HB, parser)</span>
|
|
<br>
|
|
</p>
|
|
<div class='tags'>
|
|
<h3>Parameters:</h3>
|
|
<ul class='param'>
|
|
<li>
|
|
<span class='name'>HB</span>
|
|
<span class='type'>
|
|
(
|
|
<tt><a href='../class/HistoryBuffer.html'>HistoryBuffer</a></tt>
|
|
)
|
|
</span>
|
|
</li>
|
|
<li>
|
|
<span class='name'>parser</span>
|
|
<span class='type'>
|
|
(
|
|
<tt>Array</tt>
|
|
)
|
|
</span>
|
|
—
|
|
<span class='desc'>Defines how to parse encoded messages. </span>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<h2>Instance Method Details</h2>
|
|
<div class='methods'>
|
|
<div class='method_details'>
|
|
<p class='signature' id='parseOperation-dynamic'>
|
|
#
|
|
(void)
|
|
<b>parseOperation</b><span>(json)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Parses an operatio from the json format. It uses the specified parser in your OperationType module.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='applyOpsBundle-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyOpsBundle</b><span>(ops_json)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<div class='note'>
|
|
<strong>Note:</strong>
|
|
You must not use this method when you already have ops in your HB!
|
|
</div>
|
|
<p>Apply a set of operations. E.g. the operations you received from another users HB.toJson().</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='applyOpsCheckDouble-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyOpsCheckDouble</b><span>(ops_json)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Same as applyOps but operations that are already in the HB are not applied.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='Engine.applyOps'>Engine.applyOps</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='applyOps-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyOps</b><span>(ops_json)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Apply a set of operations. (Helper for using applyOp on Arrays)</p>
|
|
</div>
|
|
<div class='tags'>
|
|
<h3>See also:</h3>
|
|
<ul class='see'>
|
|
<li>
|
|
<a href='Engine.applyOp'>Engine.applyOp</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='applyOp-dynamic'>
|
|
#
|
|
(void)
|
|
<b>applyOp</b><span>(op_json)</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Apply an operation that you received from another peer.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
<div class='method_details'>
|
|
<p class='signature' id='tryUnprocessed-dynamic'>
|
|
#
|
|
(void)
|
|
<b>tryUnprocessed</b><span>()</span>
|
|
<br>
|
|
</p>
|
|
<div class='docstring'>
|
|
<p>Call this method when you applied a new operation.
|
|
It checks if operations that were previously not executable are now executable.</p>
|
|
</div>
|
|
<div class='tags'>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div id='footer'>
|
|
August 12, 14 06:33:02 by
|
|
<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
|
|
Codo
|
|
</a>
|
|
2.0.9
|
|
✲
|
|
Press H to see the keyboard shortcuts
|
|
✲
|
|
<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
|
|
✲
|
|
<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
|
|
</div>
|
|
<iframe id='search_frame'></iframe>
|
|
<div id='fuzzySearch'>
|
|
<input type='text'>
|
|
<ol></ol>
|
|
</div>
|
|
<div id='help'>
|
|
<p>
|
|
Quickly fuzzy find classes, mixins, methods, file:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>T</span>
|
|
Open fuzzy finder dialog
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
Control the navigation frame:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>L</span>
|
|
Toggle list view
|
|
</li>
|
|
<li>
|
|
<span>C</span>
|
|
Show class list
|
|
</li>
|
|
<li>
|
|
<span>I</span>
|
|
Show mixin list
|
|
</li>
|
|
<li>
|
|
<span>F</span>
|
|
Show file list
|
|
</li>
|
|
<li>
|
|
<span>M</span>
|
|
Show method list
|
|
</li>
|
|
<li>
|
|
<span>E</span>
|
|
Show extras list
|
|
</li>
|
|
</ul>
|
|
<p>
|
|
You can focus and blur the search input:
|
|
</p>
|
|
<ul>
|
|
<li>
|
|
<span>S</span>
|
|
Focus search input
|
|
</li>
|
|
<li>
|
|
<span>Esc</span>
|
|
Blur search input
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html> |