Difference between revisions of "Template:Function"
Jump to navigation
Jump to search
imported>DragoonWraith |
imported>DragoonWraith |
||
| Line 152: | Line 152: | ||
FOR ALTERNATE ALIAS: return value: | FOR ALTERNATE ALIAS: return value: | ||
-->{{ #if: {{{ | -->{{ #if: {{{altAlias|}}} |<br/>{{ #ifeq: {{{returnType|void}}} | void | (void) |({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!-- | ||
return type (short, float, base object, ref, something else?): | return type (short, float, base object, ref, something else?): | ||
| Line 165: | Line 165: | ||
arguments | arguments | ||
-->{{ #if: {{{altArgs|}}} | {{{altArgs}}} |<!-- no Arguments -->}}|<!-- no Alias -->}}|<!-- no Alternate -->}}<!-- | -->{{ #if: {{{altArgs|}}} | {{{altArgs}}} |<!-- no Arguments -->}}|<!-- no Alias -->}}|<!-- no Alternate -->}}<!-- | ||
FOR 2nd ALTERNATE: | |||
-->{{ #if: {{{alt2Name|}}} | | |||
{{ #ifeq: {{{returnType|void}}} | void | (void) |({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!-- | |||
return type (short, float, base object, ref, something else?): | |||
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}}) }} }}<!-- | |||
optional reference type (actor, activator, door, etc.): | |||
-->{{ #if: {{{referenceType|}}} | {{ #if: {{{referenceOpt|}}} | ''{{{referenceType}}}.'' | {{{referenceType}}}. }} |<!-- no Reference Type -->}}<!-- | |||
the actual function: | |||
-->{{{alt2Name}}}<!-- | |||
arguments | |||
-->{{ #if: {{{alt2Args|}}} | {{{alt2Args}}} |<!-- no Arguments -->}}<!-- | |||
FOR 2nd ALTERNATE ALIAS: return value: | |||
-->{{ #if: {{{alt2Alias|}}} |<br/>{{ #ifeq: {{{returnType|void}}} | void | (void) |({{ #if: {{{returnVal|}}} | {{{returnVal}}}<nowiki>:</nowiki> |}}<!-- | |||
return type (short, float, base object, ref, something else?): | |||
-->{{ #ifeq: {{{returnType|missing}}} | missing | '''missing return type!''' | {{{returnType}}}) }} }}<!-- | |||
optional reference type (actor, activator, door, etc.): | |||
-->{{ #if: {{{referenceType|}}} | {{ #if: {{{referenceOpt|}}} | ''{{{referenceType}}}.'' | {{{referenceType}}}. }} |<!-- no Reference Type -->}}<!-- | |||
alias: | |||
-->{{{alt2Alias}}}<!-- | |||
arguments | |||
-->{{ #if: {{{alt2Args|}}} | {{{alt2Args}}} |<!-- no Arguments -->}}|<!-- no Alias -->}}|<!-- no 2nd Alternate -->}}<!-- | |||
short summary of the function: --> | short summary of the function: --> | ||
Revision as of 12:58, 8 August 2010
Beta Function
This function has not been fully tested yet, and is not ready to be used in a released mod. It may not have the same function in later versions, may require the script to be recompiled, or simply may be removed. Use for testing purposes only until the author of the function says otherwise.
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.
{{Function
origin = whether the function came from the CS itself or was added by OBSE.
valid values: CS1 (TES CS 1.0), CS1.1 (TES CS 1.1), CS1.2 (TES CS 1.2), OBSE
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.
altName = the name of an alternate version of a function (e.g. the "C" Magic Effect functions)
altAlias = the alias of the alternate function.
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
referenceOpt = if can take a reference, whether it must take a reference.
arguments = List of arguments specified using the {{FunctionArgument}} template,
or any other wiki syntax.
altArgs = List of arguments for the alternate version of the function.
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
|origin = OBSE
|summary = Sets the constant effect barter factor of the magic effect.
|name = SetMagicEffectBarterFactor
|alias = SetMEBarterFactor
|altName = SetMagicEffectBarterFactorC
|altAlias = SetMEBarterFactorC
|returnVal = nothing
|returnType = void
|arguments =
{{FunctionArgument
|Name = newBarterFactor
|Type = float
}}{{FunctionArgument
|Name = effect
|Type = chars
}}
|altArgs =
{{FunctionArgument
|Name = newBarterFactor
|Type = float
}}{{FunctionArgument
|Name = effectCode
|Type = long
}}
|example = SetMagicEffectBarterFactor 5 FIDG
SetMEBarterFactorC 1.5 1397247044 ; code for SHLD
}}
Result
A function added by the Oblivion Script Extender.
Syntax:
(void) SetMagicEffectBarterFactor
(void) SetMEBarterFactor
(void) SetMagicEffectBarterFactorC
(void) SetMEBarterFactorC
Sets the constant effect barter factor of the magic effect.
Example
SetMagicEffectBarterFactor 5 FIDG SetMEBarterFactorC 1.5 1397247044 ; code for SHLD