File /std/room/inherit/player_housing.c

It handles the internals for player housing. When creating a house you should inherit "/std/room/player_housing" rather than this inheritable.

Written by Belle, Gototh, Ceres

Inherits

Includes

Class Index

• decoration
  This class is used to store information on the decoration of this room (for walls, floor etc.
• exit_data
  This class stores information that we need to save about exits.
• exit_shorts
  This class is used to cache short names for exits so we don't go loading rooms all over the place.

Method index

• add_allowed(string)
  This function adds a name to the allow list of this room.
• add_surface(string, string)
  Add a surface (wall, floor etc.
• debug_log(string, mixed args)
  This class is used to cache short names for exits so we don't go loading rooms all over the place.
• decorate_surface(string, string)
  Modify a surface (wall, floor etc.
• do_allow(object, string)
• event_enter_checks(object)
  This method is used to setup things when someone enters the room.
• is_allowed(string)
  This method tells us if the person is allowed to use this room.
• ownership_change(string, string)
  This function informs the house that its owner has changed, it does not actually change the owner since that is done in the handler.
• query_allowed()
  This method returns the current list of people allowed to modify this room.
• query_base_desc()
  Query the fixed part of the description.
• query_owner()
  This method returns the current owner of the house.
• query_quit_handler()
  This method returns the room that people will be placed in if they logout while in this room and not allowed to control this room.
• remove_allowed(string)
  This function removes a name from the allow list of this room.
• set_base_desc(string)
  Set the fixed part of the long description.
• set_owner(string)
  This method locally sets the owner of the house.
• set_quit_handler(string)
  Set the room into which people should be placed if they quit in this room but are not allowed to control this room.
• test_occupier(string)
  This function determines if a given individual can be considered to be the occupier of this house.

Public Functions

These are functions that everyone can access.

.

add_allowed

int add_allowed(string pname)


This function adds a name to the allow list of this room.

• Parameters:
  pname - The name of a player.
• Returns:
  1 for success, 0 for failure

add_surface

void add_surface(string short,
                 string covering)


Add a surface (wall, floor etc.) and give the basic covering the surface has prior to decoration.

• Parameters:
  short - The short name of the surface (eg. north wall)
  covering - The text of the covering (eg. finished pine board)
  debug_log

  void debug_log(string fmt,
                 mixed args ...)
  

  
  This class is used to cache short names for exits so we don't go loading rooms all over the place.
  decorate_surface

  int decorate_surface(string short,
                       string covering)
  

  
  Modify a surface (wall, floor etc.) and give it a new covering.
  
  • Parameters:
    short - The short of the surface.
    covering - The new covering decsription.
  • Returns:
    1 for success, 0 for failure
  • See also:
    add_surface .c
    do_allow

    int do_allow(object player,
                 string location)
    

    is_allowed

    int is_allowed(string name)
    

    
    This method tells us if the person is allowed to use this room.
    
    • Parameters:
      name - the name of the person
      ownership_change

      int ownership_change(string old_owner,
                           string new_owner)
      

      
      This function informs the house that its owner has changed, it does not actually change the owner since that is done in the handler.
      
      • Parameters:
        old_owner - The name of the old owner
        new_owner - The name of the new owner
      • Returns:
        1 for success, 0 for failure.
        query_allowed

        string * query_allowed()
        

        
        This method returns the current list of people allowed to modify this room.
        
        • Returns:
          the allowed people to change this room
          query_base_desc

          string query_base_desc()
          

          
          Query the fixed part of the description.
          
          • Returns:
            the description
          • See also:
            set_base_desc .c
            query_owner

            string query_owner()
            

            
            This method returns the current owner of the house.
            query_quit_handler

            string query_quit_handler()
            

            
            This method returns the room that people will be placed in if they logout while in this room and not allowed to control this room.
            
            • Returns:
              string the filename of the room.
            • See also:
              set_quit_handler.c
              remove_allowed

              int remove_allowed(string pname)
              

              
              This function removes a name from the allow list of this room.
              
              • Parameters:
                pname - The name of a player.
              • Returns:
                1 for success, 0 for failure
                set_base_desc

                void set_base_desc(string desc)
                

                
                Set the fixed part of the long description.
                
                • Parameters:
                  desc - The description. (eg. a small and cosy front room)
                  set_owner

                  string set_owner(string who)
                  

                  
                  This method locally sets the owner of the house.
                  set_quit_handler

                  void set_quit_handler(string filename)
                  

                  
                  Set the room into which people should be placed if they quit in this room but are not allowed to control this room.
                  
                  • Parameters:
                    filename - the filename of a room.
                    test_occupier

                    int test_occupier(string name)
                    

                    
                    This function determines if a given individual can be considered to be the occupier of this house. Normally this means the person currently renting or owning this house. For shared ownership houses simply mask this function and do whatever you have to. :)
                    
                    • Parameters:
                      name - The person to be tested
                    • Returns:
                      1 if they are the occupier, 0 if not.

                      Protected Functions

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

                      void event_enter_checks(object ob)
                      

                      
                      This method is used to setup things when someone enters the room.
                      
                      • Parameters:
                        ob - the object that entered the room

                        Classes

                        These are nice data types for dealing with... Data!
                        • decoration

                          class decoration {
                                             string short;
                                             string covering;
                          }
                          
                          

                          
                          This class is used to store information on the decoration of this room (for walls, floor etc.)

                        • exit_data

                          class exit_data {
                                            string long;
                                            string key;
                                            int difficulty;
                                            int closed;
                                            int locked;
                                            int autolock;
                                            int transparent;
                                            mixed trap_data;
                          }
                          
                          

                          
                          This class stores information that we need to save about exits. For example if the player has changed the lock or added a trap.

                        • exit_shorts

                          class exit_shorts {
                                              string one_short;
                                              string a_short;
                          }
                          
                          

                          
                          This class is used to cache short names for exits so we don't go loading rooms all over the place.