Template:Dafunction

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

<!-- 
== Description == -->
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. -->
<!-- 
== Remarks == -->
<!-- This section contains additional comments, observations and known issues. -->
<!-- 
== Examples == -->
<!-- This section contains examples transcluded from the snippet library. -->
<!-- 
== See also == -->
<!-- This section contains links to articles, functions or constant groups. -->

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 headers and their purpose are:

• Description: a more verbose description of the function
• Remarks: hints and tips on usage; caveats or known issues; workarounds or unusal uses; etc.
• Examples: dascript snippets demonstrating how to use the functions
• See also: links to related articles or categories

With others added when and where needed.