spellbook_entry

Spellbook entries

Wizard spellbooks are automatically populated with a list of every spellbook entry subtype when they're made.

Wizards can then buy entries from the book to learn magic, invoke rituals, or summon items.

Vars
buy_word	Flavor. Verb used in saying how the spell is acquired. Ex "[Learn] Fireball" or "[Summon] Ghosts"
category	What category the entry falls in
cooldown	The cooldown of the spell
cost	How many book charges does the spell take
desc	The description of the entry
limit	The limit on number of purchases from this entry in a given spellbook. If null, infinite are allowed.
name	The name of the entry
no_coexistence_typecache	Used so you can't have specific spells together
refundable	Is this refundable?
requires_wizard_garb	Whether the spell requires wizard garb or not
spell_type	The type of spell that the entry grants (typepath)
times	How many times has the spell been purchased. Compared against limit.
Procs
buy_spell	Actually buy the entry for the user
can_be_purchased	Determines if this entry can be purchased from a spellbook Used for configs / round related restrictions.
can_buy	Checks if the user, with the supplied spellbook, can purchase the given entry.
can_refund	Checks if the user, with the supplied spellbook, can refund the entry
refund_spell	Actually refund the entry for the user
set_spell_info	Set any of the spell info saved on our entry after something has occured

Var Details

var
buy_word
–

Flavor. Verb used in saying how the spell is acquired. Ex "[Learn] Fireball" or "[Summon] Ghosts"

var
category
–

What category the entry falls in

var
cooldown
–

The cooldown of the spell

var
cost
–

How many book charges does the spell take

var
desc
–

The description of the entry

var
limit
–

The limit on number of purchases from this entry in a given spellbook. If null, infinite are allowed.

var
name
–

The name of the entry

var
no_coexistence_typecache
– /list

Used so you can't have specific spells together

var
refundable
–

Is this refundable?

var
requires_wizard_garb
–

Whether the spell requires wizard garb or not

var
spell_type
– /datum/action/cooldown/spell

The type of spell that the entry grants (typepath)

var
times
–

How many times has the spell been purchased. Compared against limit.

Proc Details

proc
buy_spell
(/mob/living/carbon/human/user, /obj/item/spellbook/book, log_buy)

Actually buy the entry for the user

Arguments

user - the mob who's bought the spell
book - what book they've bought the spell from

Return truthy if the purchase was successful, FALSE otherwise

proc
can_be_purchased
()

Determines if this entry can be purchased from a spellbook Used for configs / round related restrictions.

Return FALSE to prevent the entry from being added to wizard spellbooks, TRUE otherwise

proc
can_buy
(/mob/living/carbon/human/user, /obj/item/spellbook/book)

Checks if the user, with the supplied spellbook, can purchase the given entry.

Arguments

user - the mob who's buying the spell
book - what book they're buying the spell from

Return TRUE if it can be bought, FALSE otherwise

proc
can_refund
(/mob/living/carbon/human/user, /obj/item/spellbook/book)

Checks if the user, with the supplied spellbook, can refund the entry

Arguments

user - the mob who's refunding the spell
book - what book they're refunding the spell from

Return TRUE if it can refunded, FALSE otherwise

proc
refund_spell
(/mob/living/carbon/human/user, /obj/item/spellbook/book)

Actually refund the entry for the user

Arguments

user - the mob who's refunded the spell
book - what book they're refunding the spell from

Return -1 on failure, or return the point value of the refund on success

proc
set_spell_info
()

Set any of the spell info saved on our entry after something has occured

For example, updating the cooldown after upgrading it

spellbook_entry /datum/spellbook_entry

Spellbook entries

Vars

Procs

Var Details

var buy_word –

var category –

var cooldown –

var cost –

var desc –

var limit –

var name –

var no_coexistence_typecache – /list

var refundable –

var requires_wizard_garb –

var spell_type – /datum/action/cooldown/spell

var times –

Proc Details

proc buy_spell(/mob/living/carbon/human/user, /obj/item/spellbook/book, log_buy)

proc can_be_purchased()

proc can_buy(/mob/living/carbon/human/user, /obj/item/spellbook/book)

proc can_refund(/mob/living/carbon/human/user, /obj/item/spellbook/book)

proc refund_spell(/mob/living/carbon/human/user, /obj/item/spellbook/book)

proc set_spell_info()

spellbook_entry
/datum/spellbook_entry

var
buy_word
–

var
category
–

var
cooldown
–

var
cost
–

var
desc
–

var
limit
–

var
name
–

var
no_coexistence_typecache
– /list

var
refundable
–

var
requires_wizard_garb
–

var
spell_type
– /datum/action/cooldown/spell

var
times
–

proc
buy_spell
(/mob/living/carbon/human/user, /obj/item/spellbook/book, log_buy)

proc
can_be_purchased
()

proc
can_buy
(/mob/living/carbon/human/user, /obj/item/spellbook/book)

proc
can_refund
(/mob/living/carbon/human/user, /obj/item/spellbook/book)

proc
refund_spell
(/mob/living/carbon/human/user, /obj/item/spellbook/book)

proc
set_spell_info
()