Template:Opp/doc: Difference between revisions

From The Sims Wiki, a collaborative database for The Sims series
Jump to navigation Jump to search
Content added Content deleted
imported>Nikel23
(Created page with ";Description :This is an infobox used to describe an opportunity in ''The Sims 3''. ;Parameters *''name'' - Opportunity title. *''game'' - Expansion pack i...")
 
(Undid revision 970212 by Nikel23 (talk))
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:
<templatedata>
;Description
{
:This is an infobox used to describe an [[opportunity]] in ''The Sims 3''.
"description": "This is an infobox used to describe an opportunity in The Sims 3.",

"format": "block",
;Parameters
"params": {
*''name'' - Opportunity title.
"name": {
*''game'' - Expansion pack it's based on – use code based on {{T|Vgcode}}
"label": "Title",
*''icon'' - Opportunity icon – use <code>Filename.png</code> format. Use <code>Blank.png</code> for blank icon.
"description": "Opportunity title.",
*''req'' - Requirements for the opportunity to be received.
"type": "string",
*''avail'' - How the opportunities may be received, including repeatability. Use <code>N/A</code> if it's impossible to receive, i.e. a leftover opportunity only available in the game code, but not in the game itself. Optionally, use '''''disabled''''' parameter if opportunity has proper setup but cannot be received anyhow.
"required": true
*''reward'' - Rewards for completing or failing the opportunity.
},
*''timeout'' - Optional. How long the opportunity will persist before failing on its own.
"game": {
*''goal'' - How to complete the opportunity.
"label": "Pack",
*''desc'' - Opportunity description, extracted from the game strings.
"description": "Expansion pack it's based on.",
*''notes'' - Optional. Additional notes to explain about the opportunity.
"type": "string",
*''disabled'' - Optional. Receives any input to give gray header for the opportunity to indicate it's not possible to receive it.
"example": "TS3LN",

"required": true
},
"icon": {
"label": "Icon",
"description": "Opportunity icon.",
"type": "wiki-file-name",
"default": "Blank.png",
"example": "Painting skill icon.png",
"suggested": true
},
"req": {
"label": "Requirements",
"description": "Requirements for the opportunity to be received.",
"type": "string",
"required": true
},
"reward": {
"label": "Rewards",
"description": "Rewards for completing or failing the opportunity.",
"type": "string",
"required": true
},
"avail": {
"label": "Availability",
"description": "How the opportunities may be received, including repeatability. Use \"N/A\" if it's impossible to receive, i.e. a leftover opportunity only available in the game code, but not in the game itself. Optionally, use \"disabled\" parameter if opportunity has proper setup but cannot be received anyhow.",
"type": "string",
"required": true
},
"timeout": {
"label": "Timeout",
"description": "How long the opportunity will persist before failing on its own.",
"default": "N/A",
"type": "string"
},
"goal": {
"label": "Goal",
"description": "How to complete the opportunity.",
"type": "string",
"required": true
},
"desc": {
"label": "Description",
"description": "Opportunity description, extracted from the game strings.",
"type": "string",
"required": true
},
"note": {
"label": "Notes",
"description": "Additional notes to explain about the opportunity.",
"type": "string"
},
"disabled": {
"label": "Disabled",
"description": "Receives any input to give gray header for the opportunity to indicate it's not possible to receive it.",
"type": "string"
}
},
"paramOrder": [
"name",
"game",
"icon",
"req",
"reward",
"avail",
"timeout",
"goal",
"desc",
"note",
"disabled"
]
}
</templatedata>
<noinclude>[[Category:Template documentation]]</noinclude>
<noinclude>[[Category:Template documentation]]</noinclude>

Latest revision as of 12:20, 14 September 2021

This is an infobox used to describe an opportunity in The Sims 3.

Template parameters

This template prefers block formatting of parameters.

ParameterDescriptionTypeStatus
Titlename

Opportunity title.

Stringrequired
Packgame

Expansion pack it's based on.

Example
TS3LN
Stringrequired
Iconicon

Opportunity icon.

Default
Blank.png
Example
Painting skill icon.png
Filesuggested
Requirementsreq

Requirements for the opportunity to be received.

Stringrequired
Rewardsreward

Rewards for completing or failing the opportunity.

Stringrequired
Availabilityavail

How the opportunities may be received, including repeatability. Use "N/A" if it's impossible to receive, i.e. a leftover opportunity only available in the game code, but not in the game itself. Optionally, use "disabled" parameter if opportunity has proper setup but cannot be received anyhow.

Stringrequired
Timeouttimeout

How long the opportunity will persist before failing on its own.

Default
N/A
Stringoptional
Goalgoal

How to complete the opportunity.

Stringrequired
Descriptiondesc

Opportunity description, extracted from the game strings.

Stringrequired
Notesnote

Additional notes to explain about the opportunity.

Stringoptional
Disableddisabled

Receives any input to give gray header for the opportunity to indicate it's not possible to receive it.

Stringoptional