File /std/room/inherit/owned_room.c

Written by Pinkfish

Started 30th of June

Includes

Method index

• do_allow(string)
  This the main entry point for the allow command.
• do_disallow(string)
  This the main entry point for the disallow command.
• do_throwout(object *)
  This is the main entry point for the throwout command.
• is_allowed(string)
  This method tests to see if the person in question is either the owner or is allowed.
• is_allowed_in(string)
  This method checks to see if they are allowed in.
• load_room()
  This method loads the room setup.
• query_allowed()
  This method returns the current allowed list on the room.
• query_front_door()
  This method queries the current front door.
• query_owner()
  This method returns the owner of the room.
• query_save_file()
  This method returns the save file the owned room.
• save_room()
  This method saves the room setup.
• set_allowed(string *)
  This method sets the allowed array for the room.
• set_front_door(string)
  This method sets the exit that is the front door.
• set_owner(string)
  This method sets the owner of the room.
• set_save_file(string)
  This method sets the save file for the owned room.

Public Functions

These are functions that everyone can access.

.

is_allowed

int is_allowed(string person)


This method tests to see if the person in question is either the owner or is allowed.

• Parameters:
  person - the person to check

is_allowed_in

int is_allowed_in(string person)


This method checks to see if they are allowed in. Allow anyone in if the room is not locked.

• Parameters:
  person - the person to check
• Returns:
  1 if they are allowed in, 0 if not
  load_room

  void load_room()
  

  
  This method loads the room setup.
  query_allowed

  string * query_allowed()
  

  
  This method returns the current allowed list on the room.
  
  • Returns:
    the current allowed array
    query_front_door

    string query_front_door()
    

    
    This method queries the current front door.
    
    • Returns:
      the current front door
      query_owner

      string query_owner()
      

      
      This method returns the owner of the room.
      
      • Returns:
        the owner of the room
        query_save_file

        string query_save_file()
        

        
        This method returns the save file the owned room.
        
        • Returns:
          the save file for the owned room
          save_room

          void save_room()
          

          
          This method saves the room setup.
          set_front_door

          void set_front_door(string exit)
          

          
          This method sets the exit that is the front door.
          
          • Parameters:
            exit - the exit to use as the front door
            set_owner

            void set_owner(string owner)
            

            
            This method sets the owner of the room.
            
            • Parameters:
              owner - the new owner of the room
              set_save_file

              void set_save_file(string name)
              

              
              This method sets the save file for the owned room.
              
              • Parameters:
                save_file - the name of the save file

                Protected Functions

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

                int do_allow(string name)
                

                
                This the main entry point for the allow command.
                do_disallow

                int do_disallow(string name)
                

                
                This the main entry point for the disallow command.
                
                • Returns:
                  1 on succes, 0 on failure
                  do_throwout

                  int do_throwout(object * people)
                  

                  
                  This is the main entry point for the throwout command.
                  
                  • Parameters:
                    name - the name of the person to throwout
                  • Returns:
                    1 on success, 0 on failure
                    set_allowed

                    void set_allowed(string * allowed)
                    

                    
                    This method sets the allowed array for the room.
                    
                    • Parameters:
                      allowed - the new allowed array.