Files
Bubberstation/code/_onclick/click_alt.dm
Arvid Gudbrand 46f3ebc5db Add bind (shift-alt-primary) specifically for opening the TGUI loot panel (#92813)
## About The Pull Request

Adds a new bind `AltShiftClickOn` for explicitly opening the TGUI loot
panel at some tile without raising any signals or calling into an
override-able proc. This bind is in addition to the already existing
alt-click and it is not intended to replace it.

This is similar to [this
pr](https://github.com/tgstation/tgstation/pull/92307) but does not
replace the old bind nor add any features beyond the bind opening the
loot panel.

## Why It's Good For The Game

Originally I started looking into this because it was very obnoxious
that I was able to interact with pipes placed in walls, but not pipes
placed underneath windows. I had thought the issue was because the
window overlapped the pipe and was unable to open the loot panel to get
at it because the window handles alt-clicks through the
`simple_rotation` component's signal handler. Unfortunately the pipe is
still obscured by the window, so this does not fix that.

However I still see this as useful as it allows opening the very nice
and wonderful loot panel on a pile of items which may or may not handle
the alt click signal without needing to hunt for a pixel of the tile (or
of an item you _think_ may not handle it) to do so.

## Changelog

🆑
qol: shift+alt will open the tgui loot panel on any tile without being
intercepted by items that may be on the tile
code: adds a shift+alt click on proc for living mobs to explicitly open
the tgui loot panel in addition to the already existing alt bind
/🆑
2025-08-31 18:57:55 -07:00

136 lines
4.3 KiB
Plaintext

///Main proc for primary alt click
/mob/proc/AltClickOn(atom/target)
base_click_alt(target)
/**
* ### Base proc for alt click interaction left click. Returns if the click was intercepted & handled
*
* If you wish to add custom `click_alt` behavior for a single type, use that proc.
*/
/mob/proc/base_click_alt(atom/target)
SHOULD_NOT_OVERRIDE(TRUE)
// Check if they've hooked in to prevent src from alt clicking anything
if(SEND_SIGNAL(src, COMSIG_MOB_ALTCLICKON, target) & COMSIG_MOB_CANCEL_CLICKON)
return TRUE
// If it has a signal handler that returns a click action, done.
if(SEND_SIGNAL(target, COMSIG_CLICK_ALT, src) & CLICK_ACTION_ANY)
return TRUE
// If it has a custom click_alt that returns success/block, done.
if(can_perform_action(target, (target.interaction_flags_click | SILENT_ADJACENCY)))
return target.click_alt(src) & CLICK_ACTION_ANY
return FALSE
/mob/living/base_click_alt(atom/target)
SHOULD_NOT_OVERRIDE(TRUE)
. = ..()
if(.)
return
return try_open_loot_panel_on(target)
/**
* ## Custom alt click interaction
* Override this to change default alt click behavior. Return `CLICK_ACTION_SUCCESS`, `CLICK_ACTION_BLOCKING` or `NONE`.
*
* ### Guard clauses
* Consider adding `interaction_flags_click` before adding unique guard clauses.
*
* ### Return flags
* Forgetting your return will cause the default alt click behavior to occur thereafter.
*
* The difference between NONE and BLOCKING can get hazy, but I like to keep NONE limited to guard clauses and "never" cases.
*
* A good usage for BLOCKING over NONE is when it's situational for the item and there's some feedback indicating this.
*
* ### Examples:
* User is a ghost, alt clicks on item with special disk eject: NONE
*
* Machine broken, no feedback: NONE
*
* Alt click a pipe to max output but its already max: BLOCKING
*
* Alt click a gun that normally works, but is out of ammo: BLOCKING
*
* User unauthorized, machine beeps: BLOCKING
*
* @param {mob} user - The person doing the alt clicking.
*/
/atom/proc/click_alt(mob/user)
SHOULD_CALL_PARENT(FALSE)
return NONE
///Main proc for secondary alt click
/mob/proc/AltClickSecondaryOn(atom/target)
base_click_alt_secondary(target)
/**
* ### Base proc for alt click interaction right click.
*
* If you wish to add custom `click_alt_secondary` behavior for a single type, use that proc.
*/
/mob/proc/base_click_alt_secondary(atom/target)
SHOULD_NOT_OVERRIDE(TRUE)
//Hook on the mob to intercept the click
if(SEND_SIGNAL(src, COMSIG_MOB_ALTCLICKON_SECONDARY, target) & COMSIG_MOB_CANCEL_CLICKON)
return
//Hook on the atom to intercept the click
if(SEND_SIGNAL(target, COMSIG_CLICK_ALT_SECONDARY, src) & COMPONENT_CANCEL_CLICK_ALT_SECONDARY)
return
// If it has a custom click_alt_secondary then do that
if(can_perform_action(target, target.interaction_flags_click | SILENT_ADJACENCY))
target.click_alt_secondary(src)
/**
* ## Custom alt click secondary interaction
* Override this to change default alt right click behavior.
*
* ### Guard clauses
* Consider adding `interaction_flags_click` before adding unique guard clauses.
**/
/atom/proc/click_alt_secondary(mob/user)
SHOULD_CALL_PARENT(FALSE)
return NONE
/**
* ## No-op for unambiguous loot panel bind as a non-living mob.
**/
/mob/proc/alt_shift_click_on(atom/target)
SHOULD_NOT_OVERRIDE(TRUE)
return FALSE
/**
* ## Bind for unambiguously opening the loot panel as a living mob.
* This raises no signals and is not meant to have its behavior overridden.
**/
/mob/living/alt_shift_click_on(atom/target)
SHOULD_NOT_OVERRIDE(TRUE)
return try_open_loot_panel_on(target)
///Helper for determining if a living mob may open the loot panel for some target, since it is shared between
///alt and alt-shift click.
///Returns FALSE if the mob is unable to open the loot panel at the target and TRUE if the loot panel was opened.
/mob/living/proc/try_open_loot_panel_on(atom/target)
if(!CAN_I_SEE(target) || (is_blind() && !IN_GIVEN_RANGE(src, target, 1)))
return FALSE
// No alt clicking to view turf from beneath
if(HAS_TRAIT(src, TRAIT_MOVE_VENTCRAWLING))
return FALSE
/// No loot panel if it's on our person
if(isobj(target) && (target in get_all_gear()))
to_chat(src, span_warning("You can't search for this item, it's already in your inventory! Take it off first."))
return FALSE
client.loot_panel.open(get_turf(target))
return TRUE