Difference between revisions of "Manual:DIL Manual/findroom()"

From DikuMUD Wiki
Jump to navigation Jump to search
(XML import)
 
 
Line 1: Line 1:
 
 
<span id="bffindr"></span>
 
 
  unitptr findroom ( s : string )
 
  unitptr findroom ( s : string )
 
     s : Symbolic name of room.
 
     s : Symbolic name of room.
Line 7: Line 4:
 
     Example: findroom("inn@udgaard")
 
     Example: findroom("inn@udgaard")
  
  ---~---~---~---~---~---~---~---~---
+
Will return the unitptr to the room. If the symbolic name is not a room then NULL will
 +
be returned. Using findsymbolic(#) is equally efficient and does the same except it
 +
returns any type. This function is really mostly here for historical reasons.

Latest revision as of 07:02, 20 January 2021

unitptr findroom ( s : string )
   s : Symbolic name of room.
   return: A pointer to the room, or null
   Example: findroom("inn@udgaard")

Will return the unitptr to the room. If the symbolic name is not a room then NULL will be returned. Using findsymbolic(#) is equally efficient and does the same except it returns any type. This function is really mostly here for historical reasons.