Difference between revisions of "Template:Dafunction"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(using nested definition lists for more 'meaningful' markup and consistent formatting)
m (remove some whitespace)
Line 11: Line 11:
  
 
<dl>
 
<dl>
 
 
<dt>Parameters:
 
<dt>Parameters:
 
<dd>
 
<dd>
Line 18: Line 17:
 
<dt>{{{param2name}}}<dd>{{{param2desc}}}
 
<dt>{{{param2name}}}<dd>{{{param2desc}}}
 
</dl>
 
</dl>
 
 
<dt>Returns:
 
<dt>Returns:
 
<dd>{{{returndesc}}}
 
<dd>{{{returndesc}}}
 
 
<dt>Source:
 
<dt>Source:
 
<dd>{{{sourcefile}}} from the module {{{sourcemodule}}}
 
<dd>{{{sourcefile}}} from the module {{{sourcemodule}}}
 
 
</dl>
 
</dl>
  

Revision as of 18:32, 21 July 2009


{{{brief}}}

{{{returntype}}} {{{name}}} (

{{{param1type}}} {{{param1name}}} = {{{param1default}}},
{{{param2type}}} {{{param2name}}} = {{{param2default}}}
)
Parameters:
{{{param1name}}}
{{{param1desc}}}
{{{param2name}}}
{{{param2desc}}}

Returns:
{{{returndesc}}}
Source:
{{{sourcefile}}} from the module {{{sourcemodule}}}



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
}}

Note: This template is currently just a work in progress and is not usable yet.