Difference between revisions of "UT TeamAppears"

From Dragon Age Toolset Wiki
Jump to: navigation, search
(Created page with '{{dafunction |name = UT_TeamAppears |brief = Makes a team appear (they are activated). |param1type = int |param1name = nTeamID |param1desc = This is the team ID number (stored in...')
 
m
 
(2 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{dafunction
 
{{dafunction
|name = UT_TeamAppears
+
|name         = UT_TeamAppears
|brief = Makes a team appear (they are activated).
+
|brief         = Makes a team appear (they are activated).
|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 = bAppears
+
|param2name   = bAppears
|param2desc = True or false
+
|param2desc   = TRUE or FALSE
|param2default =TRUE
+
|param2default = TRUE
|param3type = int
+
|param3type   = int
|param3name = nMembersType
+
|param3name   = nMembersType
|param3desc = The type of members to retrieve ([[OBJECT_TYPE_CREATURE]], [[OBJECT_TYPE_PLACEABLE]])
+
|param3desc   = The type of members to retrieve ([[OBJECT_TYPE_*|OBJECT_TYPE_CREATURE]], [[OBJECT_TYPE_*|OBJECT_TYPE_PLACEABLE]])
|param3default =OBJECT_TYPE_CREATURE
+
|param3default = OBJECT_TYPE_CREATURE
|returntype = void
+
|returntype   = void
|returndesc =  
+
|returndesc   =  
|sourcefile = utility_h
+
|sourcefile   = utility_h
|sourcemodule = Core Resources
+
|sourcemodule = Core Game Resources
 
}}
 
}}
  
Line 23: Line 23:
 
<!-- 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 sets SetObjectActive to TRUE for every member of the specified team. 0 is not a valid parameter (because that's the default value of the variable).
+
This sets [[SetObjectActive]] to TRUE for every member of the specified team. 0 is not a valid parameter (because that's the default value of the variable).
  
 
<!-- == Remarks == -->
 
<!-- == Remarks == -->

Latest revision as of 19:35, 3 August 2011

Makes a team appear (they are activated).

void UT_TeamAppears(
int nTeamID,
int bAppears = TRUE,
int nMembersType = OBJECT_TYPE_CREATURE
);
Parameters:
nTeamID
This is the team ID number (stored in CREATURE_TEAM_ID)
bAppears
TRUE or FALSE
nMembersType
The type of members to retrieve (OBJECT_TYPE_CREATURE, OBJECT_TYPE_PLACEABLE)
Returns:

Nothing.

Source:

Core Game Resources.utility_h

Description

This sets SetObjectActive to TRUE for every member of the specified team. 0 is not a valid parameter (because that's the default value of the variable).