Difference between revisions of "UT GetTeam"
From Dragon Age Toolset Wiki
m (Updating link) |
m |
||
| Line 1: | Line 1: | ||
{{dafunction | {{dafunction | ||
| − | |name = UT_GetTeam | + | |name = UT_GetTeam |
| − | |brief = Returns an array of all team members in the area. | + | |brief = Returns an array of all team members in the area. |
| − | |param1type = int | + | |param1type = int |
| − | |param1name = nTeamID | + | |param1name = nTeamID |
| − | |param1desc = This is the team ID number (stored in [[CREATURE_TEAM_ID]]) | + | |param1desc = This is the team ID number (stored in [[CREATURE_TEAM_ID]]) |
|param1default = | |param1default = | ||
| − | |param2type = int | + | |param2type = int |
| − | |param2name = nMembersType | + | |param2name = nMembersType |
| − | |param2desc = The type of members to retrieve ([[OBJECT_TYPE_*|OBJECT_TYPE_CREATURE]], [[OBJECT_TYPE_*|OBJECT_TYPE_PLACEABLE]]) | + | |param2desc = The type of members to retrieve ([[OBJECT_TYPE_*|OBJECT_TYPE_CREATURE]], [[OBJECT_TYPE_*|OBJECT_TYPE_PLACEABLE]]) |
| − | |param2default =OBJECT_TYPE_CREATURE | + | |param2default = OBJECT_TYPE_CREATURE |
| − | |returntype = object | + | |returntype = object |
| − | |returnarra=true | + | |returnarra = true |
| − | |returndesc = an array of all team members in the area. | + | |returndesc = an array of all team members in the area. |
| − | |sourcefile = utility_h | + | |sourcefile = utility_h |
| − | |sourcemodule = Core Resources | + | |sourcemodule = Core Game Resources |
}} | }} | ||
| Line 20: | Line 20: | ||
<!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | <!-- This section contains the full description from the functions comments. Do not change unless you are confident these are incomplete or incorrect. --> | ||
| − | This function searches through all the creatures in the area and returns any creature that has | + | This function searches through all the creatures in the area and returns any creature that has its team set to nTeamID |
<!-- == Remarks == --> | <!-- == Remarks == --> | ||
Latest revision as of 19:30, 3 August 2011
Returns an array of all team members in the area.
- Parameters:
- nTeamID
- This is the team ID number (stored in CREATURE_TEAM_ID)
- nMembersType
- The type of members to retrieve (OBJECT_TYPE_CREATURE, OBJECT_TYPE_PLACEABLE)
- Returns:
- an array of all team members in the area.
- Source:
- Core Game Resources.utility_h
Description
This function searches through all the creatures in the area and returns any creature that has its team set to nTeamID
