File /std/effects/object/talker.c

Describe the arguments in here.

See also:
help::effects .c

Includes

Method index

• all_channels(object)
  This method is used to determine which talker channels can use.
• channels()
  This returns the channels that a player is on in a nifty formatted way.
• clear_cache(string)
  This method is used to clear a specific person's cache details.
• find_actual_talker(object)
• list(string, int)
  This method returns a formatted list of which players are using the talker.
• new_talker_args()
  This method returns the "default" effect arguments.
• normalise_name(string)
• query_channel_cache(string)
  This method is used for debugging purposes to query the channel cache.
• valid(mixed, object)
  This method is used to check whether or not a channel (or a list of channels are valid.

Public Functions

These are functions that everyone can access.

.

all_channels

string * all_channels(object player)


This method is used to determine which talker channels can use. It also caches the data so that it only has to be recalculated once.




• Parameters:
  player - the player's channel list to generate
• Returns:
  an array of channel names. (string *)
• See also:
  clear_cache() and query_channel_cache()

channels

string channels()


This returns the channels that a player is on in a nifty formatted way. Used in the channel list and talker shadow.

• Returns:
  a list of channels that this_player() is on.
  clear_cache

  void clear_cache(string person)
  

  
  This method is used to clear a specific person's cache details. It is called from the shadow when a person attempts to re-add a channel, so they their details can be updated.
  
  • Parameters:
    person - the person's name to clear from the cache.
    find_actual_talker

    object find_actual_talker(object thing)
    

    list

    string list(string word,
                int brief)
    

    
    This method returns a formatted list of which players are using the talker.
    
    • Parameters:
      word - the name of a specific channel to get a listing of.
      brief - only show the people, not what they are listening to
    • Returns:
      a formatted string containing who is on a channel.
      normalise_name

      string normalise_name(string channel)
      

      query_channel_cache

      varargs mapping query_channel_cache(string person)
      

      
      This method is used for debugging purposes to query the channel cache.
      
      • Parameters:
        person - the name of a person to query. If this is not specified, then the entire channel cache is returned.
      • Returns:
        a mapping containing channel cache data.
        valid

        varargs int valid(mixed word,
                          object who)
        

        
        This method is used to check whether or not a channel (or a list of channels are valid.
        
        • Parameters:
          word - if this is a string, then valid() checks to see whether or not the channel can be used. If it is an array, then it validates all the channels mentioned.
        • Returns:
          1 if the channel (or channels) are valid, 0 if they are not.

          Protected Functions

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

          class talker_args new_talker_args()
          

          
          This method returns the "default" effect arguments. They are used if the existing ones are invalid (or old).
          
          • Returns:
            a talker_args class containing "new" arguments.