Files
Bubberstation/code/datums/components/religious_tool.dm
MrMelbert aae24b1ab2 Sect of the Dream God (#95643)
## About The Pull Request

Adds a new chaplain sect, the sect of the Dream God

This sect gains favor from dreaming and blessing dreamers. 

Their blessing only works on sleeping mobs - hitting a sleeping mob with
your bible will cause it to start dreaming, and if it's already
dreaming, grant favor. Either way, the mob is healed.

For 0 favor, you can **Banish Nightmare** - offering a Nightmare's
corpse rewards favor for banishing bad dreams. If the Nightmare has a
heart, you are rewarded with a special **Sacred Heart** which heals you
while dreaming and sleeping. You can also offer a Nightmare's heart on
its own without the body attached.

For 0 favor, you can **Deaconize Dreamers** - you can deaconize up to 3
dreamers.

For 50 favor, you can have a **Dream Portent** - This rite immediately
makes you fall asleep, and grants you a dream related to something going
on in the round. It may provide insight into something you otherwise
don't know about. If you take damage, the effect ends early.

<img width="374" height="126" alt="image"
src="https://github.com/user-attachments/assets/7c4e12fe-8456-411c-9d39-691e4ac2312d"
/>

For 100 favor, you can **Dream Projection** - this rite allows you to
pick one of your deacons, and forces you to become an imaginary friend
of that deacon. For the duration of the effect you are asleep. If you
are woken up or take damage, the effect ends. If the deacon dies, the
effect ends early.

<img width="492" height="294" alt="image"
src="https://github.com/user-attachments/assets/4e2f6810-15cd-41af-a69f-daa6ddca671a"
/>

For 200 favor, you can give you and your followers **Dream Protection**
- While sleeping and dreaming all damage taken is reduced.

For 200 favor, you can start a **Slumber Party** - All nearby mobs (who
can't block magic and some other asterisks) fall asleep and share a
dream. This form of sleep heals the mob rapidly (also heals holy people
even more).

## Why It's Good For The Game

A new sect for chaplains to sink their teeth into. This one brings a
unique niche, focused around sleeping and fortune telling.

## Changelog

🆑 Melbert
add: Adds the Sect of the Dream God, a new option for chaplains.
/🆑
2026-04-29 00:01:56 +01:00

271 lines
10 KiB
Plaintext

/**
*
* 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).
*
*/
/datum/component/religious_tool
dupe_mode = COMPONENT_DUPE_HIGHLANDER
/// Enables access to the global sect directly
var/datum/religion_sect/easy_access_sect
/// Prevents double selecting sects
var/selecting_sect = FALSE
/// 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/operation_flags
/// The rite currently being invoked
var/datum/religion_rites/performing_rite
///Sets the type for catalyst
var/obj/item/catalyst_type = /obj/item/book/bible
///Enables overide of COMPONENT_NO_AFTERATTACK, not recommended as it means you can potentially cause damage to the item using the catalyst.
var/force_catalyst_afterattack = FALSE
///Callback provided to the tool for after a sect is chosen
var/datum/callback/after_sect_select_cb
///Optional argument. If a positive value, each invocation will lower charges, and the component will delete without any more charges
var/charges
///If a typecache is provided, only types of rites in the cache can be invoked.
var/list/rite_types_allowlist
/datum/component/religious_tool/Initialize(
operation_flags = ALL,
force_catalyst_afterattack = FALSE,
after_sect_select_cb = null,
catalyst_type = /obj/item/book/bible,
charges = -1,
rite_types_allowlist = null,
)
. = ..()
SetGlobalToLocal() //attempt to connect on start in case one already exists!
src.operation_flags = operation_flags
src.force_catalyst_afterattack = force_catalyst_afterattack
src.after_sect_select_cb = after_sect_select_cb
src.catalyst_type = catalyst_type
src.charges = charges
src.rite_types_allowlist = rite_types_allowlist
RegisterSignal(SSdcs, COMSIG_RELIGIOUS_SECT_CHANGED, PROC_REF(SetGlobalToLocal))
RegisterSignal(SSdcs, COMSIG_RELIGIOUS_SECT_RESET, PROC_REF(on_sect_reset))
/datum/component/religious_tool/Destroy(force)
QDEL_NULL(performing_rite)
easy_access_sect = null
catalyst_type = null
after_sect_select_cb = null
return ..()
/datum/component/religious_tool/RegisterWithParent()
RegisterSignal(parent, COMSIG_ATOM_ATTACKBY, PROC_REF(AttemptActions))
RegisterSignal(parent, COMSIG_ATOM_EXAMINE, PROC_REF(on_examine))
/datum/component/religious_tool/UnregisterFromParent()
UnregisterSignal(parent, list(COMSIG_ATOM_ATTACKBY, COMSIG_ATOM_EXAMINE))
/**
* Sets the easy access variable to the global if it exists.
*/
/datum/component/religious_tool/proc/SetGlobalToLocal()
SIGNAL_HANDLER
if(easy_access_sect)
return TRUE
if(!GLOB.religious_sect)
return FALSE
easy_access_sect = GLOB.religious_sect
after_sect_select_cb?.Invoke()
return TRUE
/// Sets the easy access variable to null in case an admin needed to change it
/datum/component/religious_tool/proc/on_sect_reset()
SIGNAL_HANDLER
easy_access_sect = null
after_sect_select_cb?.Invoke()
/**
* Since all of these involve attackby, we require mega proc. Handles Invocation, Sacrificing, And Selection of Sects.
*/
/datum/component/religious_tool/proc/AttemptActions(datum/source, obj/item/the_item, mob/living/user)
SIGNAL_HANDLER
if(istype(the_item, catalyst_type))
INVOKE_ASYNC(src, TYPE_PROC_REF(/datum, ui_interact), user) //asynchronous to avoid sleeping in a signal
/**********Sacrificing**********/
else if(operation_flags & RELIGION_TOOL_SACRIFICE)
if(!easy_access_sect?.can_sacrifice(the_item, user))
return
easy_access_sect.on_sacrifice(the_item, user)
return COMPONENT_NO_AFTERATTACK
/datum/component/religious_tool/ui_interact(mob/user, datum/tgui/ui)
ui = SStgui.try_update_ui(user, src, ui)
if(!ui)
ui = new(user, src, "ReligiousTool")
ui.open()
return COMPONENT_NO_AFTERATTACK
/datum/component/religious_tool/ui_state(mob/user)
if(!iscarbon(usr))
return GLOB.never_state
var/mob/living/carbon/carbon = usr
if(!carbon.is_holding_item_of_type(catalyst_type))
return GLOB.never_state
return GLOB.default_state
/datum/component/religious_tool/ui_data(mob/user)
var/list/data = list()
//cannot find global vars, so lets offer options
if(!SetGlobalToLocal())
data["sects"] = generate_available_sects(user)
data["alignment"] = ALIGNMENT_NEUT //neutral theme if you have no sect
else
data["sects"] = null
data["name"] = easy_access_sect.name
data["desc"] = easy_access_sect.desc
data["quote"] = easy_access_sect.quote
data["alignment"] = easy_access_sect.alignment
data["icon"] = easy_access_sect.tgui_icon
data["favordesc"] = easy_access_sect.tool_examine(user)
data["favor"] = easy_access_sect.favor
data["deity"] = GLOB.deity
data["rites"] = generate_available_rites()
data["wanted"] = generate_sacrifice_list()
var/atom/atom_parent = parent
data["toolname"] = atom_parent.name
data["can_select_sect"] = (operation_flags & RELIGION_TOOL_SECTSELECT)
data["can_invoke_rite"] = (operation_flags & RELIGION_TOOL_INVOKE)
data["can_sacrifice_item"] = (operation_flags & RELIGION_TOOL_SACRIFICE)
return data
/datum/component/religious_tool/ui_act(action, list/params, datum/tgui/ui, datum/ui_state/state)
. = ..()
switch(action)
if("sect_select")
select_sect(usr, params["path"])
return TRUE //they picked a sect lets update so some weird spammy shit doesn't happen
if("perform_rite")
if(!ispath(text2path(params["path"]), /datum/religion_rites))
message_admins("[ADMIN_LOOKUPFLW(usr)] has tried to spawn an item when performing a rite.")
return
perform_rite(usr, text2path(params["path"]))
/// Select the sect, called from [/datum/component/religious_tool/proc/AttemptActions]
/datum/component/religious_tool/proc/select_sect(mob/living/user, path)
if(user.mind.holy_role != HOLY_ROLE_HIGHPRIEST)
to_chat(user, span_warning("You are not the high priest, and therefore cannot select a religious sect."))
return
if(!user.can_perform_action(parent, FORBID_TELEKINESIS_REACH))
to_chat(user,span_warning("You cannot select a sect at this time."))
return
set_new_religious_sect(text2path(path))
/// Perform the rite, called from [/datum/component/religious_tool/proc/AttemptActions]
/datum/component/religious_tool/proc/perform_rite(mob/living/user, path)
if(user.mind.holy_role < HOLY_ROLE_PRIEST)
if(user.mind.holy_role == HOLY_ROLE_DEACON)
to_chat(user, span_warning("You are merely a deacon of [GLOB.deity], and therefore cannot perform rites."))
else
to_chat(user, span_warning("You are not holy, and therefore cannot perform rites."))
return
if(rite_types_allowlist && !is_path_in_list(path, rite_types_allowlist))
to_chat(user, span_warning("This cannot perform that kind of rite."))
return
if(!user.can_perform_action(parent, FORBID_TELEKINESIS_REACH))
to_chat(user,span_warning("You are not close enough to perform the rite."))
return
//we have a rite already, but we want to do a new one.
if(performing_rite && !ispath(performing_rite.type, path))
QDEL_NULL(performing_rite)
if(!performing_rite)
performing_rite = new path(parent)
if(!performing_rite.perform_rite(user, parent))
if(!(performing_rite.rite_flags & RITE_ALLOW_MULTIPLE_PERFORMS))
QDEL_NULL(performing_rite)
return
if(performing_rite.invoke_effect(user, parent))
performing_rite.post_invoke_effects(user, parent)
easy_access_sect.adjust_favor(-performing_rite.favor_cost)
if(!(performing_rite.rite_flags & RITE_ALLOW_MULTIPLE_PERFORMS))
if(performing_rite.rite_flags & RITE_AUTO_DELETE)
QDEL_NULL(performing_rite)
else
performing_rite = null
if(charges)
charges--
if(!charges)
qdel(src)
/**
* Generates a list of available sects to the user. Intended to support custom-availability sects.
*/
/datum/component/religious_tool/proc/generate_available_sects(mob/user)
var/list/sects_to_pick = list()
for(var/path in subtypesof(/datum/religion_sect))
var/list/sect = list()
var/datum/religion_sect/not_a_real_instance_rs = path
sect["name"] = initial(not_a_real_instance_rs.name)
sect["desc"] = initial(not_a_real_instance_rs.desc)
sect["alignment"] = initial(not_a_real_instance_rs.alignment)
sect["quote"] = initial(not_a_real_instance_rs.quote)
sect["icon"] = initial(not_a_real_instance_rs.tgui_icon)
sect["path"] = path
sects_to_pick += list(sect)
return sects_to_pick
/**
* Generates available rites to pick from. It expects the sect to be picked by the time it was called (by tgui data)
*/
/datum/component/religious_tool/proc/generate_available_rites()
var/list/rites_to_pick = list()
for(var/path in easy_access_sect.rites_list)
///checks to invalidate
var/list/rite = list()
var/datum/religion_rites/rite_type = path
rite["name"] = initial(rite_type.name)
rite["desc"] = initial(rite_type.desc)
var/cost = initial(rite_type.favor_cost)
rite["favor"] = cost
rite["can_cast"] = cost > easy_access_sect.favor
rite["path"] = path
rites_to_pick += list(rite)
return rites_to_pick
/**
* Generates an english list (so string) of wanted sac items. Returns null if no targets!
*/
/datum/component/religious_tool/proc/generate_sacrifice_list()
if(!length(easy_access_sect?.desired_items))
return //specifically null so the data sends as such
var/list/item_names = list()
for(var/atom/sac_type as anything in easy_access_sect.desired_items)
var/append = easy_access_sect.desired_items[sac_type]
var/entry = "[initial(sac_type.name)]s [append]"
item_names += entry
return english_list(item_names)
/**
* Appends to examine so the user knows it can be used for religious purposes.
*/
/datum/component/religious_tool/proc/on_examine(datum/source, mob/user, list/examine_list)
SIGNAL_HANDLER
var/can_i_see = FALSE
if(isobserver(user))
can_i_see = TRUE
else if(isliving(user))
var/mob/living/L = user
if(L.mind?.holy_role)
can_i_see = TRUE
if(!can_i_see)
return
examine_list += span_notice("Use a [catalyst_type::name] to interact with this.")
if(isnull(easy_access_sect))
if(operation_flags & RELIGION_TOOL_SECTSELECT)
examine_list += span_notice("This looks like it can be used to select a sect.")
return
if(operation_flags & RELIGION_TOOL_SACRIFICE)//this can be moved around if things change but usually no rites == no sacrifice
examine_list += span_notice("Desired items can be used on this to increase favor.")
if(easy_access_sect.rites_list && operation_flags & RELIGION_TOOL_INVOKE)
examine_list += span_notice("You can invoke rites from this.")