Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Paperwork Prefabs #5265

Draft
wants to merge 68 commits into
base: master
Choose a base branch
from

Conversation

realforest2001
Copy link
Member

@realforest2001 realforest2001 commented Dec 20, 2023

Feedback here so I see it faster: https://discord.com/channels/150315577943130112/1233574245418668042/1233574245418668042

About the pull request

Adds a bunch of forms that can be taken out of filing cabinets to be filled out. Makes use of paperwork much more practical, and as it's using HTML, significantly more customisable.

This PR has focused on Military Police and the Corporate Liaison, but the system is designed to be completely modular.

While I have thoroughly tested my system works the way I want it to, I would appreciate input on quality/efficiency improvement.

Explain why it's good for the game

QOL, I think it will encourage people to use paperwork a lot more. I particularly want to see Military Police using it more often particularly in regards to Appeals.

Testing Photographs and Procedure

Screenshots & Videos

There are a couple inconsistencies in the images below, but these have been corrected since.

image
image

Changelog

🆑
code: Reorganises how paperwork gets image references, and moves them to a new folder.
add: Added prefab paperwork forms for use by Military Police and the Corporate Liaison.
code: Changed the [logo] paperwork tag to [wy_bw]
imageadd: Added a dark background often used by staff faxes for easy referencing.
imageadd: Updated WY and USCM logos to higher quality versions.
code: Reorganises the fountain pen into a subtype of obj/item/tool/pen/multicolor to make the functionality usable in multiple pens.
add: Adds a provost pen, a variant of multicolor pen that can switch between Black, White, Orange, Blue, Green and Red. Intended for use in filling out MP forms.
/:cl:

@realforest2001 realforest2001 marked this pull request as draft December 20, 2023 22:35
@github-actions github-actions bot added Sprites Remove the soul from the game. Mapping did you remember to save in tgm format? Feature Feature coder badge labels Dec 20, 2023
@cm13-github
Copy link
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@cm13-github cm13-github added the Merge Conflict PR can't be merged because it touched too much code label Dec 25, 2023
Copy link
Contributor

github-actions bot commented Jan 2, 2024

This PR has been inactive for long enough to be automatically marked as stale. This means it is at risk of being auto closed in ~ 7 days, please address any outstanding review items and ensure your PR is finished, if these are all true and you are auto-staled anyway, you need to actively ask maintainers if your PR will be merged. Once you have done any of the previous actions then you should request a maintainer remove the stale label on your PR, to reset the stale timer. If you feel no maintainer will respond in that time, you may wish to close this PR youself, while you seek maintainer comment, as you will then be able to reopen the PR yourself

@github-actions github-actions bot added the Stale beg a maintainer to review your PR label Jan 2, 2024
@github-actions github-actions bot closed this Jan 10, 2024
@github-actions github-actions bot added the Code Improvement Make the code longer label Apr 26, 2024
@cm13-github cm13-github removed the Merge Conflict PR can't be merged because it touched too much code label Apr 26, 2024
@cm13-github
Copy link
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

@cmss13-ci cmss13-ci bot added the UI deletes nanoui/html label Dec 1, 2024
91a8e93: maps/map_files/USS_Almayer/USS_Almayer.dmm

Automatically commited by: tools\mapmerge2\fixup.py
0a93e1d: maps/map_files/USS_Almayer/USS_Almayer.dmm

Automatically commited by: tools\mapmerge2\fixup.py
@cm13-github
Copy link
Contributor

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@cm13-github cm13-github added the Merge Conflict PR can't be merged because it touched too much code label Dec 10, 2024
@cm13-github
Copy link
Contributor

Conflicts have been resolved. A maintainer will review the pull request shortly.

@cm13-github cm13-github removed the Merge Conflict PR can't be merged because it touched too much code label Dec 11, 2024
3fe9e23: maps/map_files/USS_Almayer/USS_Almayer.dmm

Automatically commited by: tools\mapmerge2\fixup.py
code/modules/paperwork/prefab_papers.dm Outdated Show resolved Hide resolved
code/modules/clothing/head/head.dm Outdated Show resolved Hide resolved
code/modules/clothing/head/helmet.dm Outdated Show resolved Hide resolved
@Drulikar Drulikar marked this pull request as draft December 12, 2024 04:56
@realforest2001 realforest2001 marked this pull request as ready for review December 13, 2024 19:04
Copy link
Contributor

@Drulikar Drulikar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Consider also amending the admin RPLY responses in topic.dm
from
var/send_choice = tgui_input_list(usr, "Send this fax?", "Fax Template", list("Send", "Cancel"))
to var/send_choice = tgui_input_list(usr, "Send this fax?", "Fax Template", list("Send", "Send Priority", "Cancel"))
or something.

name = "provost pen"
desc = "A sleek black shell pen with the Provost Office sigil engraved into the side. It can change colors as needed for various functions within the Provost and Military Police."
icon_state = "provost_pen"
colour_list = list("blue", "green", "black", "orange", "red", "white")
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If you want this as a helmet garb again, and what to use the fountain_pen garb sprite, then add
item_state_slots = list(WEAR_AS_GARB = "fountain_pen") or repath under /obj/item/tool/pen/multicolor/fountain e.g. /obj/item/tool/pen/multicolor/fountain/provost and then return the entries to the hat & helmets as NO_GARB_OVERRIDE

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There is still a reference to the old file info = replacetext(info, "%%WYLOGO%%", asset.get_url_mappings()["wylogo.png"]) instead of logo_wy

Comment on lines +195 to +203
/obj/item/tool/pen/attack(mob/M as mob, mob/user as mob)
if(!ismob(M))
return
to_chat(user, SPAN_WARNING("You stab [M] with the pen."))
M.last_damage_data = create_cause_data(initial(name), user)
M.attack_log += text("\[[time_stamp()]\] <font color='orange'>Has been stabbed with [name] by [key_name(user)]</font>")
user.attack_log += text("\[[time_stamp()]\] <font color='red'>Used the [name] to stab [key_name(M)]</font>")
msg_admin_attack("[key_name(user)] Used the [name] to stab [key_name(M)] in [get_area(user)] ([user.loc.x],[user.loc.y],[user.loc.z]).", user.loc.x, user.loc.y, user.loc.z)
return
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
/obj/item/tool/pen/attack(mob/M as mob, mob/user as mob)
if(!ismob(M))
return
to_chat(user, SPAN_WARNING("You stab [M] with the pen."))
M.last_damage_data = create_cause_data(initial(name), user)
M.attack_log += text("\[[time_stamp()]\] <font color='orange'>Has been stabbed with [name] by [key_name(user)]</font>")
user.attack_log += text("\[[time_stamp()]\] <font color='red'>Used the [name] to stab [key_name(M)]</font>")
msg_admin_attack("[key_name(user)] Used the [name] to stab [key_name(M)] in [get_area(user)] ([user.loc.x],[user.loc.y],[user.loc.z]).", user.loc.x, user.loc.y, user.loc.z)
return
/obj/item/tool/pen/attack(mob/living/target, mob/living/user)
if(!ismob(target))
return
to_chat(user, SPAN_WARNING("You stab [target] with the pen."))
target.last_damage_data = create_cause_data(initial(name), user)
target.attack_log += text("\[[time_stamp()]\] <font color='orange'>Has been stabbed with [name] by [key_name(user)]</font>")
user.attack_log += text("\[[time_stamp()]\] <font color='red'>Used the [name] to stab [key_name(target)]</font>")
msg_admin_attack("[key_name(user)] Used the [name] to stab [key_name(target)] in [get_area(user)] ([user.loc.x],[user.loc.y],[user.loc.z]).", user.loc.x, user.loc.y, user.loc.z)
return

Comment on lines +312 to +320
if(on)
current_colour_index = (current_colour_index % length(colour_list)) + 1
pen_color = colour_list[current_colour_index]
balloon_alert(user,"you twist the pen and change the ink color to [pen_color].")
if(clicky)
playsound(user.loc, 'sound/items/pen_click_on.ogg', 100, 1, 5)
update_pen_state()
else
..()
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
if(on)
current_colour_index = (current_colour_index % length(colour_list)) + 1
pen_color = colour_list[current_colour_index]
balloon_alert(user,"you twist the pen and change the ink color to [pen_color].")
if(clicky)
playsound(user.loc, 'sound/items/pen_click_on.ogg', 100, 1, 5)
update_pen_state()
else
..()
if(!on)
return ..()
current_colour_index = (current_colour_index % length(colour_list)) + 1
pen_color = colour_list[current_colour_index]
balloon_alert(user,"you twist the pen and change the ink color to [pen_color].")
if(clicky)
playsound(user.loc, 'sound/items/pen_click_on.ogg', 100, 1, 5)
update_pen_state()

Comment on lines +295 to +297
is_priority_fax = !is_priority_fax
to_chat(user, SPAN_NOTICE("Priority Alert is now [is_priority_fax ? "Enabled" : "Disabled"]."))
. = TRUE
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This needs to ensure priority even can be toggled. Otherwise you can just force it.

@Drulikar Drulikar marked this pull request as draft December 14, 2024 00:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Code Improvement Make the code longer Feature Feature coder badge Mapping Approved adds 500 new dict keys Mapping did you remember to save in tgm format? Sprites Remove the soul from the game. Stale Exempt PR can't go stale UI deletes nanoui/html
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants