Package VASSAL.counters

Class MatCargo

java.lang.Object

VASSAL.search.AbstractImageFinder

VASSAL.counters.Decorator

VASSAL.counters.MatCargo

All Implemented Interfaces:

PropertyNameSource, PropertySource, EditablePiece, GamePiece, PropertyExporter, StateMergeable, TranslatablePiece, PersistentPropertyContainer, Auditable, ImageSearchTarget, SearchTarget

public class MatCargo
extends Decorator
implements TranslatablePiece

Designates the piece as "Cargo", which can be placed on a "Mat" to move along with it

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	MatCargo.Ed

Field Summary

Fields

Modifier and Type	Field	Description
protected Map<Double,Rectangle>	bounds
static final String	CURRENT_MAT
static final String	CURRENT_MAT_BASIC_NAME
static final String	CURRENT_MAT_BOARD
static final String	CURRENT_MAT_ID
static final String	CURRENT_MAT_LOCATION_NAME
static final String	CURRENT_MAT_MAP
static final String	CURRENT_MAT_OFFSET_X
static final String	CURRENT_MAT_OFFSET_Y
static final String	CURRENT_MAT_PIECE_NAME
static final String	CURRENT_MAT_PROP0
static final String	CURRENT_MAT_PROP1
static final String	CURRENT_MAT_PROP2
static final String	CURRENT_MAT_PROP3
static final String	CURRENT_MAT_PROP4
static final String	CURRENT_MAT_PROP5
static final String	CURRENT_MAT_PROP6
static final String	CURRENT_MAT_PROP7
static final String	CURRENT_MAT_PROP8
static final String	CURRENT_MAT_PROP9
static final String	CURRENT_MAT_X
static final String	CURRENT_MAT_Y
static final String	CURRENT_MAT_ZONE
protected String	desc
protected int	detectionDistanceX
protected int	detectionDistanceY
protected GamePieceOp	gpOp
static final String	ID
static final String	IS_CARGO
protected boolean	keyCommandsSet
protected boolean	maintainRelativeFacing
protected GamePiece	mat
protected NamedKeyStroke	matDetachKey
protected KeyCommand	matDetachKeyCommand
protected NamedKeyStroke	matFindKey
protected KeyCommand	matFindKeyCommand
static final String	NO_MAT
protected static final double	PI_180
protected Map<Double,RotateScaleOp>	rotOp
protected boolean	useUnrotatedShape

Fields inherited from class VASSAL.counters.Decorator

piece

Fields inherited from interface VASSAL.counters.PropertyExporter

LOCALIZED_NAME

Fields inherited from interface VASSAL.i18n.TranslatablePiece

PREFIX

Constructor Summary

Constructors

Constructor	Description
MatCargo()
MatCargo(String type, GamePiece inner)

Method Summary

Modifier and Type	Method	Description
Rectangle	boundingBox()
void	clearMat()	Clear our relationship with any Mat we're assigned to.
void	draw(Graphics g, int x, int y, Component obs, double zoom)	If we're maintaining facing to our Mat, rotate our graphics as appropriate to account for that when drawing
Command	findNewMat()	Finds us a Mat to join at our current location.
Command	findNewMat(Map map, Point pt)	Finds us a Mat to join at the specified point on a specified map.
static Command	findNewMat(Command c, GamePiece gp)	Checks if GamePiece gp is a MatCargo, and if so finds it a new mat if needed (or clears it if it has moved off its former mat)
String	getBaseDescription()	Support for a basic-name-only description introduced later, so this default retrofits it from the full description if an explicit one is not defined.
String	getDescription()	A plain-English description of this type of trait/piece - includes data from fields where appropriate
String	getDescriptionField()	If Decorator contains a description *field*, returns the current contents of it.
PieceEditor	getEditor()
protected GamePieceOp	getGpOp()
HelpFile	getHelpFile()
Object	getLocalizedProperty(Object key)	Returns a localized translation of the specified property value, if available.
GamePiece	getMat()
protected double	getMatAngle()
double	getMatAngleInRadians()
String	getName()	The plain English name for this piece
List<NamedKeyStroke>	getNamedKeyStrokeList()	SearchTarget
Object	getProperty(Object key)	Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be read through this interface.
List<String>	getPropertyNames()	Return Property names exposed by this trait
Shape	getShape()	If we're maintaining facing to our Mat, rotate our piece's shape to account for that.
GamePiece	locateNewMat(Map map, Point pt)	Non Command generating part of findNewMat().
Command	makeClearMatCommand()	Clear our relationship with any Mat we're assigned to, and return a command to do that.
Command	makeSetMatCommand(GamePiece newMat)	Places us "on" the designated Mat and returns a Command to duplicate the changes on other clients
KeyCommand[]	myGetKeyCommands()
String	myGetState()	The "state information" is "game state" information that can change during the course of a game.
String	myGetType()	The "type information" of a piece or trait is information that does not change during the course of a game.
Command	myKeyEvent(KeyStroke stroke)	The response of this trait alone to the given KeyStroke or the virtual keystroke of a NamedKeyStroke.
void	mySetState(String newState)	Sets the state of this-trait-only (inverse of Decorator.myGetState()).
void	mySetType(String type)	Sets the information for this piece.
void	setMat(GamePiece mat)	Mark us as being on a specific Mat piece
void	setProperty(Object key, Object val)	Within a Trait/Decorator, the default behavior when setting a property is to handle changing our own inner/outer links directly, to cache the selection state (while also passing it inward), and to simply pass every other property change request inward.
boolean	testEquals(Object o)	Test if this Decorator's Class, Type and State are equal to another trait.

Methods inherited from class VASSAL.counters.Decorator

addImageNamesRecursively, addMenuCommand, buildDescription, buildDescription, buildDescription, getCommandDesc, getCommandDescription, getComponentName, getComponentTypeName, getDecorator, getDecorators, getExpressionList, getFormattedStringList, getI18nData, getI18nData, getI18nData, getId, getInner, getInnermost, getKeyCommands, getLocalizedName, getMap, getMenuTextList, getOuter, getOutermost, getParent, getPersistentProperty, getPosition, getProperties, getPropertyList, getState, getTranslation, getType, isMenuCommand, isSelected, keyEvent, mergeState, putOldProperties, repack, repack, reportDataError, reportDataError, reportDataError, setDynamicProperties, setDynamicProperties, setDynamicProperty, setId, setInner, setMap, setParent, setPersistentProperty, setPosition, setSelected, setState, toString

Methods inherited from class VASSAL.search.AbstractImageFinder

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from class java.lang.Object

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

Methods inherited from interface VASSAL.script.expression.Auditable

getComponentName, getComponentTypeName

Methods inherited from interface VASSAL.counters.EditablePiece

checkTrueMoved, finishMove, finishMove, prepareMove

Methods inherited from interface VASSAL.counters.GamePiece

getId, getLocalizedName, getMap, getParent, getPosition, getState, getType, keyEvent, setId, setMap, setParent, setPosition, setState

Methods inherited from interface VASSAL.search.ImageSearchTarget

addLocalImageNames, getAllImageNames, getLocalImageNames

Methods inherited from interface VASSAL.counters.PropertyExporter

getProperties

Methods inherited from interface VASSAL.i18n.TranslatablePiece

getI18nData

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

NO_MAT

public static final String NO_MAT

See Also:

• Constant Field Values

CURRENT_MAT

public static final String CURRENT_MAT

See Also:

• Constant Field Values

CURRENT_MAT_ID

public static final String CURRENT_MAT_ID

See Also:

• Constant Field Values

CURRENT_MAT_X

public static final String CURRENT_MAT_X

See Also:

• Constant Field Values

CURRENT_MAT_Y

public static final String CURRENT_MAT_Y

See Also:

• Constant Field Values

CURRENT_MAT_OFFSET_X

public static final String CURRENT_MAT_OFFSET_X

See Also:

• Constant Field Values

CURRENT_MAT_OFFSET_Y

public static final String CURRENT_MAT_OFFSET_Y

See Also:

• Constant Field Values

CURRENT_MAT_PIECE_NAME

public static final String CURRENT_MAT_PIECE_NAME

See Also:

• Constant Field Values

CURRENT_MAT_BASIC_NAME

public static final String CURRENT_MAT_BASIC_NAME

See Also:

• Constant Field Values

CURRENT_MAT_LOCATION_NAME

public static final String CURRENT_MAT_LOCATION_NAME

See Also:

• Constant Field Values

CURRENT_MAT_ZONE

public static final String CURRENT_MAT_ZONE

See Also:

• Constant Field Values

CURRENT_MAT_BOARD

public static final String CURRENT_MAT_BOARD

See Also:

• Constant Field Values

CURRENT_MAT_MAP

public static final String CURRENT_MAT_MAP

See Also:

• Constant Field Values

CURRENT_MAT_PROP0

public static final String CURRENT_MAT_PROP0

See Also:

• Constant Field Values

CURRENT_MAT_PROP1

public static final String CURRENT_MAT_PROP1

See Also:

• Constant Field Values

CURRENT_MAT_PROP2

public static final String CURRENT_MAT_PROP2

See Also:

• Constant Field Values

CURRENT_MAT_PROP3

public static final String CURRENT_MAT_PROP3

See Also:

• Constant Field Values

CURRENT_MAT_PROP4

public static final String CURRENT_MAT_PROP4

See Also:

• Constant Field Values

CURRENT_MAT_PROP5

public static final String CURRENT_MAT_PROP5

See Also:

• Constant Field Values

CURRENT_MAT_PROP6

public static final String CURRENT_MAT_PROP6

See Also:

• Constant Field Values

CURRENT_MAT_PROP7

public static final String CURRENT_MAT_PROP7

See Also:

• Constant Field Values

CURRENT_MAT_PROP8

public static final String CURRENT_MAT_PROP8

See Also:

• Constant Field Values

CURRENT_MAT_PROP9

public static final String CURRENT_MAT_PROP9

See Also:

• Constant Field Values

IS_CARGO

public static final String IS_CARGO

See Also:

• Constant Field Values

desc

protected String desc

maintainRelativeFacing

protected boolean maintainRelativeFacing

detectionDistanceX

protected int detectionDistanceX

detectionDistanceY

protected int detectionDistanceY

matFindKey

protected NamedKeyStroke matFindKey

matDetachKey

protected NamedKeyStroke matDetachKey

keyCommandsSet

protected boolean keyCommandsSet

matFindKeyCommand

protected KeyCommand matFindKeyCommand

matDetachKeyCommand

protected KeyCommand matDetachKeyCommand

gpOp

protected GamePieceOp gpOp

bounds

protected Map<Double,Rectangle> bounds

rotOp

protected Map<Double,RotateScaleOp> rotOp

PI_180

protected static final double PI_180

See Also:

• Constant Field Values

mat

protected GamePiece mat

useUnrotatedShape

protected boolean useUnrotatedShape

Constructor Details

MatCargo

public MatCargo()

MatCargo

public MatCargo(String type,
 GamePiece inner)

Method Details

mySetType

public void mySetType(String type)

Description copied from interface: EditablePiece

Sets the information for this piece. See Decorator.myGetType()

Specified by:

mySetType in interface EditablePiece

Parameters:

type - a serialized configuration string to set the "type information" of this piece, which is information that doesn't change during the course of a single game (e.g. Image Files, Context Menu strings, etc). Typically ready to be processed e.g. by SequenceEncoder.decode()

myGetType

public String myGetType()

Description copied from class: Decorator

The "type information" of a piece or trait is information that does not change during the course of a game. Image file names, context menu strings, etc., all should be reflected in the type. The type information is returned serialized string form, ready to be decoded by a SequenceEncoder#decode.

Specified by:

myGetType in class Decorator

Returns:

the type information of this trait alone

See Also:

• BasicCommandEncoder
• which returns type information for all inward piece members as well

getNamedKeyStrokeList

public List<NamedKeyStroke> getNamedKeyStrokeList()

Description copied from class: Decorator

SearchTarget

Specified by:

getNamedKeyStrokeList in interface SearchTarget

Overrides:

getNamedKeyStrokeList in class Decorator

Returns:

a list of any Named KeyStrokes referenced in the Decorator, if any (for search)

clearMat

public void clearMat()

Clear our relationship with any Mat we're assigned to. Does NOT clear the Mat's reference to us -- must be done separately.

makeClearMatCommand

public Command makeClearMatCommand()

Clear our relationship with any Mat we're assigned to, and return a command to do that.

Returns:

return a command to clear our Mat relationship

setMat

public void setMat(GamePiece mat)

Mark us as being on a specific Mat piece

Parameters:

mat - the mat we are joining

makeSetMatCommand

public Command makeSetMatCommand(GamePiece newMat)

Places us "on" the designated Mat and returns a Command to duplicate the changes on other clients

Parameters:

newMat - GamePiece with a Mat trait, that we are to be placed "on"

Returns:

Command to duplicate the changes on other clients

findNewMat

public Command findNewMat(Map map,
 Point pt)

Finds us a Mat to join at the specified point on a specified map. Or if no Mat, marks our removal from any we're on.

Parameters:

map - map to check

pt - point to check

Returns:

A command that will duplicate any changes on another client.

locateNewMat

public GamePiece locateNewMat(Map map,
 Point pt)

Non Command generating part of findNewMat(). Used to check for a potential valid mat at a target location without generating the Mat/Cargo commands

Parameters:

map - map to check

pt - point to check

Returns:

the Mat GamePiece at map.point or null if none

findNewMat

public Command findNewMat()

Finds us a Mat to join at our current location. Or if no Mat, marks our removal from any we were on.

Returns:

A Command that will duplicate any changes on another client.

findNewMat

public static Command findNewMat(Command c,
 GamePiece gp)

Checks if GamePiece gp is a MatCargo, and if so finds it a new mat if needed (or clears it if it has moved off its former mat)

Parameters:

c - Command to which to append

gp - GamePiece

Returns:

Command c with any needed additional commands appended

getMat

public GamePiece getMat()

Returns:

current Mat we are on top of (or null for none)

myGetKeyCommands

public KeyCommand[] myGetKeyCommands()

Specified by:

myGetKeyCommands in class Decorator

Returns:

the key commands for this trait alone

See Also:

• which returns the key commands for this trait AND all inner piece members

myGetState

public String myGetState()

Description copied from class: Decorator

The "state information" is "game state" information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.

Specified by:

myGetState in class Decorator

Returns:

the game state information of this trait alone

See Also:

• which returns state information for all inward piece members as well

myKeyEvent

public Command myKeyEvent(KeyStroke stroke)

Description copied from class: Decorator

The response of this trait alone to the given KeyStroke or the virtual keystroke of a NamedKeyStroke. NamedKeyStrokes are allocated a unique internal KeyStroke when they are first used in a module, and that KeyStroke is passed up and down the decorator stack to represent them (see NamedKeyStroke.getKeyStroke()).

Specified by:

myKeyEvent in class Decorator

Parameters:

stroke - KeyStroke to apply (to apply a Named Keystroke send NamedKeyStroke.getKeyStroke()

Returns:

Generated Command to reproduce any changes just made to to the game state, or null if no effect

See Also:

• Decorator.keyEvent(javax.swing.KeyStroke)

mySetState

public void mySetState(String newState)

Description copied from class: Decorator

Sets the state of this-trait-only (inverse of Decorator.myGetState()). The "state information" is information that can change during the course of a game. State information is saved when the game is saved and is transferred between players on the server. For example, the relative order of pieces in a stack is state information, but whether the stack is expanded is not.

Specified by:

mySetState in class Decorator

Parameters:

newState - New state information serialized in string form, ready to be passed to a SequenceEncoder#decode.

boundingBox

public Rectangle boundingBox()

Specified by:

boundingBox in interface GamePiece

Returns:

The area which this GamePiece occupies when drawn at the point (0,0)

getGpOp

protected GamePieceOp getGpOp()

getMatAngle

protected double getMatAngle()

getMatAngleInRadians

public double getMatAngleInRadians()

draw

public void draw(Graphics g,
 int x,
 int y,
 Component obs,
 double zoom)

If we're maintaining facing to our Mat, rotate our graphics as appropriate to account for that when drawing

Specified by:

draw in interface GamePiece

Parameters:

g - target Graphics object

x - x-location of the center of the piece

y - y-location of the center of the piece

obs - the Component on which this piece is being drawn

zoom - the scaling factor.

getName

public String getName()

Description copied from interface: GamePiece

The plain English name for this piece

Specified by:

getName in interface GamePiece

getShape

public Shape getShape()

If we're maintaining facing to our Mat, rotate our piece's shape to account for that.

Specified by:

getShape in interface GamePiece

Returns:

Properly rotated shape

getEditor

public PieceEditor getEditor()

Specified by:

getEditor in interface EditablePiece

Overrides:

getEditor in class Decorator

Returns:

the configurer for this trait - the dialog which allows the editing the piece's type information. Default configurer is a SimplePieceEditor, but many traits will want to provide custom versions.

getProperty

public Object getProperty(Object key)

Description copied from class: Decorator

Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be read through this interface. The properties may or may not need to be encoded in the piece's Decorator.getState() method. Properties include the value of e.g. Marker Traits, DynamicProperty Traits, and so forth. Furthermore they include the values of any visible "Global Property" in a Vassal module, whether at the module level, map level, or zone level -- but these "higher level" properties, coming from "outside the piece", CANNOT be written to by the Decorator.setProperty(java.lang.Object, java.lang.Object) method even though they can be read by this method -- in this sense the two methods are NOT perfect mirrors.

Within a Trait/Decorator, default behavior is to process some requests directly (e.g. requests for our "inner" or "outer" link), process our *part* of certain other requests (e.g. request for our game state information we supply state information for this trait and then append any information obtained from passing the same request inward), and then for any other requests that we cannot process we simply pass the request to the next trait/member inward.

When using this interface a piece's own properties are preferred to those of "Global Properties", and those in turn are searched Zone-first then Map, then Module.

This method implements the PropertySource interface, which allows Global Properties to be read by other types of object than GamePieces.

Specified by:

getProperty in interface GamePiece

Specified by:

getProperty in interface PropertySource

Overrides:

getProperty in class Decorator

Parameters:

key - String key of property to be returned

Returns:

Object containing new value of the specified property

getLocalizedProperty

public Object getLocalizedProperty(Object key)

Description copied from class: Decorator

Returns a localized translation of the specified property value, if available. Otherwise returns the non-localized version. See Decorator.getProperty(java.lang.Object).

Specified by:

getLocalizedProperty in interface PropertySource

Overrides:

getLocalizedProperty in class Decorator

Parameters:

key - String key of property to be returned

Returns:

Object containing localized text of the specified property, if available, otherwise non-localized value

setProperty

public void setProperty(Object key,
 Object val)

Description copied from class: Decorator

Within a Trait/Decorator, the default behavior when setting a property is to handle changing our own inner/outer links directly, to cache the selection state (while also passing it inward), and to simply pass every other property change request inward. A Trait with its own properties to maintain would intercept and process those requests, while sending the rest inward to the next member of the piece.

Properties can be associated with a piece -- many may be game-specific, but others are standard, such as the LocationName property exposed by BasicPiece -- and can be set through this interface. The properties may or may not need to be encoded in the piece's Decorator.getState() method. Properties include the value of e.g. Marker Traits, DynamicProperty Traits, and so forth.

NOTE: Not all properties maintained by traits can be "set" by setProperty, even though they can be read by getProperty -- they may be "read only" for instance. You will need to check the code for individual traits to see what they support in this regard.

NOTE: Properties outside the piece CANNOT be set by this method (e.g. Global Properties), even though they can be read by Decorator.getProperty(java.lang.Object) -- in this the two methods are not perfect mirrors.

Specified by:

setProperty in interface GamePiece

Overrides:

setProperty in class Decorator

Parameters:

key - String key of property to be changed

val - Object containing new value of the property

getDescription

public String getDescription()

Description copied from interface: EditablePiece

A plain-English description of this type of trait/piece - includes data from fields where appropriate

Specified by:

getDescription in interface EditablePiece

getBaseDescription

public String getBaseDescription()

Description copied from interface: EditablePiece

Support for a basic-name-only description introduced later, so this default retrofits it from the full description if an explicit one is not defined.

Specified by:

getBaseDescription in interface EditablePiece

Returns:

name of trait/piece type, w/o additional data

getDescriptionField

public String getDescriptionField()

Description copied from class: Decorator

If Decorator contains a description *field*, returns the current contents of it.

Overrides:

getDescriptionField in class Decorator

Returns:

contents of "description" field, if it exists.

testEquals

public boolean testEquals(Object o)

Description copied from class: Decorator

Test if this Decorator's Class, Type and State are equal to another trait. Implementations of this method should compare the individual values of the fields that make up the Decorators Type and State. Implementations should NOT compare the values returned by myGetType() or myGetState(). This method is intended to be used by Unit Tests to verify that a trait is unchanged after going through a process such as serialization/deserialization.

Overrides:

testEquals in class Decorator

Parameters:

o - Object to compare this Decorator to

Returns:

true if the Class, type and state all match

getHelpFile

public HelpFile getHelpFile()

Specified by:

getHelpFile in interface EditablePiece

Returns:

the help file for this trait

getPropertyNames

public List<String> getPropertyNames()

Return Property names exposed by this trait

Specified by:

getPropertyNames in interface PropertyNameSource

Overrides:

getPropertyNames in class Decorator

Returns:

List of property names "exposed" by this piece -- that are available to other Traits and components to read. Default behavior for a Trait is not to expose any properties, but Traits which should expose some (e.g. DynamicProperty or Marker) would provide an array of the property names here.