File /global/line_ed.c

Expansion of the editor. We will now allow the player to use any of three different editors. One of them is the default (the old one) one of them is ed and the other I am going to write in a few secs....

cute line editor thing. Which even a player could use!

Written by Pinkfish

Includes

Method index

• append_signature()
  This method will create the signature to append to whatever needs a signature.
• do_edit(string, mixed, object, string, mixed)
  Edit a string.
• query_editor()
  This method will return the players current editor setting.
• query_in_editor()
  This method returns true if the player is currently in the editor.
• set_in_editor(int)
  This method is used to turn off the editing stuff.

Public Functions

These are functions that everyone can access.

.

append_signature

string append_signature()


This method will create the signature to append to whatever needs a signature.

• Returns:
  the players signature

do_edit

varargs int do_edit(string str,
                    mixed end_f,
                    object end_o,
                    string fname,
                    mixed extra)


Edit a string. This will edit the string or file name and then call the end function and end object at the end. It will pas in the string if the edit is successful, or 0 if it is not.

• Parameters:
  str - the string to edit
  end_f - the function to call
  end_o - the object to call it on (defaul: previous_object())
  fname - a specific filename to edit
  extra - an array of any parameters you need to carry into the end function
• Returns:
  0 on failure.
  query_editor

  string query_editor()
  

  
  This method will return the players current editor setting.
  
  • Returns:
    the current editor setting.
    query_in_editor

    int query_in_editor()
    

    
    This method returns true if the player is currently in the editor.
    
    • Returns:
      1 if the player is in the editor

      Protected Functions

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

      void set_in_editor(int value)
      

      
      This method is used to turn off the editing stuff.