scripture

Vars
button_icon_state	Icon state of the action button
category	What category of scripture is this
cogs_required	How many cogs are required to be used to use this
desc	Shown decription of the scripture in the UI
end_on_invocation	Only set to false if you call end_invoke somewhere in your scripture
invocation_chant_timer	Timer object for the distance between invoking chants
invocation_text	Text said during invocation, automatically translates to Ratvarian
invocation_time	Time required to invoke this while standing still
invoker	Ref to the mob invoking this
invokers_required	How many people need to invoke this in sight of each other to use
invoking_slab	Ref to the slab invoking this
name	Name of the scripture
power_cost	How much power this scripture costs to use
recital_sound	Sound to play on finish
research_required	If this scripture requires research to be unlocked
tip	Tooltip shown on-hover. Keep to a few words
vitality_cost	How much vitality this scripture costs to use
Procs
begin_invoke	Start invoking a scripture, calling end_invoke() if it doesn't finish
check_special_requirements	Check for any special requriements such as not having enough invokers, or not holding the slab
end_invoke	End the invoking, nulling things out
invoke	Invoke this scripture, checking if there's valid power and vitality
invoke_fail	On failure of invoking the scripture
invoke_success	On success of invoking the scripture
recital	The overall reciting proc for saying every single line for a scripture
recite	For reciting an individual line of a scripture

Var Details

var
button_icon_state
–

Icon state of the action button

var
category
–

What category of scripture is this

var
cogs_required
–

How many cogs are required to be used to use this

var
desc
–

Shown decription of the scripture in the UI

var
end_on_invocation
–

Only set to false if you call end_invoke somewhere in your scripture

var
invocation_chant_timer
–

Timer object for the distance between invoking chants

var
invocation_text
– /list

Text said during invocation, automatically translates to Ratvarian

var
invocation_time
–

Time required to invoke this while standing still

var
invoker
– /mob/living

Ref to the mob invoking this

var
invokers_required
–

How many people need to invoke this in sight of each other to use

var
invoking_slab
– /obj/item/clockwork/clockwork_slab

Ref to the slab invoking this

var
name
–

Name of the scripture

var
power_cost
–

How much power this scripture costs to use

var
recital_sound
– /sound

Sound to play on finish

var
research_required
–

If this scripture requires research to be unlocked

var
tip
–

Tooltip shown on-hover. Keep to a few words

var
vitality_cost
–

How much vitality this scripture costs to use

Proc Details

proc
begin_invoke
(/mob/living/invoking_mob, /obj/item/clockwork/clockwork_slab/slab, bypass_unlock_checks)

Start invoking a scripture, calling end_invoke() if it doesn't finish

proc
check_special_requirements
(/mob/user)

Check for any special requriements such as not having enough invokers, or not holding the slab

proc
end_invoke
()

End the invoking, nulling things out

proc
invoke
()

Invoke this scripture, checking if there's valid power and vitality

proc
invoke_fail
()

On failure of invoking the scripture

proc
invoke_success
()

On success of invoking the scripture

proc
recital
()

The overall reciting proc for saying every single line for a scripture

proc
recite
(text_point, wait_time, stop_at)

For reciting an individual line of a scripture

scripture /datum/scripture

Vars

Procs

Var Details

var button_icon_state –

var category –

var cogs_required –

var desc –

var end_on_invocation –

var invocation_chant_timer –

var invocation_text – /list

var invocation_time –

var invoker – /mob/living

var invokers_required –

var invoking_slab – /obj/item/clockwork/clockwork_slab

var name –

var power_cost –

var recital_sound – /sound

var research_required –

var tip –

var vitality_cost –