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

778 lines
35 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>TourneyObject (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="TourneyObject (Vilya Core 1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10,"i7":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],8:["t4","Concrete 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/TourneyObject.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/tourney/data/TourneyMarshaller.html" title="class in com.threerings.parlor.tourney.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/parlor/tourney/data/TourniesMarshaller.html" title="class in com.threerings.parlor.tourney.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/tourney/data/TourneyObject.html" target="_top">Frames</a></li>
<li><a href="TourneyObject.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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.tourney.data</div>
<h2 title="Class TourneyObject" class="title">Class TourneyObject</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.presents.dobj.DObject</li>
<li>
<ul class="inheritance">
<li>com.threerings.parlor.tourney.data.TourneyObject</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.threerings.io.Streamable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">TourneyObject</span>
extends com.threerings.presents.dobj.DObject</pre>
<div class="block">Provides information on a specific tourney.</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.io.Streamable">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.io.Streamable</h3>
<code>com.threerings.io.Streamable.Closure</code></li>
</ul>
</li>
</ul>
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#CANCELLED">CANCELLED</a></span></code>
<div class="block">Tourney has been cancelled.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../com/threerings/parlor/tourney/data/TourneyConfig.html" title="class in com.threerings.parlor.tourney.data">TourneyConfig</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#config">config</a></span></code>
<div class="block">The tourney configuration.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#CONFIG">CONFIG</a></span></code>
<div class="block">The field name of the <code>config</code> field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#FINISHED">FINISHED</a></span></code>
<div class="block">Tourney has completed.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>com.threerings.presents.dobj.DSet&lt;<a href="../../../../../com/threerings/parlor/tourney/data/Participant.html" title="class in com.threerings.parlor.tourney.data">Participant</a>&gt;</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#participants">participants</a></span></code>
<div class="block">A DSet that accumulates Participant records for the players involved in this tourney.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#PARTICIPANTS">PARTICIPANTS</a></span></code>
<div class="block">The field name of the <code>participants</code> field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#PAUSED">PAUSED</a></span></code>
<div class="block">Tourney is paused.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#PENDING">PENDING</a></span></code>
<div class="block">Tourney is pending and accepting participants.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#RUNNING">RUNNING</a></span></code>
<div class="block">Tourney is currently running.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#STARTS_IN">STARTS_IN</a></span></code>
<div class="block">The field name of the <code>startsIn</code> field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#startsIn">startsIn</a></span></code>
<div class="block">The real-time number of minutes before it starts.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#state">state</a></span></code>
<div class="block">The current state of the tourney.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#STATE">STATE</a></span></code>
<div class="block">The field name of the <code>state</code> field.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#TOURNEY_SERVICE">TOURNEY_SERVICE</a></span></code>
<div class="block">The field name of the <code>tourneyService</code> field.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../com/threerings/parlor/tourney/data/TourneyMarshaller.html" title="class in com.threerings.parlor.tourney.data">TourneyMarshaller</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#tourneyService">tourneyService</a></span></code>
<div class="block">Provides the way in which tourney participants can communicate with the server.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#TourneyObject--">TourneyObject</a></span>()</code>&nbsp;</td>
</tr>
</table>
</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="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete 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/tourney/data/TourneyObject.html#addToParticipants-com.threerings.parlor.tourney.data.Participant-">addToParticipants</a></span>(<a href="../../../../../com/threerings/parlor/tourney/data/Participant.html" title="class in com.threerings.parlor.tourney.data">Participant</a>&nbsp;elem)</code>
<div class="block">Requests that the specified entry be added to the
<code>participants</code> set.</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/tourney/data/TourneyObject.html#removeFromParticipants-java.lang.Comparable-">removeFromParticipants</a></span>(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&nbsp;key)</code>
<div class="block">Requests that the entry matching the supplied key be removed from
the <code>participants</code> set.</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/tourney/data/TourneyObject.html#setConfig-com.threerings.parlor.tourney.data.TourneyConfig-">setConfig</a></span>(<a href="../../../../../com/threerings/parlor/tourney/data/TourneyConfig.html" title="class in com.threerings.parlor.tourney.data">TourneyConfig</a>&nbsp;value)</code>
<div class="block">Requests that the <code>config</code> field be set to the
specified value.</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/tourney/data/TourneyObject.html#setParticipants-com.threerings.presents.dobj.DSet-">setParticipants</a></span>(com.threerings.presents.dobj.DSet&lt;<a href="../../../../../com/threerings/parlor/tourney/data/Participant.html" title="class in com.threerings.parlor.tourney.data">Participant</a>&gt;&nbsp;value)</code>
<div class="block">Requests that the <code>participants</code> field be set to the
specified value.</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/tourney/data/TourneyObject.html#setStartsIn-int-">setStartsIn</a></span>(int&nbsp;value)</code>
<div class="block">Requests that the <code>startsIn</code> field be set to the
specified value.</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#setState-int-">setState</a></span>(int&nbsp;value)</code>
<div class="block">Requests that the <code>state</code> field be set to the
specified value.</div>
</td>
</tr>
<tr id="i6" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#setTourneyService-com.threerings.parlor.tourney.data.TourneyMarshaller-">setTourneyService</a></span>(<a href="../../../../../com/threerings/parlor/tourney/data/TourneyMarshaller.html" title="class in com.threerings.parlor.tourney.data">TourneyMarshaller</a>&nbsp;value)</code>
<div class="block">Requests that the <code>tourneyService</code> field be set to the
specified value.</div>
</td>
</tr>
<tr id="i7" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/parlor/tourney/data/TourneyObject.html#updateParticipants-com.threerings.parlor.tourney.data.Participant-">updateParticipants</a></span>(<a href="../../../../../com/threerings/parlor/tourney/data/Participant.html" title="class in com.threerings.parlor.tourney.data">Participant</a>&nbsp;elem)</code>
<div class="block">Requests that the specified entry be updated in the
<code>participants</code> set.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.presents.dobj.DObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.presents.dobj.DObject</h3>
<code>acquireLock, addListener, addListener, addSubscriber, addToSet, cancelTransaction, changeAttribute, checkPermissions, checkPermissions, commitTransaction, destroy, getAccessController, getAttribute, getLocal, getLocals, getManager, getOid, getSet, inTransaction, isActive, notifyListeners, notifyProxies, postEvent, postMessage, postMessage, releaseLock, removeFromSet, removeListener, removeSubscriber, setAccessController, setAttribute, setDestroyOnLastSubscriberRemoved, setLocal, setManager, setOid, startTransaction, toString, updateSet, which</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#equals-java.lang.Object-" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#getClass--" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#hashCode--" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notify--" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#notifyAll--" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait--" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Object.html?is-external=true#wait-long-int-" title="class or interface in java.lang">wait</a></code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field.detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="STATE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STATE</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> STATE</pre>
<div class="block">The field name of the <code>state</code> field.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.STATE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CONFIG">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CONFIG</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> CONFIG</pre>
<div class="block">The field name of the <code>config</code> field.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.CONFIG">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="STARTS_IN">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>STARTS_IN</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> STARTS_IN</pre>
<div class="block">The field name of the <code>startsIn</code> field.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.STARTS_IN">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="TOURNEY_SERVICE">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>TOURNEY_SERVICE</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> TOURNEY_SERVICE</pre>
<div class="block">The field name of the <code>tourneyService</code> field.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.TOURNEY_SERVICE">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PARTICIPANTS">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PARTICIPANTS</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public static final&nbsp;<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> PARTICIPANTS</pre>
<div class="block">The field name of the <code>participants</code> field.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.PARTICIPANTS">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PENDING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PENDING</h4>
<pre>public static final&nbsp;int PENDING</pre>
<div class="block">Tourney is pending and accepting participants.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.PENDING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="RUNNING">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>RUNNING</h4>
<pre>public static final&nbsp;int RUNNING</pre>
<div class="block">Tourney is currently running.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.RUNNING">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="CANCELLED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>CANCELLED</h4>
<pre>public static final&nbsp;int CANCELLED</pre>
<div class="block">Tourney has been cancelled.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.CANCELLED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="PAUSED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>PAUSED</h4>
<pre>public static final&nbsp;int PAUSED</pre>
<div class="block">Tourney is paused.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.PAUSED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="FINISHED">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FINISHED</h4>
<pre>public static final&nbsp;int FINISHED</pre>
<div class="block">Tourney has completed.</div>
<dl>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../../constant-values.html#com.threerings.parlor.tourney.data.TourneyObject.FINISHED">Constant Field Values</a></dd>
</dl>
</li>
</ul>
<a name="state">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>state</h4>
<pre>public&nbsp;int state</pre>
<div class="block">The current state of the tourney.</div>
</li>
</ul>
<a name="config">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>config</h4>
<pre>public&nbsp;<a href="../../../../../com/threerings/parlor/tourney/data/TourneyConfig.html" title="class in com.threerings.parlor.tourney.data">TourneyConfig</a> config</pre>
<div class="block">The tourney configuration.</div>
</li>
</ul>
<a name="startsIn">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>startsIn</h4>
<pre>public&nbsp;int startsIn</pre>
<div class="block">The real-time number of minutes before it starts.</div>
</li>
</ul>
<a name="tourneyService">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>tourneyService</h4>
<pre>public&nbsp;<a href="../../../../../com/threerings/parlor/tourney/data/TourneyMarshaller.html" title="class in com.threerings.parlor.tourney.data">TourneyMarshaller</a> tourneyService</pre>
<div class="block">Provides the way in which tourney participants can communicate with the server.</div>
</li>
</ul>
<a name="participants">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>participants</h4>
<pre>public&nbsp;com.threerings.presents.dobj.DSet&lt;<a href="../../../../../com/threerings/parlor/tourney/data/Participant.html" title="class in com.threerings.parlor.tourney.data">Participant</a>&gt; participants</pre>
<div class="block">A DSet that accumulates Participant records for the players involved in this tourney.</div>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="TourneyObject--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>TourneyObject</h4>
<pre>public&nbsp;TourneyObject()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setState-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setState</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public&nbsp;void&nbsp;setState(int&nbsp;value)</pre>
<div class="block">Requests that the <code>state</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.</div>
</li>
</ul>
<a name="setConfig-com.threerings.parlor.tourney.data.TourneyConfig-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setConfig</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public&nbsp;void&nbsp;setConfig(<a href="../../../../../com/threerings/parlor/tourney/data/TourneyConfig.html" title="class in com.threerings.parlor.tourney.data">TourneyConfig</a>&nbsp;value)</pre>
<div class="block">Requests that the <code>config</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.</div>
</li>
</ul>
<a name="setStartsIn-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setStartsIn</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public&nbsp;void&nbsp;setStartsIn(int&nbsp;value)</pre>
<div class="block">Requests that the <code>startsIn</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.</div>
</li>
</ul>
<a name="setTourneyService-com.threerings.parlor.tourney.data.TourneyMarshaller-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setTourneyService</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public&nbsp;void&nbsp;setTourneyService(<a href="../../../../../com/threerings/parlor/tourney/data/TourneyMarshaller.html" title="class in com.threerings.parlor.tourney.data">TourneyMarshaller</a>&nbsp;value)</pre>
<div class="block">Requests that the <code>tourneyService</code> field be set to the
specified value. The local value will be updated immediately and an
event will be propagated through the system to notify all listeners
that the attribute did change. Proxied copies of this object (on
clients) will apply the value change when they received the
attribute changed notification.</div>
</li>
</ul>
<a name="addToParticipants-com.threerings.parlor.tourney.data.Participant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addToParticipants</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public&nbsp;void&nbsp;addToParticipants(<a href="../../../../../com/threerings/parlor/tourney/data/Participant.html" title="class in com.threerings.parlor.tourney.data">Participant</a>&nbsp;elem)</pre>
<div class="block">Requests that the specified entry be added to the
<code>participants</code> set. The set will not change until the event is
actually propagated through the system.</div>
</li>
</ul>
<a name="removeFromParticipants-java.lang.Comparable-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>removeFromParticipants</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public&nbsp;void&nbsp;removeFromParticipants(<a href="http://docs.oracle.com/javase/1.5.0/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a>&lt;?&gt;&nbsp;key)</pre>
<div class="block">Requests that the entry matching the supplied key be removed from
the <code>participants</code> set. The set will not change until the
event is actually propagated through the system.</div>
</li>
</ul>
<a name="updateParticipants-com.threerings.parlor.tourney.data.Participant-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>updateParticipants</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public&nbsp;void&nbsp;updateParticipants(<a href="../../../../../com/threerings/parlor/tourney/data/Participant.html" title="class in com.threerings.parlor.tourney.data">Participant</a>&nbsp;elem)</pre>
<div class="block">Requests that the specified entry be updated in the
<code>participants</code> set. The set will not change until the event is
actually propagated through the system.</div>
</li>
</ul>
<a name="setParticipants-com.threerings.presents.dobj.DSet-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>setParticipants</h4>
<pre>@Generated(value="com.threerings.presents.tools.GenDObjectTask")
public&nbsp;void&nbsp;setParticipants(com.threerings.presents.dobj.DSet&lt;<a href="../../../../../com/threerings/parlor/tourney/data/Participant.html" title="class in com.threerings.parlor.tourney.data">Participant</a>&gt;&nbsp;value)</pre>
<div class="block">Requests that the <code>participants</code> field be set to the
specified value. Generally one only adds, updates and removes
entries of a distributed set, but certain situations call for a
complete replacement of the set value. The local value will be
updated immediately and an event will be propagated through the
system to notify all listeners that the attribute did
change. Proxied copies of this object (on clients) will apply the
value change when they received the attribute changed notification.</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/TourneyObject.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/tourney/data/TourneyMarshaller.html" title="class in com.threerings.parlor.tourney.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/parlor/tourney/data/TourniesMarshaller.html" title="class in com.threerings.parlor.tourney.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/tourney/data/TourneyObject.html" target="_top">Frames</a></li>
<li><a href="TourneyObject.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><a href="#field.summary">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#method.summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li><a href="#field.detail">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&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