s3games.engine

## Class LocationType

- java.lang.Object
- - s3games.engine.LocationType

-     public class LocationType
      extends java.lang.Object

  Represents a location type.

- - ### Field Summary

    Fields
    Modifier and Type | Field and Description
    --- | ---
    `ImageWithHotSpot` | `image` image that depicts the location on the simulated game board (use empty image if it is not needed
    `java.lang.String` | `name` name of the location
    `boolean` | `relevant` determines if locations of this type should be taken into account when comparing state for equality
    `LocationShape` | `shape` shape of the location where it is sensitive to mouse-clicking for the simulated-game human player

  - ### Constructor Summary

    Constructors
    Constructor and Description
    `LocationType(java.lang.String name)` create a new location type with this name, fill other parameters manually

  - ### Method Summary

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Field Detail

    - #### name

          public java.lang.String name

      name of the location

    - #### image

          public ImageWithHotSpot image

      image that depicts the location on the simulated game board (use empty image if it is not needed

    - #### shape

          public LocationShape shape

      shape of the location where it is sensitive to mouse-clicking for the simulated-game human player

    - #### relevant

          public boolean relevant

      determines if locations of this type should be taken into account when comparing state for equality

  - ### Constructor Detail

    - #### LocationType

          public LocationType(java.lang.String name)

      create a new location type with this name, fill other parameters manually