BlockedBy

##Overview

The BlockedBy setting(s) state which groups of object will block placement or movement of the Object being defined.

##Syntax

This optional setting is used in materials.txt and must be within a BEGIN Object... definition block. It can appear multiple times per definition block, once for each <groupId> as applicable.

    BlockedBy <group>

Where <group> is any valid Group used in materials.txt:

• Cable - the large manually placed power cables
• LargePipe
• SmallPipe
• StaticObject
• UtilityStation
• Wall

If no BlockedBy settings are defined, the item can be placed anywhere, except...

• [Road (Material)](Road (Material)) - Statics and Utilities can't be placed on roads unless they have the Properties CanPlaceOnRoad setting
• [Water (Material)](Water (Material)) (as in lakes) - nothing can be placed on or move on lakes. Ever.
• Map border - nothing can be placed on the map border, although entities seem able to walk on it

An additional group seems to have been remove sometime between Alpha 35 and 1.0:

• MustBeOutdoors - required that the object had to be outdoors

This value seems to have been replaced by Requirement Type Outdoor on Rooms, and there no longer seems to be a way to require that certain objects are placed outdoors.

##Examples

Most objects are blocked by Wall, StaticObject and UtilityStation groups, so you'll see this a lot:

    BlockedBy Wall
    BlockedBy StaticObject  
    BlockedBy UtilityStation

##Notes

For Entities, BlockedBy restricts their placement and movement. For all other object types, BlockedBy only affects placement.

Vehicles seem to completely ignore the BlockedBy setting. They're driving down that road no matter what, unless a [RoadGate (Door)](RoadGate (Door)) stops them.

In the base game:

• Objects with RenderDepth 3 or above are not usually blocked by StaticObject but are blocked by UtilityStation and Wall.
• The [PowerStation](PowerStation (Utility)) and [WaterPumpStation](WaterPumpStation (Utility)) are blocked by all groups.

data/scripts/

When spawning items with Object.Spawn(), or changing .Pos, the BlockedBy settings are completely ignored. However, when using .NavigateTo() or .PlayerOrderPos, the normal restrictions apply.

Tip: Scripts can search for certain collections of object (see .GetNearbyObjects()) and materials (see Object.GetMaterial()).

##See Also

• data/materials.txt:
  • Group
  • Objects:
    • Properties BlockMovement
  • Materials:
    • BlockMovement
  • Rooms:
    • Requirement Indoor
    • Requirement Outdoor