File /d/am/inherit/am_prison.c

Inherits

Includes

Class Index

• prisoner
  Class used to store the data for prisoners.

Method index

• add_cell(string, int)
  This function adds a cell to the prison.
• add_prisoner(object, int)
  This function adds a player as a prisoner.
• calculate_bail(string)
  Calculates the amount of money-units that bailing a player at this time costs.
• check_prisoners()
  This function is called by chime() to release all prisoners whos sentence is over and reduce the time left for those who have to stay a bit longer.
• clean_records()
  This function goes through the prisoner records and removes every one which does not have a valid user as the key.
• confiscate_items(object, object, int)
• do_bail_info(string)
  This command gives the player info on how much it will cost to bail another player.
• do_bail_out(object)
  This command bails a player from prison.
• do_imprison(object)
  The command used to imprison a criminal.
• do_release(string)
  This function is called when a player is due to be released from prison.
• do_return_stuff(string)
  This function loads a player's confiscated items, then calls out get_stuff_from_container to actually return the items.
• event_lockpick(object, object, int)
• get_stuff_from_container(string)
  Function which moves the items from a player's container back to the player.
• lock_cells()
  This function closes all cell-doors and locks them.
• perform_container_merge(object, object)
• prisoner_escape(string)
  This function is called by the cells if a player inside them leaves without haveing the "being released from prison"-property on him.
• prisoner_login(string)
  This function is called by the cells if a player logs in inside them.
• prisoner_net_dead(string)
  This function is called by the cells if a player inside them goes net-dead.
• prisoner_quit(string)
  This function is called by the cells if a player inside them quits.
• prisoner_refresh(string)
  This function is called by the watch-handler if a registered criminal refreshes or deletes.
• prisoner_release(string)
  This function is used to delete a prisoner from the prisoners-mapping and return his confiscated items.
• query_cells()
  This function returns the filenames of all the cells associated with this prison.
• query_prison()
  Function to verify this is a prison.
• query_prisoner(string)
  This function checks whether the specified player is a valid prisoner.
• query_prisoners()
  Function to return the _prisoners-mapping.
• query_savepath()
  Queries the path where the prison saves everything.
• query_tells_used(string)
  This function returns how many tells a prisoner has used.
• query_time_left(string)
• remove_cell(int)
  This function removes a cell from the prison.
• remove_corpse()
  This function removes all corpses from all cells and dumps them here.
• return_boxed_items(object, object)
• send_away_npcs()
  This functions clears up all NPCs in the room, since for some reasons they tend to pile up.
• set_guard(string)
  This sets the name of the guard to use.
• set_savepath(string)
  This sets the path where the prison shall store its savefile and those of the prisoners.
• tell_time_left(object)
  This function tells a player how much time he has left to serve.
• tell_used(string)
  This function is called when a prisoner uses up a tell.
• throw_out(object)
  This function throws a player out of prison if he doesn't belong there.
• time_passed_in_quarter_hour()
  This function calculates the time necessary to correct the quarter-hour reducing of the sentence directly after imprisonment.

Public Functions

These are functions that everyone can access.

.

add_cell

int add_cell(string cell,
             int security)


This function adds a cell to the prison. At the moment only one cell is permitted per security level.

• Parameters:
  cell - the filename of the cell
  security - the level of security, as defined in amcw.h
• Returns:
  1 on success, 0 on failure

add_prisoner

void add_prisoner(object prisoner,
                  int security)


This function adds a player as a prisoner. Creates the container where to store his item.s

• Parameters:
  prisoner - the player
  security - The security-level of the cell the player will be thrown into
  calculate_bail

  int calculate_bail(string name)
  

  
  Calculates the amount of money-units that bailing a player at this time costs.
  
  • Parameters:
    name - the name of the player
  • Returns:
    the cost or -1 on failure
    check_prisoners

    void check_prisoners()
    

    
    This function is called by chime() to release all prisoners whos sentence is over and reduce the time left for those who have to stay a bit longer.
    clean_records

    void clean_records()
    

    
    This function goes through the prisoner records and removes every one which does not have a valid user as the key.
    confiscate_items

    void confiscate_items(object prisoner,
                          object container,
                          int security)
    

    do_bail_info

    int do_bail_info(string name)
    

    
    This command gives the player info on how much it will cost to bail another player.
    
    • Parameters:
      name - the target's name
    • Returns:
      1 on success, 0 on failure
      do_bail_out

      int do_bail_out(object player)
      

      
      This command bails a player from prison.
      
      • Parameters:
        player - the player to bail
      • Returns:
        1 on success, 0 on failure
        do_imprison

        int do_imprison(object player)
        

        
        The command used to imprison a criminal. Gets the security level, removes the arrested-effect and turns the player over to the prison. NPCs are moved to the rubbish room.
        
        • Parameters:
          player - the target of imprisonment
        • Returns:
          1 on success, 0 on failure
          do_release

          void do_release(string name)
          

          
          This function is called when a player is due to be released from prison. Adds the "being released from prison"-property to prevent a player from running while his stuff is being returned.
          
          • Parameters:
            name - the name of the player
            do_return_stuff

            void do_return_stuff(string name)
            

            
            This function loads a player's confiscated items, then calls out get_stuff_from_container to actually return the items.
            
            • Parameters:
              name - the name of the player
              event_lockpick

              void event_lockpick(object ob,
                                  object player,
                                  int success)
              

              get_stuff_from_container

              void get_stuff_from_container(string name)
              

              
              Function which moves the items from a player's container back to the player. If he can't carry them for any reason, they are dropped onto the floor.
              
              • Parameters:
                name - the name of the prisoner
                lock_cells

                void lock_cells()
                

                
                This function closes all cell-doors and locks them.
                perform_container_merge

                void perform_container_merge(object container,
                                             object box)
                

                prisoner_escape

                void prisoner_escape(string name)
                

                
                This function is called by the cells if a player inside them leaves without haveing the "being released from prison"-property on him.
                
                • Parameters:
                  name - the name of the player
                  prisoner_login

                  void prisoner_login(string name)
                  

                  
                  This function is called by the cells if a player logs in inside them.
                  
                  • Parameters:
                    name - the name of the player
                    prisoner_net_dead

                    void prisoner_net_dead(string name)
                    

                    
                    This function is called by the cells if a player inside them goes net-dead.
                    
                    • Parameters:
                      name - the name of the player
                      prisoner_quit

                      void prisoner_quit(string name)
                      

                      
                      This function is called by the cells if a player inside them quits.
                      
                      • Parameters:
                        name - the name of the player
                        prisoner_refresh

                        void prisoner_refresh(string name)
                        

                        
                        This function is called by the watch-handler if a registered criminal refreshes or deletes. If he's got any items in this prison, the files are erased.
                        
                        • Parameters:
                          name - the name of the player
                          prisoner_release

                          void prisoner_release(string name)
                          

                          
                          This function is used to delete a prisoner from the prisoners-mapping and return his confiscated items.
                          
                          • Parameters:
                            name - the name of the player
                            query_cells

                            string * query_cells()
                            

                            
                            This function returns the filenames of all the cells associated with this prison.
                            
                            • Returns:
                              an array containing the filenames
                              query_prison

                              int query_prison()
                              

                              
                              Function to verify this is a prison.
                              
                              • Returns:
                                1
                                query_prisoner

                                int query_prisoner(string name)
                                

                                
                                This function checks whether the specified player is a valid prisoner.
                                
                                • Parameters:
                                  name - the name of the player
                                • Returns:
                                  1 if he is a prisoner, 0 if not
                                  query_prisoners

                                  mapping query_prisoners()
                                  

                                  
                                  Function to return the _prisoners-mapping. The elements are of the prisoner-class.
                                  
                                  • Returns:
                                    the mapping
                                    query_savepath

                                    string query_savepath()
                                    

                                    
                                    Queries the path where the prison saves everything.
                                    
                                    • Returns:
                                      the path
                                      query_tells_used

                                      int query_tells_used(string name)
                                      

                                      
                                      This function returns how many tells a prisoner has used.
                                      
                                      • Parameters:
                                        the - name of the player
                                      • Returns:
                                        the number of tells used, -1 on failure
                                        query_time_left

                                        int query_time_left(string name)
                                        

                                        remove_cell

                                        int remove_cell(int security)
                                        

                                        
                                        This function removes a cell from the prison.
                                        
                                        • Parameters:
                                          security - the level of security, as defined in amcw.h
                                        • Returns:
                                          1 on success, 0 on failure
                                          remove_corpse

                                          void remove_corpse()
                                          

                                          
                                          This function removes all corpses from all cells and dumps them here.
                                          return_boxed_items

                                          void return_boxed_items(object prisoner,
                                                                  object container)
                                          

                                          send_away_npcs

                                          void send_away_npcs()
                                          

                                          
                                          This functions clears up all NPCs in the room, since for some reasons they tend to pile up. Fighting NPCs are ignored. If the NPC does not have any move zones, it is assumed it is not supposed to wander around and moved to the rubbish room. If it does have one which is not Ankh-Morpork, add AM and send it away. Otherwise ignore it.
                                          set_guard

                                          int set_guard(string name)
                                          

                                          
                                          This sets the name of the guard to use.
                                          
                                          • Parameters:
                                            the - name to use, i.e. "Sergeant Flint"
                                          • Returns:
                                            1 on success, 0 on failure
                                            set_savepath

                                            int set_savepath(string path)
                                            

                                            
                                            This sets the path where the prison shall store its savefile and those of the prisoners.
                                            
                                            • Parameters:
                                              path - The path to use
                                            • Returns:
                                              1 on success, 0 on failure
                                              tell_time_left

                                              void tell_time_left(object player)
                                              

                                              
                                              This function tells a player how much time he has left to serve.
                                              
                                              • Parameters:
                                                player - the player
                                                tell_used

                                                void tell_used(string name)
                                                

                                                
                                                This function is called when a prisoner uses up a tell.
                                                
                                                • Parameters:
                                                  the - name of the player
                                                  throw_out

                                                  void throw_out(object player)
                                                  

                                                  
                                                  This function throws a player out of prison if he doesn't belong there.
                                                  
                                                  • Parameters:
                                                    player - the player
                                                    time_passed_in_quarter_hour

                                                    int time_passed_in_quarter_hour()
                                                    

                                                    
                                                    This function calculates the time necessary to correct the quarter-hour reducing of the sentence directly after imprisonment.

                                                    Classes

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

                                                      class prisoner {
                                                                       int cell;
                                                                       int time_to_serve;
                                                                       int logged_on;
                                                                       int confiscated;
                                                                       int tells_used;
                                                      }
                                                      
                                                      

                                                      
                                                      Class used to store the data for prisoners. cell - an integer representing the security level, as defined in amcw.h time_to_serve - how long the sentence will be, in seconds logged_on - no longer used confiscated - 1 if items have been confiscated, 0 if not tells_used - the number of tells used by the player