Manual:DIL Manual/help

From DikuMUD Wiki
Jump to navigation Jump to search

help

Field (string, read-only in practice; on a zoneptr).

z.help : string

The zone's help text for players: the help text in the zone file's %zone header. Empty when the header has none. Players read it with help area (helpzon.zon) in the zone they are in.

Notes

  • Don't assign it. vmc accepts the assignment, but the interpreter then frees memory it doesn't own (vme/src/dilfld.cpp, DILF_HELP), which crashes the server or corrupts its memory, and the new text is lost anyway.
  • On a null zoneptr it fails.
  • Like every field name, help is a reserved word: a variable or parameter can't be called help (vmc: "syntax error").

Example

dilbegin show_area(pc : unitptr, z : zoneptr);
code
{
   if (z == null)
      return;
   if (length(z.help) > 1)
   {
      sendtext("You are in the area known as: " + z.title + ".<br/>", pc);
      pagestring(z.help, pc);
   }
   else
      sendtext("There is no help on this area written by the creators.<br/>", pc);
}
dilend

Shows a zone's help to a player, as help area does in helpzon.zon.

See also