cusack.hcg.games.portallord

Class PortalLordInstance

java.lang.Object

java.util.Observable

cusack.hcg.model.PuzzleInstance

cusack.hcg.games.portallord.PortalLordInstance

All Implemented Interfaces:

DrawableGraphProblem, java.util.Observer

Direct Known Subclasses:

PortalForgerInstance

public abstract class PortalLordInstance
extends PuzzleInstance

Constructor Summary

Constructors

Constructor and Description
PortalLordInstance()

Method Summary

Modifier and Type	Method and Description
void	clear(java.util.ArrayList<Vertex> toClear)
void	decodeData(java.lang.String configuration) Decode a string into the game data for the particular game.
java.lang.String	encodePuzzleData() Encode the game data as a String.
boolean	getIsNumberUsed(int value)
int	getMaxBandwidth()
java.lang.String	getProcessedSolution() Probably not used.
boolean	isCurrentStateValidSolution() Each instance needs to determine when the solution is valid.
boolean	isEventForThisPuzzleType(Event<?> e) Return true iff this event is of type T.
boolean	isSolutionRefinable() For optimization problems, for instance, this will return true.
void	setIsNumberUsed(int value, boolean b)
void	setValue(Vertex v, int newValue)
boolean	tryItResultsAreBinding() Return true only if Try It mode, using the type from getTryItInstance, will produce a result that is AWLAYS valid for the puzzle type.
void	unClear(java.util.ArrayList<Vertex> toUnClear, java.util.ArrayList<java.lang.Integer> values)
java.lang.String	uniqueIdentifier(Vertex v) Return a string that represents the data related to the given Vertex in a way that is different if the data is different.
void	unsetValue(Vertex v)
void	updateStateBasedOnAlgorithmResult(java.lang.String algorithmResult) Updates the algorithm's state based on the algorithm result.
boolean	usesAlgorithms() If the game related to this problem requires running algorithms, this should return true.

Methods inherited from class cusack.hcg.model.PuzzleInstance

addDoppelganger, addGraph, addGraphWithData, addToSelected, addToSelected, addVertex, canRedo, canUndo, checkAndHandlePuzzleCompletion, clearAllSelections, clearHistory, clearTutorial, computeGlobalPoints, connectAllSelectedVertices, connectToSelected, convertMovesToTutorial, copyPuzzle, copyPuzzleSoItHasInitialStateTheSameAsMyCurrentState, copyRequested, copySelected, createNewVertexForPuzzle, currentPuzzleDataToString, deleteSelected, disableHistory, disconnectFromSelected, disconnectSelected, doNotRecordGraphEvents, enableHistory, endGame, forceRedo, getAttemptName, getBasePoints, getCurrentAnnotation, getCurrentMoveOverview, getCurrentUndoableEvent, getData, getDefaultVertexDataObject, getDescription, getDiameter, getDifficultyLevel, getEdgeDataClassName, getEditHelpClassName, getEditorClassName, getFamilyName, getFirstSelected, getFirstTimeBonus, getGameName, getGlobalBest, getGraph, getHelpClassName, getHighScoreBonus, getImprovementBonus, getInstanceClassName, getInterestingTutorialVertices, getMaximumXCoordinate, getMaximumYCoordinate, getMessage, getMinimumSelectedXCoordinate, getMinimumSelectedYCoordinate, getMinimumXCoordinate, getMinimumYCoordinate, getMode, getNumberOfEdges, getNumberOfMoves, getNumberOfVertices, getNumberSelected, getOldHighScore, getPersonalBest, getPlayClassName, getPuzzleID, getPuzzleInstanceName, getPuzzleName, getScore, getSelectedVertices, getSolution, getSolutionAsString, getSolutionID, getThemeClassName, getTimeTaken, getTopOfUndoStack, getTryItInstanceForUseOnPlayScreen, getTutorialData, getUserID, getVertexIndex, getVertices, getVisibility, getVisibleSources, goToNextEvent, grossHistoryDeleteLastEvent, grossHistoryGetLastAddedEvent, grossHistoryGetNextEvent, grossHistoryGetNextEventIndex, grossHistoryIsSaved, grossHistoryIteratorAtBeginning, grossHistoryIteratorAtEnd, grossHistoryNext, grossHistoryPrevious, grossHistorySetSaved, grossHistorySize, grossHistoryToBeginning, grossHistoryToEnd, initialPuzzleDataToString, isFinishable, isInReplayOrEditTutorialMode, isLocked, isLowerScoreBetter, isPlayable, isSaved, isShowIndices, isSpecialCopyOK, isTutorial, isValidToTranslationSelection, isVisibleSource, makeCurrentStateInitialState, moveGraphEnded, moveSelectedVerticesEnded, moveStarted, pasteAndConnectCopyOfSelected, pasteCopyOfSelected, performEvents, performEvents, performTutorialEvents, reallySetLocked, recordGraphEvents, redo, removeFromSelected, removeFromSelected, resetVerticesToInitialLocations, restart, runAlgorithms, runuTryIt, selectAll, sendAlgorithmResult, sendMeaninglessEvent, setAttemptName, setData, setDefaultData, setDescription, setFinishable, setGlobalBest, setGraph, setInReplayOrEditTutorialMode, setLocked, setMessage, setMode, setPersonalBest, setPlayable, setPuzzle, setPuzzleID, setPuzzleName, setSaved, setShowIndices, setSolutionData, setSolutionID, setSolutionInformation, setUserID, setVisibleSources, startTimer, stopTimer, stringToPuzzleData, submit, toggleSelected, tutorialModeEnabled, undo, update, updateTimeTaken

Methods inherited from class java.util.Observable

addObserver, countObservers, deleteObserver, deleteObservers, hasChanged, notifyObservers, notifyObservers

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

PortalLordInstance

public PortalLordInstance()

Method Detail

isEventForThisPuzzleType

public boolean isEventForThisPuzzleType(Event<?> e)

Description copied from class: PuzzleInstance

Return true iff this event is of type T. Stupid method that is necessary because Java is dumb. One would like to ask 'if(x instanceof T)', but since Java throws away Generics at runtime, it doesn't know what T is, so you can't ask this. This is an important method because (I think) that this is the only thing that ensure the right sort of objects are placed on history and the wrong ones aren't. Since the UndoRedoHistory is not properly parameterized (don't get me started on how much I hate Generics in Java) I think this method is the only thing that makes sure that if an RecordableEvent calls its performEvent method, that the PuzzleInstance object passed in is the correct one (for instance, a PebbleInstance must be passed if movePebbles is called since otherwise the program will crash). This may only be used in one place, but it is still necessary. CAC, Feb 2010.

Specified by:

isEventForThisPuzzleType in class PuzzleInstance

Returns:

setValue

public void setValue(Vertex v,
                     int newValue)

clear

public void clear(java.util.ArrayList<Vertex> toClear)

unClear

public void unClear(java.util.ArrayList<Vertex> toUnClear,
                    java.util.ArrayList<java.lang.Integer> values)

unsetValue

public void unsetValue(Vertex v)

setIsNumberUsed

public void setIsNumberUsed(int value,
                            boolean b)

getIsNumberUsed

public boolean getIsNumberUsed(int value)

getMaxBandwidth

public int getMaxBandwidth()

encodePuzzleData

public java.lang.String encodePuzzleData()

Description copied from class: PuzzleInstance

Encode the game data as a String. This should NOT include the initial character which encodes which game type this is--that is automatically included.

Returns:

a string that contains encoded puzzle data.

decodeData

public void decodeData(java.lang.String configuration)

Description copied from class: PuzzleInstance

Decode a string into the game data for the particular game. This String does NOT include the initial character which encodes the type of game--that is dealt with by the method that calls this.

Parameters:

configuration - a string containing the encoded puzzle data.

isSolutionRefinable

public boolean isSolutionRefinable()

Description copied from class: PuzzleInstance

For optimization problems, for instance, this will return true. For decision problems, this will generally return false.

Specified by:

isSolutionRefinable in class PuzzleInstance

Returns:

true if the solution can be defined.

usesAlgorithms

public boolean usesAlgorithms()

Description copied from class: PuzzleInstance

If the game related to this problem requires running algorithms, this should return true. In addition there must be a class in the game package called FooAlgorithmRunner.

Specified by:

usesAlgorithms in class PuzzleInstance

Returns:

true if this problem requires running algorithms.

isCurrentStateValidSolution

public boolean isCurrentStateValidSolution()

Description copied from class: PuzzleInstance

Each instance needs to determine when the solution is valid.

Specified by:

isCurrentStateValidSolution in class PuzzleInstance

Returns:

true if the current state is a valid solution.

updateStateBasedOnAlgorithmResult

public void updateStateBasedOnAlgorithmResult(java.lang.String algorithmResult)

Description copied from class: PuzzleInstance

Updates the algorithm's state based on the algorithm result. (This is mostly for Confound It and Optimize It, but it may be useful for other things.)

Specified by:

updateStateBasedOnAlgorithmResult in class PuzzleInstance

Parameters:

algorithmResult - a boolean that describes the result of the algorithm.

tryItResultsAreBinding

public boolean tryItResultsAreBinding()

Description copied from class: PuzzleInstance

Return true only if Try It mode, using the type from getTryItInstance, will produce a result that is AWLAYS valid for the puzzle type. For instance, in Optimize it, valid is solvable, and if in Try It the player shows it is solvable, then it is correct. On the other hand Confound It is not binding because if you play it and don't find it solvable, that doesn't mean anything.

Specified by:

tryItResultsAreBinding in class PuzzleInstance

getProcessedSolution

public java.lang.String getProcessedSolution()

Probably not used. For now, we'll just return the solution data.

Specified by:

getProcessedSolution in class PuzzleInstance

uniqueIdentifier

public java.lang.String uniqueIdentifier(Vertex v)

Description copied from class: PuzzleInstance

Return a string that represents the data related to the given Vertex in a way that is different if the data is different. e.g. if the only data is number of pebbles, it can just return the number of pebbles as a string. If there is no real data, returning an empty string is acceptable.

Specified by:

uniqueIdentifier in class PuzzleInstance

Returns: