StructurePickUpBalance
Configuration
Modes, exemptions and notification wording.
On this page4 sections
Configuration lives in config.json in the plugin folder. Comments using // are supported, so the shipped file is annotated inline.
Defaults are the values in the shipped file.
General
| Key | Default | What it does |
|---|---|---|
General.Enabled | true | Master switch for the plugin. false behaves like unmodified ASA. |
General.Mode | Demolish | Demolish, Destroy, Block or Vanilla. An unrecognised value logs a warning and falls back to Demolish. |
General.LogActions | false | Logs one line per removed structure. Useful while verifying, noisy in production. |
LogActions is very verbose
It writes a line for every structure removed. One pickup of a large build can produce hundreds of lines, so turn it off once you have confirmed the behaviour you wanted.
Notifications
| Key | Default | What it does |
|---|---|---|
Notifications.NotifyOnDependentsRemoved | true | Tells the player how many structures collapsed. |
Notifications.DependentsRemovedText | see below | The collapse message. {} is replaced with the number of structures. |
Notifications.NotifyOnBlockedPickup | true | Tells the player when a pickup is refused. Only ever appears in Block mode. |
Notifications.BlockedPickupText | see below | The refused-pickup message. |
Notifications.Color | [1.0, 0.2, 0.2, 1.0] | Colour of both messages as red, green, blue and opacity, each from 0.0 to 1.0. The default is red. |
Notifications.DisplayScale | 1.2 | Text size of both messages. 1.0 is normal size. |
Notifications.DisplayTime | 6.0 | How long both messages stay on screen. |
json
"DependentsRemovedText": "{} snapped structure(s) collapsed, they were not picked up with the support.",
"BlockedPickupText": "You cannot pick this up while other structures are snapped to it."Exempt structures
| Key | Default | What it does |
|---|---|---|
ExemptBlueprintPaths | [] | Part of a blueprint path, not case-sensitive. An exempt structure keeps stock pickup behaviour. Empty applies the plugin to every structure. |
ExemptBlueprintPaths is matched as a substring, and where the match lands changes the effect:
- Exempt the structure being picked up, and the whole chain behaves as vanilla.
- Exempt a dependent, and that structure alone is still picked up rather than collapsing.
Choosing a mode
- Demolish — collapses refund as a manual demolish would, which keeps pickup and demolish consistent.
- Destroy — collapses without a refund, at any depth of the attached build. The closest match to ASE.
- Block — the strictest option. Players simply cannot pick up a structure that is holding something else up.
- Vanilla — leaves stock behaviour in place, useful for temporarily disabling the plugin without removing it.
Changing mode mid-session
Edit the config and run
SPB.Reload. There is no need to restart the server to switch modes.