Difference between revisions of "Template:Dafunction"
From Dragon Age Toolset Wiki
(fixed for arrays breaking wikilinks, affected pages will need pages to be manually updated, see FilterObjectsInShape for a fixed version) |
(Fix for where there are no params (now inserts "None" rather than leaving Parameters blank), see GetHero for example) |
||
| Line 18: | Line 18: | ||
<dl> | <dl> | ||
<dt>Parameters: | <dt>Parameters: | ||
| − | <dd> | + | <dd>{{#if:{{{param1name|}}}| |
<dl> | <dl> | ||
{{#if:{{{param1name|}}}|<dt style="font-weight:normal; font-style:italic;">{{{param1name}}}<dd>{{{param1desc|}}}|}}<!-- | {{#if:{{{param1name|}}}|<dt style="font-weight:normal; font-style:italic;">{{{param1name}}}<dd>{{{param1desc|}}}|}}<!-- | ||
| Line 30: | Line 30: | ||
-->{{#if:{{{param9name|}}}|<dt style="font-weight:normal; font-style:italic;">{{{param9name}}}<dd>{{{param9desc|}}}|}}<!-- | -->{{#if:{{{param9name|}}}|<dt style="font-weight:normal; font-style:italic;">{{{param9name}}}<dd>{{{param9desc|}}}|}}<!-- | ||
-->{{#if:{{{param10name|}}}|<dt style="font-weight:normal; font-style:italic;">{{{param10name}}}<dd>{{{param10desc|}}}|}} | -->{{#if:{{{param10name|}}}|<dt style="font-weight:normal; font-style:italic;">{{{param10name}}}<dd>{{{param10desc|}}}|}} | ||
| − | </dl> | + | </dl>|None}} |
<dt>Returns: | <dt>Returns: | ||
<dd>{{#ifeq:{{{returntype}}}|void|Nothing.|{{{returndesc}}}}} | <dd>{{#ifeq:{{{returntype}}}|void|Nothing.|{{{returndesc}}}}} | ||
Revision as of 07:59, 4 January 2010
{{{brief}}}
[[{{{returntype}}}]] {{{name}}}(
);
- Parameters:
- None
- 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.
