Interface ITeamRobotPeer

    • Method Detail

      • getTeammates

        java.lang.String[] getTeammates()
        Returns the names of all teammates, or null there is no teammates.

        Example:

           public void run() {
               // Prints out all teammates
               String[] teammates = getTeammates();
               if (teammates != null) {
                   for (String member : teammates) {
                       out.println(member);
                   }
               }
           }
         
        Returns:
        a String array containing the names of all your teammates, or null if there is no teammates. The length of the String array is equal to the number of teammates.
        See Also:
        isTeammate(String), broadcastMessage(Serializable), sendMessage(String, Serializable)
      • isTeammate

        boolean isTeammate​(java.lang.String name)
        Checks if a given robot name is the name of one of your teammates.

        Example:

           public void onScannedRobot(ScannedRobotEvent e) {
               if (isTeammate(e.getName()) {
                   return;
               }
               fire(1);
           }
         
        Parameters:
        name - the robot name to check
        Returns:
        true if the specified name belongs to one of your teammates; false otherwise.
        See Also:
        getTeammates(), broadcastMessage(Serializable), sendMessage(String, Serializable)
      • broadcastMessage

        void broadcastMessage​(java.io.Serializable message)
                       throws java.io.IOException
        Broadcasts a message to all teammates.

        Example:

           public void run() {
               broadcastMessage("I'm here!");
           }
         
        Parameters:
        message - the message to broadcast to all teammates
        Throws:
        java.io.IOException - if the message could not be broadcasted to the teammates
        See Also:
        isTeammate(String), getTeammates(), sendMessage(String, Serializable)
      • sendMessage

        void sendMessage​(java.lang.String name,
                         java.io.Serializable message)
                  throws java.io.IOException
        Sends a message to one (or more) teammates.

        Example:

           public void run() {
               sendMessage("sample.DroidBot", "I'm here!");
           }
         
        Parameters:
        name - the name of the intended recipient of the message
        message - the message to send
        Throws:
        java.io.IOException - if the message could not be sent
        See Also:
        isTeammate(String), getTeammates(), broadcastMessage(Serializable)
      • getMessageEvents

        java.util.List<MessageEvent> getMessageEvents()
        Returns a vector containing all MessageEvents currently in the robot's queue. You might, for example, call this while processing another event.

        Example:

           for (MessageEvent e : getMessageEvents()) {
              // do something with e
           }
         
        Returns:
        a vector containing all MessageEvents currently in the robot's queue
        Since:
        1.2.6
        See Also:
        onMessageReceived(MessageEvent), MessageEvent