2020-05-03 18:14:17 +02:00
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
< html lang = "no" >
< head >
2020-05-05 15:46:33 +02:00
<!-- Generated by javadoc (1.8.0_201) on Tue May 05 15:44:52 CEST 2020 -->
2020-05-03 18:14:17 +02:00
< title > Phase< / title >
2020-05-05 15:46:33 +02:00
< meta name = "date" content = "2020-05-05" >
2020-05-03 18:14:17 +02:00
< 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="Phase";
}
}
catch(err) {
}
//-->
2020-05-05 15:46:33 +02:00
var methods = {"i0":10,"i1":10,"i2":10,"i3":10,"i4":10,"i5":10,"i6":10};
2020-05-03 18:14:17 +02:00
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 = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../index-files/index-1.html" > Index< / a > < / li >
< li > < a href = "../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../../inf112/fiasko/roborally/objects/Particle.html" title = "class in inf112.fiasko.roborally.objects" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../inf112/fiasko/roborally/objects/Player.html" title = "class in inf112.fiasko.roborally.objects" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?inf112/fiasko/roborally/objects/Phase.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "Phase.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_top" >
< li > < a href = "../../../../allclasses-noframe.html" > All 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: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / 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" > inf112.fiasko.roborally.objects< / div >
< h2 title = "Class Phase" class = "title" > Class Phase< / h2 >
< / div >
< div class = "contentContainer" >
< ul class = "inheritance" >
< li > java.lang.Object< / li >
< li >
< ul class = "inheritance" >
< li > inf112.fiasko.roborally.objects.Phase< / li >
< / ul >
< / li >
< / ul >
< div class = "description" >
< ul class = "blockList" >
< li class = "blockList" >
< hr >
< br >
< pre > public class < span class = "typeNameLabel" > Phase< / span >
extends java.lang.Object< / pre >
< div class = "block" > This class handles everything that should happen during a phase< / div >
< / li >
< / ul >
< / div >
< div class = "summary" >
< ul class = "blockList" >
< li class = "blockList" >
<!-- ======== 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" > < / 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 = "../../../../inf112/fiasko/roborally/objects/Phase.html#Phase-inf112.fiasko.roborally.objects.Board-java.util.List-int-inf112.fiasko.roborally.objects.InteractableGame-" > Phase< / a > < / span > (< a href = "../../../../inf112/fiasko/roborally/objects/Board.html" title = "class in inf112.fiasko.roborally.objects" > Board< / a > gameBoard,
java.util.List< < a href = "../../../../inf112/fiasko/roborally/objects/Player.html" title = "class in inf112.fiasko.roborally.objects" > Player< / a > > playerList,
int cycleDelay,
< a href = "../../../../inf112/fiasko/roborally/objects/InteractableGame.html" title = "interface in inf112.fiasko.roborally.objects" > InteractableGame< / a > game)< / code >
< div class = "block" > Instantiates a new phase< / div >
< / 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" > < / span > < / span > < span id = "t2" class = "tableTab" > < span > < a href = "javascript:show(2);" > Instance Methods< / a > < / span > < span class = "tabEnd" > < / span > < / span > < span id = "t4" class = "tableTab" > < span > < a href = "javascript:show(8);" > Concrete Methods< / a > < / span > < span class = "tabEnd" > < / 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 = "../../../../inf112/fiasko/roborally/objects/Phase.html#checkAllFlags--" > checkAllFlags< / a > < / span > ()< / code >
< div class = "block" > Checks all flags for robots.< / div >
< / td >
< / tr >
< tr id = "i1" class = "rowColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../inf112/fiasko/roborally/objects/Phase.html#fireAllLasers--" > fireAllLasers< / a > < / span > ()< / code >
< div class = "block" > Fires all lasers on the game board< / div >
< / td >
< / tr >
< tr id = "i2" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../inf112/fiasko/roborally/objects/Phase.html#makeMove-inf112.fiasko.roborally.objects.properties.RobotID-inf112.fiasko.roborally.objects.properties.Action-" > makeMove< / a > < / span > (< a href = "../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title = "enum in inf112.fiasko.roborally.objects.properties" > RobotID< / a > robotID,
< a href = "../../../../inf112/fiasko/roborally/objects/properties/Action.html" title = "enum in inf112.fiasko.roborally.objects.properties" > Action< / a > action)< / code >
< div class = "block" > Makes the given robot move according to to the action input.< / div >
< / td >
< / tr >
< tr id = "i3" class = "rowColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../inf112/fiasko/roborally/objects/Phase.html#moveAllConveyorBelts--" > moveAllConveyorBelts< / a > < / span > ()< / code >
< div class = "block" > Moves robots standing on conveyor belts in the direction of the conveyor belt
In addition, the function rotates appropriately when arriving at any non-straight conveyor belt.< / div >
< / td >
< / tr >
< tr id = "i4" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../inf112/fiasko/roborally/objects/Phase.html#rotateCogwheels--" > rotateCogwheels< / a > < / span > ()< / code >
< div class = "block" > Rotates all robots that are standing on cogWheel tiles on the board.< / div >
< / td >
< / tr >
< tr id = "i5" class = "rowColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../inf112/fiasko/roborally/objects/Phase.html#runPhase-int-" > runPhase< / a > < / span > (int phaseNumber)< / code >
< div class = "block" > Runs one phase as defined in the Robo Rally rulebook< / div >
< / td >
< / tr >
< tr id = "i6" class = "altColor" >
< td class = "colFirst" > < code > void< / code > < / td >
< td class = "colLast" > < code > < span class = "memberNameLink" > < a href = "../../../../inf112/fiasko/roborally/objects/Phase.html#runProgrammingCards-int-" > runProgrammingCards< / a > < / span > (int phase)< / code >
< div class = "block" > Runs all programming cards for a phase< / div >
< / td >
< / tr >
< / table >
< ul class = "blockList" >
< li class = "blockList" > < a name = "methods.inherited.from.class.java.lang.Object" >
<!-- -->
< / a >
< h3 > Methods inherited from class java.lang.Object< / h3 >
< code > clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait< / 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 = "Phase-inf112.fiasko.roborally.objects.Board-java.util.List-int-inf112.fiasko.roborally.objects.InteractableGame-" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > Phase< / h4 >
< pre > public Phase(< a href = "../../../../inf112/fiasko/roborally/objects/Board.html" title = "class in inf112.fiasko.roborally.objects" > Board< / a > gameBoard,
java.util.List< < a href = "../../../../inf112/fiasko/roborally/objects/Player.html" title = "class in inf112.fiasko.roborally.objects" > Player< / a > > playerList,
int cycleDelay,
< a href = "../../../../inf112/fiasko/roborally/objects/InteractableGame.html" title = "interface in inf112.fiasko.roborally.objects" > InteractableGame< / a > game)< / pre >
< div class = "block" > Instantiates a new phase< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > gameBoard< / code > - The board to act on< / dd >
< dd > < code > playerList< / code > - A list of players participating in the game< / dd >
< dd > < code > cycleDelay< / code > - The amount of milliseconds to wait between moves< / dd >
< dd > < code > game< / code > - The game which uses this object< / dd >
< / dl >
< / li >
< / ul >
< / li >
< / ul >
<!-- ============ METHOD DETAIL ========== -->
< ul class = "blockList" >
< li class = "blockList" > < a name = "method.detail" >
<!-- -->
< / a >
< h3 > Method Detail< / h3 >
< a name = "runPhase-int-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > runPhase< / h4 >
< pre > public void runPhase(int phaseNumber)
throws java.lang.InterruptedException< / pre >
< div class = "block" > Runs one phase as defined in the Robo Rally rulebook< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > phaseNumber< / code > - The number of the phase to run< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.InterruptedException< / code > - If interrupted wile trying to sleep< / dd >
< / dl >
< / li >
< / ul >
< a name = "checkAllFlags--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > checkAllFlags< / h4 >
< pre > public void checkAllFlags()< / pre >
< div class = "block" > Checks all flags for robots. Tries to update the flag of the robot.< / div >
< / li >
< / ul >
< a name = "fireAllLasers--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > fireAllLasers< / h4 >
< pre > public void fireAllLasers()
throws java.lang.InterruptedException< / pre >
< div class = "block" > Fires all lasers on the game board< / div >
< dl >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.InterruptedException< / code > - If it gets interrupted while trying to sleep< / dd >
< / dl >
< / li >
< / ul >
< a name = "runProgrammingCards-int-" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > runProgrammingCards< / h4 >
< pre > public void runProgrammingCards(int phase)
throws java.lang.InterruptedException< / pre >
< div class = "block" > Runs all programming cards for a phase< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > phase< / code > - The number of the phase to run cards for< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.InterruptedException< / code > - If it gets interrupted while trying to sleep< / dd >
< / dl >
< / li >
< / ul >
< a name = "rotateCogwheels--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > rotateCogwheels< / h4 >
< pre > public void rotateCogwheels()
throws java.lang.InterruptedException< / pre >
< div class = "block" > Rotates all robots that are standing on cogWheel tiles on the board.< / div >
< dl >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.InterruptedException< / code > - If interrupted while sleeping.< / dd >
< / dl >
< / li >
< / ul >
< a name = "moveAllConveyorBelts--" >
<!-- -->
< / a >
< ul class = "blockList" >
< li class = "blockList" >
< h4 > moveAllConveyorBelts< / h4 >
< pre > public void moveAllConveyorBelts()
throws java.lang.InterruptedException< / pre >
< div class = "block" > Moves robots standing on conveyor belts in the direction of the conveyor belt
< p > In addition, the function rotates appropriately when arriving at any non-straight conveyor belt.< / p > < / div >
< dl >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.InterruptedException< / code > - If disturbed during sleep< / dd >
< / dl >
< / li >
< / ul >
< a name = "makeMove-inf112.fiasko.roborally.objects.properties.RobotID-inf112.fiasko.roborally.objects.properties.Action-" >
<!-- -->
< / a >
< ul class = "blockListLast" >
< li class = "blockList" >
< h4 > makeMove< / h4 >
< pre > public void makeMove(< a href = "../../../../inf112/fiasko/roborally/objects/properties/RobotID.html" title = "enum in inf112.fiasko.roborally.objects.properties" > RobotID< / a > robotID,
< a href = "../../../../inf112/fiasko/roborally/objects/properties/Action.html" title = "enum in inf112.fiasko.roborally.objects.properties" > Action< / a > action)
throws java.lang.InterruptedException< / pre >
< div class = "block" > Makes the given robot move according to to the action input.< / div >
< dl >
< dt > < span class = "paramLabel" > Parameters:< / span > < / dt >
< dd > < code > robotID< / code > - The ID of the robot to move.< / dd >
< dd > < code > action< / code > - The specific movement the robot is to take.< / dd >
< dt > < span class = "throwsLabel" > Throws:< / span > < / dt >
< dd > < code > java.lang.InterruptedException< / code > - If interrupted wile trying to sleep.< / 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 = "package-tree.html" > Tree< / a > < / li >
< li > < a href = "../../../../deprecated-list.html" > Deprecated< / a > < / li >
< li > < a href = "../../../../index-files/index-1.html" > Index< / a > < / li >
< li > < a href = "../../../../help-doc.html" > Help< / a > < / li >
< / ul >
< / div >
< div class = "subNav" >
< ul class = "navList" >
< li > < a href = "../../../../inf112/fiasko/roborally/objects/Particle.html" title = "class in inf112.fiasko.roborally.objects" > < span class = "typeNameLink" > Prev Class< / span > < / a > < / li >
< li > < a href = "../../../../inf112/fiasko/roborally/objects/Player.html" title = "class in inf112.fiasko.roborally.objects" > < span class = "typeNameLink" > Next Class< / span > < / a > < / li >
< / ul >
< ul class = "navList" >
< li > < a href = "../../../../index.html?inf112/fiasko/roborally/objects/Phase.html" target = "_top" > Frames< / a > < / li >
< li > < a href = "Phase.html" target = "_top" > No Frames< / a > < / li >
< / ul >
< ul class = "navList" id = "allclasses_navbar_bottom" >
< li > < a href = "../../../../allclasses-noframe.html" > All 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: < / li >
< li > Nested | < / li >
< li > Field | < / li >
< li > < a href = "#constructor.summary" > Constr< / a > | < / li >
< li > < a href = "#method.summary" > Method< / a > < / li >
< / ul >
< ul class = "subNavList" >
< li > Detail: < / li >
< li > Field | < / li >
< li > < a href = "#constructor.detail" > Constr< / a > | < / li >
< li > < a href = "#method.detail" > Method< / a > < / li >
< / ul >
< / div >
< a name = "skip.navbar.bottom" >
<!-- -->
< / a > < / div >
<!-- ======== END OF BOTTOM NAVBAR ======= -->
< / body >
< / html >