Difference between revisions of "Template:Function"

From the Fallout3 GECK Wiki
Jump to navigation Jump to search
imported>SnakeChomp
m (Note on new arguments parameter. CategoryList is technically optional)
imported>Pintocat
 
(35 intermediate revisions by 12 users not shown)
Line 4: Line 4:


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]].
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]].
{{Template:Community_Wiki}}


  <nowiki>{{Function</nowiki>
  <nowiki>{{Function</nowiki>
   ''CSWikiPage''        = name of corresponding page on the [http://cs.elderscrolls.com/constwiki/index.php/Category:Functions TES CS Wiki]
   ''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 FOSE.
   origin            = whether the function came from the GECK itself or was added by a script extender.
                       valid values: GECK1 (GECK 1.1), FOSE0001 (FOSE v0001)
                       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
   summary          = description of the function
   ''name''              = the name of the function. The page name is the default value.
   ''name''              = the name of the function. The page name is the default value.
   ''shortname''         = An abbreviated version of the function name that can be
   ''alias''             = An abbreviated version of the function name that can be
                       used instead of the long name.
                       used instead of the long name.
   ''returnVal ''        = what the function returns
   ''returnVal ''        = what the function returns.
   returnType        = the type of the returned value. Use void if there is no return value.
   ''returnType''       = the type of the returned value.
   ''referenceType''    = if appropriate, the type of reference that the function may be called
   ''referenceType''    = if appropriate, the type of reference that the function may be called
                       on with the dot syntax
                       on with the dot syntax
   ''arguments''        = List of arguments specified using the [[Template:FunctionArgument]] template,
   ''arguments''        = List of arguments specified using the [[Template:FunctionArgument]] template,
                       or any other wiki syntax. Use this or the arg0-arg9 parameters.
                       or any other wiki syntax.
  ''arg0''              = the first '''mandatory''' argument
                      (''arg*'' parameters are optional, not all functions have mandatory arguments)
  ''arg1''              = the second mandatory argument
  ...                (the template supports 10 mandatory arguments, arg0 through arg9)
  ''optArg0''          = the first '''optional''' argument
                      (this means it is optional for the scripter)
  ''optArg1''          = second optional argument
  ...                (the template also accepts 10 optional arguments, optArg0 through optArg9)
   ''example''          = optionally, the function used as part of a script to serve as an example
   ''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
   ''CategoryList''      = the list of categories to which the page belongs
Line 34: Line 29:


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


Line 52: Line 54:


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


</noinclude><includeonly><!--
</noinclude><includeonly>__NOEDITSECTION__<!--


Back to: link-->{{Bc|Category:Functions}}<!--
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    = A function included in the GECK version 1.1.0.36.
| GECK1    = A function included in the GECK version 1.1.0.36.
| FOSE0001 = A function added by 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}}
}}<!--
}}<!--
Line 88: Line 106:
<!-- syntax starts here: -->
<!-- syntax starts here: -->
== Syntax ==
== Syntax ==
<!-- help link -->
<div style="font-size:10px;margin-top:-3em;margin-left:6.3em;">[[Function syntax|[help]]]</div>


<!-- return value:
<!-- return value:
--> {{ #ifeq: {{{returnType}}} | void | |({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!--
--> {{ #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?):
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&nbsp; |}} }}<!--
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&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|{{PAGENAME}}}}}<!--
-->{{{name|{{PAGENAME}}}}}<!--


shortname:
arguments
-->{{ #if: {{{shortname|}}} | ({{{shortname}}}) |}}<!--
-->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}}<!--
 
<!-- FOR ALIAS: return value:
-->{{ #if: {{{alias|}}} | &nbsp;
Or:
{{ #ifeq: {{{returnType|void}}} | void |<!-- no Return Value -->|({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!--
 
return type (short, float, base object, ref, something else?):
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}})&nbsp; }} }}<!--


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


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


optional arguments + types:
arguments
-->{{ #if: {{{optarg0|}}} | &nbsp;''{{{optarg0}}}:{{{optarg0Type}}}'' |}}<!--
-->{{ #if: {{{arguments|}}} | {{{arguments}}} |<!-- no Arguments -->}}|<!-- no Alias -->}}<!--
-->{{ #if: {{{optarg1|}}} | &nbsp;''{{{optarg1}}}:{{{optarg1Type}}}'' |}}<!--
-->{{ #if: {{{optarg2|}}} | &nbsp;''{{{optarg2}}}:{{{optarg2Type}}}'' |}}<!--
-->{{ #if: {{{optarg3|}}} | &nbsp;''{{{optarg3}}}:{{{optarg3Type}}}'' |}}<!--
-->{{ #if: {{{optarg4|}}} | &nbsp;''{{{optarg4}}}:{{{optarg4Type}}}'' |}}<!--
-->{{ #if: {{{optarg5|}}} | &nbsp;''{{{optarg5}}}:{{{optarg5Type}}}'' |}}<!--
-->{{ #if: {{{optarg6|}}} | &nbsp;''{{{optarg6}}}:{{{optarg6Type}}}'' |}}<!--
-->{{ #if: {{{optarg7|}}} | &nbsp;''{{{optarg7}}}:{{{optarg7Type}}}'' |}}<!--
-->{{ #if: {{{optarg8|}}} | &nbsp;''{{{optarg8}}}:{{{optarg8Type}}}'' |}}<!--
-->{{ #if: {{{optarg9|}}} | &nbsp;''{{{optarg9}}}:{{{optarg9Type}}}'' |}}<!--


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


categorization code (needs something clever): -->{{{CategoryList|}}}</includeonly>
categorization code (needs something clever): -->{{{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"