Difference between revisions of "OXPIconSummary"

From Elite Wiki
m
({{Deleteme|Moved to Template:IconOXP, of which it clearly was the documentation.}})
 
Line 1: Line 1:
__TOC__
 
  +
{{Deleteme|Moved to [[Template:IconOXP]], of which it clearly was the documentation.}}
 
{{OXPNote|The template itself is work in progress and will get more icons. Later on it will push SemanticMediaWiki properties.}}
 
Summary of icons for [[:Template:IconOXP]]. The icons itself should give users a visual hint about expected costs and features.
 
 
 
An example:
 
{{IconOXP
 
|ooVersion = "1.77"
 
|oxpCPU = "Low"
 
|oxpMEM = "Medium"
 
|oxpGPU = "Heavy"
 
|oxpIsParent = true
 
|oxpIsChild = true
 
|oxpIsAPI = true
 
|oxpIsDocumented = true
 
|oxpIsConfigurable = true
 
}}
 
 
== Required ==
 
=== ooVersion ===
 
Specifies the required minimum version of Oolite for the latest OXP version. The template expects a string with the version number.Results in '??' if not specified or '<1.76' if the string is empty or the value is not listed.
 
 
Values: "1.76", "1.76.1", "1.77", "1.77.1".
 
 
[[Image:IconOONo.png]][[Image:IconOOPre1_76.png]][[Image:IconOO1_76.png]][[Image:IconOO1_76_1.png]][[Image:IconOO1_77.png]][[Image:IconOO1_77_1.png]]
 
 
=== oxpCPU ===
 
Specifies the CPU usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
 
 
Values: "Low", "Average", "Medium", "High", Heavy".
 
 
[[Image:IconOXPCPUNo.png]][[Image:IconOXPCPULow.png]][[Image:IconOXPCPUAverage.png]][[Image:IconOXPCPUMedium.png]][[Image:IconOXPCPUHigh.png]][[Image:IconOXPCPUHeavy.png]]
 
 
=== oxpMEM ===
 
Specifies the memory usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
 
 
Values: "Low", "Average", "Medium", "High", Heavy".
 
 
[[Image:IconOXPMEMNo.png]][[Image:IconOXPMEMLow.png]][[Image:IconOXPMEMAverage.png]][[Image:IconOXPMEMMedium.png]][[Image:IconOXPMEMHigh.png]][[Image:IconOXPMEMHeavy.png]]
 
 
=== oxpGPU ===
 
Specifies the GPU usage during normal gameplay. Result in '??' if not specified, empty or value not listed.
 
 
Values: "Low", "Average", "Medium", "High", Heavy".
 
 
[[Image:IconOXPGPUNo.png]][[Image:IconOXPGPULow.png]][[Image:IconOXPGPUAverage.png]][[Image:IconOXPGPUMedium.png]][[Image:IconOXPGPUHigh.png]][[Image:IconOXPGPUHeavy.png]]
 
 
 
== Optional ==
 
=== oxpIsAPI ===
 
Specifies if the OXP ships a API or has entry points for other OXPs.
 
 
Values: true or empty.
 
 
[[Image:IconOXPIsAPI.png]]
 
 
=== oxpIsChild ===
 
Specifies if the OXP requires other OXPs.
 
 
Values: true or empty.
 
 
[[Image:IconOXPIsChild.png]]
 
 
=== oxpIsConfigurable ===
 
Specifies if OXP can be configured ingame, either by handling it on its own or by using [[OXPConfig]].
 
 
Values: true or empty.
 
 
[[Image:IconOXPIsConfigurable.png]]
 
 
=== oxpIsDocumented ===
 
Specifies if OXP has documentation for configuration, entry points or other important bits for other OXPs.
 
 
Values: true or empty.
 
 
[[Image:IconOXPIsDocumented.png]]
 
 
=== oxpIsParent ===
 
Specifies if OXP is required by other OXPs.
 
 
Values: true or empty.
 
 
[[Image:IconOXPIsParent.png]]
 

Latest revision as of 21:54, 23 January 2016