Difference between revisions of "Template:Function"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Qazaaq
m
imported>Qazaaq
m (does double space inside an #if insert a space?)
Line 33: Line 33:


Note that duration does not need to be specified for this command; it will play once unless you specify a longer duration.
Note that duration does not need to be specified for this command; it will play once unless you specify a longer duration.
}}
}}</noinclude><includeonly><!--


</noinclude><includeonly><!--
-->{{ #if: {{{CSWikiPage|}}} | Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/{{{CSWikiPage}}} {{{CSWikiPage}}}].|}}<!--
-->{{ #if: {{{CSWikiPage|}}} | Link to TES4 Construction Set Wiki: [http://cs.elderscrolls.com/constwiki/index.php/{{{CSWikiPage}}} {{{CSWikiPage}}}].|}}<!--


Line 60: Line 59:


required arguments + types:
required arguments + types:
-->{{ #if: {{{arg0|}}} | {{{arg0}}}:{{{arg0Type}}}|}}<!--
-->{{ #if: {{{arg0|}}} | {{{arg0}}}:{{{arg0Type}}}|}}<!--
-->{{ #if: {{{arg1|}}} | {{{arg1}}}:{{{arg1Type}}}|}}<!--
-->{{ #if: {{{arg1|}}} | {{{arg1}}}:{{{arg1Type}}}|}}<!--
-->{{ #if: {{{arg2|}}} | {{{arg2}}}:{{{arg2Type}}}|}}<!--
-->{{ #if: {{{arg2|}}} | {{{arg2}}}:{{{arg2Type}}}|}}<!--
-->{{ #if: {{{arg3|}}} | {{{arg3}}}:{{{arg3Type}}}|}}<!--
-->{{ #if: {{{arg3|}}} | {{{arg3}}}:{{{arg3Type}}}|}}<!--
-->{{ #if: {{{arg4|}}} | {{{arg4}}}:{{{arg4Type}}}|}}<!--
-->{{ #if: {{{arg4|}}} | {{{arg4}}}:{{{arg4Type}}}|}}<!--
-->{{ #if: {{{arg5|}}} | {{{arg5}}}:{{{arg5Type}}}|}}<!--
-->{{ #if: {{{arg5|}}} | {{{arg5}}}:{{{arg5Type}}}|}}<!--
-->{{ #if: {{{arg6|}}} | {{{arg6}}}:{{{arg6Type}}}|}}<!--
-->{{ #if: {{{arg6|}}} | {{{arg6}}}:{{{arg6Type}}}|}}<!--
-->{{ #if: {{{arg7|}}} | {{{arg7}}}:{{{arg7Type}}}|}}<!--
-->{{ #if: {{{arg7|}}} | {{{arg7}}}:{{{arg7Type}}}|}}<!--
-->{{ #if: {{{arg8|}}} | {{{arg8}}}:{{{arg8Type}}}|}}<!--
-->{{ #if: {{{arg8|}}} | {{{arg8}}}:{{{arg8Type}}}|}}<!--
-->{{ #if: {{{arg9|}}} | {{{arg9}}}:{{{arg9Type}}}|}}<!--
-->{{ #if: {{{arg9|}}} | {{{arg9}}}:{{{arg9Type}}}|}}<!--


optional arguments + types:
optional arguments + types:
Line 89: Line 88:
categorization code (needs something clever):
categorization code (needs something clever):
-->
-->
{{{CategoryList|}}}
{{{CategoryList|}}}</includeonly>
</includeonly>

Revision as of 13:50, 12 December 2008


This article is incomplete. You can help by filling in any blank descriptions.
Further information might be found in a section of the discussion page. Please remove this message when no longer necessary.

This is a WIP, feedback is appreciated. To retain readability a lot of HTML comments are used, they shouldn't impact the working of the template, but could add to the confusion a bit.

example:

{{Function
| name          = PlayMagicEffectVisuals
| CSWikiPage    = PlayMagicEffectVisuals
| ReferenceType = [Actor, Activator]
| arg0          = EffectID
| arg0Type      = MagicEffect
| optarg0       = duration
| optarg0Type   = Short
| summary       = Plays the visuals of the specified [[Magic Effects|Magic Effect]] on the calling reference. Visuals will play at least one cycle, regardless of
duration, and if no duration is specified they play indefinitely or until the art stops animating.

Note that duration does not need to be specified for this command; it will play once unless you specify a longer duration.
}}

result:

Link to TES4 Construction Set Wiki: PlayMagicEffectVisuals.

Syntax:

[Actor, Activator].PlayMagicEffectVisualsEffectID:MagicEffectduration:Short

Plays the visuals of the specified Magic Effect on the calling reference. Visuals will play at least one cycle, regardless of duration, and if no duration is specified they play indefinitely or until the art stops animating.

Note that duration does not need to be specified for this command; it will play once unless you specify a longer duration.