Difference between revisions of "Template:Dafunction"
From Dragon Age Toolset Wiki
BryanDerksen (Talk | contribs) m (using to prevent MediaWiki from trimming the leading spaces on the defaults) |
BryanDerksen (Talk | contribs) (account for functions with return type void) |
||
| Line 32: | Line 32: | ||
</dl> | </dl> | ||
<dt>Returns: | <dt>Returns: | ||
| − | <dd>{{{returndesc}}} | + | <dd>{{#ifeq:{{{returntype}}}|void|Nothing.|{{{returndesc}}}}} |
<dt>Source: | <dt>Source: | ||
<dd>[[{{{sourcefile}}}]] {{#if:{{{sourcemodule|}}}|from the module [[{{{sourcemodule}}}]]|}} | <dd>[[{{{sourcefile}}}]] {{#if:{{{sourcemodule|}}}|from the module [[{{{sourcemodule}}}]]|}} | ||
Revision as of 19:39, 24 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
Examples
Known issues
See also
With others added when and where needed.
