View Javadoc

1   /*
2    @See License.txt@
3    */
4   package spellcast.beings;
5   
6   import spellcast.gestures.Gesture;
7   import spellcast.questions.IQuestion;
8   
9   /***
10   * A Wizard of Spellcast.
11   *
12   * @author Barrie Treloar
13   * @version $Revision: 1.1 $
14   */
15  public interface IWizard extends IBeing {
16  
17      /***
18       * Whether the Wizard has completed their actions for this turn and is ready for the next turn.
19       *
20       * @return true if the Wizard is ready, false otherwise.
21       */
22      boolean isReady();
23  
24      /***
25       * Indicate whether the Wizard has completed all the actions for this turn and is ready for the turn to be completed.
26       *
27       * @param isReady true if the Wizard is ready, false otherwise.
28       */
29      void setReady(boolean isReady);
30  
31      /***
32       * Get the value of leftHandGesture.
33       *
34       * @return value of leftHandGesture.
35       */
36      Gesture getLeftHandGesture();
37  
38      /***
39       * Set the value of leftHandGesture.
40       *
41       * @param theGesture Value to assign to leftHandGesture.
42       */
43      void setLeftHandGesture(Gesture theGesture);
44  
45      /***
46       * Get the value of rightHandGesture.
47       *
48       * @return value of rightHandGesture.
49       */
50      Gesture getRightHandGesture();
51  
52      /***
53       * Set the value of rightHandGesture.
54       *
55       * @param theGesture Value to assign to rightHandGesture.
56       */
57      void setRightHandGesture(Gesture theGesture);
58  
59      /***
60       * Add a <code>IQuestion</code> to the <code>IWizard</code>.
61       *
62       * @param theQuestionToAsk the <code>IQuestion</code> to ask the <code>IWizard</code>
63       */
64      void addQuestion(IQuestion theQuestionToAsk);
65  
66  }