Block Restrictions

Last updated February 10, 2024

Hello! Have you ever wanted to restrict the use of certain blocks for certain player types? Now you can! This mod enables server owners and admins to customize the availability settings for all terminal blocks in the game, to include any that have been added via other mods!

Note that the Basic Assembler cannot be locked as Keen checks for it explicitly. As such, the script will force the AllowedForPlayer setting to true for this block.

How to get started using Block Restrictions

Follow these easy steps:[olist] [*] Add the mod to your server's mod list [*] Start the server [*] Locate the generated config file, "BlockRestrictions.cfg" in your server's storage folder [*] Edit the config file per the guidelines below and save the changes [*] Restart the server for changes to take effect [*] ??? [*] Profit!![/olist]

Editing the configuration file

I recommend opening the config file in Notepad++ or another editor that supports XML syntax highlighting. Once you have it open, you'll see sections like this:

<SerializableBlockSetting>
  <Type>MyObjectBuilder_Projector/LargeProjector</Type>
  <PlayerMaxCount>0</PlayerMaxCount>
  <GridMaxCount>0</GridMaxCount>
  <FactionMaxCount>0</FactionMaxCount>
  <AllowedForNPC>true</AllowedForNPC>
  <AllowedForPlayer>true</AllowedForPlayer>
  <AllowedForUnowned>true</AllowedForUnowned>
  <AllowedForNPCStaticOnly>false</AllowedForNPCStaticOnly>
  <AllowedForPlayerStaticOnly>false</AllowedForPlayerStaticOnly>
  <AllowedForUnownedStaticOnly>false</AllowedForUnownedStaticOnly>
</SerializableBlockSetting>

Block Types The config file holds a section for every variant of every terminal block in the game, so you will see two entries for the projector, two for the programmable block, etc. You'll need to change the settings for each variant separately if you want all variants to be restricted.

Max Counts The first three values after the type are for setting up the max counts for players, grids, and factions. A setting of zero means there is no maximum. If you want to disable the block, that setting is outlined below and you need not mess with these values.

Owner Types There are three owner types you can affect with the settings:[list] [*] NPCs [*] Players [*] Unowned[/list]

The Logic By setting something to false, that block will no longer be able to be placed by that owner type. If an owner of that type does place a block, or if ownership of the block is changed to them, the block will be removed from the game. If the block is player-owned, and the player is around, the mod will attempt to refund the components used to the player's inventory, provided the block wasn't placed with creative tools.

You will also see the "Static Only" option for each owner type; this means that the block is placeable only on stations. In order for the static only option to work, the normal option must be set to true.

NOTE: Server owners and Admins are able to place any block anywhere, regardless of the player setting for that block type, as long as they are either in a creative game or have Enable Creative Tools checked in the admin settings

NEW! Group Settings You can now group items together with a GroupSetting! This setting allows you to mix and match any block types and apply a group restriction on them, so you can for example restrict a grid / player / faction to having only 5 of ANY type of turret. Here's what that would look like for vanilla turrets. Note that GroupName must be unique for each group.

<SerializableGroupSetting>
  <GroupName>Vanilla Turrets</GroupName>
  <PlayerMaxCount>0</PlayerMaxCount>
  <GridMaxCount>5</GridMaxCount>
  <FactionMaxCount>0</FactionMaxCount>
  <AllowedForNPC>true</AllowedForNPC>
  <AllowedForPlayer>true</AllowedForPlayer>
  <AllowedForUnowned>true</AllowedForUnowned>
  <AllowedForNPCStaticOnly>false</AllowedForNPCStaticOnly>
  <AllowedForPlayerStaticOnly>false</AllowedForPlayerStaticOnly>
  <AllowedForUnownedStaticOnly>false</AllowedForUnownedStaticOnly>
  <Definitions>
	<DefinitionId Type="MyObjectBuilder_LargeGatlingTurret" SubtypeId="(null)" />
	<DefinitionId Type="MyObjectBuilder_LargeGatlingTurret" SubtypeId="SmallGatlingTurret" />
	<DefinitionId Type="MyObjectBuilder_LargeMissileTurret" SubtypeId="(null)" />
	<DefinitionId Type="MyObjectBuilder_LargeMissileTurret" SubtypeId="SmallMissileTurret" />
	<DefinitionId Type="MyObjectBuilder_InteriorTurret" SubtypeId="LargeInteriorTurret" />
  </Definitions>
</SerializableGroupSetting>

Found a bug?

I've tested the mod both in single player and on my test server without issue, but that isn't to say that there aren't bugs that I haven't thought of or found. If you find one, please let me know and I'll get it fixed up ASAP! You can leave a message here or find me on Discord @ jTurp#7926

Known Issues

None that I know of.