mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2026-07-20 20:45:28 +01:00
Circuit editor QoL and new circuit components (#82969)
## About The Pull Request This PR introduces a number of minor quality of life improvements to already existing circuit components, and adds three new components. <img width="600" alt="preview" src="https://github.com/tgstation/tgstation/assets/80724828/85d39b6d-b055-430e-8996-0da088616887"> ## Why It's Good For The Game This improves the overall experience for circuits. ### UI changes <img width="550" alt="grid aligned" src="https://github.com/tgstation/tgstation/assets/80724828/cc7b43b5-292f-4643-beab-e01ae675fb19"> Grid align is now an option for circuit designers. It will round objects to the nearest 10px units internally, and can be toggled on/off by the new additional button beside the component menu button. This makes circuits easier on the eyes as things are pixel perfect aligned. <img width="814" alt="tooltips" src="https://github.com/tgstation/tgstation/assets/80724828/0d31c98f-3be9-46e0-ab37-20bac3799112"> All three buttons have been given tool tips. ### Tweaked Components <img width="136" alt="voice activator" src="https://github.com/tgstation/tgstation/assets/80724828/21dd0f65-cb98-4bd5-aeb0-63315e842cb6"> * Adds a on/off flag to the voice activator component -- This saves power for circuits as you're not forced to use a compare flag check to turn off voice activation <img width="136" alt="speech" src="https://github.com/tgstation/tgstation/assets/80724828/9137b76c-3077-4597-8411-2d9694b39e9e"> * Adds a quiet mode flag to speech component -- This is ideal when you want a device to speak, but don't want other people to hear. A good example would be a handheld translator that you only want to hear yourself. ### New Components <img width="136" alt="ntnet list literal" src="https://github.com/tgstation/tgstation/assets/80724828/657c851b-d442-4a63-8650-410cb8e76089"> * An NTNet Send component that allows everything to be input much like the list literal component -- This makes sending stuff over NTNet easier for the user, and use less power as it won't require an additional list literal component <img width="136" alt="compare health state" src="https://github.com/tgstation/tgstation/assets/80724828/0bed076c-3aa1-4931-af90-2b9eb8e1ae9a"> * A health comparison component that checks the entity's health state, and can return true or false depending if the entity is alive, sleeping, unconscious, critical or dead -- This could be achieved by using a health sensor and a compare component, however it lacks the ability to know when a entity is unconscious or sleeping <img width="136" alt="toggle" src="https://github.com/tgstation/tgstation/assets/80724828/7017b6bf-937a-42ad-87f3-4f1134853ac3"> * A quick toggle component to allow the switching between a true and false state -- This could be achieved by using a logic component and self linking, however this makes it far easier for newcomers to make something as simple as an on/off switch (such as a handheld translator which uses the front button to turn on/off) ## Changelog 🆑 qol: Add tooltips to circuit editor buttons qol: Add grid alignment mode to circuit editor add: Added new compare health state component add: Added new NTNet send list literal component add: Added new toggle component qol: Added activity toggle to voice activator component qol: Added quiet mode to speech component qol: NTNet send component will not use power/trigger if NTNet is offline /🆑
This commit is contained in:
@@ -11,6 +11,8 @@
|
||||
|
||||
/// The message to send
|
||||
var/datum/port/input/message
|
||||
/// The quiet mode flag
|
||||
var/datum/port/input/quietmode
|
||||
|
||||
/// The cooldown for this component of how often it can send speech messages.
|
||||
var/speech_cooldown = 1 SECONDS
|
||||
@@ -21,6 +23,7 @@
|
||||
|
||||
/obj/item/circuit_component/speech/populate_ports()
|
||||
message = add_input_port("Message", PORT_TYPE_STRING, trigger = null)
|
||||
quietmode = add_input_port("Quiet Mode", PORT_TYPE_NUMBER, default = 0)
|
||||
|
||||
/obj/item/circuit_component/speech/input_received(datum/port/input/port)
|
||||
if(!parent.shell)
|
||||
@@ -31,5 +34,5 @@
|
||||
|
||||
if(message.value)
|
||||
var/atom/movable/shell = parent.shell
|
||||
shell.say(message.value, forced = "circuit speech | [parent.get_creator()]")
|
||||
shell.say(message.value, forced = "circuit speech | [parent.get_creator()]", message_range = quietmode.value > 0 ? WHISPER_RANGE : MESSAGE_RANGE)
|
||||
TIMER_COOLDOWN_START(shell, COOLDOWN_CIRCUIT_SPEECH, speech_cooldown)
|
||||
|
||||
@@ -0,0 +1,56 @@
|
||||
/**
|
||||
* # Compare Health State Component
|
||||
*
|
||||
* Returns true when state matches entity.
|
||||
*/
|
||||
|
||||
/obj/item/circuit_component/compare/health_state
|
||||
display_name = "Compare Health State"
|
||||
desc = "A component that compares the health state of an organism, and returns true or false."
|
||||
category = "Entity"
|
||||
|
||||
/// The input port
|
||||
var/datum/port/input/input_port
|
||||
|
||||
/// Compare state option
|
||||
var/datum/port/input/option/state_option
|
||||
|
||||
var/max_range = 5
|
||||
|
||||
/obj/item/circuit_component/compare/health_state/get_ui_notices()
|
||||
. = ..()
|
||||
. += create_ui_notice("Maximum Range: [max_range] tiles", "orange", "info")
|
||||
|
||||
/obj/item/circuit_component/compare/health_state/populate_options()
|
||||
input_port = add_input_port("Organism", PORT_TYPE_ATOM)
|
||||
|
||||
var/static/component_options = list(
|
||||
"Alive",
|
||||
"Asleep",
|
||||
"Critical",
|
||||
"Unconscious",
|
||||
"Deceased",
|
||||
)
|
||||
state_option = add_option_port("Comparison Option", component_options)
|
||||
|
||||
/obj/item/circuit_component/compare/health_state/do_comparisons()
|
||||
var/mob/living/organism = input_port.value
|
||||
var/turf/current_turf = get_location()
|
||||
if(!istype(organism) || current_turf.z != organism.z || get_dist(current_turf, organism) > max_range)
|
||||
return FALSE
|
||||
|
||||
var/current_option = state_option.value
|
||||
var/state = organism.stat
|
||||
switch(current_option)
|
||||
if("Alive")
|
||||
return state != DEAD
|
||||
if("Asleep")
|
||||
return !!organism.IsSleeping() && !organism.IsUnconscious()
|
||||
if("Critical")
|
||||
return state == SOFT_CRIT || state == HARD_CRIT
|
||||
if("Unconscious")
|
||||
return state == UNCONSCIOUS || state == HARD_CRIT || !!organism.IsUnconscious()
|
||||
if("Deceased")
|
||||
return state == DEAD
|
||||
//Unknown state, something fucked up really bad - just return false
|
||||
return FALSE
|
||||
@@ -8,6 +8,9 @@
|
||||
desc = "A component that listens for messages. Requires a shell."
|
||||
category = "Entity"
|
||||
|
||||
/// The on/off port
|
||||
var/datum/port/input/on
|
||||
|
||||
/// The message heard
|
||||
var/datum/port/output/message_port
|
||||
/// The language heard
|
||||
@@ -20,6 +23,7 @@
|
||||
var/datum/port/output/trigger_port
|
||||
|
||||
/obj/item/circuit_component/hear/populate_ports()
|
||||
on = add_input_port("On", PORT_TYPE_NUMBER, default = 1)
|
||||
message_port = add_output_port("Message", PORT_TYPE_STRING)
|
||||
language_port = add_output_port("Language", PORT_TYPE_STRING)
|
||||
speaker_port = add_output_port("Speaker", PORT_TYPE_ATOM)
|
||||
@@ -40,6 +44,8 @@
|
||||
return Hear(arglist(arguments))
|
||||
|
||||
/obj/item/circuit_component/hear/Hear(message, atom/movable/speaker, datum/language/message_language, raw_message, radio_freq, list/spans, list/message_mods, message_range)
|
||||
if(!on.value)
|
||||
return FALSE
|
||||
if(speaker == parent?.shell)
|
||||
return FALSE
|
||||
|
||||
|
||||
@@ -0,0 +1,36 @@
|
||||
/**
|
||||
* # Toggle Component
|
||||
*
|
||||
* Does a toggle between true and false on trigger
|
||||
*/
|
||||
/obj/item/circuit_component/compare/toggle
|
||||
display_name = "Toggle"
|
||||
desc = "A component that toggles between on and off when triggered. All input ports (except for set toggle) will trigger the component."
|
||||
category = "Math"
|
||||
|
||||
/// A signal to reset the toggle back to 0
|
||||
var/datum/port/input/toggle_set
|
||||
/// A signal to toggle and return the current state
|
||||
var/datum/port/input/toggle_and_compare
|
||||
|
||||
var/toggle_state = FALSE
|
||||
|
||||
/obj/item/circuit_component/compare/toggle/populate_custom_ports()
|
||||
toggle_set = add_input_port("Set Toggle State", PORT_TYPE_NUMBER)
|
||||
toggle_and_compare = add_input_port("Toggle And Compare", PORT_TYPE_SIGNAL)
|
||||
toggle_state = FALSE
|
||||
|
||||
/obj/item/circuit_component/compare/toggle/input_received(datum/port/input/port)
|
||||
if(port == toggle_set)
|
||||
toggle_state = !!port.value
|
||||
return
|
||||
if(COMPONENT_TRIGGERED_BY(toggle_and_compare, port))
|
||||
toggle_state = !toggle_state
|
||||
if(toggle_state)
|
||||
true.set_output(COMPONENT_SIGNAL)
|
||||
else
|
||||
false.set_output(COMPONENT_SIGNAL)
|
||||
return ..()
|
||||
|
||||
/obj/item/circuit_component/compare/toggle/do_comparisons()
|
||||
return toggle_state
|
||||
@@ -27,12 +27,17 @@
|
||||
data_package = add_input_port("Data Package", PORT_TYPE_LIST(PORT_TYPE_ANY))
|
||||
enc_key = add_input_port("Encryption Key", PORT_TYPE_STRING)
|
||||
|
||||
/obj/item/circuit_component/ntnet_send/should_receive_input(datum/port/input/port)
|
||||
. = ..()
|
||||
if(!.)
|
||||
return FALSE
|
||||
/// If the server is down, don't use power or attempt to send data
|
||||
return find_functional_ntnet_relay()
|
||||
|
||||
/obj/item/circuit_component/ntnet_send/pre_input_received(datum/port/input/port)
|
||||
if(port == list_options)
|
||||
var/new_datatype = list_options.value
|
||||
data_package.set_datatype(PORT_TYPE_LIST(new_datatype))
|
||||
|
||||
/obj/item/circuit_component/ntnet_send/input_received(datum/port/input/port)
|
||||
if(!find_functional_ntnet_relay())
|
||||
return
|
||||
SEND_GLOBAL_SIGNAL(COMSIG_GLOB_CIRCUIT_NTNET_DATA_SENT, list("data" = data_package.value, "enc_key" = enc_key.value, "port" = WEAKREF(data_package)))
|
||||
send_ntnet_data(data_package, enc_key.value)
|
||||
|
||||
@@ -0,0 +1,30 @@
|
||||
/**
|
||||
* # NTNet Transmitter List Literal Component
|
||||
*
|
||||
* Create a list literal and send a data package through NTNet
|
||||
*
|
||||
* This file is based off of ntnet_send.dm
|
||||
* Any changes made to those files should be copied over with discretion
|
||||
*/
|
||||
/obj/item/circuit_component/list_literal/ntnet_send
|
||||
display_name = "NTNet Transmitter List Literal"
|
||||
desc = "Creates a list literal data package and sends it through NTNet. If Encryption Key is set then transmitted data will be only picked up by receivers with the same Encryption Key."
|
||||
category = "NTNet"
|
||||
|
||||
/// Encryption key
|
||||
var/datum/port/input/enc_key
|
||||
|
||||
/obj/item/circuit_component/list_literal/ntnet_send/populate_ports()
|
||||
. = ..()
|
||||
enc_key = add_input_port("Encryption Key", PORT_TYPE_STRING)
|
||||
|
||||
/obj/item/circuit_component/list_literal/ntnet_send/should_receive_input(datum/port/input/port)
|
||||
. = ..()
|
||||
if(!.)
|
||||
return FALSE
|
||||
/// If the server is down, don't use power or attempt to send data
|
||||
return find_functional_ntnet_relay()
|
||||
|
||||
/obj/item/circuit_component/list_literal/ntnet_send/input_received(datum/port/input/port)
|
||||
. = ..()
|
||||
send_ntnet_data(list_output, enc_key.value)
|
||||
@@ -405,3 +405,14 @@
|
||||
*/
|
||||
/obj/item/circuit_component/proc/unregister_usb_parent(atom/movable/shell)
|
||||
return
|
||||
|
||||
/**
|
||||
* Called when a circuit component requests to send Ntnet data signal.
|
||||
*
|
||||
* Arguments:
|
||||
* * port - The required list port needed by the Ntnet recieve
|
||||
* * key - The encryption key
|
||||
* * signal_type - The signal type used for sending this global signal (optional, default is COMSIG_GLOB_CIRCUIT_NTNET_DATA_SENT)
|
||||
*/
|
||||
/obj/item/circuit_component/proc/send_ntnet_data(datum/port/input/port, key, signal_type = COMSIG_GLOB_CIRCUIT_NTNET_DATA_SENT)
|
||||
SEND_GLOBAL_SIGNAL(signal_type, list("data" = port.value, "enc_key" = key, "port" = WEAKREF(port)))
|
||||
|
||||
@@ -80,6 +80,9 @@ GLOBAL_LIST_EMPTY_TYPED(integrated_circuits, /obj/item/integrated_circuit)
|
||||
/// The Y position of the screen. Used for adding components.
|
||||
var/screen_y = 0
|
||||
|
||||
/// The grid mode state for the circuit.
|
||||
var/grid_mode = TRUE
|
||||
|
||||
/// The current size of the circuit.
|
||||
var/current_size = 0
|
||||
|
||||
@@ -400,6 +403,7 @@ GLOBAL_LIST_EMPTY_TYPED(integrated_circuits, /obj/item/integrated_circuit)
|
||||
.["examined_notices"] = examined?.get_ui_notices()
|
||||
.["examined_rel_x"] = examined_rel_x
|
||||
.["examined_rel_y"] = examined_rel_y
|
||||
.["grid_mode"] = grid_mode
|
||||
|
||||
.["is_admin"] = (admin_only || isAdminGhostAI(user)) && check_rights_for(user.client, R_VAREDIT)
|
||||
|
||||
@@ -577,6 +581,9 @@ GLOBAL_LIST_EMPTY_TYPED(integrated_circuits, /obj/item/integrated_circuit)
|
||||
else
|
||||
set_display_name("")
|
||||
. = TRUE
|
||||
if("toggle_grid_mode")
|
||||
toggle_grid_mode()
|
||||
. = TRUE
|
||||
if("set_examined_component")
|
||||
var/component_id = text2num(params["component_id"])
|
||||
if(!WITHIN_RANGE(component_id, attached_components))
|
||||
@@ -709,6 +716,10 @@ GLOBAL_LIST_EMPTY_TYPED(integrated_circuits, /obj/item/integrated_circuit)
|
||||
else
|
||||
shell.name = initial(shell.name)
|
||||
|
||||
/// Toggles the grid mode property for this circuit.
|
||||
/obj/item/integrated_circuit/proc/toggle_grid_mode()
|
||||
grid_mode = !grid_mode
|
||||
|
||||
/**
|
||||
* Returns the creator of the integrated circuit. Used in admin messages and other related things.
|
||||
*/
|
||||
|
||||
Reference in New Issue
Block a user