Difference between revisions of "Template:Function"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>Haama
(Test)
imported>Pintocat
 
(84 intermediate revisions by 13 users not shown)
Line 1: Line 1:
<noinclude>
<noinclude>
__NOTOC__
{{Incomplete}}
{{Incomplete}}


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.
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 in the [[Sandbox#Function_Template_Test|Sandbox]].


'''example:'''<pre>
{{Template:Community_Wiki}}
<nowiki>{{</nowiki>Function
| name          = PlayMagicEffectVisuals
| CSWikiPage    = PlayMagicEffectVisuals
| ReturnVal    = void
| ReferenceType = [Actor|Activator]
| arg0          = EffectID
| arg0Type      = MagicEffectRef
| 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.
<nowiki>{{Function</nowiki>
  ''CSWikiPage''        = name of corresponding page on the [http://cs.elderscrolls.com/constwiki/index.php/Category:Functions TES CS Wiki]
  origin            = whether the function came from the GECK itself or was added by a script extender.
                      valid values: GECK1 (GECK 1.1), GECK1.5 (GECK 1.5), FOSE1 (FOSE v1),
                      VEGAS1 (GECK 1.1 New Vegas), NVSE (NVSE), NX (NX plugin), LU (Lutana Plugin), PN (Project Nevada), MCM (MCM), UDF (UDF), JIP (JIP)
  summary          = description of the function
  ''name''              = the name of the function. The page name is the default value.
  ''alias''            = An abbreviated version of the function name that can be
                      used instead of the long name.
  ''returnVal ''        = what the function returns.
  ''returnType''        = the type of the returned value.
  ''referenceType''    = if appropriate, the type of reference that the function may be called
                      on with the dot syntax
  ''arguments''        = List of arguments specified using the [[Template:FunctionArgument]] template,
                      or any other wiki syntax.
  ''example''          = optionally, the function used as part of a script to serve as an example
  ''CategoryList''      = the list of categories to which the page belongs
<nowiki>}}</nowiki>
 
=Example=
 
<pre>{{Function
|CSWikiPage = Test
|origin = GECK1
|summary = Used to test actor and activator references to assure that they are testable.
|name = Test
|alias = tst
|returnVal = 0, 1
|returnType = void
|referenceType = [Actor, Activator]
|arguments =
  {{FunctionArgument
  |Name = Count
  |Type = int
  |Value = 1, 2, 3
  }}{{FunctionArgument
  |Name = Target
  |Type = ref
  |Optional = y
  }}
|example = Player.Test 3
ShackDoor.Test 1 Molerat01
}}</pre>
}}</pre>


'''result:'''
=Result=


{{Function
{{Function
  | name         = PlayMagicEffectVisuals
|CSWikiPage = Test
  | CSWikiPage    = PlayMagicEffectVisuals
|origin = GECK1
  | ReturnVal    = void
|summary = Used to test actor and activator references to assure that they are testable.
  | ReferenceType = [Actor|Activator]
  |name = Test
  | arg0          = EffectID
|alias = tst
| arg0Type      = MagicEffectRef
  |returnVal = 0, 1
| optarg0      = Duration
  |returnType = void
| optarg0Type   = Short
  |referenceType = [Actor, Activator]
| origin        = GECK1
  |arguments =  
  | summary      = Plays the visuals of the specified [[Magic Effects|Magic Effect]] on the calling reference. Visuals will play at least one cycle, regardless of
  {{FunctionArgument
duration, and if no duration is specified they play indefinitely or until the art stops animating.
  |Name = Count
  |Type = int
  |Value = 1, 2, 3
   }}{{FunctionArgument
  |Name = Target
  |Type = ref
  |Optional = y
  }}
  |example = Player.Test 3
ShackDoor.Test 1 Molerat01
}}


Note that duration does not need to be specified for this command; it will play once unless you specify a longer duration.
</noinclude><includeonly>__NOEDITSECTION__<!--
}}</noinclude><includeonly><!--
 
Back to: link-->{{Bc|Category:Functions}}<!--


link to the CS Wiki page
link to the CS Wiki page
-->{{ #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/index.php?title={{{CSWikiPage}}} {{{CSWikiPage}}}].|<!-- no CSwiki page -->}}<!--


line about the origin of the function (GECK1, FOSE0001)
line about the origin of the function (GECK1, FOSE1)
-->
-->
{{ #switch: {{{origin}}}
{{ #switch: {{{origin}}}
| GECK1    =  
| GECK1    = A function included in the GECK version 1.1.0.36.
| FOSE0001 = A command for the [[Fallout Script Extender]].
| GECK1.5 = A function included in the GECK version 1.5.0.19.
| VEGAS1 = A function included in the GECK Version 1.1.0.262 for '''Fallout: New Vegas'''.
| FOSE1 = A function added by the [[Fallout Script Extender]].
| NVSE = A function added by the [[New Vegas Script Extender]].
| NX = A function added by the [[NX]] NVSE plugin.
| PN = A function added by the [[PN|Project Nevada]] NVSE plugin.
| LU = A function added by the [[Lutana]] NVSE plugin.
| MCM = A function added the [[MCM]] NVSE plugin.
| JIP = A function added by the [[Functions_(JIP)|JIP NVSE Plugin]].
| UDF = An example [[User Defined Function|UDF]] script.
| #default = {{Error|missing function origin info}}
| #default = {{Error|missing function origin info}}
}}
}}<!--


<!--
short summary of the function: -->
 
== Description ==
syntax starts here:
{{{summary}}}
-->


'''Syntax:'''
<!-- syntax starts here: -->
<!--
== Syntax ==
<!-- help link -->
<div style="font-size:10px;margin-top:-3em;margin-left:6.3em;">[[Function syntax|[help]]]</div>


return value:
<!-- return value:
-->{{ #ifeq: {{{ReturnVal|missing}}} | missing | '''missing return value!''' | ({{{ReturnVal}}}|}}<!--
--> {{ #ifeq: {{{returnType|void}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!--


return type (short, float, base object, ref, something else?):
return type (short, float, base object, ref, something else?):
-->{{ #if: {{{ReturnType|}}} |:{{{ReturnType}}}|}}<!--
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&nbsp; }} }}<!--
 
closing parenthesis:
-->{{ #if: {{{ReturnVal|}}} |)&nbsp;|}}<!--


optional reference type (actor, activator, door, etc.):
optional reference type (actor, activator, door, etc.):
-->{{ #if: {{{ReferenceType|}}} |''{{{ReferenceType}}}.''|}}<!--
-->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|<!-- no Reference Type -->}}<!--


the actual function:
the actual function:
-->{{{name}}}<!--
-->{{{name|{{PAGENAME}}}}}<!--


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


optional arguments + types:
<!-- FOR ALIAS: return value:
-->{{ #if: {{{optarg0|}}} | &nbsp;''{{{optarg0}}}:{{{optarg0Type}}}''&nbsp; |}}<!--
-->{{ #if: {{{alias|}}} | &nbsp;
-->{{ #if: {{{optarg1|}}} | &nbsp;''{{{optarg1}}}:{{{optarg1Type}}}''&nbsp; |}}<!--
Or:
-->{{ #if: {{{optarg2|}}} | &nbsp;''{{{optarg2}}}:{{{optarg2Type}}}''&nbsp; |}}<!--
{{ #ifeq: {{{returnType|void}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!--
-->{{ #if: {{{optarg3|}}} | &nbsp;''{{{optarg3}}}:{{{optarg3Type}}}''&nbsp; |}}<!--
-->{{ #if: {{{optarg4|}}} | &nbsp;''{{{optarg4}}}:{{{optarg4Type}}}''&nbsp; |}}<!--
-->{{ #if: {{{optarg5|}}} | &nbsp;''{{{optarg5}}}:{{{optarg5Type}}}''&nbsp; |}}<!--
-->{{ #if: {{{optarg6|}}} | &nbsp;''{{{optarg6}}}:{{{optarg6Type}}}''&nbsp; |}}<!--
-->{{ #if: {{{optarg7|}}} | &nbsp;''{{{optarg7}}}:{{{optarg7Type}}}''&nbsp; |}}<!--
-->{{ #if: {{{optarg8|}}} | &nbsp;''{{{optarg8}}}:{{{optarg8Type}}}''&nbsp; |}}<!--
-->{{ #if: {{{optarg9|}}} | &nbsp;''{{{optarg9}}}:{{{optarg9Type}}}''&nbsp; |}}<!--


short summary of the function:
return type (short, float, base object, ref, something else?):
-->
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&nbsp; }} }}<!--
{{{summary}}}
 
optional reference type (actor, activator, door, etc.):
-->{{ #if: {{{referenceType|}}} |''{{{referenceType}}}.''|<!-- no Reference Type -->}}<!--
 
alias:
-->{{{alias}}}<!--
 
arguments
-->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}}|<!-- no Alias -->}}<!--


==Notes==<!--
example: -->
{{ #if: {{{example|}}} | == Example ==
{{{example}}} |<!-- no Example -->}}<!--


categorization code (needs something clever):
categorization code (needs something clever): -->{{{CategoryList|}}}</includeonly>
-->
{{{CategoryList|}}}</includeonly>

Latest revision as of 13:25, 7 May 2017


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 in the Sandbox.


Please Note: The official wiki is no longer being maintained by the community

The modding community for Fallout 3 and Fallout New Vegas has created its own wiki due to onerous and painful captcha requirements for every edit.

The active wiki contributors have moved to the new wiki -- for the most current information, visit:

http://geckwiki.com

{{Function
 CSWikiPage        = name of corresponding page on the TES CS Wiki
 origin            = whether the function came from the GECK itself or was added by a script extender.
                     valid values: GECK1 (GECK 1.1), GECK1.5 (GECK 1.5), FOSE1 (FOSE v1),
                     VEGAS1 (GECK 1.1 New Vegas), NVSE (NVSE), NX (NX plugin), LU (Lutana Plugin), PN (Project Nevada), MCM (MCM), UDF (UDF), JIP (JIP)
 summary           = description of the function
 name              = the name of the function. The page name is the default value.
 alias             = An abbreviated version of the function name that can be
                     used instead of the long name.
 returnVal         = what the function returns.
 returnType        = the type of the returned value.
 referenceType     = if appropriate, the type of reference that the function may be called
                     on with the dot syntax
 arguments         = List of arguments specified using the Template:FunctionArgument template,
                     or any other wiki syntax.
 example           = optionally, the function used as part of a script to serve as an example
 CategoryList      = the list of categories to which the page belongs
}}

Example

{{Function
 |CSWikiPage = Test
 |origin = GECK1
 |summary = Used to test actor and activator references to assure that they are testable.
 |name = Test
 |alias = tst
 |returnVal = 0, 1
 |returnType = void
 |referenceType = [Actor, Activator]
 |arguments = 
  {{FunctionArgument
   |Name = Count
   |Type = int
   |Value = 1, 2, 3
  }}{{FunctionArgument
   |Name = Target
   |Type = ref
   |Optional = y
  }}
 |example = Player.Test 3
 ShackDoor.Test 1 Molerat01
}}

Result

Link to TES4 Construction Set Wiki: Test.

A function included in the GECK version 1.1.0.36.

Description

Used to test actor and activator references to assure that they are testable.

Syntax

[help]
[Actor, Activator].Test Count:int{1, 2, 3} Target:ref 

Or: 

[Actor, Activator].tst Count:int{1, 2, 3} Target:ref

Example

Player.Test 3
ShackDoor.Test 1 Molerat01


Retrieved from "https://geck.uesp.net/w/index.php?title=Template:Function&oldid=190"