[Crossfire-wiki] [Crossfire DokuWiki] page changed: cfpython

[no-reply_wiki at metalforge.org]

A page in your DokuWiki was added or changed. Here are the details:

Date        : 2007/03/31 15:55
User        : ryo
Edit Summary: update

@@ -74,10 +74,8 @@
  
  
  
  ===== Crossfire module methods =====
- 
- 
  
  ==== WhoAmI ====
  Returns the ''Crossfire.Object'' from which the event being handled was raised, corresponds to the "op" parameter of the event. Can be ''None''. For a map event, this is a ''Crossfire.Map'' 
  
@@ -109,18 +107,18 @@
  ==== TempDirectory ====
  Returns the system directory where temporary files are stored.
  
  ==== ConfigDirectory ====
- FIXME?
+ Returns the system directory containing configuration files.
  
  ==== LocalDirectory ====
- FIXME?
+ Returns the system directory containing read/write files.
  
  ==== PlayerDirectory ====
  Returns the system directory containing player files.
  
  ==== DataDirectory ====
- Returns the system directory containing persistent data.
+ Returns the system directory containing read-only data.
  
  ==== DirectionNorth ====
  ==== DirectionNorthEast ====
  ==== DirectionEast ====
@@ -146,14 +144,14 @@
  ''Flags'' specifies what kind of map should be loaded. It matches the 2nd argument of ''ready_map_name()'' {FIXME} add flags and such
  
  ==== FindPlayer ====
  Parameter:
-   * player name (string) FIXME partial?
+   * player name (string)
  
- Returns a ''Crossfire.Player'' object for specified player, based on name, or ''None'' if not found.
+ Returns a ''Crossfire.Player'' object for specified player, based on full name, or ''None'' if not found.
  
  ==== MatchString ====
- Parameters: FIXME check order
+ Parameters:
    * string to be searched
    * pattern to search for
  
  Returns ''1'' if string matches the pattern, ''0'' else.
@@ -176,11 +174,11 @@
  Returns an empty object which can then be manipulated and inserted in map.
  
  ==== CreateObjectByName ====
  Parameters:
-   * archetype name (string) FIXME make sure
+   * object or archetype name (string)
  
- Returns object of specified archetype, or ''None'' if archetype wasn't found.
+ Returns object with specified name or archetype, or ''None'' if no object has the name, and archetype wasn't found.
  
  ==== GetPrivateDictionary ====
  Returns a Python ''dictionary'' the script can use to store data between runs. This data is not shared with other scripts.
  
@@ -192,9 +190,8 @@
  Note that data will be lost in case of server restart.
  
  ==== GetArchetypes ====
  Returns a Python ''list'' containing ''Crossfire.Archetype'' objects representing all archetypes the server knows. Should not be called lightly, as this can take some time.
- 
  
  ==== GetMaps ====
  Returns a Python ''list'' containing ''[[cfpython#Crossfire.Map methods and attributes|Crossfire.Map]]'' objects, one for each map currently being loaded. This includes random and unique maps.
  


IP-Address  : 82.236.87.204
Old Revision: http://wiki.metalforge.net/doku.php/cfpython?rev=1175373178
New Revision: http://wiki.metalforge.net/doku.php/cfpython

-- 
This mail was generated by DokuWiki at
http://wiki.metalforge.net/