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

From DikuMUD Wiki
Jump to navigation Jump to search
(XML import of LLM wiki pages)
 
Line 1: Line 1:
 +
 +
 +
<span id="bffinds"></span>
 
  unitptr findsymbolic ( s : string )
 
  unitptr findsymbolic ( s : string )
−
     s : Symbolic name of the unit to find (player, room, object, NPC)
+
     s : Symbolic name of the NPC or Object to find.
 
     return: A pointer to an instance of the unit, or null.
 
     return: A pointer to an instance of the unit, or null.
 
     Example: findsymbolic("bread@midgaard")
 
     Example: findsymbolic("bread@midgaard")
  
−
This routine supplements findunit() and findsymbolic(#,#,#). It comes in handy, if it is
+
    This routine supplements findroom and findunit. It comes in handy,if it is
−
important to get a unitptr to a unit in the world.  This is super fast
+
    important to get a correct reference to a NPC in the world.  If for example,
−
and a great routine if it doesn't matter where in the world the unit is.
+
    Mary needs to send a message to John the Lumberjack,  then she should NOT
−
Otherwise, look at the findsymbolic(u,s,i) below If for example,
+
    use the findunit() since it may locate a different John - even a player!
−
Mary needs to send a message to John the Lumberjack,  then she should NOT
+
    If she instead locates him using findsymbolic("john@haon_dor") she will be
−
use the findunit() since it may locate a different John - even a player!
+
    certain that it is in fact her husband, and not the player John Dow from
−
If she instead locates him using findsymbolic("john@haon_dor") she will be
+
    Norway. It will NOT locate rooms, for the only reason that findroom is a
−
certain that it is in fact her husband, and not the player John Dow from
+
    lot more efficient.
−
Norway. If there was two john@haon_dor in the game, she'd get a random one of
+
 
−
them (but there's only one John and if there was two it wouldn't really matter
 
−
which one she would activate). This function also will return rooms and players (which it did
 
−
not do in the past), making findroom somewhat superfluous.
 
  
 
  unitptr findsymbolic ( u : unitptr, s : string, i : integer )
 
  unitptr findsymbolic ( u : unitptr, s : string, i : integer )
Line 24: Line 24:
 
     Example: findsymbolic(self, "bread@midgaard", FIND_UNIT_INVEN)
 
     Example: findsymbolic(self, "bread@midgaard", FIND_UNIT_INVEN)
  
−
This routine supplements findroom, findunit and findsymbolic(#).   
+
    This routine supplements findroom, findunit and findsymbolic(#).  It comes in
−
It will simply return the first unit matching the symbolic name.
+
    handy, if it is important to get a correct reference to a unit somewhere
−
It comes in handy, if it is important to get a correct reference to a unit somewhere
+
    relative to 'u'.  If for example, Mary needs to check if she has her own
−
relative to 'u'.  If for example, Mary needs to check if she has her own
+
    cooking pot, then she should NOT use the findunit since it may locate a
−
cooking pot, then she should NOT use the findunit since it may locate a
+
    different pot, not belonging to Haon-Dor but to some other zone.  If she
−
different pot, not belonging to Haon-Dor but to some other zone.  If she
+
    instead locates it using findsymbolic(self, "pot@haon_dor", FIND_UNIT_IN_ME)
−
instead locates it using findsymbolic(self, "pot@haon_dor", FIND_UNIT_IN_ME)
+
    she would be certain that it is in fact her own cooking pot that she is
−
she would be certain that it is in fact her own cooking pot that she is
+
    carrying around, and not some other pot from a Joe Blow's zone.
−
carrying around, and not some other pot from a Joe Blow's zone.
 
  
  
−
  unitptr findsymbolic ( s : string, idx : integer )
+
  ---~---~---~---~---~---~---~---~---
−
    s : Symbolic name of the unit to find (player, room, object, NPC)
+
 
−
    idx : is the index to match (find precisely the right city guard), see unitptr.idx
+
dilbegin zonelog (s:string);
−
    return: A pointer to an instance of the unit, or null.
+
code
−
    Example: findsymbolic("guard@midgaard", 71262816721)
+
{
 +
flog (self.zonidx+".log",s,"a");
 +
return;
 +
}
 +
dilend
 +
 
 +
---~---~---~---~---~---~---~---~---
  
−
This routine helps you find a precise unique unit in the world. So imagine a
+
</i><!--ENDCODE-->
−
bounty hunter. Locks on a city guard that has committed a crime. Because you
+
The previous DIL function will work in any zone to log to a file with that zones
−
cannot secure a unitptr not in your local environment how can you find the right
+
  name each zone could use it to keep zone logs separate.
−
cityguard in a city of 100? So when you first catch the unit, store its symname and
 
−
idx. The use this function to retrieve it again. For players it will find the online
 
−
player regardless of the idx.
 
  
−
Example:
 
  
−
  // Presume target is pointing to a particular cityguard
+
---~---~---~---~---~---~---~---~---
−
  s := target.symname; // Save the symbolic name
 
−
  i := target.idx;
 
−
  // Do stuff. Wake up 9 hours later. Find the target again like this:
 
−
  target := findsymbolic(s, i);
 
−
  // and if the guard is still alive you'll get your pointer back.
 

Latest revision as of 10:43, 4 December 2025


unitptr findsymbolic ( s : string )
   s : Symbolic name of the NPC or Object to find.
   return: A pointer to an instance of the unit, or null.
   Example: findsymbolic("bread@midgaard")

   This routine supplements findroom and findunit. It comes in handy,if it is
   important to get a correct reference to a NPC in the world.  If for example,
   Mary needs to send a message to John the Lumberjack,  then she should NOT
   use the findunit() since it may locate a different John - even a player!
   If she instead locates him using findsymbolic("john@haon_dor") she will be
   certain that it is in fact her husband, and not the player John Dow from
   Norway.  It will NOT locate rooms, for the only reason that findroom is a
   lot more efficient.



unitptr findsymbolic ( u : unitptr, s : string, i : integer )
   u : Search is relative to this unit.
   s : Symbolic name of the NPC or Object to find.
   i : FIND_UNIT_XXX bit vector of places to search.
   return: A pointer to an instance of the unit, or null.
   Example: findsymbolic(self, "bread@midgaard", FIND_UNIT_INVEN)

   This routine supplements findroom, findunit and findsymbolic(#).  It comes in
   handy, if it is important to get a correct reference to a unit somewhere
   relative to 'u'.  If for example, Mary needs to check if she has her own
   cooking pot, then she should NOT use the findunit since it may locate a
   different pot, not belonging to Haon-Dor but to some other zone.  If she
   instead locates it using findsymbolic(self, "pot@haon_dor", FIND_UNIT_IN_ME)
   she would be certain that it is in fact her own cooking pot that she is
   carrying around, and not some other pot from a Joe Blow's zone.



---~---~---~---~---~---~---~---~---

dilbegin zonelog (s:string);
code
{
flog (self.zonidx+".log",s,"a");
return;
}
dilend

---~---~---~---~---~---~---~---~---


The previous DIL function will work in any zone to log to a file with that zones
 name each zone could use it to keep zone logs separate.



---~---~---~---~---~---~---~---~---
Retrieved from "http://wiki.dikumud.net/index.php?title=Manual:DIL_Manual/findsymbolic()&oldid=1054"