Difference between revisions of "Template:CMF Function"

Latest revision as of 20:35, 17 December 2022

template for CMF function docs. (this description will be more fleshed out at a later date. for now just look at a function for an example on how to use it)

Difference between revisions of "Template:CMF Function"

Latest revision as of 20:35, 17 December 2022

Navigation menu

Search

@@ Line 1: / Line 1: @@
+<includeonly>__NOTOC__ __NOEDITSECTION__
+{{DISPLAYTITLE:{{#if: {{{displayTitle|}}}
+	| {{{displayTitle}}}
+	| {{#ifeq:{{lc:{{{type}}}}}
+		| command
+		| {{#replace:{{#replace:{{PAGENAME}}|diag <nowiki/>|diag_}}|buldozer <nowiki/>|buldozer_}}
+		| {{#replace:{{PAGENAME}}|<nowiki> </nowiki>|_}}
+	}}
+}}}}
 <!-- Minimum required versions -->
 <div class="top-icons">
@@ Line 18: / Line 27: @@
 <!-- DESCRIPTION -->
-<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Description:</dt>
+<dt>Description:</dt>
-<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
+<dd>{{{descr|-Missing Description-}}}</dd>
-{{{descr|- Missing Description -}}}
-</div></dd>
 <!-- EXECUTION -->
-<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Execution:</dt>
+<dt>Execution:</dt>
-<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
+<dd>{{{exec|Call}}}</dd>
-{{{exec|- Missing Execution -}}}
-</div></dd>
 <!-- GROUPS -->
-<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Groups:</dt>
+<dt>Groups:</dt>
-<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
+<dd>
-{{#if: {{{cmp|}}} | [[:Category:Function Group: {{{cmp}}}]]}}
+{{#if: {{{cmp|}}}{{{gr1|}}}{{{gr2|}}}{{{gr3|}}}{{{gr4|}}}
-{{#if: {{{gr1|}}} | [[:Category:Function Group: {{{grp1}}}]]}}
+| {{#if: {{{cmp|}}} | [[:Category:CMF3: {{{cmp}}}|CMF3: {{{cmp}}}]]}}
-{{#if: {{{gr2|}}} | [[:Category:Function Group: {{{grp2}}}]]}}
+{{#if: {{{grp1|}}} | [[:Category:CMF3: {{{grp1}}}|CMF3: {{{grp1}}}]]}}
-{{#if: {{{gr3|}}} | [[:Category:Function Group: {{{grp3}}}]]}}
+{{#if: {{{grp2|}}} | [[:Category:CMF3: {{{grp2}}}|CMF3: {{{grp2}}}]]}}
-{{#if: {{{gr4|}}} | [[:Category:Function Group: {{{grp4}}}]]}}
+{{#if: {{{grp3|}}} | [[:Category:CMF3: {{{grp3}}}|CMF3: {{{grp3}}}]]}}
-</div></dd>
+{{#if: {{{grp4|}}} | [[:Category:CMF3: {{{grp4}}}|CMF3: {{{grp4}}}]]}}
-</dl>
+| Uncategorised
+}}
+</dd>
+</dl>
 <div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block;border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Syntax</div>
@@ Line 44: / Line 52: @@
 <!-- SYNTAX -->
-<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Syntax:</dt>
+<dt>Syntax:</dt>
-<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
+<dd>{{#if:{{{s1|}}}|{{{s1}}} | ''Syntax needed''}}</dd>
-{{#if:{{{s1|}}}|{{{s1}}} | ''- Missing Syntax -''}}
-</div></dd>
 <!-- PARAMETERS -->
@@ Line 75: / Line 81: @@
 <!-- RETURN VALUE -->
-<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Return Value:</dt>
+<dt id="Return Value 1">Return Value:</dt>
-<dd style="width:90%;padding:.3em .3em .3em 7em;"><div style="display:block;">
+<dd>{{#if:{{{r1|}}} | {{{r1}}} |None}}</dd>
-Boolean - Returns true on success.
+</dl>
-</div></dd>
 </dl>
 <div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block; border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Examples</div>
 <dl style="width:100%;">
+{{#if:{{{x1|}}}{{{x2|}}}{{{x3|}}}{{{x4|}}}{{{x5|}}}{{{x6|}}}{{{x7|}}}{{{x8|}}}{{{x9|}}}{{{x10|}}}
-<!-- EXAMPLE -->
+|
-<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">Example 1:</dt>
+   {{#if: {{{x1|}}}|<dt id="Example 1">Example 1:</dt><dd>{{{x1}}}</dd>}}<!--
-<dd style="width:90%;padding:.3em .3em .3em 7em;"><code style="border:#25A1A1 dashed 1px;display:block;">
+-->{{#if: {{{x2|}}}|<dt id="Example 2">Example 2:</dt><dd>{{{x2}}}</dd>}}<!--
-[this, 5] call '''emf_limitedRespawns_fnc_setLives''';
+-->{{#if: {{{x3|}}}|<dt id="Example 3">Example 3:</dt><dd>{{{x3}}}</dd>}}<!--
-</code></dd>
+-->{{#if: {{{x4|}}}|<dt id="Example 4">Example 4:</dt><dd>{{{x4}}}</dd>}}<!--
+-->{{#if: {{{x5|}}}|<dt id="Example 5">Example 5:</dt><dd>{{{x5}}}</dd>}}<!--
+-->{{#if: {{{x6|}}}|<dt id="Example 6">Example 6:</dt><dd>{{{x6}}}</dd>}}<!--
+-->{{#if: {{{x7|}}}|<dt id="Example 7">Example 7:</dt><dd>{{{x7}}}</dd>}}<!--
+-->{{#if: {{{x8|}}}|<dt id="Example 8">Example 8:</dt><dd>{{{x8}}}</dd>}}<!--
+-->{{#if: {{{x9|}}}|<dt id="Example 9">Example 9:</dt><dd>{{{x9}}}</dd>}}<!--
+-->{{#if:{{{x10|}}}|<dt id="Example 10">Example 10:</dt><dd>{{{x10}}}</dd>}}
+| <dt>Examples:</dt><dd>''Example Needed''</dd>
+}}
 </dl>
@@ Line 97: / Line 109: @@
 <!-- SEE ALSO -->
-<dt style="clear:both;font-weight:bold;position:absolute;padding:.3em;">See also:</dt>
+<dt>See also:</dt>
-<dd style="width:90%;padding:.3em .3em .3em 7em;column-count:4;">
+<dd class="seealso">
-<div style="display:block;">[[init (limitedRespawns)]]</div>
+{{#if: {{{seealso|}}} | {{#replace:{{#replace:{{{seealso}}}|], [|][}}|],[|][}} | ''See also needed''}}
 </dd>
 </dl>
+<!-- INTERNAL VARIABLES -->
+<div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block; border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Internal Variables</div>
+<dl style="width:100%;">
+{{#if:{{{var1|}}}{{{var2|}}}{{{var3|}}}{{{var4|}}}{{{var5|}}}{{{var6|}}}{{{var7|}}}{{{var8|}}}{{{var9|}}}{{{var10|}}}
+|{{{!}} class="wikitable"
+! Locality !! Namespace !! Name !! Description
+{{#if: {{{var1|}}}|{{!}}-
+{{{var1|}}}}}
+{{#if: {{{var2}}}|{{!}}-
+{{{var2|}}}}}
+{{#if: {{{var3}}}|{{!}}-
+{{{var3|}}}}}
+{{#if: {{{var4}}}|{{!}}-
+{{{var4|}}}}}
+{{#if: {{{var5}}}|{{!}}-
+{{{var5|}}}}}
+{{#if: {{{var6}}}|{{!}}-
+{{{var6|}}}}}
+{{#if: {{{var7}}}|{{!}}-
+{{{var7|}}}}}
+{{#if: {{{var8}}}|{{!}}-
+{{{var8|}}}}}
+{{#if: {{{var9}}}|{{!}}-
+{{{var9|}}}}}
+{{#if:{{{var10|}}}|{{!}}-
+{{{var10}}}}}
+{{#if: {{{var11}}}|{{!}}-
+{{{var11|}}}}}
+{{#if: {{{var12}}}|{{!}}-
+{{{var12|}}}}}
+{{#if: {{{var13}}}|{{!}}-
+{{{var13|}}}}}
+{{#if: {{{var14}}}|{{!}}-
+{{{var14|}}}}}
+{{#if: {{{var15}}}|{{!}}-
+{{{var15|}}}}}
+{{#if: {{{var16}}}|{{!}}-
+{{{var16|}}}}}
+{{#if: {{{var17}}}|{{!}}-
+{{{var17|}}}}}
+{{#if: {{{var18}}}|{{!}}-
+{{{var18|}}}}}
+{{#if: {{{var19}}}|{{!}}-
+{{{var19|}}}}}
+{{#if: {{{var20}}}|{{!}}-
+{{{var20|}}}}}
+{{#if: {{{var21}}}|{{!}}-
+{{{var21|}}}}}
+{{#if: {{{var22}}}|{{!}}-
+{{{var22|}}}}}
+{{#if: {{{var23}}}|{{!}}-
+{{{var23|}}}}}
+{{#if: {{{var24}}}|{{!}}-
+{{{var24|}}}}}
+{{#if: {{{var25}}}|{{!}}-
+{{{var25|}}}}}
+{{#if: {{{var26}}}|{{!}}-
+{{{var26|}}}}}
+{{#if: {{{var27}}}|{{!}}-
+{{{var27|}}}}}
+{{#if: {{{var28}}}|{{!}}-
+{{{var28|}}}}}
+{{#if: {{{var29}}}|{{!}}-
+{{{var29|}}}}}
+{{#if: {{{var30}}}|{{!}}-
+{{{var30|}}}}}
+{{#if: {{{var31}}}|{{!}}-
+{{{var31|}}}}}
+{{#if: {{{var32}}}|{{!}}-
+{{{var32|}}}}}
+{{#if: {{{var33}}}|{{!}}-
+{{{var33|}}}}}
+{{#if: {{{var34}}}|{{!}}-
+{{{var34|}}}}}
+{{#if: {{{var35}}}|{{!}}-
+{{{var35|}}}}}
+{{#if: {{{var36}}}|{{!}}-
+{{{var36|}}}}}
+{{#if: {{{var37}}}|{{!}}-
+{{{var37|}}}}}
+{{#if: {{{var38}}}|{{!}}-
+{{{var38|}}}}}
+{{#if: {{{var39}}}|{{!}}-
+{{{var39|}}}}}
+{{!}}}
+| <dd>''No internal variables''</dd>
+}}
+</dl>
+<!-- INTERNAL VARIABLES -->
+<div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block; border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Events</div>
+<dl style="width:100%;">
+{{#if:{{{event1|}}}{{{event2|}}}{{{event3|}}}{{{event4|}}}{{{event5|}}}{{{event6|}}}{{{event7|}}}{{{event8|}}}{{{event9|}}}{{{event10|}}}
+|{{{!}} class="wikitable"
+! Locality !! Name !! Variables !! Description
+{{#if: {{{event1|}}}|{{!}}-
+{{{event1|}}}}}
+{{#if: {{{event2}}}|{{!}}-
+{{{event2|}}}}}
+{{#if: {{{event3}}}|{{!}}-
+{{{event3|}}}}}
+{{#if: {{{event4}}}|{{!}}-
+{{{event4|}}}}}
+{{#if: {{{event5}}}|{{!}}-
+{{{event5|}}}}}
+{{#if: {{{event6}}}|{{!}}-
+{{{event6|}}}}}
+{{#if: {{{event7}}}|{{!}}-
+{{{event7|}}}}}
+{{#if: {{{event8}}}|{{!}}-
+{{{event8|}}}}}
+{{#if: {{{event9}}}|{{!}}-
+{{{event9|}}}}}
+{{#if:{{{event10|}}}|{{!}}-
+{{{event10}}}}}
+{{!}}}
+| <dd>''No events''</dd>
+}}
+</dl>
 <div style="padding:0.33em 2em;font-size:1.2em;font-weight:bold;display:block;border-bottom: #25A1A1 solid 1px; background-color:#E0FFFF;color:#25A1A1">Notes</div>
 <!-- NOTES -->
-<dl style="width:100%;"></dl>
+<dl style="width:100%;">{{{notes|}}}</dl>
 <!-- CATEGORIES -->
-[[Category:Functions: Eric's Mission Framework]]
+[[Category:CMF3: All Functions]]
-[[Category:Limited Respawn: Eric's Mission Framework]]
+{{#if: {{{cmp|}}}{{{gr1|}}}{{{gr2|}}}{{{gr3|}}}{{{gr4|}}}
+| {{#if: {{{cmp|}}} | [[Category:CMF3: {{{cmp}}}]]}}
+{{#if: {{{gr1|}}} | [[Category:CMF3 Function Group: {{{grp1}}}]]}}
+{{#if: {{{gr2|}}} | [[Category:CMF3 Function Group: {{{grp2}}}]]}}
+{{#if: {{{gr3|}}} | [[Category:CMF3 Function Group: {{{grp3}}}]]}}
+{{#if: {{{gr4|}}} | [[Category:CMF3 Function Group: {{{grp4}}}]]}}
+|
+}}
+<!-- INTRODUCED WITH -->
+{{#if: {{{game1|}}}{{{game2|}}}{{{game3|}}}{{{game4|}}}{{{game5|}}}{{{game6|}}}{{{game7}}}
+| {{#if: {{{game1|}}} | [[Category:Introduced with {{CMF Name|{{{game1}}}}} version {{lc:{{{version1|}}}}}]]}}
+{{#if: {{{game2|}}} | [[Category:Introduced with {{CMF Name|{{{game2}}}}} version {{lc:{{{version2|}}}}}]]}}
+{{#if: {{{game3|}}} | [[Category:Introduced with {{CMF Name|{{{game3}}}}} version {{lc:{{{version3|}}}}}]]}}
+{{#if: {{{game4|}}} | [[Category:Introduced with {{CMF Name|{{{game4}}}}} version {{lc:{{{version4|}}}}}]]}}
+{{#if: {{{game5|}}} | [[Category:Introduced with {{CMF Name|{{{game5}}}}} version {{lc:{{{version5|}}}}}]]}}
+{{#if: {{{game6|}}} | [[Category:Introduced with {{CMF Name|{{{game6}}}}} version {{lc:{{{version6|}}}}}]]}}
+{{#if: {{{game7|}}} | [[Category:Introduced with {{CMF Name|{{{game7}}}}} version {{lc:{{{version7|}}}}}]]}}
+|
+}}
+</includeonly>
+<noinclude>
+template for CMF function docs. (this description will be more fleshed out at a later date. for now just look at a function for an example on how to use it)
+</noinclude>