Template:Function

From GECK


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

[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


Personal tools