religious_tool

Allows the parent to act similarly to the Altar of Gods with modularity. Invoke and Sect Selection is done via attacking with a bible. This means you cannot sacrifice Bibles (you shouldn't want to do this anyways although now that I mentioned it you probably will want to).

Vars
after_sect_select_cb	Callback provided to the tool for after a sect is chosen
catalyst_type	Sets the type for catalyst
charges	Optional argument. If a positive value, each invocation will lower charges, and the component will delete without any more charges
easy_access_sect	Enables access to the global sect directly
force_catalyst_afterattack	Enables overide of COMPONENT_NO_AFTERATTACK, not recommended as it means you can potentially cause damage to the item using the catalyst.
operation_flags	What extent do we want this religious tool to act? In case you don't want full access to the list. Generated on New
performing_rite	The rite currently being invoked
rite_types_allowlist	If a typecache is provided, only types of rites in the cache can be invoked.
selecting_sect	Prevents double selecting sects
Procs
AttemptActions	Since all of these involve attackby, we require mega proc. Handles Invocation, Sacrificing, And Selection of Sects.
SetGlobalToLocal	Sets the easy access variable to the global if it exists.
generate_available_rites	Generates available rites to pick from. It expects the sect to be picked by the time it was called (by tgui data)
generate_available_sects	Generates a list of available sects to the user. Intended to support custom-availability sects.
generate_sacrifice_list	Generates an english list (so string) of wanted sac items. Returns null if no targets!
on_examine	Appends to examine so the user knows it can be used for religious purposes.
on_sect_reset	Sets the easy access variable to null in case an admin needed to change it
perform_rite	Perform the rite, called from /datum/component/religious_tool/proc/AttemptActions
select_sect	Select the sect, called from /datum/component/religious_tool/proc/AttemptActions

Var Details

var
after_sect_select_cb
– /datum/callback

Callback provided to the tool for after a sect is chosen

var
catalyst_type
– /obj/item

Sets the type for catalyst

var
charges
–

Optional argument. If a positive value, each invocation will lower charges, and the component will delete without any more charges

var
easy_access_sect
– /datum/religion_sect

Enables access to the global sect directly

var
force_catalyst_afterattack
–

Enables overide of COMPONENT_NO_AFTERATTACK, not recommended as it means you can potentially cause damage to the item using the catalyst.

var
operation_flags
–

What extent do we want this religious tool to act? In case you don't want full access to the list. Generated on New

var
performing_rite
– /datum/religion_rites

The rite currently being invoked

var
rite_types_allowlist
– /list

If a typecache is provided, only types of rites in the cache can be invoked.

var
selecting_sect
–

Prevents double selecting sects

Proc Details

proc
AttemptActions
(/datum/source, /obj/item/the_item, /mob/living/user)

Since all of these involve attackby, we require mega proc. Handles Invocation, Sacrificing, And Selection of Sects.

proc
SetGlobalToLocal
()

Sets the easy access variable to the global if it exists.

proc
generate_available_rites
()

Generates available rites to pick from. It expects the sect to be picked by the time it was called (by tgui data)

proc
generate_available_sects
(/mob/user)

Generates a list of available sects to the user. Intended to support custom-availability sects.

proc
generate_sacrifice_list
()

Generates an english list (so string) of wanted sac items. Returns null if no targets!

proc
on_examine
(/datum/source, /mob/user, /list/examine_list)

Appends to examine so the user knows it can be used for religious purposes.

proc
on_sect_reset
()

Sets the easy access variable to null in case an admin needed to change it

proc
perform_rite
(/mob/living/user, path)

Perform the rite, called from /datum/component/religious_tool/proc/AttemptActions

proc
select_sect
(/mob/living/user, path)

Select the sect, called from /datum/component/religious_tool/proc/AttemptActions

religious_tool /datum/component/religious_tool

Vars

Procs

Var Details

var after_sect_select_cb – /datum/callback

var catalyst_type – /obj/item

var charges –

var easy_access_sect – /datum/religion_sect

var force_catalyst_afterattack –

var operation_flags –

var performing_rite – /datum/religion_rites

var rite_types_allowlist – /list

var selecting_sect –

Proc Details

proc AttemptActions(/datum/source, /obj/item/the_item, /mob/living/user)

proc SetGlobalToLocal()

proc generate_available_rites()

proc generate_available_sects(/mob/user)

proc generate_sacrifice_list()

proc on_examine(/datum/source, /mob/user, /list/examine_list)

proc on_sect_reset()

proc perform_rite(/mob/living/user, path)

proc select_sect(/mob/living/user, path)