Skip to content

Latest commit

 

History

History
249 lines (173 loc) · 11.1 KB

README.md

File metadata and controls

249 lines (173 loc) · 11.1 KB

Sections

Sections is a Space Engineers plugin, which allows for selecting part of a grid, then copying, cutting, deleting or blueprinting the blocks inside the selection box.

This is an implementation of a publicly announced Space Engineers 2 feature for the current version of the game. It is so useful, that I could not stand not implementing it. Sorry. :)

Watch the video

This is an implementation of a publicly announced Space Engineers 2 feature for the current version of the game. It is so useful, that I could not stand not implementing it. Sorry. :)

For support please join the SE Mods Discord.

Please consider supporting my work on Patreon or one time via PayPal.

Thank you and enjoy!

Prerequisites

Installation

  1. Install Plugin Loader's Space Engineers Launcher
  2. Run the game
  3. In the new Plugins menu add the Sections plugin
  4. Apply and restart the game as requested

Features

This plugin is designed for offline ship design. It works only in creative mode. It is availabel in survival mode only if the creative mode tools are enabled for the player.

Selecting grid sections

Start your selection by pressing the NumPad 0 key. It is rebindable in the configuration, should you play on a keyboard without a numpad.

Follow the hints shown on the screen. You do not need to hold a block in hand for the selection to work, actually it would just be in the way. I suggest pressing 0 to deselect anything held in hand to clear up your view.

Selecting the first block Selecting the second block

Resizing the selection box

Adjust the selection box as needed:

  • Block rotation keys: Grow the selection box. Hold down shift to shrink.
  • R key: Resets the selection box to its initial size.

Resizing the selection box

You are free to fly around while right-sizing the selection box. It is helpful, since you will likely need to check the other side or inside your ship as well.

The keys used here are different from the ones seen in the SE2 reveal video in order to allow for flying around while resizing the selection box.

Section operations

Once the selection is good, you can do these operations on the selected blocks:

  • Left mouse button: Copy the section to the clipboard, so it can be pasted elsewhere.
  • Right mouse button: Cut the section (copy, then delete), so it can be moved elsewhere.
  • Backspace key: Delete the blocks in the section. It may result in a grid split, so careful.
  • Enter key: Make a blueprint out of the blocks inside the section. They will be stored locally in the Sections blueprint folder. You can name the blueprint on saving and confirm a possible overwrite.

By default, only the blocks fully enclosed in the selection box are operated on.

You can hold down the Ctrl key while using the above section operations to include the blocks intersecting the surface of the selection box without being fully contained.

Subgrid support

Any subgrids which would be orphaned if the selected blocks would be deleted are copied together with the section. This allows for cutting out custom PDCs and other mechanical constructs using subgrids without disconnecting the mechanical bases from their tops, so they can also be pasted back into the same grid.

Notice how the custom PDCs were cut out together with their base: PDC cut out

The same applies to saving to a section blueprint: PDC selection

Pasted the blueprint into clear space. As you can see both PDCs are preserved: PDC pasted

Please note, that the selection box must cover only the mechanical base or top blocks connecting the subgrids. The selection box does not have to cover the subgrids themselves, because the selection applies only to blocks on the same grid as the first selected block.

Any subgraph of subgrids are also copied the same way, as long as they lose all mechanical connections to the main grid which was selected. It ensures that no subgrid is lost. It should work in any combination of mechanical connections, including reverse order ones (which cannot be built directly in the game, only "towed" together) and multiple connections between the same pair of subgrids (like double hinged PDCs or doors).

Managing saved sections

You can paste your saved sections efficiently using the existing blueprint functionality.

Configure the Blueprints dialog (F10) this way:

  • Select only the Home source for blueprints, so it lists only local files
  • Open the Sections folder: Click on the folder icon above the search box, then double-click on Sections

This way you can press F10 and quick search immediately in the saved sections.

The Sections folder will be created automatically when you save your first section.

The sections are saved with the grid names, plus numbering to avoid overwriting. The numbering works exactly the same way as saving blueprints with Ctrl-B.

The sections have thumbnails generated from a screenshot taken when the section is saved. Position your character to have a good view before saving the section, if possible. If not, then you can make a new screenshot in the Blueprints dialog. Blueprints dialog

Pasting sections

The vanilla game sets the drag point of pasted blueprints to the center of their bounding sphere. Not to mention, this is very suboptimal for sections, because it works well only if you try to align a block near the center of the blueprint.

For example, let's consider this corner girder section. Notice the blue cube at the far corner, that's the origin block faced while making the blueprint. That's why it is at the dead center of the blueprint's thumbnail: Corner girder section

If you're trying to paste it on top of the other corner in the vanilla game, then it is impossible to align properly: Unable to align

With the fix implemented in this plugin you can just face where the origin block should go: Able to align

Certainly you have to make sure first, that the rotation is right, but that's already second nature...

Disabling the placement test

Holding Alt disables the placement test while pasting. It is very useful if there is a subgrid in the way and while you know for sure it will not collide the game does not agree with you.

It happens with some tight designs. For example if a small block torpedo is inside a tube of large block sliding doors: Disable placement test

Let's cut out the PDC block and the torpedo tubes, so there is easy access to the torpedo welders: Disable placement test Disable placement test

When you attempt to paste the block back the game shows a red placement box, indicating a collision: Disable placement test

Hold down Alt in this state. It will show a warning message to remind you and the placement box will turn green, so the block can be pasted.

Use this feature with great care! Always make sure that no collision will happen, otherwise you will likely trigger some mighty horror by Clang with a potentially explisive effect.

Configuration

Press Ctrl-Alt-/ while in-game and not in the GUI. It will open the list of configurable plugins. Select Sections from the list to configure this plugin. Alternatively you can open the settings by double-clicking on this plugin in the Plugins dialog of Plugin Loader, then clicking Settings in the dialog opened. The configuration can be changed anytime without having to restart the game.

Configuration

Known issues and limitations

  • Blocks assigned to any toolbars (cockpits, timers, etc) or added to Event/Turret Controller block lists get disconnected if they end up on separate grids. I plan to solve this issue in a straighforward way. Stay tuned!
  • The selection box can cover blocks and operate only on a single grid. This is normal and likely won't change.
  • Pasting sections with disconnected blocks works as expected, but may result in "floating" blocks. This is normal and by design to allow for some building tricks. Play with it!
  • This plugin is largely untested in survival (only with creative mode tools enabled) and is disabled in multiplayer (even if you're an admin). It should work if you're playing on the server of a "Friends" multiplayer game, but this mode has not been tested yet.
  • Pasting sections may be blocked by subgrids in the way, even if the hitboxes of actual blocks would not collide. There will be an override key to turn this check off during pasting. Stay tuned!

Troubleshooting

Should you have any issues using this plugin, then please either submit a ticket here on GitHub or report the issue in the #bug-reports channel of the SE Mods Discord.

Legal

Space Engineers and Space Engineers 2 are trademarks of Keen Software House s.r.o.

Want to know more?

Credits

Workshop

This is the ship used in some documentation screenshots and demo videos: IMDC Honorius DDS Warship

IMDC Honorius DDS Warship

Patreon Supporters

in alphabetical order

Admiral level

  • BetaMark
  • Casinost
  • Mordith - Guardians SE
  • Robot10
  • wafoxxx

Captain level

  • Diggz
  • jiringgot
  • Jimbo
  • Kam Solastor
  • lazul
  • Linux123123
  • Lotan
  • Lurking StarCpt
  • NeonDrip
  • NeVaR
  • opesoorry

Testers

  • Avaness
  • mkaito

Creators

  • avaness - Plugin Loader
  • Fred XVI - Racing maps
  • Kamikaze - M&M mod
  • LTP
  • Mordith - Guardians SE
  • Mike Dude - Guardians SE
  • SwiftyTech - Stargate Dimensions

Thank you very much for all your support!