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

328 lines
12 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:09 PDT 2015 -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PieceDropLogic (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="PieceDropLogic (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/PieceDropLogic.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/puzzle/drop/util/PieceDestroyer.DestroyLogic.html" title="interface in com.threerings.puzzle.drop.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/puzzle/drop/util/PieceDropper.html" title="class in com.threerings.puzzle.drop.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/puzzle/drop/util/PieceDropLogic.html" target="_top">Frames</a></li>
<li><a href="PieceDropLogic.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.puzzle.drop.util</div>
<h2 title="Interface PieceDropLogic" class="title">Interface PieceDropLogic</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public interface <span class="typeNameLabel">PieceDropLogic</span></pre>
<div class="block">An interface to be implemented by games that would like to be able to drop their pieces during
game play.</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== 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>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/util/PieceDropLogic.html#boardAlwaysFilled--">boardAlwaysFilled</a></span>()</code>
<div class="block">Should the board always be filled?</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/util/PieceDropLogic.html#getConstrainedEdge-com.threerings.puzzle.drop.data.DropBoard-int-int-int-">getConstrainedEdge</a></span>(<a href="../../../../../com/threerings/puzzle/drop/data/DropBoard.html" title="class in com.threerings.puzzle.drop.data">DropBoard</a>&nbsp;board,
int&nbsp;col,
int&nbsp;row,
int&nbsp;dir)</code>
<div class="block">Returns the x-axis coordinate of the specified edge of the given constrained piece.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/util/PieceDropLogic.html#isClimbablePiece-boolean-int-boolean-">isClimbablePiece</a></span>(boolean&nbsp;allowConst,
int&nbsp;piece,
boolean&nbsp;pre)</code>
<div class="block">Returns whether the given piece terminates a column climb when determining the height of a
piece column to be dropped.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/util/PieceDropLogic.html#isConstrainedPiece-int-">isConstrainedPiece</a></span>(int&nbsp;piece)</code>
<div class="block">Returns whether the given piece has constraints upon it that impact its droppability.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../../com/threerings/puzzle/drop/util/PieceDropLogic.html#isDroppablePiece-int-">isDroppablePiece</a></span>(int&nbsp;piece)</code>
<div class="block">Returns whether the given piece is potentially droppable.</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="boardAlwaysFilled--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>boardAlwaysFilled</h4>
<pre>boolean&nbsp;boardAlwaysFilled()</pre>
<div class="block">Should the board always be filled?</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>false for normal behavior.</dd>
</dl>
</li>
</ul>
<a name="isDroppablePiece-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isDroppablePiece</h4>
<pre>boolean&nbsp;isDroppablePiece(int&nbsp;piece)</pre>
<div class="block">Returns whether the given piece is potentially droppable.</div>
</li>
</ul>
<a name="isConstrainedPiece-int-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isConstrainedPiece</h4>
<pre>boolean&nbsp;isConstrainedPiece(int&nbsp;piece)</pre>
<div class="block">Returns whether the given piece has constraints upon it that impact its droppability.</div>
</li>
</ul>
<a name="isClimbablePiece-boolean-int-boolean-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isClimbablePiece</h4>
<pre>boolean&nbsp;isClimbablePiece(boolean&nbsp;allowConst,
int&nbsp;piece,
boolean&nbsp;pre)</pre>
<div class="block">Returns whether the given piece terminates a column climb when determining the height of a
piece column to be dropped.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>allowConst</code> - whether to allow dropping constrained pieces (though only in the first
encountered constrained block.)</dd>
<dd><code>piece</code> - the piece to consider.</dd>
<dd><code>pre</code> - whether the climbability check is being performed before the height is
incremented, or after.</dd>
</dl>
</li>
</ul>
<a name="getConstrainedEdge-com.threerings.puzzle.drop.data.DropBoard-int-int-int-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getConstrainedEdge</h4>
<pre>int&nbsp;getConstrainedEdge(<a href="../../../../../com/threerings/puzzle/drop/data/DropBoard.html" title="class in com.threerings.puzzle.drop.data">DropBoard</a>&nbsp;board,
int&nbsp;col,
int&nbsp;row,
int&nbsp;dir)</pre>
<div class="block">Returns the x-axis coordinate of the specified edge of the given constrained piece.
<p> TODO: This should go away once the sword and sail games have standardized on WEST/EAST
or BLOCK_LEFT/BLOCK_RIGHT to reference block edges.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>board</code> - the board to search.</dd>
<dd><code>col</code> - the column of the constrained piece.</dd>
<dd><code>row</code> - the row of the constrained piece.</dd>
<dd><code>dir</code> - the edge direction to find; one of <code>DirectionCodes.LEFT</code> or
<code>DirectionCodes.RIGHT</code>.</dd>
</dl>
</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/PieceDropLogic.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/puzzle/drop/util/PieceDestroyer.DestroyLogic.html" title="interface in com.threerings.puzzle.drop.util"><span class="typeNameLink">Prev&nbsp;Class</span></a></li>
<li><a href="../../../../../com/threerings/puzzle/drop/util/PieceDropper.html" title="class in com.threerings.puzzle.drop.util"><span class="typeNameLink">Next&nbsp;Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?com/threerings/puzzle/drop/util/PieceDropLogic.html" target="_top">Frames</a></li>
<li><a href="PieceDropLogic.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