Template:DecorationBox

Template documentation
Note: portions of the template sample may not be visible without values provided.
View or edit this template's documentation. (About template documentation)

See Template:DecorationBox/Values which stores the Cargo table values passed to it by this template.

Passed Values

This template passes values to:

• {{DecorationBox/Values}}

Example(s)

Obstacle, Main Shop, "sell" and "xp" auto-calc

{{DecorationBox
|size=Medium
|type=Natural
|update=1.2
|island=Main Island
|cost=9,000
|level=12
|time=2m
|clearing=4,000
}}

Gives: File:Decoration - Medium Tree.png

Obstacle Details

Obstacle Name	Decoratio		Island	Main Island
Type	Natural		Clearing Time	2m
In Main Shop	Yes		Clearing Cost	4,000
Cost	9,000		Experience	160
Size	Medium 2 x 2		Level Needed	12
Selling Value	2,250		Update	Update 1.2

Obstacle, NOT in Main Shop, "xp" auto-calc

{{DecorationBox
|size=Medium
|type=Natural
|update=1.0
|island=Magma's Land
|time=3h
|clearing=150,000
|shop=No
}}

Gives: File:Decoration - Charred Stump.png

Obstacle Details

Obstacle Name	Decoratio		Island	Magma's Land
Type	Natural		Clearing Time	3h
In Main Shop	No		Clearing Cost	150,000
Cost	n/a		Experience	6,000
Size	Medium 2 x 2		Level Needed	1
Selling Value	n/a		Update	Update 1.0

Main Shop-only, "sell" auto-calc (if gold), non-island/obstacle

{{DecorationBox
|size=Large
|type=Natural
|update=1.2
|cost=100,000
|level=15
|shop=Yes
}}

Gives: File:Decoration - Apple Tree.png

Decoration Details

Decoration Name	Decoratio		Island	n/a
Type	Natural		Clearing Time	n/a
In Main Shop	Yes		Clearing Cost	n/a
Cost	100,000		Experience	n/a
Size	Large 3 x 3		Level Needed	15
Selling Value	25,000		Update	Update 1.2

Dungeon Obstacle, auto-Dungeon Shop ("xp", "sell" override)

{{DecorationBox
|size=Medium
|type=Sculpture
|update=4.6
|island=Steam Fields
|cost=250
|currency=Tokens
|sell=62
|time=16h
|clearing=600
|xp=15,000
}}

Gives: File:Decoration - Boiler.png

Obstacle Details

Obstacle Name	Decoratio		Island	Steam Fields
Type	Sculpture		Clearing Time	16h
In Dungeon Shop	Yes		Clearing Cost	600
Cost	250		Experience	15,000
Size	Medium 2 x 2		Level Needed	1
Selling Value	62		Update	Update 4.6

Dungeon Obstacle NOT in Shop

{{DecorationBox
|size=Medium
|type=Sculpture
|update=4.6
|island=Steam Fields
|currency=Tokens
|time=16h
|clearing=600
|xp=15,000
|shop=No
}}

Gives: File:Decoration - Manhole.png

Obstacle Details

Obstacle Name	Decoratio		Island	Steam Fields
Type	Sculpture		Clearing Time	16h
In Dungeon Shop	No		Clearing Cost	600
Cost	n/a		Experience	15,000
Size	Medium 2 x 2		Level Needed	1
Selling Value	n/a		Update	Update 4.6

Note: See Fail Cases below for "missing xp" when "island" set.

Event-only (non-special, auto "sell" and "shop=No")

{{DecorationBox
|size=Medium
|type=Sculpture
|update=1.3
|method=Event
}}

Gives: for File:Decoration - Winner's Circle.png

Decoration Details

Decoration Name	Decoratio		Island	n/a
Type	Sculpture		Clearing Time	n/a
In	No		Clearing Cost	n/a
Cost	Variable in some Shops, n/a (Event prizes)		Experience	n/a
Size	Medium 2 x 2		Level Needed	1
Selling Value	18,750		Update	Update 1.3

Omitted "time" (Instant) clear time (pay-only islands)

{{DecorationBox
|size=Small
|type=Sculpture
|update=4.6
|island=Gem Island
|xp=4
|clearing=10,000
}}

Gives: for File:Decoration - Gold Nodule.png

Obstacle Details

Obstacle Name	Decoratio		Island	Gem Island
Type	Sculpture		Clearing Time	Instant
In Main Shop	Yes		Clearing Cost	10,000
Cost	n/a		Experience	4
Size	Small 1 x 1		Level Needed	1
Selling Value	n/a		Update	Update 4.6

Currency "Gems", "shop=Yes" override, "sell" override

{{DecorationBox
|size=Large
|type=Natural
|update=1.8
|cost=25
|sell=3,125
|currency=Gems
|level=10
|shop=Yes
}}

Gives: File:Decoration - Festive Tree.png

Decoration Details

Decoration Name	Decoratio		Island	n/a
Type	Natural		Clearing Time	n/a
In Main Shop	Yes		Clearing Cost	n/a
Cost	25		Experience	n/a
Size	Large 3 x 3		Level Needed	10
Selling Value	3,125		Update	Update 1.8

Divine Generator

{{DecorationBox
|size=Medium
|type=Sculpture
|update=6.3
|method=Divine Generator
|cost=1.99
|currency=USD
|sell=Unsellable
}}

Gives: for File:Amber Jewel Shrine (2021).png

Decoration Details

Decoration Name	Decoratio		Island	n/a
Type	Sculpture		Clearing Time	n/a
In	No		Clearing Cost	n/a
Cost	$1.99 USD		Experience	n/a
Size	Medium 2 x 2		Level Needed	1
Selling Value	Unsellable		Update	Update 6.3

This item was available only in exchange for real money, initially at a reduced-cost price (only the reduced-cost price is tracked).

Ticket Generator

{{DecorationBox
|size=Medium
|type=Sculpture
|update=5.2
|method=Ticket Generator
|cost=3.99
|currency=USD
|sell=Unsellable
}}

Gives: for File:Chrono Odin's Totem.png

Decoration Details

Decoration Name	Decoratio		Island	n/a
Type	Sculpture		Clearing Time	n/a
In	No		Clearing Cost	n/a
Cost	$3.99 USD		Experience	n/a
Size	Medium 2 x 2		Level Needed	1
Selling Value	Unsellable		Update	Update 5.2

This item was available only in exchange for real money, initially at a reduced-cost price (only the reduced-cost price is tracked).

Event-only ("event" override), "seasonal" set

{{DecorationBox
|size=Large
|type=Sculpture
|update=1.7
|method=Event
|seasonal=Yes
}}

Gives: for File:Decoration - Trick-Or-Sweet.png

Decoration Details

Decoration Name	Decoratio		Island	n/a
Type	Sculpture		Clearing Time	n/a
In	No		Clearing Cost	n/a
Cost	Variable in some Shops, n/a (Event prizes)		Experience	n/a
Size	Large 3 x 3		Level Needed	1
Selling Value	18,750		Update	Update 1.7

Fail Cases

Missing "xp" (non-gold obstacles)

{{DecorationBox
|size=Medium
|type=Sculpture
|update=4.6
|island=Steam Fields
|currency=Tokens
|time=16h
|clearing=600
|shop=No
}}

Gives:

Obstacle Details

Obstacle Name	Decoratio		Island	Steam Fields
Type	Sculpture		Clearing Time	16h
In Dungeon Shop	No		Clearing Cost	600
Cost	n/a		Experience	Unknown
Size	Medium 2 x 2		Level Needed	1
Selling Value	n/a		Update	Update 4.6

Missing "sell" (non-gold obstacles)

{{DecorationBox
|size=Medium
|type=Sculpture
|update=4.6
|island=Steam Fields
|cost=250
|currency=Tokens
|time=16h
|clearing=600
|xp=15,000
}}

Gives:

Obstacle Details

Obstacle Name	Decoratio		Island	Steam Fields
Type	Sculpture		Clearing Time	16h
In Dungeon Shop	Yes		Clearing Cost	600
Cost	250		Experience	15,000
Size	Medium 2 x 2		Level Needed	1
Selling Value	Unknown		Update	Update 4.6

Missing "size" (non-gold obstacles)

{{DecorationBox
|type=Sculpture
|update=4.6
|island=Steam Fields
|currency=Tokens
|time=16h
|clearing=600
|sell=200
|shop=No
|xp=200
}}

Gives:

Obstacle Details

Obstacle Name	Decoratio		Island	Steam Fields
Type	Sculpture		Clearing Time	16h
In Dungeon Shop	No		Clearing Cost	600
Cost	n/a		Experience	200
Size	Unknown		Level Needed	1
Selling Value	200		Update	Update 4.6

Missing "type"

{{DecorationBox
|size=Large
|update=1.8
|cost=25
|sell=3,125
|currency=Gems
|level=10
|shop=Yes
}}

Decoration Details

Decoration Name	Decoratio		Island	n/a
Type	Unknown		Clearing Time	n/a
In Main Shop	Yes		Clearing Cost	n/a
Cost	25		Experience	n/a
Size	Large 3 x 3		Level Needed	10
Selling Value	3,125		Update	Update 1.8

Missing "update"

{{DecorationBox
|size=Large
|type=Sculpture
|method=Event
|seasonal=Yes
}}

Decoration Details

Decoration Name	Decoratio		Island	n/a
Type	Sculpture		Clearing Time	n/a
In	No		Clearing Cost	n/a
Cost	Variable in some Shops, n/a (Event prizes)		Experience	n/a
Size	Large 3 x 3		Level Needed	1
Selling Value	18,750		Update	Unknown

Used to create File page tables to summarize their data, and (eventually) autopopulate the {{ctg|Decorations}} and {{ctg|Obstacles}} pages. Typically, only the first 3 parameters are typically required as much of it defaults for event decorations, which are entered more often.

Template parameters

Parameter		Description	Type	Status
size	size	Size of the object Suggested values Small Medium Large Default Unknown Example Medium	String	required
type	type	no description Suggested values Path Natural Sculpture Default Unknown Example Sculpture	String	required
update	update	Add the update float number (with one decimal place) Default Unknown Example 1.1	Number	required
(Optional) method	method	Where it was first *introduced*. Note that "Divine, Ancient, Tyrant" are for decorations-only. "Generator" is for non-special event currency generators. Suggested values Event Generator Divine Divine Generator Ticket Generator Ancient Ancient Generator Tyrant Tyrant Generator Example Event	String	optional
(Optional) island	island	Add proper Island Name (with proper capitalization) Default n/a Example Main Island	Page name	optional
(Optional) cost	cost	Enter numbers using a thousands (comma) separator if applicable Suggested values Unbuyable Default n/a Example 100	Number	optional
(Override/Optional, Value) sell	sell	Enter only if not auto-calculated correctly. Enter the number for the cost, with thousands comma separator if applicable, or enter another suggested value Suggested values Unsellable n/a Default If "island" NOT empty, "sell" NOT empty or "unbuyable" or "n/a", default = {{{sell|}}} (Gold). If "island" NOT empty, "sell" empty, cost not empty, default = {{{cost|}}} * 0.25 (Gold). If "island" empty, "sell" NOT empty or "Unsellable" or "n/a", default = {{{sell|}}} (Gold). If "island" empty, "sell" empty, if {{{currency|}}} === (blank) default = {{{cost|}}} * 0.25 (Gold); otherwise, 18,750 (Gold). Example 120	String	optional
(Override) currency	currency	If the cost currency icon should not be gold, enter a value from "Suggested values" Suggested values Gems Tokens USD ? Default {{{cost|}}} {{i|Gold}} Example Tokens	String	optional
(Override) level	level	If items are level restricted, enter the level required before the item can be obtained Default 1 Example 10	Number	optional
(Optional, Obstacle Clearing) time	time	Set time up to 2 increments e.g., "2h 12m" Default If "island" not empty, AND "time" empty, default="Instant" (pay islands). If "island" not empty, AND "time" NOT empty, default={{{time|}}} (value entered). If "island" empty and "time" empty, default="n/a". Example 2h 12m	String	optional
(Override, Obstacle) xp	xp	Used for obstacles. XP is auto-calculated for items whose currency is Gold. Use this to override XP for other items such as pay-island obstacles. Default IF "xp" NOT empty {{{xp|}}}.---- IF "xp" empty, "clearing" NOT empty,"currency" not emtpy show "Unknown".---- IF "xp" empty, "clearing" NOT empty, "currency" emtpy (Gold) auto-calc {{{clearing|}}} * 0.04 (experience).---- IF "xp" empty, AND "clearing" empty show "n/a". Example 50	Number	optional
(Override, Main/Dungeon) shop	shop	Only enter if needing to override the default behavior Suggested values Yes No Default If "shop" NOT empty gives {{{shop|}}} ("Yes"/"No"). If "shop" empty, if "island" not empty, gives "Yes" (unless overridden). If "shop" empty, if "island" empty, gives "No" (unless overridden).	String	optional
(Optional, Obstacle Time) clearing	clearing	Enter the clearing time (2 largest units of time) Default If "clearing" not empty, show {{{clearing|}}} (cost) and get {{{{currency|}}} icon (default, Gold). If "clearing" empty, show "n/a". Example 4h 20m	String	optional
(Optional) seasonal	seasonal	If the decoration was related to a holiday/season, set this parameter to Yes, otherwise leave blank. Default Seasonal Example Yes	Boolean	optional