File /std/room/inherit/carriage/carriage.c

Inherits

Includes

Method index

• check_can_leave(string, object)
• co()
• create_bell()
• create_carriage_driver()
  This method should be overriden by higher level carriages to setup the driver correctly.
• create_fake_carriage()
  This creates the default fake carriage object (moved to rooms that the carriage stops at).
• do_ring()
• give_warning(string, string)
• make_carriage(string, class route_details, object)
  This is called by the handler to originaly setup the current route information.
• make_stop()
  Stop at the next location.
• move_on()
• query_carriage_name()
  This method returns the name of the route the carriage is on.
• query_current_stop()
  This method returns the details of the current stop.
• query_environ_long()
• query_moving_chats()
  Returns the default carriage-moving chats - can be overriden by higher level carriages for default ones)
• query_next_stop()
  This method returns the details of the next stop.
• query_outside()
  This method returns the object that is the outside of us.
• query_route_map()
  This method returns the entire details of the route used by this carriage.
• query_stop_info()
  This method returns the indexes of the current stop and the next stop.
• set_bell(object)
  Sets the bell object for the carriage
• set_fake_carriage(object)
  Sets the fake carriage object (moved to rooms that the carriage stops at)
• update_route(string, class route_details, object)
  This is called by the handler to update the current route information

Public Functions

These are functions that everyone can access.

.

check_can_leave

int check_can_leave(string exit,
                    object person)

co

mixed * co()

create_bell

object create_bell()

create_carriage_driver

object create_carriage_driver()


This method should be overriden by higher level carriages to setup the driver correctly.

• Returns:
  the driver to use for this carriage

create_fake_carriage

object create_fake_carriage()


This creates the default fake carriage object (moved to rooms that the carriage stops at). This method can be overriden to create a custom fake carriage

• Returns:
  the fake carriage object
  do_ring

  int do_ring()
  

  give_warning

  void give_warning(string this_stop_name,
                    string next_stop_name)
  

  make_carriage

  int make_carriage(string name,
                    class route_details new_route_info,
                    object handler)
  

  
  This is called by the handler to originaly setup the current route information.
  
  • Parameters:
    name - the name of the rotue
    new_route_info - the new route to use
    handler - the handler for the carriage
    make_stop

    void make_stop()
    

    
    Stop at the next location.
    move_on

    void move_on()
    

    query_carriage_name

    string query_carriage_name()
    

    
    This method returns the name of the route the carriage is on.
    
    • Returns:
      the name of the carriage route.
      query_current_stop

      class stop_list_details query_current_stop()
      

      
      This method returns the details of the current stop.
      
      • Returns:
        the details of the current stop
        query_environ_long

        string query_environ_long()
        

        query_moving_chats

        string * query_moving_chats()
        

        
        Returns the default carriage-moving chats - can be overriden by higher level carriages for default ones)
        
        • Returns:
          An array of room chats to play during carriage movement
          query_next_stop

          class stop_list_details query_next_stop()
          

          
          This method returns the details of the next stop.
          
          • Returns:
            the details of the next stop
            query_outside

            object query_outside()
            

            
            This method returns the object that is the outside of us.
            
            • Returns:
              the environment of the carriage
              query_route_map

              class route_details query_route_map()
              

              
              This method returns the entire details of the route used by this carriage.
              
              • Returns:
                the entire route details
                query_stop_info

                int * query_stop_info()
                

                
                This method returns the indexes of the current stop and the next stop.
                
                • Returns:
                  ({ current stop, next stop })
                  set_bell

                  void set_bell(object bell)
                  

                  
                  Sets the bell object for the carriage
                  
                  • Parameters:
                    the - bell object
                    set_fake_carriage

                    void set_fake_carriage(object carriage)
                    

                    
                    Sets the fake carriage object (moved to rooms that the carriage stops at)
                    
                    • Parameters:
                      update_route

                      void update_route(string name,
                                        class route_details new_route_info,
                                        object handler)
                      

                      
                      This is called by the handler to update the current route information
                      
                      • Parameters:
                        name - the name of the rotue
                        new_route_info - the new route to use
                        handler - the handler for the carriage