Template:Distribution foraging/doc

This is a documentation subpage for Template:Distribution foraging.
It contains usage information and other content that is not part of the original template page.

The {{distribution foraging}} template displays a table based on the type of distribution modifier, i.e. location, month and weather. This is used to simplify creating the standard tables for each item distribution for foraging.

Usage

Copy and paste the following snippet of code relevant to the article.

Location

Location distribution
Location	Weight
Forest	forest
Deep Forest	deep_forest
Grasslands	vegetation
Farmland	farmland
Farm	farm
Trailer Park	trailer_park
Town	town
Road/Car Park	road

{{distribution foraging
| type = location
| forest = 		<!-- or | Forest -->
| deep_forest = 	<!-- or | DeepForest -->
| vegetation = 		<!-- or | Vegitation --> <!-- or | grassland -->
| farmland = 		<!-- or | FarmLand -->
| farm = 		<!-- or | Farm -->
| trailer_park = 	<!-- or | TrailerPark -->
| town = 		<!-- or | TownZone -->
| road = 		<!-- or | Nav --> <!-- or | car_park -->
}}

Month

Month distribution
Month	Availability
January	Unavailable
February	Unavailable
March	Unavailable
April	Unavailable
May	Unavailable
June	Unavailable
July	Unavailable
August	Unavailable
September	Unavailable
October	Unavailable
November	Unavailable
December	Unavailable

{{distribution foraging
| type = month
| jan = 	<!-- or | january = --> <!-- or | 1 = -->
| feb = 	<!-- or | february = --> <!-- or | 2 = -->
| mar = 	<!-- or | march = --> <!-- or | 3 = -->
| apr = 	<!-- or | april = --> <!-- or | 4 = -->
| may = 	<!-- or | may = --> <!-- or | 5 = -->
| jun = 	<!-- or | june = --> <!-- or | 6 = -->
| jul = 	<!-- or | july = --> <!-- or | 7 = -->
| aug = 	<!-- or | august = --> <!-- or | 8 = -->
| sep = 	<!-- or | september = --> <!-- or | 9 = -->
| oct = 	<!-- or | october = --> <!-- or | 10 = -->
| nov = 	<!-- or | november = --> <!-- or | 11 = -->
| dec = 	<!-- or | december = --> <!-- or | 12 = -->
}}

Weather

Weather distribution
Weather	Bonus
Raining	rain%
Has Rained	has_rained%
Snowing	snow%
Day	day%
Night	night%

{{distribution foraging
| type = weather
| rain = 	<!-- or | rainChance = --> <!-- or | raining = -->
| has_rained = 	<!-- or | hasRainedChance = -->
| snow = 	<!-- or | snowChance = --> <!-- or | snowing = -->
| day = 	<!-- or | dayChance = -->
| night = 	<!-- or | nightChance = -->
}}

Parameters

List of parameters that can be used in this template. Blank parameters or omitted parameters will use default value.

This template uses metatemplates for the format of each table, which is determined by the value the type parameter.

Parameter	Value	Description
`type`	`location`	Location table
	`month`	Month table
	`weather`	Weather table

Location

See more: Template:Distribution_foraging/Location

Parameter		Type	Description	Default
Preferred	Alternative	Type	Description	Default
`forest`	`Forest`	Integer	Forest zone type	`1`
`deep_forest`	`DeepForest`	Integer	DeepForest zone type	`1`
`vegetation`	`Vegetation` `vegitation` `Vegitation` `grassland` `Grassland`	Integer	Vegitation zone type	`1`
`farmland`	`Farmland` `Farm_land` `FarmLand`	Integer	FarmLand zone type	`1`
`farm`	`Farm`	Integer	Farm zone type	`1`
`trailer_park`	`TrailerPark`	Integer	TrailerPark zone type	`1`
`town`	`Town` `town_zone` `TownZone`	Integer	TrailerPark zone type	`1`
`road`	`Road` `car_park` `CarPark` `nav` `Nav`	Integer	Nav zone type	`1`

Month

Month table format

See more: Template:Distribution_foraging/Month

Parameter		Type	Description	Default
Preferred	Alternative	Type	Description	Default
`jan`	`january` `1`	String	Month 1 (Janaury)	`Unavailable`
`feb`	`february` `2`	String	Month 2 (February)	`Unavailable`
`mar`	`march` `3`	String	Month 3 (March)	`Unavailable`
`apr`	`april` `4`	String	Month 4 (April)	`Unavailable`
`may`	`5`	String	Month 5 (May)	`Unavailable`
`jun`	`june` `6`	String	Month 6 (June)	`Unavailable`
`jul`	`july` `7`	String	Month 7 (July)	`Unavailable`
`aug`	`august` `8`	String	Month 8 (August)	`Unavailable`
`sep`	`september` `9`	String	Month 9 (September)	`Unavailable`
`oct`	`october` `10`	String	Month 10 (October)	`Unavailable`
`nov`	`november` `11`	String	Month 11 (November)	`Unavailable`
`dec`	`december` `12`	String	Month 12 (December)	`Unavailable`

Month value format

See more: Template:Distribution_foraging/Month/Output

Values		Description	Output
Preferred	Alternative	Description	Output
`available`	`Available` `months` `Months`	Months when the item can be found. Definition: months	Available
`bonus`	`bonusMonths` `plentiful` `Plentiful`	Months when the item is more common. Definition: bonusMonths	Plentiful
`malus`	`malusMonths` `scarce` `Scarce`	Months when the item is less common. Definition: malusMonths	Scarce
`unavailable`	`Unavailable` #default	Months when the item is unavailable. Absent in all other definitions	Unavailable

Weather

See more: Template:Distribution_foraging/Weather

Parameter		Type	Description	Default
Preferred	Alternative	Type	Description	Default
`rain`	`raining` `rainChance`	Integer	Rain chance modifier (percent). Definition: rainChance	`0`
`has_rained`	`hasRainedChance`	Integer	After rain chance modifier (percent). Definition: hasRainedChance	`0`
`snow`	`snowing` `snowChance`	Integer	Snow chance modifier (percent). Definition: snowChance	`0`
`day`	`dayChance`	Integer	Day chance modifier (percent). Definition: dayChance	`0`
`night`	`nightChance`	Integer	Night chance modifier (percent). Definition: nightChance	`0`