Difference between revisions of "Template:Dafunction"
From Dragon Age Toolset Wiki
(Fix for where there are no params (now inserts "None" rather than leaving Parameters blank), see GetHero for example) |
BryanDerksen (Talk | contribs) (mentioning arra parameters in documentation) |
||
| Line 65: | Line 65: | ||
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. | 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. | ||
| + | |||
| + | The return and parameter fields also have corresponding "arra" fields, for example param1arra. When any value is placed in these fields the corresponding return type or parameter type will be made into an array. This is needed because the [] notation of arrays conflicts with the wiki's link notation. | ||
Suggested standard headers include: | Suggested standard headers include: | ||
Revision as of 19:23, 9 February 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.
The return and parameter fields also have corresponding "arra" fields, for example param1arra. When any value is placed in these fields the corresponding return type or parameter type will be made into an array. This is needed because the [] notation of arrays conflicts with the wiki's link notation.
Suggested standard headers include:
Description
Known issues
Examples
See also
With others added when and where needed.
