Goonstation 13 - Modules - TypesVar Details - Proc Details

Boardgame

Vars

active_users
board_widthDesignate the size of the board Don't forget to update styling["aspectRatio"] if you want to keep the board autoscaling
boardstyleUsed by TGUI to render a board design
lock_pieces_to_tileIf true, pieces will be locked to the center of the tile they're on, otherwise they'll be free to move around
styling

Procs

resetColorStylingReset the board to its color scheme, in case it has been changed

Var Details

active_users

Boardgame Data and State

board_width

Designate the size of the board Don't forget to update styling["aspectRatio"] if you want to keep the board autoscaling

boardstyle

Used by TGUI to render a board design

lock_pieces_to_tile

If true, pieces will be locked to the center of the tile they're on, otherwise they'll be free to move around

styling

Boardgame styling
src.styling[key] = value

Give the boardgame a custom look by using these key value pairs.

// Sets color of first tile
[STYLING_TILECOLOR1] = "#FFFFFF" or rgb(255, 255, 255)
// Sets color of second tile
[STYLING_TILECOLOR2] = "#FFFFFF" or rgb(255, 255, 255)
// Sets color of the border
[STYLING_BORDER] = "#FFFFFF" or rgb(255, 255, 255)
// Aspect ratio of the board. This is the ratio of the width to the height.
1 = 1:1, 2 = 2:1, 0.5 = 1:2
[STYLING_ASPECT] = NUMBER
```dm

// Whether to use chess-like notation around the board. ... [STYLING_NOTATIONS] = TRUE/FALSE

The following keys are used by the boardgame itself and changes itself.
```dm
// Sets original color of first tile
[STYLING_OLDTILECOLOR1] = "#FFFFFF" or rgb(255, 255, 255)
```

```dm
// Sets original color of first tile
[STYLING_OLDTILECOLOR2] = "#FFFFFF" or rgb(255, 255, 255)
```

Proc Details

resetColorStyling

Reset the board to its color scheme, in case it has been changed