File /cmds/player/group_cmds/base_group.c

To create a new sub command that plugs in to the master "group" command, create a new file in the directory where sub commands are stored and have it inherit this file.

One file can support several verbs, however it is strongly discouraged unless they are *very* closely tied together. The file also supports different patterns for the same verb, which is no problem, and in no way discouraged.

It is suggested you name the file the same name as the verb(s) it declares.

Written by Tape

Method index

• add_group_sub_command(string, string, function)
  This function declares a new sub command.
• query_group_sub_command_amount()
  This is the signature function for a group sub command.
• query_group_sub_command_function(string, string)
  This function returns the command function for a specific verb and pattern.
• query_group_sub_command_patterns(string)
  This function returns all patterns for a specific verb.
• query_group_sub_command_verbs()
  This function returns all the verbs that have been declared by this object.
• query_leadership_required(string, string)
  This function returns whether a command user has to be the leader of a group in order to use that command.
• query_membership_required(string, string)
  This function returns whether a command user has to be a member of a group in order to use that command.
• remove_group_sub_command(string, string)
  This function will remove a command from the list of declared sub commands.
• set_leadership_required(string, string, int)
  This function sets a flag which requires the player accessing the command to be the leader of a group.
• set_membership_required(string, string, int)
  This function sets a flag which requires the player accessing the command to be a member of a group.

Public Functions

These are functions that everyone can access.

.

add_group_sub_command

int add_group_sub_command(string verb,
                          string pattern,
                          function cmd_function)


This function declares a new sub command. If the verb provided already exists, it assumes it is a version of the command that uses a different pattern. If the verb *and* the pattern already exist, the function will fail. The cmd_function variable should point to the function which contains the command code. This function will return 1 or 0 depending if the command succeeds and is passed the same arguments as normal commands get. An additional argument ($6) can be included which returns the group this_player() is a member of (if any).

• Parameters:
  verb - the verb for the command
  pattern - the command pattern
  cmd_function - the command function
• Returns:
  1 on success, 0 on failure
• See also:
  add_command()
• Example:
  

  add_group_sub_command( "join", "", (: do_join( $1, $6 ) :)
  

query_group_sub_command_amount

int query_group_sub_command_amount()


This is the signature function for a group sub command.

• Returns:
  number of sub-commands
  query_group_sub_command_function

  varargs function * query_group_sub_command_function(string verb,
                                                      string pattern)
  

  
  This function returns the command function for a specific verb and pattern. If only the verb is provided, all functions for that verb are returned (in no particular order).
  
  • Parameters:
    verb - the command verb
    pattern - the command pattern (optional)
  • Returns:
    array of pointer(s) to the function, 0 if verb/pattern doesn't exist
    query_group_sub_command_patterns

    string * query_group_sub_command_patterns(string verb)
    

    
    This function returns all patterns for a specific verb.
    
    • Parameters:
      verb - the verb you want patterns for
    • Returns:
      a string array of the patterns, 0 if verb doesn't exist
      query_group_sub_command_verbs

      string * query_group_sub_command_verbs()
      

      
      This function returns all the verbs that have been declared by this object.
      
      • Returns:
        a string array of the verbs
        query_leadership_required

        varargs int query_leadership_required(string verb,
                                              string pattern)
        

        
        This function returns whether a command user has to be the leader of a group in order to use that command. If no pattern is provided, a flag for a random pattern for that verb is returned. This is not suggested unless it is certain that all patterns use the same settings, and/or there is only one pattern for that verb.
        
        • Parameters:
          verb - the command verb
          pattern - the pattern for the verb (optional)
        • Returns:
          1 if membership is required, 0 if not, -1 if verb/pattern not found
          query_membership_required

          varargs int query_membership_required(string verb,
                                                string pattern)
          

          
          This function returns whether a command user has to be a member of a group in order to use that command. If no pattern is provided, a flag for a random pattern for that verb is returned. This is not suggested unless it is certain that all patterns use the same settings, and/or there is only one pattern for that verb.
          
          • Parameters:
            verb - the command verb
            pattern - the pattern for the verb (optional)
          • Returns:
            1 if membership is required, 0 if not, -1 if verb/pattern not found
            remove_group_sub_command

            varargs int remove_group_sub_command(string verb,
                                                 string pattern)
            

            
            This function will remove a command from the list of declared sub commands. If a pattern is provided, it will try to only remove that specific pattern.
            
            • Parameters:
              verb - the verb to be removed
              pattern - the specific pattern to be removed (optional)
            • Returns:
              1 on success, 0 on failure
              set_leadership_required

              int set_leadership_required(string verb,
                                          string pattern,
                                          int flag)
              

              
              This function sets a flag which requires the player accessing the command to be the leader of a group. This is automatically handled by the master command before the actual command function is called. If no pattern is specified, then the flag is set for all patterns of that verb.
              
              • Parameters:
                verb - the command verb
                pattern - the command pattern, or 0
              • Returns:
                1 on success, 0 if verb/pattern not found
                set_membership_required

                int set_membership_required(string verb,
                                            string pattern,
                                            int flag)
                

                
                This function sets a flag which requires the player accessing the command to be a member of a group. This is automatically handled by the master command before the actual command function is called. If no pattern is specified, then the flag is set for all patterns of that verb.
                
                • Parameters:
                  verb - the command verb
                  pattern - the command pattern, or 0
                • Returns:
                  1 on success, 0 if verb/pattern not found