Files
vilya/apidocs/com/threerings/parlor/card/data/CardGameObject.html
T
2015-03-14 10:44:30 -07:00

339 lines
18 KiB
HTML

<!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:07 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>CardGameObject (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="CardGameObject (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><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/CardGameObject.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/data/CardCodes.html" title="interface in com.threerings.parlor.card.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/parlor/card/data/Deck.html" title="class in com.threerings.parlor.card.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/card/data/CardGameObject.html" target="_top">Frames</a></li>
<li><a href="CardGameObject.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><a href="#nested.classes.inherited.from.class.com.threerings.crowd.data.PlaceObject">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.threerings.parlor.game.data.GameObject">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.com.threerings.parlor.game.data.GameObject">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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.card.data</div>
<h2 title="Class CardGameObject" class="title">Class CardGameObject</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.crowd.data.PlaceObject</li>
<li>
<ul class="inheritance">
<li><a href="../../../../../com/threerings/parlor/game/data/GameObject.html" title="class in com.threerings.parlor.game.data">com.threerings.parlor.game.data.GameObject</a></li>
<li>
<ul class="inheritance">
<li>com.threerings.parlor.card.data.CardGameObject</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Implemented Interfaces:</dt>
<dd>com.threerings.crowd.chat.data.SpeakObject, com.threerings.io.Streamable</dd>
</dl>
<hr>
<br>
<pre>public class <span class="typeNameLabel">CardGameObject</span>
extends <a href="../../../../../com/threerings/parlor/game/data/GameObject.html" title="class in com.threerings.parlor.game.data">GameObject</a></pre>
<div class="block">Game object class for card games.</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.crowd.data.PlaceObject">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from class&nbsp;com.threerings.crowd.data.PlaceObject</h3>
<code>com.threerings.crowd.data.PlaceObject.ManagerCaller</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="nested.classes.inherited.from.class.com.threerings.crowd.chat.data.SpeakObject">
<!-- -->
</a>
<h3>Nested classes/interfaces inherited from interface&nbsp;com.threerings.crowd.chat.data.SpeakObject</h3>
<code>com.threerings.crowd.chat.data.SpeakObject.ListenerOp</code></li>
</ul>
<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>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.parlor.game.data.GameObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.threerings.parlor.game.data.<a href="../../../../../com/threerings/parlor/game/data/GameObject.html" title="class in com.threerings.parlor.game.data">GameObject</a></h3>
<code><a href="../../../../../com/threerings/parlor/game/data/GameObject.html#CANCELLED">CANCELLED</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#GAME_OVER">GAME_OVER</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#IN_PLAY">IN_PLAY</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#IS_PRIVATE">IS_PRIVATE</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#IS_RATED">IS_RATED</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#isPrivate">isPrivate</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#isRated">isRated</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYER_IN_PLAY">PLAYER_IN_PLAY</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYER_LEFT_GAME">PLAYER_LEFT_GAME</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYER_STATUS">PLAYER_STATUS</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#players">players</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#PLAYERS">PLAYERS</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#playerStatus">playerStatus</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#PRE_GAME">PRE_GAME</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#SESSION_ID">SESSION_ID</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#sessionId">sessionId</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#state">state</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#STATE">STATE</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#winners">winners</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#WINNERS">WINNERS</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.crowd.data.PlaceObject">
<!-- -->
</a>
<h3>Fields inherited from class&nbsp;com.threerings.crowd.data.PlaceObject</h3>
<code>manager, OCCUPANT_INFO, occupantInfo, occupants, OCCUPANTS, SPEAK_SERVICE, speakService</code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="fields.inherited.from.class.com.threerings.crowd.chat.data.SpeakObject">
<!-- -->
</a>
<h3>Fields inherited from interface&nbsp;com.threerings.crowd.chat.data.SpeakObject</h3>
<code>DEFAULT_IDENTIFIER</code></li>
</ul>
</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/card/data/CardGameObject.html#CardGameObject--">CardGameObject</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>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.parlor.game.data.GameObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.parlor.game.data.<a href="../../../../../com/threerings/parlor/game/data/GameObject.html" title="class in com.threerings.parlor.game.data">GameObject</a></h3>
<code><a href="../../../../../com/threerings/parlor/game/data/GameObject.html#getActivePlayerCount--">getActivePlayerCount</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#getPlayerCount--">getPlayerCount</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#getPlayerIndex-com.threerings.util.Name-">getPlayerIndex</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#getWinnerCount--">getWinnerCount</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#getWinnerIndex--">getWinnerIndex</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#isActivePlayer-int-">isActivePlayer</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#isDraw--">isDraw</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#isInPlay--">isInPlay</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#isOccupiedPlayer-int-">isOccupiedPlayer</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#isWinner-int-">isWinner</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setIsPrivate-boolean-">setIsPrivate</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setIsRated-boolean-">setIsRated</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setPlayers-com.threerings.util.Name:A-">setPlayers</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setPlayersAt-com.threerings.util.Name-int-">setPlayersAt</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setPlayerStatus-int:A-">setPlayerStatus</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setPlayerStatusAt-int-int-">setPlayerStatusAt</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setSessionId-int-">setSessionId</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setState-int-">setState</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setWinners-boolean:A-">setWinners</a>, <a href="../../../../../com/threerings/parlor/game/data/GameObject.html#setWinnersAt-boolean-int-">setWinnersAt</a></code></li>
</ul>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.com.threerings.crowd.data.PlaceObject">
<!-- -->
</a>
<h3>Methods inherited from class&nbsp;com.threerings.crowd.data.PlaceObject</h3>
<code>addToOccupantInfo, addToOccupants, applyToListeners, getChatIdentifier, getOccupantInfo, initManagerCaller, removeFromOccupantInfo, removeFromOccupants, setOccupantInfo, setSpeakService, shouldBroadcast, updateOccupantInfo</code></li>
</ul>
<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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor.detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="CardGameObject--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>CardGameObject</h4>
<pre>public&nbsp;CardGameObject()</pre>
</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/CardGameObject.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/data/CardCodes.html" title="interface in com.threerings.parlor.card.data"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/parlor/card/data/Deck.html" title="class in com.threerings.parlor.card.data"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/parlor/card/data/CardGameObject.html" target="_top">Frames</a></li>
<li><a href="CardGameObject.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><a href="#nested.classes.inherited.from.class.com.threerings.crowd.data.PlaceObject">Nested</a>&nbsp;|&nbsp;</li>
<li><a href="#fields.inherited.from.class.com.threerings.parlor.game.data.GameObject">Field</a>&nbsp;|&nbsp;</li>
<li><a href="#constructor.summary">Constr</a>&nbsp;|&nbsp;</li>
<li><a href="#methods.inherited.from.class.com.threerings.parlor.game.data.GameObject">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail:&nbsp;</li>
<li>Field&nbsp;|&nbsp;</li>
<li><a href="#constructor.detail">Constr</a>&nbsp;|&nbsp;</li>
<li>Method</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>