Difference between revisions of "Template:Dafunction"

From Dragon Age Toolset Wiki
Jump to: navigation, search
m
(a basic layout.)
Line 1: Line 1:
 
<noinclude>
 
<noinclude>
 +
 +
{{{brief}}}
 +
 +
<div style="background:#DDDDDD;">
 +
{{{returntype}}} {{{name}}} (
 +
:: {{{param1type}}} {{{param1name}}} = {{{param1default}}},
 +
:: {{{param2type}}} {{{param2name}}} = {{{param2default}}}
 +
:)
 +
</div>
 +
 +
'''Parameters:'''
 +
;{{{param1name}}}:{{{param1desc}}}
 +
;{{{param2name}}}:{{{param2desc}}}
 +
 +
'''Returns:'''
 +
:{{{returndesc}}}
 +
 +
'''Source:'''
 +
:{{{sourcefile}}} from the module {{{sourcemodule}}}
  
 
</noinclude><noinclude>
 
</noinclude><noinclude>
Line 20: Line 39:
 
.
 
.
 
.
 
.
|returnstype= object
+
|returntype= object
|returnsdesc= A creature of a specific type (self, ally, hostile) that has the status applied, OBJECT_INVALID otherwise
+
|returndesc= A creature of a specific type (self, ally, hostile) that has the status applied, OBJECT_INVALID otherwise
 
|sourcefile= ai_conditions_h
 
|sourcefile= ai_conditions_h
 
|sourcemodule= Core Resources
 
|sourcemodule= Core Resources

Revision as of 17:30, 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.