File /std/room/basic/topography/fixed_shadow.c

See also:
topography .c

Written by Jeremy

Includes

Method index

• add_topo_barriers(mapping)
  This method adds directions from which the room cannot be reached.
• add_topo_exits(string *, string)
  This method adds exits for the room if they don't already exist.
• query_dest_other(string)
  This method masks the standard query_dest_other() function.
• query_fixed_room()
  This method can be used to determine if this is a fixed room.
• query_topo_barrier(string)
  This method returns the message associated with the given barred direction.
• query_topo_barriers()
  This method returns the current mapping of barriers.
• query_topo_handler()
  This method returns the topography handler set for this fixed room.
• set_area_handler(string)
  This method is deprecated.
• set_topo_handler(string)
  This method sets the topography handler for this fixed room.

Public Functions

These are functions that everyone can access.

.

add_topo_barriers

void add_topo_barriers(mapping m)


This method adds directions from which the room cannot be reached. The parameter is a mapping, giving the direction as the key and a message to be printed upon failure as the value.

NOTE: the direction is the direction the person is going (ie, the command given); e.g., to block access from the west, use "east" as the key.


• Parameters:
  m - a mapping representing the direction(s) from which to block access (the key) and a message to be printed (the value).
• See also:
  query_topo_barriers() and query_topo_barrier()

add_topo_exits

void add_topo_exits(string * other_exits,
                    string other_types)


This method adds exits for the room if they don't already exist. "compass4" and "compass8" can be specified as exit names to add exits for all of the normal 4 or 8 compass directions, respectively.

• Parameters:
  e - array of exit names
  type - type of exit ("path", "road", etc)
  query_dest_other

  varargs mixed * query_dest_other(string direc)
  

  
  This method masks the standard query_dest_other() function. It calls the topology handler to find the connecting room (which is usually cloned on-the-fly).
  
  • Parameters:
    direc - room exit name
  • Returns:
    structure describing the exit
  • See also:
    /std/room .c
    query_fixed_room

    int query_fixed_room()
    

    
    This method can be used to determine if this is a fixed room.
    
    • Returns:
      1
      query_topo_barrier

      mixed query_topo_barrier(string direc)
      

      
      This method returns the message associated with the given barred direction.
      
      • Parameters:
        direc - the direction to be queried
      • Returns:
        the failure message associated with the given direction
      • See also:
        add_topo_barriers() and query_topo_barriers()
        query_topo_barriers

        mapping query_topo_barriers()
        

        
        This method returns the current mapping of barriers.
        
        • Returns:
          the current mapping of barred directions and messages.
        • See also:
          add_topo_barriers() and query_topo_barrier()
          query_topo_handler

          string query_topo_handler()
          

          
          This method returns the topography handler set for this fixed room.
          
          • Returns:
            the topography handler
          • See also:
            set_topo_handler()
            set_area_handler

            void set_area_handler(string s)
            

            
            This method is deprecated. Use set_topo_handler().
            set_topo_handler

            void set_topo_handler(string s)
            

            
            This method sets the topography handler for this fixed room.
            
            • Parameters:
              s - pathname of topography handler
            • See also:
              topography.c and query_topo_handler()