GamePieceImage

From VASSAL
Jump to: navigation, search

VASSAL Reference Manual

Home > Module > Game Piece Image Definitions > Game Piece Layout > Game Piece Image


Game Piece Image

This component is an actual image using the layout corresponding to the Game Piece Layout component which contains this component.   Here, you specify the colors, text, and images to use in the layout, as well as the name under which this image will appear in the image-chooser drop-down.

Name: Specify a name for the image definition. This is the name under which this image will appear in the image-chooser drop-down menu in a Game Piece trait's properties.
Background Color: Select a background color for the image from the drop down list of available colors.

The next section shows a visualization of what the finished image will look like with your choices.

The Items panel shows the configurable items that make up your image layout. Click on an item to display the configurable options for that item in the bottom display panel. There is a different display panel for each type of item.


Imagedefn.png


Symbol Item Configuration

Unit Size: Select the NATO Unit Size specifier from the drop-down menu.
1st Symbol: Select the Primary NATO Symbol from the drop-down menu.
2nd Symbol: Select the Secondary NATO Symbol from the drop-down menu.
Symbol Color: Select the color used to draw the symbol lines.
Background Color: Select the color to use for the background of the symbol body.
Size Color: Select the color used to draw the Size Specifier drawn above the symbol body.

Symbolinstance.png

Label Item Configuration

Value: Enter the text to display on the image.
Foreground Color: Select the color to use to draw the text.
Background Color: Select the color to use to draw a box behind the text.

Textinstance.png

Text Box Item Configuration

Value: Enter the text to display on the image.
Text Color: Select the color to use to draw the text.
Background Color: Select the color to use to draw a box behind the text.

Textboxinstance.png

Image Item Configuration

Import an image to draw at the position specified in the layout.

Shape Item Configuration

''''Foreground Color: Select the fill color for the shape.
Background Color: Select the color for the shape's outline.

ShapeItemInstance.png