File /std/npc/types/transport.c

Written by Pinkfish, Goldenthread/Runtime

Started Tue Sep 21 18:21:13 PDT 1999 still going, Wed Jun 25 13:40:12 GMT 2003

Inherits

Includes

Method index

• add_response(string)
  This method adds a response to thoses the transport may choose from when issued a voice command
• add_rider(object)
  This adds a rider to the list of riders
• add_transport_commands(object)
• bolt_transport(int)
  This method bolts the transport when it encounters a fight.
• check_doing_follow(object, string, string)
  This method is called when ever someone we are following causes us to move.
• do_allow(string)
  This allows someone to use the transport.
• do_disallow(string)
  This disallows someone from using transports.
• do_dismount()
  This is used to get off the transport the easy way.
• do_lead()
  This sets up the transport for being led.
• do_list()
  This method lists the people currently able to use your transports.
• do_mount()
  Mount the transport!
• do_move_transport()
  This method moves the transport.
• do_name(string)
  This sets the transports name.
• do_offer(object *)
  This offers the transport food
• do_ride(string, int, string)
  Ride the transport off into the sunset.
• do_rustle()
  This method will attempt to get the transport rustled by some nasty pk person.
• do_slide_off(object)
  This method is called to make the object slide off.
• do_stop()
  Stop the transport from running off.
• do_tack(object *)
  This method puts stuff on the transport, like saddle bags, saddles and things.
• do_tether(object *)
  This method is used to tether the mount to something.
• do_untack(object *)
  This method removes stuff that you've tacked the transport with.
• do_untether()
  This method untethers the mount if it is tethered to someone.
• do_wander()
  This method causes the transport to wander randomly
• inform_of_move(string)
• is_allowed_to_use(string)
  This method checks to see if the specified person is allowed to do things to this transport.
• is_rider(object)
  This method checks to see if the person specified is actually a rider.
• query_allowed_directions(int)
  This returns the list of directions the transport can currently move from this location.
• query_bolting()
  This method returns if the transport is bolting or not.
• query_current_exhaustion()
  This method returns the current exhaustion points for the transport.
• query_default_direction_difficulty()
  This method determines the default directional control of the transport.
• query_default_mount_difficulty()
  This method returns the default mount difficulty for the transport.
• query_direction_as_number(string)
  This method turns a standard direction into a number.
• query_exhaustion_string()
  This method returns the string giving some indication about how tired the transport it.
• query_ideal_temp()
  This method returns the ideal temperature for the mount
• query_inside_long()
  This method returns the inside long of the transport.
• query_maximum_exhaustion()
  This method returns the maximum exhaustion points for the transport.
• query_maximum_speed()
  This method queries the maximum speed for the transport.
• query_owner()
  This method returns the current owner of the transport.
• query_owner_pk_check()
  This method returns the current owner of the transport, it is used by the pk checking code to make sure that this transport can be used in exciting pk ways.
• query_quiet()
  This method sets the quiet flag on the transport.
• query_responses()
  This method returns the responses the transport may choose from when issued a voice command
• query_riders()
  This method returns the current list of people riding the transport.
• query_speed_string(int, int)
  This method returns the string associated with the specified speed.
• query_stabled()
  This method returns the stabled flag of the transport.
• query_tethered_to()
  This method returns the object we are currently tethered to.
• query_transport()
  This method will tell if the object is a transport or not.
• query_transport_base_name()
  This method returns the base name of the transport.
• query_transport_colour()
  returns the mount's colour
• query_transport_desc()
  This returns the basic desc of the transport
• query_transport_id()
  This method returns the id of the transport.
• query_transport_name()
  This method returns the full name of the transport.
• query_transport_speed()
  This method returns the amount of time it takes to move the transport one room.
• query_transport_type()
  This method returns the type of transport that this is.
• query_value()
  This method returns the value of the transport.
• query_wander_time()
  This method returns the amount of time before the mount will wander
• remove_rider(object)
  This method removes a rider from the list of riders.
• set_current_exhaustion(int)
  This method sets the current exhaustion points for the transport.
• set_default_direction_difficulty(int)
  This method determines the default directional control of the transport.
• set_default_mount_difficulty(int)
  This method sets the default mount difficulty for the transport.
• set_ideal_temp(int)
  This method set the mount's ideal temperature
• set_inside_long(string)
  This method sets the inside long of the transport.
• set_maximum_exhaustion(int)
  This method sets the maximum exhaustion points for the transport.
• set_maximum_speed(int)
  This method sets the maximum speed for the transport.
• set_owner(string)
  This method sets the owner of the transport.
• set_quiet(int)
  This method sets the quiet flag on the transport.
• set_responses(string *)
  This method sets the array of responses the transport may choose from when issued a voice command
• set_tethered_to(object)
  This method sets the object we are tethered to.
• set_transport_base_name(string)
  This method sets the name of the transport.
• set_transport_colour(string)
  This sets the mount's colour
• set_transport_id(int)
  This method sets the id of the transpot.
• set_transport_speed(int)
  This sets the speed at which the transport defaults to moving.
• set_value(int)
  This method sets the value of the transport.
• set_wander_time(int)
  This method sets the new wander time
• setup_movement()
  Sets up the call_out if needed.
• tell_riders(string)
  This method tells the riders about something.

Public Functions

These are functions that everyone can access.

.

add_response

void add_response(string resp)


This method adds a response to thoses the transport may choose from when issued a voice command

• Parameters:
  resp - the response to add

add_rider

int add_rider(object rider)


This adds a rider to the list of riders

• Parameters:
  rider - the rider to add
• Returns:
  1 on success, 0 on failure
  add_transport_commands

  int add_transport_commands(object ob)
  

  bolt_transport

  void bolt_transport(int multiplier)
  

  
  This method bolts the transport when it encounters a fight.
  
  • Parameters:
    multiplier - make the difficulty harder
    check_doing_follow

    int check_doing_follow(object thing,
                           string verb,
                           string special)
    

    
    This method is called when ever someone we are following causes us to move.
    do_allow

    int do_allow(string person)
    

    
    This allows someone to use the transport.
    
    • Parameters:
      person - the person to allow
    • Returns:
      1 if successful, 0 if not
      do_disallow

      int do_disallow(string person)
      

      
      This disallows someone from using transports.
      
      • Parameters:
        person - the person to disallow
      • Returns:
        1 if successful, 0 if not
        do_dismount

        int do_dismount()
        

        
        This is used to get off the transport the easy way.
        
        • Returns:
          1 on success, 0 on failure
          do_lead

          int do_lead()
          

          
          This sets up the transport for being led. Basicly it just makes the transport follow you.
          
          • Returns:
            1 on success, 0 on failure
            do_list

            int do_list()
            

            
            This method lists the people currently able to use your transports.
            
            • Returns:
              1 on success, 0 on failure
              do_mount

              int do_mount()
              

              
              Mount the transport!
              
              • Returns:
                1 on success, 0 on failure
                do_move_transport

                void do_move_transport()
                

                
                This method moves the transport.
                do_name

                int do_name(string name)
                

                
                This sets the transports name.
                
                • Parameters:
                  name - the name to set the transport to
                • Returns:
                  1 on success, 0 on failure
                  do_offer

                  int do_offer(object * food)
                  

                  
                  This offers the transport food
                  
                  • Parameters:
                    food - the food objects offered to the transport
                  • Returns:
                    1 on success, 0 on failure
                    do_ride

                    int do_ride(string direction,
                                int speed,
                                string type)
                    

                    
                    Ride the transport off into the sunset.
                    
                    • Returns:
                      1 on success, 0 on failure
                      do_rustle

                      int do_rustle()
                      

                      
                      This method will attempt to get the transport rustled by some nasty pk person.
                      
                      • Returns:
                        1 on success, 0 on failure
                        do_slide_off

                        void do_slide_off(object thing)
                        

                        
                        This method is called to make the object slide off.
                        
                        • Parameters:
                          ob - the object sliding off
                          do_stop

                          int do_stop()
                          

                          
                          Stop the transport from running off.
                          
                          • Returns:
                            1 on success, 0 on failure
                            do_tack

                            int do_tack(object * obs)
                            

                            
                            This method puts stuff on the transport, like saddle bags, saddles and things.
                            
                            • Parameters:
                              obs - the objects to try and tack the transport in
                              do_tether

                              int do_tether(object * obs)
                              

                              
                              This method is used to tether the mount to something. The transport must be wearing something that responds to the id 'tether'.
                              
                              • Parameters:
                                obs - the thing to tether us too
                              • Returns:
                                1 on success, 0 on failure
                                do_untack

                                int do_untack(object * obs)
                                

                                
                                This method removes stuff that you've tacked the transport with.
                                
                                • Parameters:
                                  obs - the object to try to untack
                                  do_untether

                                  int do_untether()
                                  

                                  
                                  This method untethers the mount if it is tethered to someone.
                                  
                                  • Returns:
                                    1 on success, 0 on failure
                                    do_wander

                                    void do_wander()
                                    

                                    
                                    This method causes the transport to wander randomly
                                    is_allowed_to_use

                                    int is_allowed_to_use(string name)
                                    

                                    
                                    This method checks to see if the specified person is allowed to do things to this transport.
                                    
                                    • Parameters:
                                      name - the name of the person to check
                                    • Returns:
                                      1 if they can do things, 0 if not
                                      is_rider

                                      int is_rider(object ob)
                                      

                                      
                                      This method checks to see if the person specified is actually a rider.
                                      
                                      • Returns:
                                        1 if they are a rider, 0 if not
                                        query_allowed_directions

                                        string * query_allowed_directions(int no_last)
                                        

                                        
                                        This returns the list of directions the transport can currently move from this location. It takes in account things like size and if the exit is obvious or not.
                                        
                                        • Parameters:
                                          no_last - don't go back where we came from
                                          query_bolting

                                          int query_bolting()
                                          

                                          
                                          This method returns if the transport is bolting or not.
                                          
                                          • Returns:
                                            1 if it's bolting, 0 if not
                                            query_current_exhaustion

                                            int query_current_exhaustion()
                                            

                                            
                                            This method returns the current exhaustion points for the transport.
                                            
                                            • Returns:
                                              the current exhaustion points
                                              query_default_direction_difficulty

                                              int query_default_direction_difficulty()
                                              

                                              
                                              This method determines the default directional control of the transport. (no reins? Where do you think your going?)
                                              
                                              • Returns:
                                                the default directional difficulty
                                                query_default_mount_difficulty

                                                int query_default_mount_difficulty()
                                                

                                                
                                                This method returns the default mount difficulty for the transport.
                                                
                                                • Returns:
                                                  the default difficulty
                                                  query_direction_as_number

                                                  int query_direction_as_number(string direction)
                                                  

                                                  
                                                  This method turns a standard direction into a number.
                                                  
                                                  • Parameters:
                                                    direction - the direction to turn into a number
                                                  • Returns:
                                                    the number associated with the direction
                                                    query_exhaustion_string

                                                    string query_exhaustion_string()
                                                    

                                                    
                                                    This method returns the string giving some indication about how tired the transport it.
                                                    
                                                    • Returns:
                                                      the exhaustion string of the transport
                                                      query_ideal_temp

                                                      int query_ideal_temp()
                                                      

                                                      
                                                      This method returns the ideal temperature for the mount
                                                      
                                                      • Returns:
                                                        the ideal temperature
                                                        query_inside_long

                                                        string query_inside_long()
                                                        

                                                        
                                                        This method returns the inside long of the transport.
                                                        
                                                        • Returns:
                                                          the inside long of the transport
                                                          query_maximum_exhaustion

                                                          int query_maximum_exhaustion()
                                                          

                                                          
                                                          This method returns the maximum exhaustion points for the transport.
                                                          
                                                          • Returns:
                                                            the maximum exhaustion points
                                                            query_maximum_speed

                                                            int query_maximum_speed()
                                                            

                                                            
                                                            This method queries the maximum speed for the transport.
                                                            
                                                            • Returns:
                                                              the maximum speed for the transport
                                                              query_owner

                                                              string query_owner()
                                                              

                                                              
                                                              This method returns the current owner of the transport.
                                                              
                                                              • Returns:
                                                                the current owner of the transport
                                                                query_owner_pk_check

                                                                string query_owner_pk_check()
                                                                

                                                                
                                                                This method returns the current owner of the transport, it is used by the pk checking code to make sure that this transport can be used in exciting pk ways.
                                                                
                                                                • Returns:
                                                                  the owner
                                                                  query_quiet

                                                                  int query_quiet()
                                                                  

                                                                  
                                                                  This method sets the quiet flag on the transport. If they are quiet they will not say anything when they do commands and so on.
                                                                  
                                                                  • Returns:
                                                                    the current setting of the quiet flag
                                                                    query_responses

                                                                    string * query_responses()
                                                                    

                                                                    
                                                                    This method returns the responses the transport may choose from when issued a voice command
                                                                    
                                                                    • Returns:
                                                                      the array of responses
                                                                      query_riders

                                                                      object * query_riders()
                                                                      

                                                                      
                                                                      This method returns the current list of people riding the transport.
                                                                      
                                                                      • Returns:
                                                                        the list of people riding the transport
                                                                        query_speed_string

                                                                        string query_speed_string(int speed,
                                                                                                  int bolt)
                                                                        

                                                                        
                                                                        This method returns the string associated with the specified speed.
                                                                        
                                                                        • Parameters:
                                                                          speed - the speed to check
                                                                          bolt - if the transport is bolting
                                                                        • Returns:
                                                                          the name of the speed
                                                                          query_stabled

                                                                          int query_stabled()
                                                                          

                                                                          
                                                                          This method returns the stabled flag of the transport.
                                                                          
                                                                          • Returns:
                                                                            the stabled flag
                                                                            query_tethered_to

                                                                            object query_tethered_to()
                                                                            

                                                                            
                                                                            This method returns the object we are currently tethered to.
                                                                            
                                                                            • Returns:
                                                                              the object we are tethered to
                                                                              query_transport

                                                                              int query_transport()
                                                                              

                                                                              
                                                                              This method will tell if the object is a transport or not.
                                                                              
                                                                              • Returns:
                                                                                1 if it is a transport
                                                                                query_transport_base_name

                                                                                string query_transport_base_name()
                                                                                

                                                                                
                                                                                This method returns the base name of the transport.
                                                                                
                                                                                • Returns:
                                                                                  the base name of the transport
                                                                                  query_transport_colour

                                                                                  string query_transport_colour()
                                                                                  

                                                                                  
                                                                                  returns the mount's colour
                                                                                  
                                                                                  • Returns:
                                                                                    the colour
                                                                                    query_transport_desc

                                                                                    string query_transport_desc()
                                                                                    

                                                                                    
                                                                                    This returns the basic desc of the transport
                                                                                    
                                                                                    • Returns:
                                                                                      the basic desc of the transport
                                                                                      query_transport_id

                                                                                      int query_transport_id()
                                                                                      

                                                                                      
                                                                                      This method returns the id of the transport.
                                                                                      
                                                                                      • Returns:
                                                                                        the id of the transport
                                                                                        query_transport_name

                                                                                        string query_transport_name()
                                                                                        

                                                                                        
                                                                                        This method returns the full name of the transport.
                                                                                        
                                                                                        • Returns:
                                                                                          the full name of the transport
                                                                                          query_transport_speed

                                                                                          int query_transport_speed()
                                                                                          

                                                                                          
                                                                                          This method returns the amount of time it takes to move the transport one room.
                                                                                          
                                                                                          • Returns:
                                                                                            the amount of time to move one room
                                                                                            query_transport_type

                                                                                            string query_transport_type()
                                                                                            

                                                                                            
                                                                                            This method returns the type of transport that this is.
                                                                                            
                                                                                            • Returns:
                                                                                              the type of transport
                                                                                              query_value

                                                                                              int query_value()
                                                                                              

                                                                                              
                                                                                              This method returns the value of the transport.
                                                                                              
                                                                                              • Returns:
                                                                                                value
                                                                                                query_wander_time

                                                                                                int query_wander_time()
                                                                                                

                                                                                                
                                                                                                This method returns the amount of time before the mount will wander
                                                                                                
                                                                                                • Returns:
                                                                                                  the wander time
                                                                                                  remove_rider

                                                                                                  int remove_rider(object rider)
                                                                                                  

                                                                                                  
                                                                                                  This method removes a rider from the list of riders.
                                                                                                  
                                                                                                  • Parameters:
                                                                                                    rider - the rider to remove
                                                                                                  • Returns:
                                                                                                    1 on success, 0 on failure
                                                                                                    set_current_exhaustion

                                                                                                    int set_current_exhaustion(int points)
                                                                                                    

                                                                                                    
                                                                                                    This method sets the current exhaustion points for the transport.
                                                                                                    
                                                                                                    • Parameters:
                                                                                                      points - the current exhaustion points
                                                                                                      set_default_direction_difficulty

                                                                                                      void set_default_direction_difficulty(int difficulty)
                                                                                                      

                                                                                                      
                                                                                                      This method determines the default directional control of the transport. (no reins? Where do you think your going?)
                                                                                                      
                                                                                                      • Parameters:
                                                                                                        difficulty - the default directional difficulty
                                                                                                        set_default_mount_difficulty

                                                                                                        void set_default_mount_difficulty(int difficulty)
                                                                                                        

                                                                                                        
                                                                                                        This method sets the default mount difficulty for the transport.
                                                                                                        
                                                                                                        • Parameters:
                                                                                                          difficulty - The default difficulty
                                                                                                          set_ideal_temp

                                                                                                          void set_ideal_temp(int temp)
                                                                                                          

                                                                                                          
                                                                                                          This method set the mount's ideal temperature
                                                                                                          
                                                                                                          • Parameters:
                                                                                                            temp - the ideal temperature
                                                                                                            set_inside_long

                                                                                                            void set_inside_long(string long)
                                                                                                            

                                                                                                            
                                                                                                            This method sets the inside long of the transport. This is what people will see when they are inside a transport.
                                                                                                            
                                                                                                            • Parameters:
                                                                                                              long - the inside of the long of the transport
                                                                                                              set_maximum_exhaustion

                                                                                                              void set_maximum_exhaustion(int num)
                                                                                                              

                                                                                                              
                                                                                                              This method sets the maximum exhaustion points for the transport.
                                                                                                              
                                                                                                              • Parameters:
                                                                                                                exhaust - the maximum exhaustion points
                                                                                                                set_maximum_speed

                                                                                                                int set_maximum_speed(int speed)
                                                                                                                

                                                                                                                
                                                                                                                This method sets the maximum speed for the transport.
                                                                                                                
                                                                                                                • Parameters:
                                                                                                                  the - maximum speed
                                                                                                                • Returns:
                                                                                                                  1 if successful, 0 on invalid speed
                                                                                                                  set_owner

                                                                                                                  void set_owner(string owner)
                                                                                                                  

                                                                                                                  
                                                                                                                  This method sets the owner of the transport. This should be used when the owner is changed.
                                                                                                                  
                                                                                                                  • Parameters:
                                                                                                                    owner - the new owner of the transport
                                                                                                                    set_quiet

                                                                                                                    void set_quiet(int quiet)
                                                                                                                    

                                                                                                                    
                                                                                                                    This method sets the quiet flag on the transport. If they are quiet they will not say anything when they do commands and so on.
                                                                                                                    
                                                                                                                    • Parameters:
                                                                                                                      quiet - the new value for the quiet flag
                                                                                                                      set_responses

                                                                                                                      void set_responses(string * resp)
                                                                                                                      

                                                                                                                      
                                                                                                                      This method sets the array of responses the transport may choose from when issued a voice command
                                                                                                                      
                                                                                                                      • Parameters:
                                                                                                                        resp - the array of responses
                                                                                                                        set_tethered_to

                                                                                                                        void set_tethered_to(object ob)
                                                                                                                        

                                                                                                                        
                                                                                                                        This method sets the object we are tethered to.
                                                                                                                        
                                                                                                                        • Parameters:
                                                                                                                          ob - the object we are tethered to, 0 if we are not tethered
                                                                                                                          set_transport_base_name

                                                                                                                          void set_transport_base_name(string name)
                                                                                                                          

                                                                                                                          
                                                                                                                          This method sets the name of the transport.
                                                                                                                          
                                                                                                                          • Parameters:
                                                                                                                            name - sets the name of the transport
                                                                                                                            set_transport_colour

                                                                                                                            void set_transport_colour(string colour)
                                                                                                                            

                                                                                                                            
                                                                                                                            This sets the mount's colour
                                                                                                                            
                                                                                                                            • Parameters:
                                                                                                                              colour - the colour
                                                                                                                              set_transport_id

                                                                                                                              void set_transport_id(int id)
                                                                                                                              

                                                                                                                              
                                                                                                                              This method sets the id of the transpot.
                                                                                                                              
                                                                                                                              • Parameters:
                                                                                                                                id - the id of the transport
                                                                                                                                set_transport_speed

                                                                                                                                void set_transport_speed(int num)
                                                                                                                                

                                                                                                                                
                                                                                                                                This sets the speed at which the transport defaults to moving. This is how long it takes to move one room by default.
                                                                                                                                
                                                                                                                                • Parameters:
                                                                                                                                  the - default number of action points
                                                                                                                                  set_value

                                                                                                                                  void set_value(int value)
                                                                                                                                  

                                                                                                                                  
                                                                                                                                  This method sets the value of the transport.
                                                                                                                                  
                                                                                                                                  • Parameters:
                                                                                                                                    value - the value of the transport
                                                                                                                                    set_wander_time

                                                                                                                                    void set_wander_time(int time)
                                                                                                                                    

                                                                                                                                    
                                                                                                                                    This method sets the new wander time
                                                                                                                                    
                                                                                                                                    • Parameters:
                                                                                                                                      time - The new wander time
                                                                                                                                      setup_movement

                                                                                                                                      void setup_movement()
                                                                                                                                      

                                                                                                                                      
                                                                                                                                      Sets up the call_out if needed.
                                                                                                                                      tell_riders

                                                                                                                                      void tell_riders(string str)
                                                                                                                                      

                                                                                                                                      
                                                                                                                                      This method tells the riders about something.
                                                                                                                                      
                                                                                                                                      • Parameters:
                                                                                                                                        str - the message to tell the riders

                                                                                                                                        Protected Functions

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

                                                                                                                                        void inform_of_move(string dir)