Space Station 13 - Modules - TypesVar Details - Proc Details

granter

Books that teach things.

(Intrinsic actions like bar flinging, spells like fireball or smoke, or martial arts)

Vars

book_soundsThe sounds played as the user's reading the book.
pages_to_masteryControls how long a mob must keep the book in his hand to actually successfully learn
readingSanity, whether it's currently being read
reading_timeThe time it takes to read the book
remarksFlavor messages displayed to mobs reading the granter
usesThe amount of uses on the granter.

Procs

can_learnChecks if the user can learn whatever this granter... grants
on_reading_finishedCalled when the reading is completely finished. This is where the actual granting should happen.
on_reading_startCalled when the user starts to read the granter.
on_reading_stoppedCalled when the reading is interrupted without finishing.
recoilEffects that occur whenever the book is read when it has no uses left.
turn_pageThe actual "turning over of the page" flavor bit that happens while someone is reading the granter.

Var Details

book_sounds

The sounds played as the user's reading the book.

pages_to_mastery

Controls how long a mob must keep the book in his hand to actually successfully learn

reading

Sanity, whether it's currently being read

reading_time

The time it takes to read the book

remarks

Flavor messages displayed to mobs reading the granter

uses

The amount of uses on the granter.

Proc Details

can_learn

Checks if the user can learn whatever this granter... grants

on_reading_finished

Called when the reading is completely finished. This is where the actual granting should happen.

on_reading_start

Called when the user starts to read the granter.

on_reading_stopped

Called when the reading is interrupted without finishing.

recoil

Effects that occur whenever the book is read when it has no uses left.

turn_page

The actual "turning over of the page" flavor bit that happens while someone is reading the granter.