AfflictionNetworks/vilya
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
907eaa7014cde93e994514299f845079dafc5ad4
vilya/apidocs/com/threerings/parlor/client/TableService.html
T
Michael Bayne 907eaa7014 Updated docs for 1.6 release.
2015-03-14 10:44:30 -07:00

351 lines
14 KiB
HTML
Raw Blame History

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (1.8.0_31) on Sat Mar 14 10:07:08 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>TableService (Vilya Core 1.6 API)</title>
<meta name="date" content="2015-03-14">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="TableService (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.top.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TableService.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/parlor/client/TableObserver.html" title="interface in com.threerings.parlor.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/client/TableService.html" target="_top">Frames</a></li>
<li><a href="TableService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">com.threerings.parlor.client</div>
<h2 title="Interface TableService" class="title">Interface TableService</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd>com.threerings.presents.client.InvocationService</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../../com/threerings/parlor/data/TableMarshaller.html" title="class in com.threerings.parlor.data">TableMarshaller</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">TableService</span>
extends com.threerings.presents.client.InvocationService</pre>
<div class="block">Provides table lobbying services.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ======== NESTED CLASS SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="nested.class.summary">
<!-- -->
</a>
<h3>Nested Class Summary</h3>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.presents.client.InvocationService">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.presents.client.InvocationService</h3>
<code>com.threerings.presents.client.InvocationService.ConfirmListener, com.threerings.presents.client.InvocationService.InvocationListener, com.threerings.presents.client.InvocationService.ResultListener</code></li>
</ul>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method.summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd">&nbsp;</span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd">&nbsp;</span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd">&nbsp;</span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/TableService.html#bootPlayer-int-com.threerings.util.Name-com.threerings.presents.client.InvocationService.InvocationListener-">bootPlayer</a></span>(int&nbsp;tableId,
com.threerings.util.Name&nbsp;target,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</code>
<div class="block">Requests that another user be booted from the specified table.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/TableService.html#createTable-com.threerings.parlor.data.TableConfig-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ResultListener-">createTable</a></span>(<a href="../../../../com/threerings/parlor/data/TableConfig.html" title="class in com.threerings.parlor.data">TableConfig</a>&nbsp;tableConfig,
<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;config,
com.threerings.presents.client.InvocationService.ResultListener&nbsp;listener)</code>
<div class="block">Requests that a new table be created.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/TableService.html#joinTable-int-int-com.threerings.presents.client.InvocationService.InvocationListener-">joinTable</a></span>(int&nbsp;tableId,
int&nbsp;position,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</code>
<div class="block">Requests that the current user be added to the specified table at the specified position.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/TableService.html#leaveTable-int-com.threerings.presents.client.InvocationService.InvocationListener-">leaveTable</a></span>(int&nbsp;tableId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</code>
<div class="block">Requests that the current user be removed from the specified table.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../com/threerings/parlor/client/TableService.html#startTableNow-int-com.threerings.presents.client.InvocationService.InvocationListener-">startTableNow</a></span>(int&nbsp;tableId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</code>
<div class="block">Requests that the specified table be started now, even if all seats are not occupied.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="createTable-com.threerings.parlor.data.TableConfig-com.threerings.parlor.game.data.GameConfig-com.threerings.presents.client.InvocationService.ResultListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>createTable</h4>
<pre>void&nbsp;createTable(<a href="../../../../com/threerings/parlor/data/TableConfig.html" title="class in com.threerings.parlor.data">TableConfig</a>&nbsp;tableConfig,
<a href="../../../../com/threerings/parlor/game/data/GameConfig.html" title="class in com.threerings.parlor.game.data">GameConfig</a>&nbsp;config,
com.threerings.presents.client.InvocationService.ResultListener&nbsp;listener)</pre>
<div class="block">Requests that a new table be created.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tableConfig</code> - the table configuration parameters.</dd>
<dd><code>config</code> - the game config for the game to be matchmade by the table.</dd>
<dd><code>listener</code> - will receive and process the response.</dd>
</dl>
</li>
</ul>
<a name="joinTable-int-int-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>joinTable</h4>
<pre>void&nbsp;joinTable(int&nbsp;tableId,
int&nbsp;position,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</pre>
<div class="block">Requests that the current user be added to the specified table at the specified position.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tableId</code> - the unique id of the table to which this user wishes to be added.</dd>
<dd><code>position</code> - the position at the table to which this user desires to be added.</dd>
<dd><code>listener</code> - will receive and process the response.</dd>
</dl>
</li>
</ul>
<a name="leaveTable-int-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>leaveTable</h4>
<pre>void&nbsp;leaveTable(int&nbsp;tableId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</pre>
<div class="block">Requests that the current user be removed from the specified table.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>tableId</code> - the unique id of the table from which this user wishes to be removed.</dd>
<dd><code>listener</code> - will receive and process the response.</dd>
</dl>
</li>
</ul>
<a name="startTableNow-int-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startTableNow</h4>
<pre>void&nbsp;startTableNow(int&nbsp;tableId,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</pre>
<div class="block">Requests that the specified table be started now, even if all seats are not occupied. This
will always fail if called by any other player than that seated in position 0 (usually the
creator).</div>
</li>
</ul>
<a name="bootPlayer-int-com.threerings.util.Name-com.threerings.presents.client.InvocationService.InvocationListener-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>bootPlayer</h4>
<pre>void&nbsp;bootPlayer(int&nbsp;tableId,
com.threerings.util.Name&nbsp;target,
com.threerings.presents.client.InvocationService.InvocationListener&nbsp;listener)</pre>
<div class="block">Requests that another user be booted from the specified table.</div>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar.bottom">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<a name="navbar.bottom.firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/TableService.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../index-all.html">Index</a></li>
<li><a href="../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../com/threerings/parlor/client/TableObserver.html" title="interface in com.threerings.parlor.client"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li>Next&nbsp;Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/client/TableService.html" target="_top">Frames</a></li>
<li><a href="TableService.html" target="_top">No&nbsp;Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All&nbsp;Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary:&nbsp;</li>
<li>Nested&nbsp;|&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li>Constr&nbsp;|&nbsp;</li>
<li><a href="#method.detail">Method</a></li>
</ul>
</div>
<a name="skip.navbar.bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright &#169; 2015. All rights reserved.</small></p>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink