mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2026-08-29 08:08:49 +01:00
Improves/Abstracts Suicide A Bit More (#72949)
## About The Pull Request Basically all of the heavy lifting was done in #72919, but we do a few key things here that I wasn't able to do then because it was just fucking massive. Player Facing Changes: * hear_blind arg is now a default state and must be specifically overridden. Pretty much every mob that wasn't a pAI or alien was lacking this, so let's toss it in as a default now. Let me know if the generic message I put in for /mob/living sucks and we can go from there. Code Side Changes: * suicide.dm now only contains code pertinent to the suicide verb, and all subtype proc-overrides have been moved to an appropriate file pertinent to that subtype. * suicide.dm has also been organized a bit more to aid the previous change. * There is only one suicide verb now, implemented on /mob/living. All the verb does is invoke the handle_suicide() proc, which does all of the lifting. * Leaning into *mumble mumble* object-oriented philosophy, the message we send to the world on suicide is handled on subtype procs, rather than be in the huge fuck-off message tree I implemented in the earlier PR. It definitely makes the visible_message() proc not hard to read IMO. This also means that we can take up a less footprint when we re-use certain suicide messages (i.e. Silicon), which is nifty too. i'm probably forgetting something but that's all of the big ones ## Why It's Good For The Game There is now a very, very common framework for how suicide works across all living mobs, and it's much easier to override how suicide is handled. Certain subtypes do their own bullshit thing, but it's quite easy to account for this on that case-by-case basis. The overall code takes up a much less footprint that just makes it look nicer. ## Changelog 🆑 qol: Some mob suicides now have a message that shows to blind people or people that didn't actually witness the suicide, pretty cool. /🆑
This commit is contained in:
san7890
@@ -1,12 +1,20 @@
|
||||
/// Defines for all the types of messages we can dispatch, since there are a few that are re-used in different contexts (like generic messages, mechanical)
|
||||
#define ALIEN_SUICIDE_MESSAGE "alien message"
|
||||
#define BRAIN_SUICIDE_MESSAGE "brain message"
|
||||
#define GENERIC_SUICIDE_MESSAGE "generic message"
|
||||
#define HUMAN_BRAIN_DAMAGE_SUICIDE_MESSAGE "brain damaged message"
|
||||
#define HUMAN_COMBAT_MODE_SUICIDE_MESSAGE "combat mode message"
|
||||
#define HUMAN_DEFAULT_MODE_SUICIDE_MESSAGE "default mode message"
|
||||
#define MECHANICAL_SUICIDE_MESSAGE "mechanical message"
|
||||
#define PAI_SUICIDE_MESSAGE "pai message"
|
||||
/// Verb to simply kill yourself (in a very visual way to all players) in game! How family-friendly. Can be governed by a series of multiple checks (i.e. confirmation, is it allowed in this area, etc.) which are
|
||||
/// handled and called by the proc this verb invokes. It's okay to block this, because we typically always give mobs in-game the ability to Ghost out of their current mob irregardless of context. This, in contrast,
|
||||
/// can have as many different checks as you desire to prevent people from doing the deed to themselves.
|
||||
/mob/living/verb/suicide()
|
||||
set hidden = TRUE
|
||||
handle_suicide()
|
||||
|
||||
/// Actually handles the bare basics of the suicide process. Message type is the message we want to dispatch in the world regarding the suicide, using the defines in this file.
|
||||
/// Override this ENTIRELY if you want to add any special behavior to your suicide handling, if you fuck up the order of operations then shit will break.
|
||||
/mob/living/proc/handle_suicide()
|
||||
SHOULD_CALL_PARENT(FALSE)
|
||||
if(!suicide_alert())
|
||||
return
|
||||
|
||||
set_suicide(TRUE)
|
||||
send_applicable_messages()
|
||||
final_checkout()
|
||||
|
||||
/// Proc that handles changing the suiciding var on the mob in question, as well as additional operations to ensure that everything goes smoothly when we're certain that this person is going to kill themself.
|
||||
/// suicide_state is a boolean, to match the suiciding/suicided var.
|
||||
@@ -17,87 +25,6 @@
|
||||
else
|
||||
remove_from_mob_suicide_list()
|
||||
|
||||
/mob/living/carbon/set_suicide(suicide_state) //you thought that box trick was pretty clever, didn't you? well now hardmode is on, boyo.
|
||||
. = ..()
|
||||
var/obj/item/organ/internal/brain/userbrain = getorganslot(ORGAN_SLOT_BRAIN)
|
||||
if(userbrain)
|
||||
userbrain.suicided = suicide_state
|
||||
|
||||
/mob/living/silicon/robot/set_suicide(suicide_state)
|
||||
. = ..()
|
||||
if(mmi)
|
||||
if(mmi.brain)
|
||||
mmi.brain.suicided = suicide_state
|
||||
if(mmi.brainmob)
|
||||
mmi.brainmob.suiciding = suicide_state
|
||||
|
||||
/// Verb to simply kill yourself (in a very visual way to all players) in game! How family-friendly. Can be governed by a series of multiple checks (i.e. confirmation, is it allowed in this area, etc.) which are
|
||||
/// handled and called by the proc this verb invokes. It's okay to block this, because we typically always give mobs in-game the ability to Ghost out of their current mob irregardless of context. This, in contrast,
|
||||
/// can have as many different checks as you desire to prevent people from doing the deed to themselves.
|
||||
/mob/living/verb/suicide()
|
||||
set hidden = TRUE
|
||||
handle_suicide(message_type = GENERIC_SUICIDE_MESSAGE)
|
||||
|
||||
/mob/living/brain/suicide()
|
||||
set hidden = TRUE
|
||||
handle_suicide(message_type = BRAIN_SUICIDE_MESSAGE, do_damage = FALSE) // brains don't need damage applied.
|
||||
|
||||
/mob/living/carbon/alien/adult/suicide()
|
||||
set hidden = TRUE
|
||||
handle_suicide(message_type = ALIEN_SUICIDE_MESSAGE)
|
||||
|
||||
/mob/living/carbon/human/suicide()
|
||||
set hidden = TRUE
|
||||
handle_suicide() // message types are handled in handle_suicide for humans. no args needed.
|
||||
|
||||
/mob/living/silicon/ai/suicide()
|
||||
set hidden = TRUE
|
||||
handle_suicide(message_type = MECHANICAL_SUICIDE_MESSAGE)
|
||||
|
||||
/mob/living/silicon/pai/suicide()
|
||||
set hidden = TRUE
|
||||
handle_suicide(message_type = PAI_SUICIDE_MESSAGE)
|
||||
|
||||
/mob/living/silicon/robot/suicide()
|
||||
set hidden = TRUE
|
||||
handle_suicide(message_type = MECHANICAL_SUICIDE_MESSAGE)
|
||||
|
||||
/// Actually handles the bare basics of the suicide process. Message type is the message we want to dispatch in the world regarding the suicide, using the defines in this file.
|
||||
/// If do not want to do damage to the mob (if it's incompatible with damage or something weird), set the do_damage boolean to FALSE when you call this proc.
|
||||
/mob/living/proc/handle_suicide(message_type, do_damage = TRUE)
|
||||
if(!suicide_alert())
|
||||
return
|
||||
|
||||
set_suicide(TRUE)
|
||||
dispatch_message_from_tree(message_type)
|
||||
final_checkout(apply_damage = do_damage)
|
||||
|
||||
/mob/living/carbon/human/handle_suicide(message_type, do_damage = TRUE)
|
||||
if(!suicide_alert())
|
||||
return
|
||||
|
||||
set_suicide(TRUE) //need to be called before calling suicide_act as fuck knows what suicide_act will do with your suicide
|
||||
|
||||
var/obj/item/held_item = get_active_held_item()
|
||||
var/damage_type = SEND_SIGNAL(src, COMSIG_HUMAN_SUICIDE_ACT) || held_item?.suicide_act(src)
|
||||
|
||||
if(damage_type)
|
||||
if(apply_suicide_damage(held_item, damage_type))
|
||||
final_checkout(held_item, apply_damage = FALSE)
|
||||
return
|
||||
|
||||
// if no specific item or damage type we want to deal, default to doing the deed with our own bare hands.
|
||||
if(combat_mode)
|
||||
dispatch_message_from_tree(HUMAN_COMBAT_MODE_SUICIDE_MESSAGE)
|
||||
else
|
||||
var/obj/item/organ/internal/brain/userbrain = getorgan(/obj/item/organ/internal/brain)
|
||||
if(userbrain?.damage >= 75)
|
||||
dispatch_message_from_tree(HUMAN_BRAIN_DAMAGE_SUICIDE_MESSAGE)
|
||||
else
|
||||
dispatch_message_from_tree(HUMAN_DEFAULT_MODE_SUICIDE_MESSAGE)
|
||||
|
||||
final_checkout(held_item, do_damage)
|
||||
|
||||
/// Sends a TGUI Alert to the person attempting to commit suicide. Returns TRUE if they confirm they want to die, FALSE otherwise. Check can_suicide here as well.
|
||||
/mob/living/proc/suicide_alert()
|
||||
// Save this for later to ensure that if we change ckeys somehow, we exit out of the suicide.
|
||||
@@ -117,6 +44,28 @@
|
||||
balloon_alert(src, "suicide attempt aborted!")
|
||||
return FALSE
|
||||
|
||||
/// Checks if we are in a valid state to suicide (not already suiciding, capable of actually killing ourselves, area checks, etc.) Returns TRUE if we can suicide, FALSE if we can not.
|
||||
/mob/living/proc/can_suicide()
|
||||
if(suiciding)
|
||||
to_chat(src, span_warning("You are already commiting suicide!"))
|
||||
return FALSE
|
||||
|
||||
var/area/checkable = get_area(src)
|
||||
if(checkable.area_flags & BLOCK_SUICIDE)
|
||||
to_chat(src, span_warning("You can't commit suicide here! You can ghost if you'd like."))
|
||||
return FALSE
|
||||
|
||||
switch(stat)
|
||||
if(CONSCIOUS)
|
||||
return TRUE
|
||||
if(SOFT_CRIT)
|
||||
to_chat(src, span_warning("You can't commit suicide while in a critical condition!"))
|
||||
if(UNCONSCIOUS, HARD_CRIT)
|
||||
to_chat(src, span_warning("You need to be conscious to commit suicide!"))
|
||||
if(DEAD)
|
||||
to_chat(src, span_warning("You're already dead!"))
|
||||
return FALSE
|
||||
|
||||
/// Inserts in logging and death + mind dissociation when we're fully done with ending the life of our mob, as well as adjust the health. We will disallow re-entering the body when this is called.
|
||||
/// The suicide_tool variable is currently only used for humans in order to allow suicide log to properly put stuff in investigate log.
|
||||
/// Set apply_damage to FALSE in order to not do damage (in case it's handled elsewhere in the verb or another proc that the suicide tree calls). Will dissociate client from mind and ghost the player regardless.
|
||||
@@ -128,47 +77,31 @@
|
||||
death(FALSE)
|
||||
ghostize(FALSE)
|
||||
|
||||
/// Send all suicide-related messages out to the world. message_type can be used to change out the dispatched suicide message depending on the suicide context.
|
||||
/mob/living/proc/send_applicable_messages(message_type)
|
||||
visible_message(span_danger(get_visible_suicide_message()), span_userdanger(get_visible_suicide_message()), span_hear(get_blind_suicide_message()))
|
||||
|
||||
/// Returns a subtype-specific flavorful string pertaining to this exact living mob's ending their own life to those who can see it (visible message).
|
||||
/// If you don't want a message, prefer to override send_applicable_messages() on your subtype instead.
|
||||
/mob/living/proc/get_visible_suicide_message()
|
||||
return "[src] begins to fall down. It looks like [p_theyve()] lost the will to live."
|
||||
|
||||
/// Returns an appropriate string for what people who lack visibility hear when this mob kills itself.
|
||||
/// If you don't want a message, prefer to override send_applicable_messages() on your subtype instead.
|
||||
/mob/living/proc/get_blind_suicide_message()
|
||||
return "You hear something hitting the floor."
|
||||
|
||||
/// Inserts logging in both the mob's logs and the investigate log pertaining to their death. Suicide tool is the object we used to commit suicide, if one was held and used (presently only humans use this arg).
|
||||
/mob/living/proc/suicide_log(obj/item/suicide_tool)
|
||||
investigate_log("has died from committing suicide.", INVESTIGATE_DEATHS)
|
||||
log_message("committed suicide as [src.type]", LOG_ATTACK)
|
||||
|
||||
/mob/living/carbon/human/suicide_log(obj/item/suicide_tool)
|
||||
investigate_log("has died from committing suicide[suicide_tool ? " with [suicide_tool]" : ""].", INVESTIGATE_DEATHS)
|
||||
log_message("(job: [src.job ? "[src.job]" : "None"]) committed suicide", LOG_ATTACK)
|
||||
|
||||
/// The actual proc that will apply the damage to the suiciding mob. damage_type is the actual type of damage we want to deal, if that matters.
|
||||
/// Return TRUE if we actually apply any real damage, FALSE otherwise.
|
||||
/mob/living/proc/apply_suicide_damage(obj/item/suicide_tool, damage_type = NONE)
|
||||
adjustOxyLoss(max(maxHealth * 2 - getToxLoss() - getFireLoss() - getBruteLoss() - getOxyLoss(), 0))
|
||||
return TRUE
|
||||
|
||||
/mob/living/carbon/human/apply_suicide_damage(obj/item/suicide_tool, damage_type = NONE)
|
||||
// if we don't have any damage_type passed in, default to parent.
|
||||
if(damage_type == NONE)
|
||||
return ..()
|
||||
|
||||
if(damage_type & SHAME)
|
||||
adjustStaminaLoss(200)
|
||||
set_suicide(FALSE)
|
||||
add_mood_event("shameful_suicide", /datum/mood_event/shameful_suicide)
|
||||
return FALSE
|
||||
|
||||
if(damage_type & MANUAL_SUICIDE_NONLETHAL)
|
||||
set_suicide(FALSE)
|
||||
return FALSE
|
||||
|
||||
if(damage_type & MANUAL_SUICIDE) // Assume that the suicide tool will handle the death.
|
||||
suicide_log(suicide_tool)
|
||||
return FALSE
|
||||
|
||||
if(damage_type & (BRUTELOSS | FIRELOSS | OXYLOSS | TOXLOSS))
|
||||
handle_suicide_damage_spread(damage_type)
|
||||
return TRUE
|
||||
|
||||
return ..() //if all else fails, hope parent accounts for it or just do whatever damage that parent prescribes.
|
||||
|
||||
|
||||
/// If we want to apply multiple types of damage to a carbon mob based on the way they suicide, this is the proc that handles that.
|
||||
/// Currently only compatible with Brute, Burn, Toxin, and Suffocation Damage. damage_type is the bitflag that carries the information.
|
||||
/mob/living/proc/handle_suicide_damage_spread(damage_type)
|
||||
@@ -198,91 +131,3 @@
|
||||
adjustOxyLoss(damage_to_apply)
|
||||
if(TOXLOSS)
|
||||
adjustToxLoss(damage_to_apply)
|
||||
|
||||
/// We re-use a few messages in several contexts, so let's minimize some nasty footprint in the verbs.
|
||||
/mob/living/proc/dispatch_message_from_tree(type)
|
||||
switch(type)
|
||||
if(ALIEN_SUICIDE_MESSAGE)
|
||||
visible_message(span_danger("[src] is thrashing wildly! It looks like [p_theyre()] trying to commit suicide."), \
|
||||
span_userdanger("[src] is thrashing wildly! It looks like [p_theyre()] trying to commit suicide."), \
|
||||
span_hear("You hear thrashing."))
|
||||
if(BRAIN_SUICIDE_MESSAGE)
|
||||
visible_message(span_danger("[src]'s brain is growing dull and lifeless. [p_they(TRUE)] look[p_s()] like [p_theyve()] lost the will to live."), \
|
||||
span_userdanger("[src]'s brain is growing dull and lifeless. [p_they(TRUE)] look[p_s()] like [p_theyve()] lost the will to live."))
|
||||
if(GENERIC_SUICIDE_MESSAGE)
|
||||
visible_message(span_danger("[src] begins to fall down. It looks like [p_theyve()] lost the will to live."), \
|
||||
span_userdanger("[src] begins to fall down. It looks like [p_theyve()] lost the will to live."))
|
||||
if(MECHANICAL_SUICIDE_MESSAGE)
|
||||
visible_message(span_danger("[src] is powering down. It looks like [p_theyre()] trying to commit suicide."), \
|
||||
span_userdanger("[src] is powering down. It looks like [p_theyre()] trying to commit suicide."))
|
||||
if(PAI_SUICIDE_MESSAGE)
|
||||
var/turf/location = get_turf(src)
|
||||
location.visible_message(span_notice("[src] flashes a message across its screen, \"Wiping core files. Please acquire a new personality to continue using pAI device functions.\""), null, \
|
||||
span_notice("[src] bleeps electronically."))
|
||||
|
||||
/mob/living/carbon/human/dispatch_message_from_tree(type)
|
||||
var/suicide_message = ""
|
||||
switch(type)
|
||||
if(HUMAN_BRAIN_DAMAGE_SUICIDE_MESSAGE) // god damn this message is fucking stupid
|
||||
suicide_message = "[src] pulls both arms outwards in front of [p_their()] chest and pumps them behind [p_their()] back, repeats this motion in a smaller range of motion \
|
||||
down to [p_their()] hips two times once more all while sliding [p_their()] legs in a faux walking motion, claps [p_their()] hands together \
|
||||
in front of [p_them()] while both [p_their()] knees knock together, pumps [p_their()] arms downward, pronating [p_their()] wrists and abducting \
|
||||
[p_their()] fingers outward while crossing [p_their()] legs back and forth, repeats this motion again two times while keeping [p_their()] shoulders low \
|
||||
and hunching over, does finger guns with right hand and left hand bent on [p_their()] hip while looking directly forward and putting [p_their()] left leg forward then \
|
||||
crossing [p_their()] arms and leaning back a little while bending [p_their()] knees at an angle! It looks like [p_theyre()] trying to commit suicide."
|
||||
|
||||
if(HUMAN_COMBAT_MODE_SUICIDE_MESSAGE)
|
||||
suicide_message = pick(list(
|
||||
"[src] is attempting to bite [p_their()] tongue off! It looks like [p_theyre()] trying to commit suicide.",
|
||||
"[src] is holding [p_their()] breath! It looks like [p_theyre()] trying to commit suicide.",
|
||||
"[src] is jamming [p_their()] thumbs into [p_their()] eye sockets! It looks like [p_theyre()] trying to commit suicide.",
|
||||
"[src] is twisting [p_their()] own neck! It looks like [p_theyre()] trying to commit suicide.",
|
||||
))
|
||||
|
||||
if(HUMAN_DEFAULT_MODE_SUICIDE_MESSAGE)
|
||||
suicide_message = pick(list(
|
||||
"[src] is getting too high on life! It looks like [p_theyre()] trying to commit suicide.",
|
||||
"[src] is high-fiving [p_them()]self to death! It looks like [p_theyre()] trying to commit suicide.",
|
||||
"[src] is hugging [p_them()]self to death! It looks like [p_theyre()] trying to commit suicide.",
|
||||
))
|
||||
|
||||
visible_message(span_danger("[suicide_message]"), span_userdanger("[suicide_message]"))
|
||||
|
||||
/// Checks if we are in a valid state to suicide (not already suiciding, capable of actually killing ourselves, area checks, etc.) Returns TRUE if we can suicide, FALSE if we can not.
|
||||
/mob/living/proc/can_suicide()
|
||||
if(suiciding)
|
||||
to_chat(src, span_warning("You are already commiting suicide!"))
|
||||
return FALSE
|
||||
|
||||
var/area/checkable = get_area(src)
|
||||
if(checkable.area_flags & BLOCK_SUICIDE)
|
||||
to_chat(src, span_warning("You can't commit suicide here! You can ghost if you'd like."))
|
||||
return FALSE
|
||||
|
||||
switch(stat)
|
||||
if(CONSCIOUS)
|
||||
return TRUE
|
||||
if(SOFT_CRIT)
|
||||
to_chat(src, span_warning("You can't commit suicide while in a critical condition!"))
|
||||
if(UNCONSCIOUS, HARD_CRIT)
|
||||
to_chat(src, span_warning("You need to be conscious to commit suicide!"))
|
||||
if(DEAD)
|
||||
to_chat(src, span_warning("You're already dead!"))
|
||||
return FALSE
|
||||
|
||||
/mob/living/carbon/can_suicide()
|
||||
if(!..())
|
||||
return FALSE
|
||||
if(!(mobility_flags & MOBILITY_USE)) //just while I finish up the new 'fun' suiciding verb. This is to prevent metagaming via suicide
|
||||
to_chat(src, span_warning("You can't commit suicide whilst immobile! (You can type Ghost instead however)."))
|
||||
return FALSE
|
||||
return TRUE
|
||||
|
||||
#undef ALIEN_SUICIDE_MESSAGE
|
||||
#undef BRAIN_SUICIDE_MESSAGE
|
||||
#undef GENERIC_SUICIDE_MESSAGE
|
||||
#undef HUMAN_BRAIN_DAMAGE_SUICIDE_MESSAGE
|
||||
#undef HUMAN_COMBAT_MODE_SUICIDE_MESSAGE
|
||||
#undef HUMAN_DEFAULT_MODE_SUICIDE_MESSAGE
|
||||
#undef MECHANICAL_SUICIDE_MESSAGE
|
||||
#undef PAI_SUICIDE_MESSAGE
|
||||
|
||||
Reference in New Issue
Block a user