Mudlib book

Documentation for the std-book functions for the mudlib in /std/book.c.

Functions

void set_pages(mixed *page_data...)

Set the pages that are in the book. Each element of the array is the text that appears on the page. The elements can be either the text that is on the page, a filename, or a function pointer that generates one of these.

void add_pages(string *page_data...)

Add pages to the existing pages of the book. See set_pages()

void remove_pages(mixed *pagenum...)

Remove pages from the existing pages of the book. The arguments passed to remove_pages() are the page numbers to be removed. See set_pages()

string *list_pages()

Return all of the pages in the book in an array.

string query_page(int pagenum)

Return the contents of the page specified.

void set_contents(mapping new_contents)

Set the contents of the book. The contents are a mapping with the section heading as the key and the page it starts with as the value (a string).

void add_contents(mapping additions)

Add additional contents to the existing contents. See set_contents

void remove_contents(string *headings...)

Remove contents from the existing contents See set_contents()

string query_content_page(string heading)

Return the page number of the contents heading

mapping list_contents()

Return the mapping of contents

void set_title(string new_title)

Set the title of the book.

string query_title()

Return the title of the book.

void set_author(string who)

Set the author of the book

string query_author()

Return the author of the book

int is_book()

Return whether or not the object is a book.

File generated by Lima 1.1a4 reStructured Text daemon.