File /std/basic/close_lock.c

Written by Gototh

Includes

Method index

• add_close_lock_commands(object)
  This method adds the lock commands to the specified player.
• pick_unlock(object)
  This is called when someone successfully unlocks the object.
• query_autolock()
  This tells us whether an object will lock automatically when closed.
• query_closed()
  This function tells you whether an object is open or closed.
• query_closed_locked_status()
  This method returns the closed and locked status.
• query_difficulty()
  This returns the difficulty picking the lock on the object.
• query_key()
  This returns the property of the key that will unlock the object.
• query_lock_trap_func()
  This returns the name of the function to be called when some attempts to unlock the object.
• query_lock_trap_ob()
  This returns the object on which the trap function is stored.
• query_locked()
  This tells us whether an object is locked.
• query_open()
  This function tells you whether an object is open or closed.
• query_open_trap_func()
  This returns the name of the function to be called when someone tries to open the object.
• query_open_trap_ob()
  This returns the object on which the trap function is stored.
• query_pick_skill()
  This returns the name of the skill which is used when determining if the object can be unlocked.
• query_stuck()
  This tells you whether an object is stuck or not.
• query_transparent()
  This method returns the current transparent value of the object.
• query_unlocked()
  This tells us whether an object is unlocked.
• reset_transparent()
  This method removes the current objects transparent status.
• set_autolock(int)
  This sets the object so that it will lock automatically when closed.
• set_closed(int)
  This sets the object as being closed.
• set_difficulty(int)
  This sets how difficult the lock on an object is to pick.
• set_key(mixed)
  This sets the property of the key that will unlock the object.
• set_lock_trap(object, string)
  This sets the function to be called when someone attempts to unlock the object.
• set_locked()
  This sets the object as being locked.
• set_open(int)
  This sets the object as being open.
• set_open_trap(object, string)
  This sets the function to be called when someone attempts to open the object.
• set_pick_skill(string)
  This sets the skill that will be used when attempting to pick the lock.
• set_stuck(int)
  This can set an object as being stuck, or make it unstuck.
• set_transparent()
  This sets the object as being transparent.
• set_unlocked()
  This sets the object as being unlocked.

Public Functions

These are functions that everyone can access.

.

add_close_lock_commands

void add_close_lock_commands(object player)


This method adds the lock commands to the specified player. It's been abstracted out of init() to make it easier for some odd situations (like the t-shop).
pick_unlock

int pick_unlock(object player)


This is called when someone successfully unlocks the object. If there is a trap, and the trap function returns true, the object will not be opened. If the trap function returns false, the object will still be opened even if the trap is sprung.

• Parameters:
  player - The player who is unlocking the object.
• Returns:
  Returns 1 if the object was unlocked, and 0 otherwise.

query_autolock

int query_autolock()


This tells us whether an object will lock automatically when closed.

• Returns:
  1 for true 0 for false;
• See also:
  set_autolock()
  query_closed

  int query_closed()
  

  
  This function tells you whether an object is open or closed. It returns 1 if the object is closed, and 0 if the object is open.
  
  • Returns:
    Return 1 if closed, 0 if open.
  • See also:
    set_open() and set_closed()
    query_closed_locked_status

    int query_closed_locked_status()
    

    
    This method returns the closed and locked status. The status is 0 if open and unlocked, 1 if locked, 2 if closed and 3 if closed and locked.
    
    • Returns:
      closed and locked status
      query_difficulty

      int query_difficulty()
      

      
      This returns the difficulty picking the lock on the object. By default it is set to 200 unless it has been changed with set_difficulty().
      
      • See also:
        set_difficulty()
        query_key

        string query_key()
        

        
        This returns the property of the key that will unlock the object.
        
        • See also:
          set_key()
          query_lock_trap_func

          string query_lock_trap_func()
          

          
          This returns the name of the function to be called when some attempts to unlock the object.
          
          • Returns:
            The function to be called when someone attempts to unlock the object.
          • See also:
            set_open_trap() and query_open_trap_ob()
            query_lock_trap_ob

            object query_lock_trap_ob()
            

            
            This returns the object on which the trap function is stored. The trap function is called when someone tries to unlock the the object.
            
            • Returns:
              The function to be called when the object is opened.
            • See also:
              set_open_trap() and query_open_trap_func()
              query_locked

              int query_locked()
              

              
              This tells us whether an object is locked. It returns 1 if the object is locked and 0 is the object is unlocked.
              
              • Returns:
                Return 1 if locked and 0 if unlocked.
              • See also:
                set_locked() and set_unlocked()
                query_open

                int query_open()
                

                
                This function tells you whether an object is open or closed. It returns 1 if the object is open and 0 if the object is closed.
                
                • Returns:
                  Return 1 if open, 0 if closed.
                • See also:
                  set_open() and set_closed()
                  query_open_trap_func

                  string query_open_trap_func()
                  

                  
                  This returns the name of the function to be called when someone tries to open the object.
                  
                  • Returns:
                    The function to be called when the object is opened.
                  • See also:
                    set_open_trap() and query_open_trap_ob()
                    query_open_trap_ob

                    object query_open_trap_ob()
                    

                    
                    This returns the object on which the trap function is stored. The trap function is called when someone tries to open the the object.
                    
                    • Returns:
                      The function to be called when the object is opened.
                    • See also:
                      set_open_trap() and query_open_trap_func()
                      query_pick_skill

                      string query_pick_skill()
                      

                      
                      This returns the name of the skill which is used when determining if the object can be unlocked.
                      
                      • See also:
                        set_pick_skill()
                        query_stuck

                        int query_stuck()
                        

                        
                        This tells you whether an object is stuck or not. It will return 1 if the object is stuck, and 0 if the object is not stuck.
                        
                        • Returns:
                          Return 1 if the object is stuck, and 0 if it is not.
                        • See also:
                          set_stuck()
                          query_transparent

                          int query_transparent()
                          

                          
                          This method returns the current transparent value of the object. A transparent object is one in which you can see the inventory even if it is closed. This is also used for light propogration.
                          
                          • Returns:
                            1 if the object is transparent
                          • See also:
                            reset_transparent() and query_transparent()
                            query_unlocked

                            int query_unlocked()
                            

                            
                            This tells us whether an object is unlocked. It returns 1 if the object is unlocked and 0 is the object is locked.
                            
                            • Returns:
                              Return 1 if unlocked and 0 if locked.
                            • See also:
                              set_locked() and set_unlocked()
                              reset_transparent

                              void reset_transparent()
                              

                              
                              This method removes the current objects transparent status. A transparent object is one in which you can see the inventory even if it is closed. This is also used for light propogration.
                              
                              • See also:
                                set_transparent() and query_transparent()
                                set_autolock

                                void set_autolock(int number)
                                

                                
                                This sets the object so that it will lock automatically when closed.
                                
                                • Parameters:
                                  number - 1 for autolock, 0 for no autolock.
                                  set_closed

                                  varargs void set_closed(int no_event)
                                  

                                  
                                  This sets the object as being closed. If you are moving objects into the object, make sure that you do not set the object as closed and then try to move the objects in. Move the objects in and then close the object.
                                  
                                  • See also:
                                    set_open() and query_closed()
                                    set_difficulty

                                    void set_difficulty(int i)
                                    

                                    
                                    This sets how difficult the lock on an object is to pick. By default it is set to 200.
                                    
                                    • Parameters:
                                      i - The difficulty of the lock to pick.
                                    • See also:
                                      query_difficulty()
                                      set_key

                                      void set_key(mixed val)
                                      

                                      
                                      This sets the property of the key that will unlock the object. This can be a string, or a function pointer which will evaluate to a string.
                                      
                                      • Parameters:
                                        val - The property the key must have to unlock the object.
                                      • See also:
                                        set_locked()
                                        set_lock_trap

                                        void set_lock_trap(object ob,
                                                           string func)
                                        

                                        
                                        This sets the function to be called when someone attempts to unlock the object. The function does not have to be in the object's file, and can be specified using the 'ob' paramater. In most cases the function will be stored in the same file, so use this_object() in these cases. The function will be called with a single string parameter of "lock", "unlock" or "pick"
                                        
                                        • Parameters:
                                          ob - The object in which the function is stored.
                                          func - The function to be called.
                                        • See also:
                                          query_lock_trap_func() and query_lock_trap_ob()
                                          set_locked

                                          void set_locked()
                                          

                                          
                                          This sets the object as being locked. Remember to set the object as being closed before using this. In most cases you should probably use set_key() to set the key which opens the lock and use set_difficulty() to set the skill level required to pick the lock.
                                          
                                          • See also:
                                            set_open(), set_closed(), set_key() and set_difficulty()
                                            set_open

                                            varargs void set_open(int no_event)
                                            

                                            
                                            This sets the object as being open. Note that to find out if an object is open we use query_closed() which will return 0 if the object is open.
                                            
                                            • See also:
                                              set_closed() and query_closed()
                                              set_open_trap

                                              void set_open_trap(object ob,
                                                                 string func)
                                              

                                              
                                              This sets the function to be called when someone attempts to open the object. The function does not have to be in the object's file, and can be specified using the 'ob' paramater. In most cases the function will be stored in the same file, so use this_object() in these cases. The function will be called with a single string parameter of "open" or "close"
                                              
                                              • Parameters:
                                                ob - The object in which the function is stored.
                                                func - The function to be called.
                                              • See also:
                                                query_open_trap_func() and query_open_trap_ob()
                                                set_pick_skill

                                                void set_pick_skill(string str)
                                                

                                                
                                                This sets the skill that will be used when attempting to pick the lock. By default it is set to "covert.lockpick.safes" so it need only be changed if you want to check a different skill.
                                                
                                                • Parameters:
                                                  str - The skill to use when picking the lock.
                                                • See also:
                                                  query_pick_skill() and set_difficulty()
                                                  set_stuck

                                                  void set_stuck(int i)
                                                  

                                                  
                                                  This can set an object as being stuck, or make it unstuck. Stuck objects cannot be opened, closed, locked or unlocked. Using set_stuck(1) will make the object stuck, and set_stuck(0) will unstick it.
                                                  
                                                  • Parameters:
                                                    i - Use 1 to make the object stuck, and 0 to unstick it.
                                                  • See also:
                                                    query_stuck()
                                                    set_transparent

                                                    void set_transparent()
                                                    

                                                    
                                                    This sets the object as being transparent. A transparent object is one in which you can see the inventory even if it is closed.
                                                    
                                                    • See also:
                                                      reset_transparent() and query_transparent()
                                                      set_unlocked

                                                      void set_unlocked()
                                                      

                                                      
                                                      This sets the object as being unlocked.
                                                      
                                                      • See also:
                                                        set_locked()