book 
Vars | |
| book_data | The packet of information that describes this book |
|---|---|
| carved | whether or not we have been carved out |
| due_date | Game time in 1/10th seconds |
| maximum_book_state | Maximum icon state number |
| starting_author | The initial author, for use in var editing and such |
| starting_content | The initial bit of content, for use in var editing and such |
| starting_title | The initial title, for use in var editing and such |
| unique | false - Normal book, true - Should not be treated as normal book, unable to be copied, unable to be modified |
Procs | |
| can_read_book | Proc that checks if the user is capable of reading the book, for UI interactions and otherwise. Returns TRUE if they can, FALSE if they can't. |
| carve_out | Called when the book gets carved successfully |
| credit_book_to_reader | Proc that adds the book to a list on the user's mind so we know what works of art they've been catching up on. |
| display_content | Proc that handles sending the book information to the user, as well as some housekeeping stuff. |
| gen_random_icon_state | Generates a random icon state for the book |
| try_carve | Called when user attempts to carve the book with an item |
Var Details
book_data
The packet of information that describes this book
carved
whether or not we have been carved out
due_date
Game time in 1/10th seconds
maximum_book_state
Maximum icon state number
starting_author
The initial author, for use in var editing and such
starting_content
The initial bit of content, for use in var editing and such
starting_title
The initial title, for use in var editing and such
unique
false - Normal book, true - Should not be treated as normal book, unable to be copied, unable to be modified
Proc Details
can_read_book
Proc that checks if the user is capable of reading the book, for UI interactions and otherwise. Returns TRUE if they can, FALSE if they can't.
carve_out
Called when the book gets carved successfully
credit_book_to_reader
Proc that adds the book to a list on the user's mind so we know what works of art they've been catching up on.
display_content
Proc that handles sending the book information to the user, as well as some housekeeping stuff.
gen_random_icon_state
Generates a random icon state for the book
try_carve
Called when user attempts to carve the book with an item