Map Tokens - Prism-99/FarmExpansion GitHub Wiki
Map tokens are used to provide details of the expansion. The tokens are used for entrances, sign posts, cave entrance, fishing areas and mine carts. An expansion map must has north, south, east and west tokens to be a valid expansion. All other tokens are optional. The Tokens are added as tile properties on the Back layer of the expansion map file. In order for an expansion to be shown in the Warp Room it must a cavein and caveout token defined on the map.
| Token | Purpose | |
|---|---|---|
| Entrances | ||
| north | Defines the northern entrance to the expansion. You can use multiple tokens to set the width of the entrance. These tokens will be used to define the warp in and out points. | |
| east | Defines the eastern entrance to the expansion. You can use multiple tokens to set the width of the entrance. These tokens will be used to define the warp in and out points. | |
| south | Defines the southern entrance to the expansion. You can use multiple tokens to set the width of the entrance. These tokens will be used to define the warp in and out points. | |
| west | Defines the western entrance to the expansion. You can use multiple tokens to set the width of the entrance. These tokens will be used to define the warp in and out points. | |
| cavein (optional) | Defines the warp in point where the Player enters the Warp Room. | |
| caveout (optional) | Defines the warp out point where the Player exits the Warp Room. | |
| Signs | ||
| northsign (optional) | Defines where the northern sign post will be placed with the name of expansion the exit leads to. | |
| eastsign (optional) | Defines where the eastern sign post will be placed with the name of expansion the exit leads to. | |
| southsign (optional) | Defines where the southern sign post will be placed with the name of expansion the exit leads to. | |
| westsign (optional) | Defines where the western sign post will be placed with the name of expansion the exit leads to. | |
| Fish Areas | ||
| fish_area_start (optional) | Top left-hand corner of a rectangle containing the fish area to be defined. The value of the token is a unique name identifying the area. | |
| fish_area_end (optional) | Bottom righ-hand corner of a rectangle containing the fish area to be defined. The value of the token is the unique name defined in the fish_area_start token. | |
| Mine Carts | ||
| minecart_action (optional) | Identifies the square that the Player triggers the mine cart menu. The value of the token should be 'T'. | |
| minecart_landing (optional) | Identifies where the Player will land when this destination is picked from the Mine Cart menu. | |
| minecart_landing sub tokens | ||
| displayname | The name of the destination that will be shown in the Mine Cart menu. | |
| direction | The direction the Player should be facing when they arrive at the destination Mine Cart. | |
Fish area sub tokens are used to provide additional details about the area.
| Token | Purpose |
|---|---|
| displayname (optional) | Display name of the fish area. This will be shown to the Player in any GUI references. |
| spring (optional) |
A space delimited list of 'fishid chance'. These fish will be potential catches in the Spring for this area. FishId is the objectId of the fish and chance is a float between 0 and 1.
Example: 150 .33 698 .4 706 .66 699 .2 |
| summer (optional) |
A space delimited list of 'fishid chance'. These fish will be potential catches in the Summer for this area. FishId is the objectId of the fish and chance is a float between 0 and 1.
Example: 150 .33 698 .4 706 .66 699 .2 |
| fall (optional) |
A space delimited list of 'fishid chance'. These fish will be potential catches in the Fall for this area. FishId is the objectId of the fish and chance is a float between 0 and 1.
Example: 150 .33 698 .4 706 .66 699 .2 |
| winter (optional) |
A space delimited list of 'fishid chance'. These fish will be potential catches in the Winter for this area. FishId is the objectId of the fish and chance is a float between 0 and 1.
Example: 150 .33 698 .4 706 .66 699 .2 |
| autofill (optional) | If set True SDR will pick a random fish from the game fish inventory and add it to fish to each of the seasons. |
| maxfishtypes (optional) | Sets the maximum number of fish that SDR will autofill. |