GenOLC Interface Routines

NOTE: This document is not finished in order to expedite release.

genwld.c

• room_rnum add_room(struct room_data *)
  • Needs
  1. A pointer to the room structure to add to the world.
  • Returns
    • Success: The real number where the room was placed or updated.
    • Failure: -1
• int delete_room(room_rnum)
  • Needs
    1. The real number of the room to delete.
  • Returns
    • Success: TRUE
    • Failure: FALSE
  • Bugs
    • Can't delete real room #0.
• int save_rooms(zon_vnum)
  • Needs
    1. The virtual number of the zone to save.
  • Returns
    • Success: TRUE
    • Failure: FALSE
  • Bugs
    • Doesn't check all error returns.
• room_rnum copy_room(room_vnum, room_rnum)
  • Needs
    1. The destination virtual number.
    2. The source real number.
  • Returns
    • Success: Real number of new copy of room.
    • Failure: -1
• int copy_room_strings(struct room_data *, struct room_data *)
  • Needs
    1. Pointer to destination of room string copy.
    2. Pointer to source of room string copy.
  • Returns
    • Success: TRUE
    • Failure: FALSE
• int free_room_strings(struct room_data *)
  • Needs
    1. Pointer to room to free strings.
  • Returns
    • Success: TRUE
    • Failure: Crash