mirror of
https://github.com/GTNewHorizons/StructureLib.git
synced 2026-11-12 00:07:27 +00:00
Many multiblocks can only be placed or rotated in certain orientations. This has been always done ad-hoc, with individual checks for each controller. This is inconsistent and sometimes it results in bugs where certain orientations are not allowed for no discernible reason; for example https://github.com/GTNewHorizons/GT-New-Horizons-Modpack/issues/14206. This PR introduces a short list of named constants to `IAlignmentLimits`, which describe common multiplboc orientations. These are currently: * `UNLIMITED`: Any orientation is allowed. Most multiblocks. * `UPRIGHT`: The multiblock must be in an upright position, with the top side facing up. Example: Distillation Tower, Ore Washing Plant. * `NOT_UPSIDE_DOWN`: The multiblock can be in any orientation, except for the top side facing directly downwards. This is currently only the Large Heat Exchanger and Integrated Ore Factory. * `FACING_UP`: The front of the controller must face up. Example: Flotation Cell, XL Turbines. Currently, these constants describe the allowed facings of *all* GT5U multiblocks. A multiblock can then simply return one of these constants from `getInitialAlignmentLimits()` to describe its valid orientations, instead of implementing the logic itself. This concentrates the code to one place, improves readability, and fixes any bugs connected with these checks being done wrong. Of course, even though the list is currently complete, if any future multiblock wants to implement its own strange restrictions on orientation, it can still implement its own check instead of returning one of the constants. A follow-up PR to GT5U implements this for all multiblocks which restrict valid orientations: https://github.com/GTNewHorizons/GT5-Unofficial/pull/4595