Skip to content

Selectable

Examples

Example

<Selectable>
</Selectable>

XML Elements

The following elements can be used within this component:

Selectable

EditorOnly

If this element is present, the entity is only selectable in Atlas

Path: Selectable/EditorOnly

Overlay

Specifies the type of overlay to be displayed when this entity is selected.

Path: Selectable/Overlay

Shape

Specifies shape of overlay. If not specified, footprint shape will be used.

Path: Selectable/Overlay/Shape

Square

Set the overlay to a square of the given size

Path: Selectable/Overlay/Shape/Square

@width

Size of the overlay along the left/right direction (in meters)

Type: decimal (e.g. -10.0 or 0.0 or 2.5)

Path: Selectable/Overlay/Shape/Square@width

@depth

Size of the overlay along the front/back direction (in meters)

Type: decimal (e.g. -10.0 or 0.0 or 2.5)

Path: Selectable/Overlay/Shape/Square@depth

Circle

Set the overlay to a circle of the given size

Path: Selectable/Overlay/Shape/Circle

@radius

Radius of the overlay (in meters)

Type: decimal (e.g. -10.0 or 0.0 or 2.5)

Path: Selectable/Overlay/Shape/Circle@radius

AlwaysVisible

If this element is present, the selection overlay will always be visible (with transparency and desaturation)

Path: Selectable/Overlay/AlwaysVisible

Texture

Displays a texture underneath the entity.

Path: Selectable/Overlay/Texture

MainTexture

Texture to display underneath the entity. Filepath relative to art/textures/selection/.

Type: text

Path: Selectable/Overlay/Texture/MainTexture

MainTextureMask

Mask texture that controls where to apply player color. Filepath relative to art/textures/selection/.

Type: text

Path: Selectable/Overlay/Texture/MainTextureMask

Outline

Traces the outline of the entity with a line texture.

Path: Selectable/Overlay/Outline

LineTexture

Texture to apply to the line. Filepath relative to art/textures/selection/.

Type: text

Path: Selectable/Overlay/Outline/LineTexture

LineTextureMask

Texture that controls where to apply player color. Filepath relative to art/textures/selection/.

Type: text

Path: Selectable/Overlay/Outline/LineTextureMask

LineThickness

Thickness of the line, in world units.

Type: positive decimal

Path: Selectable/Overlay/Outline/LineThickness

RELAX NG Grammar

<define name="component.Selectable">
  <element name="Selectable">
    <interleave>
      <optional>
        <element name="EditorOnly">
          <empty/>
        </element>
      </optional>
      <element name="Overlay">
        <interleave>
          <optional>
            <element name="Shape">
              <choice>
                <element name="Square">
                  <attribute name="width">
                    <data type="decimal">
                      <param name="minExclusive">
                      </param>
                    </data>
                  </attribute>
                  <attribute name="depth">
                    <data type="decimal">
                      <param name="minExclusive">
                      </param>
                    </data>
                  </attribute>
                </element>
                <element name="Circle">
                  <attribute name="radius">
                    <data type="decimal">
                      <param name="minExclusive">
                      </param>
                    </data>
                  </attribute>
                </element>
              </choice>
            </element>
          </optional>
          <optional>
            <element name="AlwaysVisible">
              <empty/>
            </element>
          </optional>
          <choice>
            <element name="Texture">
              <element name="MainTexture"/>
              <element name="MainTextureMask"/>
            </element>
            <element name="Outline">
              <element name="LineTexture"/>
              <element name="LineTextureMask"/>
              <element name="LineThickness">
                <ref name="positiveDecimal"/>
              </element>
            </element>
          </choice>
        </interleave>
      </element>
    </interleave>
  </element>
</define>