Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
imported>Qazaaq (filling in void as return value) |
imported>Qazaaq m |
||
| Line 59: | Line 59: | ||
return value: | return value: | ||
-->{{ #ifeq: {{{ReturnVal|missing}}} | missing | '''missing return value!''' | {{{ReturnVal}}} |}}<!-- | -->{{ #ifeq: {{{ReturnVal|missing}}} | missing | '''missing return value!''' | ({{{ReturnVal}}}|}}<!-- | ||
return type (short, float, base object, ref, something else?): | return type (short, float, base object, ref, something else?): | ||
Revision as of 15:04, 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
| ReturnVal = void
| ReferenceType = [Actor, Activator]
| arg0 = EffectID
| arg0Type = MagicEffect
| optarg0 = duration
| optarg0Type = Short
| origin = GECK1
| 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:
(void)[Actor, Activator].PlayMagicEffectVisuals EffectID:MagicEffectRef duration: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.