mirror of
https://github.com/Bubberstation/Bubberstation.git
synced 2026-01-01 12:31:32 +00:00
fe47d6ba35
* Refactors sheet crafting to better support directional construction (#74572)
## About The Pull Request
0426f7ddba/code/game/objects/items/stacks/stack.dm (L449)
Ok, but can we not?
This PR refactors sheet crafting to generalize all the cases that were
previously locked behind grille/window type checks and such. In their
stead there are bitflags that can be set to achieve certain behaviors.
All the behavior from before should be preserved, but now it can be
extended to other items. E.g. if you want a railing that can be crafted
underneath directional windows, or an item that behaves like a grille
does--it's just a matter of setting the right obj_flags for it now.
This makes it very simple and painless to add new recipes that use
directional crafting! It's all modular now.
<details><summary>Details</summary>
---
### What I've done:
-Eliminated all the type checks, instead it will now be handled by
object flags and recipe vars, making for a much more configurable
system.
-Added two new obj_flags: `BLOCKS_CONSTRUCTION_DIR` and
`IGNORE_DENSITY`.
-Additionally, I renamed the existing flag `NO_BUILD` to
`BLOCKS_CONSTRUCTION`.
-Changes the proc `valid_window_location` to `valid_build_direction`,
and makes it work for things other than windows.
-Removed a deprecated `window_checks` var from the stack_recipe datum.
-Added three more vars to the stack_recipe datum: `check_direction` and
`check_density`, `is_fulltile`
-Decoupled `on_solid_ground` from the object density check. Now you can
set those separately, allowing you to make recipes that forbid/allow
building things over other things while in space.
---
### What the new flags do:
`BLOCKS_CONSTRUCTION` works as before---prevents objects from being
built on the object. I felt that the previous name was not descriptive
enough, you should know exactly what it does just from looking at the
name.
_example: dna scanner_
`BLOCKS_CONSTRUCTION_DIR` -- setting this on an object will prevent
objects from being built on it when their directions are the same.
_example: directional windows, windoors, railings_
`IGNORE_DENSITY` -- setting this on an object will cause its density to
be ignored when performing the construction density check. This could
have other potential uses as well in the future.
_example: grilles, directional windows, tables_
These three flags cover all the bases for the types of items that are
currently craftable, so there is no more need for any type checking or
weird snowflake window checks. Simply set the appropriate flag and it'll
work as you would expect.
---
### What the recipe vars do:
`check_direction` tells the recipe to check if there's something in that
direction with the `BLOCKS_CONSTRUCTION_DIR` flag set.
`check_density` tells the recipe to run the density check when set. This
is true by default. There are very few items in the game that currently
have this set to false--namely grilles. Setting this to false will make
it so that the object can be constructed regardless of what is in that
tile (unless `one_per_turf` is also set, which will make it so that you
can't craft the same thing twice in the same turf).
`is_fulltile` is used for fulltile windows, but it doesn't necessarily
have to be--you can give this to any recipe and it will adopt the same
properties as that of the fulltile window. Basically they have a special
case where they shouldn't be able to be built over directional
constructions, where normally things would be able to be. Setting this
makes check_direction true as well.
---
### In summary:
Sheet crafting still works just as it did before. But the backend of it
has gotten a glow up and will be able to more easily support new
behaviors.
</details>
## Why It's Good For The Game
This makes the crafting system much more flexible to add recipes to, and
will prevent bad code practices of stacking more conditionals down the
line whenever someone wants to add an item that behaves like grilles or
directional windows in how they are constructed.
It had to be done. Those window checks were a mess.
## Changelog
🆑
qol: added fifty stack versions of remaining glass sheet stacks for ease
of debugging
refactor: refactored sheet crafting to better support directional
constructions that aren't windows
/🆑
---------
Co-authored-by: san7890 <the@ san7890.com>
* Refactors sheet crafting to better support directional construction
* fex
* https://github.com/Skyrat-SS13/Skyrat-tg/pull/20636
---------
Co-authored-by: Bloop <vinylspiders@gmail.com>
Co-authored-by: san7890 <the@ san7890.com>
Co-authored-by: Gandalf <9026500+Gandalf2k15@users.noreply.github.com>
123 lines
3.3 KiB
Plaintext
123 lines
3.3 KiB
Plaintext
|
|
/*
|
|
* Recipe datum
|
|
*/
|
|
/datum/stack_recipe
|
|
/// The title of the recipe
|
|
var/title = "ERROR"
|
|
/// What atom the recipe makes, typepath
|
|
var/atom/result_type
|
|
/// Amount of stack required to make
|
|
var/req_amount = 1
|
|
/// Amount of resulting atoms made
|
|
var/res_amount = 1
|
|
/// Max amount of resulting atoms made
|
|
var/max_res_amount = 1
|
|
/// How long it takes to make
|
|
var/time = 0
|
|
/// If only one of the resulting atom is allowed per turf
|
|
var/one_per_turf = FALSE
|
|
/// If the atom is fulltile, as in a fulltile window. This is used for the direction check to prevent fulltile windows from being able to be built over directional stuff.
|
|
/// Setting this to true will effectively set check_direction to true.
|
|
var/is_fulltile = FALSE
|
|
/// If this atom should run the direction check, for use when building things like directional windows where you can have more than one per turf
|
|
var/check_direction = FALSE
|
|
/// If the atom requires a floor below
|
|
var/on_solid_ground = FALSE
|
|
/// If the atom requires a tram floor below
|
|
var/on_tram = FALSE
|
|
/// If the atom checks that there are objects with density in the same turf when being built. TRUE by default
|
|
var/check_density = TRUE
|
|
/// Bitflag of additional placement checks required to place. (STACK_CHECK_CARDINALS|STACK_CHECK_ADJACENT)
|
|
var/placement_checks = NONE
|
|
/// If TRUE, the created atom will gain custom mat datums
|
|
var/applies_mats = FALSE
|
|
/// What trait, if any, boosts the construction speed of this item
|
|
var/trait_booster
|
|
/// How much the trait above, if supplied, boosts the construct speed of this item
|
|
var/trait_modifier = 1
|
|
/// Category for general crafting menu
|
|
var/category
|
|
|
|
/datum/stack_recipe/New(
|
|
title,
|
|
result_type,
|
|
req_amount = 1,
|
|
res_amount = 1,
|
|
max_res_amount = 1,
|
|
time = 0,
|
|
one_per_turf = FALSE,
|
|
on_solid_ground = FALSE,
|
|
on_tram = FALSE,
|
|
is_fulltile = FALSE,
|
|
check_direction = FALSE,
|
|
check_density = TRUE,
|
|
placement_checks = NONE,
|
|
applies_mats = FALSE,
|
|
trait_booster,
|
|
trait_modifier = 1,
|
|
category,
|
|
)
|
|
|
|
src.title = title
|
|
src.result_type = result_type
|
|
src.req_amount = req_amount
|
|
src.res_amount = res_amount
|
|
src.max_res_amount = max_res_amount
|
|
src.time = time
|
|
src.one_per_turf = one_per_turf
|
|
src.on_solid_ground = on_solid_ground
|
|
src.on_tram = on_tram
|
|
src.is_fulltile = is_fulltile
|
|
src.check_direction = check_direction || is_fulltile
|
|
src.check_density = check_density
|
|
src.placement_checks = placement_checks
|
|
src.applies_mats = applies_mats
|
|
src.trait_booster = trait_booster
|
|
src.trait_modifier = trait_modifier
|
|
src.category = src.category || category || CAT_MISC
|
|
|
|
/datum/stack_recipe/radial
|
|
/// Optional info to be shown on the radial option for this item
|
|
var/desc
|
|
|
|
/datum/stack_recipe/radial/New(
|
|
title,
|
|
result_type,
|
|
req_amount = 1,
|
|
res_amount = 1,
|
|
max_res_amount = 1,
|
|
time = 0,
|
|
one_per_turf = FALSE,
|
|
on_solid_ground = FALSE,
|
|
on_tram = FALSE,
|
|
window_checks = FALSE,
|
|
placement_checks = NONE,
|
|
applies_mats = FALSE,
|
|
trait_booster,
|
|
trait_modifier = 1,
|
|
desc,
|
|
required_noun,
|
|
category,
|
|
)
|
|
if(category)
|
|
src.category = category
|
|
if(desc)
|
|
src.desc = desc
|
|
if(required_noun)
|
|
src.desc += span_boldnotice("[desc ? " - ":""]Requires: [req_amount] [required_noun]\s.")
|
|
|
|
return ..()
|
|
|
|
|
|
/*
|
|
* Recipe list datum
|
|
*/
|
|
/datum/stack_recipe_list
|
|
var/title = "ERROR"
|
|
var/list/recipes
|
|
|
|
/datum/stack_recipe_list/New(title, recipes)
|
|
src.title = title
|
|
src.recipes = recipes
|