Difference between revisions of "Template:Dafunction"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(account for functions with return type void)
m (some cosmetic tweaks)
Line 2: Line 2:
  
 
<div class="dascript" style="font-family:monospace; background-color:#F9F9F9; border: 1px dashed #2F6FAB; line-height: 1.1em; padding: 1em;">
 
<div class="dascript" style="font-family:monospace; background-color:#F9F9F9; border: 1px dashed #2F6FAB; line-height: 1.1em; padding: 1em;">
[[{{{returntype}}}]] {{{name}}} (
+
[[{{{returntype}}}]] {{{name}}}(
::{{#if:{{{param1name|}}}|[[{{{param1type}}}]] {{{param1name}}}{{#if:{{{param1default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param1default}}}|}}|}}{{#if:{{{param2name|}}}|,
+
:{{#if:{{{param1name|}}}|[[{{{param1type}}}]] {{{param1name}}}{{#if:{{{param1default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param1default}}}|}}|}}{{#if:{{{param2name|}}}|,
::[[{{{param2type}}}]] {{{param2name}}}{{#if:{{{param2default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param2default}}}|}}|}}{{#if:{{{param3name|}}}|,
+
:[[{{{param2type}}}]] {{{param2name}}}{{#if:{{{param2default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param2default}}}|}}|}}{{#if:{{{param3name|}}}|,
::[[{{{param3type}}}]] {{{param3name}}}{{#if:{{{param3default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param3default}}}|}}|}}{{#if:{{{param4name|}}}|,
+
:[[{{{param3type}}}]] {{{param3name}}}{{#if:{{{param3default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param3default}}}|}}|}}{{#if:{{{param4name|}}}|,
::[[{{{param4type}}}]] {{{param4name}}}{{#if:{{{param4default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param4default}}}|}}|}}{{#if:{{{param5name|}}}|,
+
:[[{{{param4type}}}]] {{{param4name}}}{{#if:{{{param4default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param4default}}}|}}|}}{{#if:{{{param5name|}}}|,
::[[{{{param5type}}}]] {{{param5name}}}{{#if:{{{param5default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param5default}}}|}}|}}{{#if:{{{param6name|}}}|,
+
:[[{{{param5type}}}]] {{{param5name}}}{{#if:{{{param5default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param5default}}}|}}|}}{{#if:{{{param6name|}}}|,
::[[{{{param6type}}}]] {{{param6name}}}{{#if:{{{param6default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param6default}}}|}}|}}{{#if:{{{param7name|}}}|,
+
:[[{{{param6type}}}]] {{{param6name}}}{{#if:{{{param6default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param6default}}}|}}|}}{{#if:{{{param7name|}}}|,
::[[{{{param7type}}}]] {{{param7name}}}{{#if:{{{param7default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param7default}}}|}}|}}{{#if:{{{param8name|}}}|,
+
:[[{{{param7type}}}]] {{{param7name}}}{{#if:{{{param7default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param7default}}}|}}|}}{{#if:{{{param8name|}}}|,
::[[{{{param8type}}}]] {{{param8name}}}{{#if:{{{param8default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param8default}}}|}}|}}{{#if:{{{param9name|}}}|,
+
:[[{{{param8type}}}]] {{{param8name}}}{{#if:{{{param8default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param8default}}}|}}|}}{{#if:{{{param9name|}}}|,
::[[{{{param9type}}}]] {{{param9name}}}{{#if:{{{param9default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param9default}}}|}}|}}{{#if:{{{param10name|}}}|,
+
:[[{{{param9type}}}]] {{{param9name}}}{{#if:{{{param9default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param9default}}}|}}|}}{{#if:{{{param10name|}}}|,
::[[{{{param10type}}}]] {{{param10name}}}{{#if:{{{param10default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param10default}}}|}}|}}
+
:[[{{{param10type}}}]] {{{param10name}}}{{#if:{{{param10default|}}}|&nbsp;<span style="color: #FF0000;">=</span> {{{param10default}}}|}}|}}
:)
+
);
 
</div>
 
</div>
  
Line 70: Line 70:
 
__NOTOC__
 
__NOTOC__
 
== Description ==
 
== Description ==
== Examples ==
 
 
== Known issues ==
 
== Known issues ==
 +
== Examples ==
 
== See also ==
 
== See also ==
  

Revision as of 02:26, 25 July 2009

{{{brief}}}

[[{{{returntype}}}]] {{{name}}}(

);

Parameters:

Returns:
{{{returndesc}}}
Source:
[[{{{sourcefile}}}]]



Usage:

{{dafunction
|name = _AI_Condition_GetCreatureWithAIStatus
|brief = Returns a creature with a specifc AI Status
|param1type = int
|param1name = nAIStatus
|param1desc = the status being checked for if active on a creature
|param1default =
|param2type = int
|param2name = nTargetType
|param2desc = the target type of creature we are looking for that might have the specified status
|param2default =
.
.
.
|returntype = object
|returndesc = A creature of a specific type (self, ally, hostile) that has the status applied, OBJECT_INVALID otherwise
|sourcefile = ai_conditions_h
|sourcemodule = Core Resources
}}

A standard dafunction page will have a number of other headers below this template where more detailed and free-form information will be added by editors.

Suggested standard headers include:

Description

Known issues

Examples

See also

With others added when and where needed.