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

257 lines
11 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:12 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>com.threerings.parlor.client (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="com.threerings.parlor.client (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
</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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/card/trick/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../com/threerings/parlor/data/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/client/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<a name="skip.navbar.top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<div class="header">
<h1 title="Package" class="title">Package&nbsp;com.threerings.parlor.client</h1>
</div>
<div class="contentContainer">
<ul class="blockList">
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Interface Summary table, listing interfaces, and an explanation">
<caption><span>Interface Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Interface</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/GameReadyObserver.html" title="interface in com.threerings.parlor.client">GameReadyObserver</a></td>
<td class="colLast">
<div class="block">Used to inform interested parties when the <a href="../../../../com/threerings/parlor/client/ParlorDirector.html" title="class in com.threerings.parlor.client"><code>ParlorDirector</code></a>
receives a game ready notification.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/InvitationHandler.html" title="interface in com.threerings.parlor.client">InvitationHandler</a></td>
<td class="colLast">
<div class="block">A client entity that wishes to handle invitations received by other
clients should implement this interface and register itself with the
parlor director.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/InvitationResponseObserver.html" title="interface in com.threerings.parlor.client">InvitationResponseObserver</a></td>
<td class="colLast">
<div class="block">A client entity that wishes to generate invitations for games must
implement this interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/ParlorReceiver.html" title="interface in com.threerings.parlor.client">ParlorReceiver</a></td>
<td class="colLast">
<div class="block">Defines, for the parlor services, a set of notifications delivered
asynchronously by the server to the client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/ParlorService.html" title="interface in com.threerings.parlor.client">ParlorService</a></td>
<td class="colLast">
<div class="block">Provides an interface to the various parlor invocation services.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/ParlorService.InviteListener.html" title="interface in com.threerings.parlor.client">ParlorService.InviteListener</a></td>
<td class="colLast">
<div class="block">Used to communicate responses to <a href="../../../../com/threerings/parlor/client/ParlorService.html#invite-com.threerings.util.Name-com.threerings.parlor.game.data.GameConfig-com.threerings.parlor.client.ParlorService.InviteListener-"><code>ParlorService.invite(com.threerings.util.Name, com.threerings.parlor.game.data.GameConfig, com.threerings.parlor.client.ParlorService.InviteListener)</code></a> requests.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/SeatednessObserver.html" title="interface in com.threerings.parlor.client">SeatednessObserver</a></td>
<td class="colLast">
<div class="block">Entites that wish to hear about when we sit down at a table or stand up
from a table can implement this interface and register themselves with
the <a href="../../../../com/threerings/parlor/client/TableDirector.html" title="class in com.threerings.parlor.client"><code>TableDirector</code></a>.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/TableObserver.html" title="interface in com.threerings.parlor.client">TableObserver</a></td>
<td class="colLast">
<div class="block">The <a href="../../../../com/threerings/parlor/client/TableDirector.html" title="class in com.threerings.parlor.client"><code>TableDirector</code></a> converts distributed object events into
higher level callbacks to implementers of this interface, which are
expected to render these events sensically in a user interface.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/TableService.html" title="interface in com.threerings.parlor.client">TableService</a></td>
<td class="colLast">
<div class="block">Provides table lobbying services.</div>
</td>
</tr>
</tbody>
</table>
</li>
<li class="blockList">
<table class="typeSummary" border="0" cellpadding="3" cellspacing="0" summary="Class Summary table, listing classes, and an explanation">
<caption><span>Class Summary</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Class</th>
<th class="colLast" scope="col">Description</th>
</tr>
<tbody>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/DefaultSwingTableConfigurator.html" title="class in com.threerings.parlor.client">DefaultSwingTableConfigurator</a></td>
<td class="colLast">
<div class="block">Provides a default implementation of a TableConfigurator for
a Swing interface.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/Invitation.html" title="class in com.threerings.parlor.client">Invitation</a></td>
<td class="colLast">
<div class="block">The invitation class is used to track information related to
outstanding invitations generated by or targeted to this client.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/ParlorDecoder.html" title="class in com.threerings.parlor.client">ParlorDecoder</a></td>
<td class="colLast">
<div class="block">Dispatches calls to a <a href="../../../../com/threerings/parlor/client/ParlorReceiver.html" title="interface in com.threerings.parlor.client"><code>ParlorReceiver</code></a> instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/ParlorDirector.html" title="class in com.threerings.parlor.client">ParlorDirector</a></td>
<td class="colLast">
<div class="block">The parlor director manages the client side of the game configuration and matchmaking
processes.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/TableConfigurator.html" title="class in com.threerings.parlor.client">TableConfigurator</a></td>
<td class="colLast">
<div class="block">This should be implemented some user-interface element that allows
the user to configure whichever TableConfig options are relevant.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><a href="../../../../com/threerings/parlor/client/TableDirector.html" title="class in com.threerings.parlor.client">TableDirector</a></td>
<td class="colLast">
<div class="block">As tables are created and managed within the scope of a place (a lobby), we want to fold the
table management functionality into the standard hierarchy of place controllers that deal with
place-related functionality on the client.</div>
</td>
</tr>
</tbody>
</table>
</li>
</ul>
</div>
<!-- ======= 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 class="navBarCell1Rev">Package</li>
<li>Class</li>
<li><a href="package-use.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/card/trick/util/package-summary.html">Prev&nbsp;Package</a></li>
<li><a href="../../../../com/threerings/parlor/data/package-summary.html">Next&nbsp;Package</a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?com/threerings/parlor/client/package-summary.html" target="_top">Frames</a></li>
<li><a href="package-summary.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>
<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