File /global/start_position.c

See also:
/global/player.c

Written by Pinkfish

Inherits

Includes

Method index

• add_start(string, string)
  This method will add a new start location to the player.
• check_last_pos()
  This method figured out what the last saved position was and sets it on the player.
• inform_entered_game()
  This method handles informing people that the player has entered the game.
• inform_reconnect_game()
  THis method is called to inform people that someone has just reconnected.
• move_to_start_pos()
  This method moves the player to the last saved position.
• query_last_pos()
  This method returns the last saved position of the player.
• query_saved_co_ords()
  This method returns the co-ordinates of the room in which the player last saved.
• query_start_pos()
  This method returns the starting location of the player.
• query_starts()
  This method returns the current array of possible start positions on the player.
• remove_start(string)
  This method will remove a start location from the player.
• reset_starts()
  This method resets the start locations back to an empty array.
• set_last_pos(string)
  This method sets the current start location.
• set_start_location(string)
  This method sets the start location of the player.

Public Functions

These are functions that everyone can access.

.

add_start

void add_start(string start_file,
               string start_desc)


This method will add a new start location to the player. The description will be used in the starts command.

• Parameters:
  start_file - the file name of the start location
  start_desc - the description of the start location
• See also:
  query_start_pos(), reset_starts() , remove_start(), query_starts() and set_start_location()
• Example:
  

  // NB: This should be done with a define :)
  player->add_start("/d/am/am/mendeddrum", "the mended drum");
  

check_last_pos

void check_last_pos()


This method figured out what the last saved position was and sets it on the player. This basicly sets the last saved postion.

• See also:
  query_last_pos()
  inform_reconnect_game

  void inform_reconnect_game()
  

  
  THis method is called to inform people that someone has just reconnected.
  query_last_pos

  string query_last_pos()
  

  
  This method returns the last saved position of the player.
  
  • Returns:
    the last saved position
    query_saved_co_ords

    int * query_saved_co_ords()
    

    
    This method returns the co-ordinates of the room in which the player last saved.
    
    • Returns:
      the last saved co-ordinates
    • See also:
      check_last_pos(), move_to_start() and query_start_pos()
      query_start_pos

      string query_start_pos()
      

      
      This method returns the starting location of the player. This the location they will start at if the saved position does not work for some reason.
      
      • Returns:
        the start position to use
      • See also:
        query_starts(), add_start(), remove_start(), reset_starts() and set_start_location()
        query_starts

        string * query_starts()
        

        
        This method returns the current array of possible start positions on the player.
        
        • Returns:
          the array of possible start locations
        • See also:
          query_start_pos(), add_start(), remove_start(), reset_starts() and set_start_location()
          remove_start

          void remove_start(string start_file)
          

          
          This method will remove a start location from the player.
          
          • Parameters:
            start_file - the file name of the location to remove
          • See also:
            query_start_pos(), reset_starts(), add_start(), query_starts() and set_start_location()
          • Example:
            

            // NB: This should be done with a define :)
            player->remove_start("/d/am/am/mendeddrum");
            

            reset_starts

            void reset_starts()
            

            
            This method resets the start locations back to an empty array.
            
            • See also:
              query_start_pos(), add_start(), remove_start(), query_starts() and set_start_location()
              set_start_location

              void set_start_location(string start_file)
              

              
              This method sets the start location of the player.
              
              • Parameters:
                start_file - the start location to set
              • See also:
                query_start_pos(), reset_starts(), remove_start(), query_starts() and add_start()
              • Example:
                

                // NB: This should be done with a define :)
                player->set_start_location("/d/am/am/mendeddrum");
                

                Protected Functions

                These are functions that only objects inheriting the class can access.
                inform_entered_game

                void inform_entered_game()
                

                
                This method handles informing people that the player has entered the game.
                
                • See also:
                  move_to_start_pos()
                  move_to_start_pos

                  void move_to_start_pos()
                  

                  
                  This method moves the player to the last saved position. This should only be called in the startup sequence. If the last location could not be loaded, the the start position will be used.
                  
                  • See also:
                    query_last_pos() and quert_start_pos()
                    set_last_pos

                    void set_last_pos(string pos)
                    

                    
                    This method sets the current start location.
                    
                    • Parameters:
                      last_pos - the start location