Sandbox

From GECK
Jump to: navigation, search
This is NOT a function. It is a sandbox area to test page changes. It shows up in Functions_(All) because it transcludes the Template:Function page. 


{{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: CONSOLENV (console functions), 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), JohnnyGuitar (Johnny Guitar), SUP (SUP NVSE), kNVSE (kNVSE Plugin), TTW (TTW), LNONLY (Lutana, not merged in JIP), BookMenu (Book Menu Restored), CommandExtender (Command Extender), HotReload (Hot Reload), ShowOff (ShowOff NVSE), Anh (AnhNVSE),  ClearCommand (Clear Command NVSE), PostalOut (PostalOut NVSE), PP (pp NVSE), ButcherPete (ButcherPete FOSE).
 originVersion     = optionally display the version of the origin the function was introduced in				  
 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
 consoleOnly       = Usable only in console, not in compiled scripts
 conditionFunc     = whether the function can be used as a condition
                         Valid values: Condition, Script, or Both.
}}


Example

{{Function
 |origin = GECK1
 |originVersion = 1.0
 |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
}}

Result


A function included in the GECK for Fallout 3 version 1.0.

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



{{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: CONSOLENV (console functions), 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), JohnnyGuitar (Johnny Guitar), SUP (SUP NVSE), kNVSE (kNVSE Plugin), TTW (TTW), LNONLY (Lutana, not merged in JIP), BookMenu (Book Menu Restored), CommandExtender (Command Extender), HotReload (Hot Reload), ShowOff (ShowOff NVSE), Anh (AnhNVSE),  ClearCommand (Clear Command NVSE), PostalOut (PostalOut NVSE), PP (pp NVSE), ButcherPete (ButcherPete FOSE).
 originVersion     = optionally display the version of the origin the function was introduced in				  
 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
 consoleOnly       = Usable only in console, not in compiled scripts
 conditionFunc     = whether the function can be used as a condition
                         Valid values: Condition, Script, or Both.
}}


Example

{{Function
 |origin = GECK1
 |originVersion = 1.0
 |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
}}

Result


A function included in the GECK for Fallout 3 version 1.0.

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


There is also a Template:Sandbox

Template:Function

Link to TES4 Construction Set Wiki: PlayMagicEffectVisuals.

A function included in the GECK for Fallout 3.

Description

Plays the visuals of the specified Base 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.

Syntax

[help]
(int) [Actor, Activator].PlayMagicEffectVisuals

Example

player.PlayMagicEffectVisuals poison 5


Template:Function_(Test)


A function added by the ShowOff NVSE Plugin version 1.0.

Description

Returns the amount of corner messages (those with icons that display on the top-left corner) that are in queue. This includes the currently displaying corner message.

Syntax

[help]
(numQueuedMsg:int) GetNumQueuedCornerMessages

Example

set iNum to GetNumQueuedCornerMessages

Template:Function_(Test2)


A function added by the Clear Command Plugin.

Description

Clears displayed output in console. Alias to clr

Syntax

[help]
clear



<categorytree mode="pages" namespaces="Main Category">Manual</categorytree>


Expanded Bc test

< [[::|]]

Template with page test

Action Indices

Index Action
1 PLAYER_ACTION_SWING_MELEE_WEAPON
2 PLAYER_ACTION_THROW_GRANADE
3 PLAYER_ACTION_FIRE_WEAPON
4 PLAYER_ACTION_LAY_MINE
5 PLAYER_ACTION_Z_KEY_OBJECT
6 PLAYER_ACTION_JUMPING
7 PLAYER_ACTION_KNOCKING_OVER_OBJECTS
8 PLAYER_ACTION_STAND_ON_TABLE_CHAIR
9 PLAYER_ACTION_IRON_SIGHTS
10 PLAYER_ACTION_DESTROY_OBJECT


Settings template test

sandbox
Default value 0.75
Description This is just an example.
  • And these
  • are a few
  • bullet points


IfExist test for external links

Doesn't seem to work. Template code used
{{ #ifexist: http://cs.elderscrolls.com/index.php/Main_Page | Can refer to external pages | Doesn't work }}

LaTeX Tests

Examples from [1]

<math>\frac{2}{4}=0.5</math> <math>\sqrt{2}</math> <math>\alpha\,</math>

<math>\left ( \frac{a}{b} \right )</math>
Retrieved from "https://geckwiki.com/index.php?title=Sandbox&oldid=37109"