Class PlayerHand

java.lang.Object
VASSAL.search.AbstractImageFinder
VASSAL.build.AbstractBuildable
VASSAL.build.AbstractConfigurable
VASSAL.build.AbstractToolbarItem
VASSAL.build.module.Map
VASSAL.build.module.PrivateMap
VASSAL.build.module.PlayerHand
All Implemented Interfaces:
DropTargetListener, MouseListener, MouseMotionListener, PropertyChangeListener, EventListener, AutoConfigurable, Buildable, Configurable, GameComponent, PlayerRoster.SideChangeListener, MutablePropertiesContainer, PropertyNameSource, PropertySource, ComponentDescription, ValidityChecker, Translatable, Auditable, ImageSearchTarget, SearchTarget, ToolBarComponent, UniqueIdManager.Identifyable
public class PlayerHand extends PrivateMap

  • Constructor Details

    • PlayerHand

      public PlayerHand()

  • Method Details

    • build

      public void build(Element el)
      Description copied from class: Map
      Builds the map's component hierarchy from a given XML element, or a null one is given initializes a brand new default "new map" hierarchy.
      Specified by:
      build in interface Buildable
      Overrides:
      build in class PrivateMap
      Parameters:
      el - XML element to build from, or null to build the default hierarchy for a brand new Map

    • getConfigureTypeName

      public static String getConfigureTypeName()

    • getHelpFile

      public HelpFile getHelpFile()
      Specified by:
      getHelpFile in interface Configurable
      Overrides:
      getHelpFile in class PrivateMap
      Returns:
      a HelpFile describing how to use and configure this component

    • getStackMetrics

      public StackMetrics getStackMetrics()
      Description copied from class: Map
      Every map must include a single StackMetrics object as one of its build components, which governs the visuals of stacking of GamePieces on the map
      Overrides:
      getStackMetrics in class Map
      Returns:
      the StackMetrics for this map

    • mapSize

      public Dimension mapSize()
      Overrides:
      mapSize in class Map
      Returns:
      the size of the map in pixels at 100% zoom, including the edge buffer