File /global/command.c

Includes

Method index

• AddSearchPath(mixed)
  Add a directory(s) into the search path for commands.
• cmdAll(string)
  Try and execute the command.
• cmdPatterns(string)
  This method tries to lookup the patterns for the given verb.
• command_commands()
  Add in the command catch all action.
• eventForce(string)
  A force event.
• GetClient()
  This tells us if we are a client.
• GetForced()
  This method returns if we are being forced or not
• GetSearchPath()
  This method returns the current search path
• query_current_cmd()
  What are the args to the current verb?
• query_current_verb()
  What is the current verb?
• RemoveSearchPath(mixed)
  Remove a directory(s) from the search path.

Public Functions

These are functions that everyone can access.

.

AddSearchPath

string * AddSearchPath(mixed val)


Add a directory(s) into the search path for commands. If the input is an array then the members of that are added to the search path.

• Parameters:
  val - the path to array
• Returns:
  the new search path

eventForce

int eventForce(string cmd)


A force event.

• Parameters:
  cmd - the command to force
• Returns:
  0 on failure and 1 on success
  GetClient

  string GetClient()
  

  
  This tells us if we are a client.
  
  • Returns:
    always returns 0
    GetForced

    int GetForced()
    

    
    This method returns if we are being forced or not
    
    • Returns:
      1 if we are being forced
      GetSearchPath

      string * GetSearchPath()
      

      
      This method returns the current search path
      
      • Returns:
        the current search path
        query_current_cmd

        string query_current_cmd()
        

        
        What are the args to the current verb?
        query_current_verb

        string query_current_verb()
        

        
        What is the current verb?
        RemoveSearchPath

        string * RemoveSearchPath(mixed val)
        

        
        Remove a directory(s) from the search path. If the input is an array then the members of that are added to the search path.
        
        • Parameters:
          val - the directory(s) to remove
        • Returns:
          the new search path

          Protected Functions

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

          int cmdAll(string args)
          

          
          Try and execute the command. It calls the fuinction command_shadowed with the verb and args as parameters if the command is found to exist.
          
          • Parameters:
            args - the args to use for the verb
          • Returns:
            1 on success, 0 on failure
            cmdPatterns

            mixed * cmdPatterns(string verb)
            

            
            This method tries to lookup the patterns for the given verb.
            
            • Parameters:
              verb - the verb to get the patterns for
            • Returns:
              the array of patterns
            • See also:
              /obj/handlers/pattern_compiler.c and /gloal/new_parse->add_command()
              command_commands

              void command_commands()
              

              
              Add in the command catch all action.