File /obj/handlers/co_ordinate_handler.c

Written by Pinkfish

Started Mon Nov 3 13:57:58 PST 2003

Includes

Class Index

• room_data

Method index

• look_for_deletions()
  This is a function which runs through and finds old outdated rooms and removes them.
• query_fixed_rooms()
  Returns the list of fixed rooms.
• query_room_based_of(string)
  This returns the room the co-ordinates for this room as based off.
• query_room_co_ords(string)
  Find the room's co-ordinates.
• query_room_direction(string)
  This returns the direction the co-ordinates for this room as based off.
• query_rooms()
  Returns the current list of stored rooms.
• remove_room(string)
  This removes a specific path from the list of remembered rooms.
• setup_fixed_room(string, int *)
  Sets up the specific co-ordinates for the specific room.
• setup_room(string)
  Sets up the room, based on a room with a known co-ordinate and an exit direction.

Public Functions

look_for_deletions

void look_for_deletions()

This is a function which runs through and finds old outdated rooms and removes them. It looks for rooms that have been deleted etc.

query_fixed_rooms

string * query_fixed_rooms()

Returns the list of fixed rooms.

query_room_based_of

string query_room_based_of(string path)

This returns the room the co-ordinates for this room as based off.

Parameters:
path - the path the co-ordinates are based off

Returns:
the path

query_room_co_ords

int * query_room_co_ords(string path)

Find the room's co-ordinates.

Parameters:
room - the room to lookup

Returns:
the co-ordinates

query_room_direction

string query_room_direction(string path)

This returns the direction the co-ordinates for this room as based off.

Parameters:
path - the path the co-ordinates are based off

Returns:
the direction

query_rooms

mapping query_rooms()

Returns the current list of stored rooms.

remove_room

void remove_room(string path)

This removes a specific path from the list of remembered rooms.

Parameters:
path - the path to remove

setup_fixed_room

int setup_fixed_room(string path,
                     int * coords)

Sets up the specific co-ordinates for the specific room.

Parameters:
path - the path for the main room
coords - the coordinates to set

setup_room

int setup_room(string path)

Sets up the room, based on a room with a known co-ordinate and an exit direction. We search around to try and find a fixed co-ordinate room.

Parameters:
path - the room being setup

Classes

• room_data

  class room_data {
                    string other;
                    string direction;
                    int * coords;
                    int last_update;
                    string * refs;
  }