Template:Opp/doc: Difference between revisions

1,695 bytes removed ,  2 years ago
<templatedata> cannot achieve the same thing what raw formatting can do
No edit summary
Tag: Reverted
(<templatedata> cannot achieve the same thing what raw formatting can do)
Line 1:
;Description
<templatedata>
: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.",
;Parameters
"format": "\n{{_\n|_ = _\n}}\n",
*''name'' - Opportunity title.
"params": {
*''game'' - Expansion pack it's based on – use code based on {{T|Vgcode}}
"name": {
*''icon'' - Opportunity icon – use <code>Filename.png</code> format. Use <code>Blank.png</code> for blank icon.
"label": "Title",
*''req'' - Requirements for the opportunity to be received.
"description": "Opportunity title.",
*''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.
"type": "string",
*''reward'' - Rewards for completing or failing the opportunity.
"required": true
*''timeout'' - Optional. How long the opportunity will persist before failing on its own.
},
*''goal'' - How to complete the opportunity.
"game": {
*''desc'' - Opportunity description, extracted from the game strings.
"label": "Pack",
*''notes'' - Optional. Additional notes to explain about the opportunity.
"description": "Expansion pack it's based on.",
*''disabled'' - Optional. Receives any input to give gray header for the opportunity to indicate it's not possible to receive it.
"type": "string",
 
"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>