mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2026-08-23 13:10:02 +01:00
[TM First] Paint Canvas Refactor (powered by the Universal Icon Editing Framework) (#94797)
## About The Pull Request This PR adds a universal framework for editing sprites, and adds an example implementation by way of porting paint canvases to it. This should have no impact on serializing paintings in the database. As part of this canvas refactor, zooming in and out of a canvas is now handled entirely on the client side. The paint palette component has also been refactored to allow a variable number of colors up to the specified maximum, instead of populating all color slots to start out with. Some features of the sprite editing framework are unused in this PR, as they were not necessary for feature parity with the current implementation of paintings. However, they remain present for use in future PRs, such as a PDA painting app that was separated out of this branch for atomicity. These features include: - Eraser tool - Undo history - Layers - Multi-dir icon support Support for animated icons is not present, but planned to be added when a new feature needs it. ### New Painting UI Screenshot: <img width="1210" height="596" alt="NewCanvasUiDemo" src="https://github.com/user-attachments/assets/4181745b-716b-4068-b3a2-d2491e5abf09" /> ## Why It's Good For The Game This framework opens the possibility for a wide variety of new features, such as Goofball's planned tailoring mechanic. Additionally, the consolidation of all the controls into a single window should make painting more user-friendly. ## Changelog 🆑 refactor: Painting has been significantly refactored with a new UI that should provide every painting control you need without having to unfocus the UI window. Please report any issues. refactor: Items that can store paint palettes now start with no colors. Colors can be added to and removed from the item's palette, up to the number of colors they previously stored. /🆑 --------- Co-authored-by: Jordan Dominion <dominion@tgstation13.org>
This commit is contained in:
Y0SH1M4S73R
co-authored by
Jordan Dominion
Jordan Dominion
parent
8f330fe5af
commit
5efeedbad9
@@ -5,9 +5,10 @@
|
||||
* and call set_painting_tool_color() on the parent for more specific object behavior.
|
||||
*/
|
||||
/datum/component/palette
|
||||
/// The maximum number of colors this palette can have.
|
||||
var/max_colors
|
||||
/*
|
||||
* A list that stores a selection of colors.
|
||||
* The number of available spaces is defined by the available_space arg of Initialize()
|
||||
*/
|
||||
var/list/colors = list()
|
||||
/*
|
||||
@@ -20,25 +21,20 @@
|
||||
/// The radial menu choice datums are stored here as a microop to avoid generating new ones every time the menu is opened or updated.
|
||||
var/list/datum/radial_menu_choice/menu_choices
|
||||
|
||||
/datum/component/palette/Initialize(available_space, selected_color)
|
||||
/datum/component/palette/Initialize(max_colors, selected_color)
|
||||
if(!isitem(parent))
|
||||
return COMPONENT_INCOMPATIBLE
|
||||
|
||||
if(!isnum(available_space) || available_space < 1) /// This component means nothing if there's no space for colors
|
||||
stack_trace("palette component initialized without a proper value for the available_space arg")
|
||||
if(!isnum(max_colors) || max_colors < 1) /// This component means nothing if there's no space for colors
|
||||
stack_trace("palette component initialized without a proper value for the max_colors arg")
|
||||
return COMPONENT_INCOMPATIBLE
|
||||
|
||||
for(var/index in 1 to available_space)
|
||||
colors += "#ffffff"
|
||||
|
||||
src.colors = colors
|
||||
src.max_colors = max_colors
|
||||
src.selected_color = selected_color || "#ffffff"
|
||||
|
||||
RegisterSignal(parent, COMSIG_ITEM_ATTACK_SELF_SECONDARY, PROC_REF(on_attack_self_secondary))
|
||||
RegisterSignal(parent, COMSIG_ATOM_EXAMINE, PROC_REF(on_examine))
|
||||
RegisterSignal(parent, COMSIG_PAINTING_TOOL_SET_COLOR, PROC_REF(on_painting_tool_set_color))
|
||||
RegisterSignal(parent, COMSIG_PAINTING_TOOL_GET_ADDITIONAL_DATA, PROC_REF(get_palette_data))
|
||||
RegisterSignal(parent, COMSIG_PAINTING_TOOL_PALETTE_COLOR_CHANGED, PROC_REF(palette_color_changed))
|
||||
|
||||
/datum/component/palette/Destroy()
|
||||
QDEL_NULL(color_picker_menu)
|
||||
@@ -51,7 +47,7 @@
|
||||
SIGNAL_HANDLER
|
||||
|
||||
examine_list += span_notice("<b>Right-Click</b> this item while it's in your active hand to open/close its color picker menu.")
|
||||
examine_list += span_notice("In the color picker, <b>Left-Click</b> a color button to pick it or <b>Right-Click</b> to edit it.")
|
||||
examine_list += span_notice("In the color picker, <b>Left-Click</b> a color button to pick it or <b>Right-Click</b> to remove it.")
|
||||
|
||||
/datum/component/palette/proc/on_attack_self_secondary(datum/source, mob/user)
|
||||
SIGNAL_HANDLER
|
||||
@@ -72,12 +68,27 @@
|
||||
|
||||
/datum/component/palette/proc/build_radial_list()
|
||||
var/radial_list = list()
|
||||
LAZYSETLEN(menu_choices, length(colors))
|
||||
var/color_count = length(colors)
|
||||
LAZYSETLEN(menu_choices, max(color_count+1))
|
||||
if(color_count < max_colors && !(selected_color in colors))
|
||||
var/datum/radial_menu_choice/add_option = peek(menu_choices)
|
||||
if(!add_option)
|
||||
add_option = new
|
||||
menu_choices[color_count+1] = add_option
|
||||
var/image/element = image(icon = 'icons/hud/radial.dmi', icon_state = "palette_element")
|
||||
element.color = selected_color
|
||||
var/image/plus = image(icon = 'icons/hud/radial.dmi', icon_state = "palette_add")
|
||||
plus.appearance_flags = /image::appearance_flags | RESET_COLOR
|
||||
element.add_overlay(plus)
|
||||
add_option.image = element
|
||||
add_option.name = "Add Color ([selected_color])"
|
||||
radial_list["add"] = add_option
|
||||
for(var/index in 1 to length(colors))
|
||||
var/hexcolor = colors[index]
|
||||
var/datum/radial_menu_choice/option = menu_choices[index]
|
||||
if(!option)
|
||||
option = new
|
||||
menu_choices[index] = option
|
||||
var/icon_state_to_use = hexcolor == selected_color ? "palette_selected" : "palette_element"
|
||||
var/image/element = image(icon = 'icons/hud/radial.dmi', icon_state = icon_state_to_use)
|
||||
element.color = hexcolor
|
||||
@@ -104,11 +115,14 @@
|
||||
close_radial_menu()
|
||||
return
|
||||
var/is_right_clicking = LAZYACCESS(params2list(params), RIGHT_CLICK)
|
||||
if(choice == "add")
|
||||
if(length(colors) < max_colors)
|
||||
colors += selected_color
|
||||
update_radial_list()
|
||||
return
|
||||
var/index = text2num(choice)
|
||||
if(is_right_clicking)
|
||||
var/chosen_color = tgui_color_picker(user, "Pick new color", "[parent]", colors[index])
|
||||
if(chosen_color && !QDELETED(src) && !IS_DEAD_OR_INCAP(user) && user.is_holding(parent))
|
||||
colors[index] = chosen_color
|
||||
colors.Cut(index, index+1)
|
||||
update_radial_list()
|
||||
else
|
||||
var/obj/item/parent_item = parent
|
||||
@@ -119,24 +133,3 @@
|
||||
|
||||
selected_color = chosen_color
|
||||
update_radial_list()
|
||||
|
||||
/datum/component/palette/proc/get_palette_data(datum/source, data)
|
||||
SIGNAL_HANDLER
|
||||
var/list/painting_data = list()
|
||||
for(var/hexcolor in colors)
|
||||
painting_data += list(list(
|
||||
"color" = hexcolor,
|
||||
"is_selected" = hexcolor == selected_color
|
||||
))
|
||||
data["paint_tool_palette"] = painting_data
|
||||
|
||||
/datum/component/palette/proc/palette_color_changed(datum/source, chosen_color, index)
|
||||
SIGNAL_HANDLER
|
||||
|
||||
var/was_selected_color = selected_color == colors[index]
|
||||
colors[index] = chosen_color
|
||||
if(was_selected_color)
|
||||
var/obj/item/parent_item = parent
|
||||
parent_item.set_painting_tool_color(chosen_color)
|
||||
else
|
||||
update_radial_list()
|
||||
|
||||
Reference in New Issue
Block a user