/tg/ Station 13 - Modules - TypesVar Details - Proc Details

book

Vars

book_dataThe packet of information that describes this book
carvedWhether or not we have been carved out.
carved_storage_typeThe typepath for the storage datum we use when carved out.
due_dateGame time in 1/10th seconds
maximum_book_stateMaximum icon state number
starting_authorThe initial author, for use in var editing and such
starting_contentThe initial bit of content, for use in var editing and such
starting_titleThe initial title, for use in var editing and such
uniquefalse - Normal book, true - Should not be treated as normal book, unable to be copied, unable to be modified

Procs

can_read_bookProc 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.
can_vandalizeChecks for whether we can vandalize this book, to ensure we still can after each input. Uses to_chat over balloon alerts to give more detailed information as to why.
carve_outHandles setting everything a carved book needs.
carving_actCalled when user clicks on the book with a carving utensil. Attempts to carve the book.
credit_book_to_readerProc 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_contentProc that handles sending the book information to the user, as well as some housekeeping stuff.
gen_random_icon_stateGenerates a random icon state for the book
get_attack_self_contextGets the context to add for clicking the book inhand. Returns null if none.
writing_utensil_actCalled when user clicks on the book with a writing utensil. Attempts to vandalize the book.

Var Details

book_data

The packet of information that describes this book

carved

Whether or not we have been carved out.

carved_storage_type

The typepath for the storage datum we use when 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.

can_vandalize

Checks for whether we can vandalize this book, to ensure we still can after each input. Uses to_chat over balloon alerts to give more detailed information as to why.

carve_out

Handles setting everything a carved book needs.

carving_act

Called when user clicks on the book with a carving utensil. Attempts to carve the book.

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

get_attack_self_context

Gets the context to add for clicking the book inhand. Returns null if none.

writing_utensil_act

Called when user clicks on the book with a writing utensil. Attempts to vandalize the book.