Difference between revisions of "Template:Dafunction"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (add a space to see if it fixes functions that return an array) |
BryanDerksen (Talk | contribs) m (nope. Looks like [ and ] are invalid characters for page titles, I'll need to do something clever here.) |
||
| 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|}}}| <span style="color: #FF0000;">=</span> {{{param1default}}}|}}|}}{{#if:{{{param2name|}}}|, | :{{#if:{{{param1name|}}}|[[{{{param1type}}}]] {{{param1name}}}{{#if:{{{param1default|}}}| <span style="color: #FF0000;">=</span> {{{param1default}}}|}}|}}{{#if:{{{param2name|}}}|, | ||
:[[{{{param2type}}}]] {{{param2name}}}{{#if:{{{param2default|}}}| <span style="color: #FF0000;">=</span> {{{param2default}}}|}}|}}{{#if:{{{param3name|}}}|, | :[[{{{param2type}}}]] {{{param2name}}}{{#if:{{{param2default|}}}| <span style="color: #FF0000;">=</span> {{{param2default}}}|}}|}}{{#if:{{{param3name|}}}|, | ||
Revision as of 22:22, 31 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.