Always snap to grid

Difference between revisions of "Legacy:TeamInfo"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
Line 1: Line 1:
−
{{classbox| [[Legacy:UT2003|UT2003]] :: [[Legacy:Object|Object]] >> [[Legacy:Actor|Actor]] >> [[Legacy:Info|Info]] >> [[Legacy:ReplicationInfo|ReplicationInfo]] >> TeamInfo (Package: Engine)}}
+
{{classbox| [[Legacy:UT2003|UT2003]] :: [[Legacy:Actor|Actor]] >> [[Legacy:Info|Info]] >> [[Legacy:ReplicationInfo|ReplicationInfo]] >> TeamInfo (Package: Engine)}}
  
−
==Properties ==
+
Holds information about a team.
−
; color AltTeamColor :
+
−
; string ColorNames[4] :
+
−
; class<Pawn> DefaultPlayerClass :
+
−
; Actor HomeBase :
+
−
; float Score :
+
−
; int Size :
+
−
; color TeamColor :
+
−
; int TeamIndex :
+
−
; string TeamName :
+
  
−
==Functions ==
+
See [[Legacy:TeamInfo (UT)|TeamInfo (UT)]] for the UT version of this class.
−
; bool AddToTeam( Controller Other ):  
+
 
−
; bool BelongsOnTeam( class<Pawn> PawnClass ):  
+
==Properties==
−
; string GetHumanReadableName( ):  
+
; color AltTeamColor (replicated to clients) : Alternate display color for this team.
−
;  RemoveFromTeam( Controller Other ):  
+
; string ColorNames[4] (localized) : Team color names. (red, blue, green, gold)
 +
; class<[[Legacy:Pawn|Pawn]]> DefaultPlayerClass : A default [[Legacy:Pawn|Pawn]] class to use when a player's class is not allowed in this team. (only implemented in the subclass [[Legacy:UnrealTeamInfo|UnrealTeamInfo]])
 +
; [[Legacy:Actor|Actor]] HomeBase (replicated to clients) : A team's home base actor, e.g. the bomb goals in Bombing Run.
 +
; float Score (replicated to clients) : The team's current score.
 +
; int Size : The current number of players in this team.
 +
; color TeamColor (replicated to clients) : Primary display color for this team.
 +
; int TeamIndex (replicated to clients) : This team's [[Legacy:Team Number|team number]].
 +
; string TeamName (localized, replicated to clients) : The team's display name.
 +
 
 +
==Methods==
 +
 
 +
===Inherited From [[Legacy:Actor|Actor]]===
 +
; string GetHumanReadableName ( ) : Returns the team's human readable name. If the TeamName has not changed from its default, the color name corresponding to the [[Legacy:Team Number|team number]] is returned, or "''TeamName'' ''TeamIndex''" if the team number doesn't have a corresponding color name. Otherwise only the TeamName is returned.
 +
 
 +
===Other Methods===
 +
; bool AddToTeam([[Legacy:Controller|Controller]] Other) : Tries to add the Controller to this team and returnes whether it was successfully added.
 +
; bool BelongsOnTeam(class<[[Legacy:Pawn|Pawn]]> PawnClass) : Returns whether a [[Legacy:Pawn|Pawn]] class is allowed in this team.
 +
;  RemoveFromTeam([[Legacy:Controller|Controller]] Other) : Removes a Controller from this team.
 +
 
 +
==Known Subclasses==
 +
TeamInfo
 +
  +- [[Legacy:UnrealTeamInfo|UnrealTeamInfo]]
 +
      +- [[Legacy:DMRoster|DMRoster]]
 +
      |  +- [[Legacy:XDMRoster|xDMRoster]]
 +
      |      +- ''(various subclasses used in the single player DM ladder)''
 +
      +- [[Legacy:XTeamRoster|xTeamRoster]]
 +
          +- ''(various subclasses used in the UT2003 single player team ladders)''
 +
          +- [[Legacy:UT2K4TeamRoster|UT2K4TeamRoster]]
 +
              +- ''(various subclasses used in the UT2004 single player team ladders)''
 +
              +- [[Legacy:UT2K4PhantomRoster|UT2K4PhantomRoster]]
  
 
[[Category:Legacy Class (UT2003)|{{PAGENAME}}]]
 
[[Category:Legacy Class (UT2003)|{{PAGENAME}}]]
 +
[[Category:Legacy Class (UT2004)|{{PAGENAME}}]]
 +
[[Category:Legacy Class Tree|{{PAGENAME}}]]

Revision as of 04:11, 28 November 2004

UT2003 :: Actor >> Info >> ReplicationInfo >> TeamInfo (Package: Engine)

Holds information about a team.

See TeamInfo (UT) for the UT version of this class.

Properties

color AltTeamColor (replicated to clients) 
Alternate display color for this team.
string ColorNames[4] (localized) 
Team color names. (red, blue, green, gold)
class<Pawn> DefaultPlayerClass 
A default Pawn class to use when a player's class is not allowed in this team. (only implemented in the subclass UnrealTeamInfo)
Actor HomeBase (replicated to clients) 
A team's home base actor, e.g. the bomb goals in Bombing Run.
float Score (replicated to clients) 
The team's current score.
int Size 
The current number of players in this team.
color TeamColor (replicated to clients) 
Primary display color for this team.
int TeamIndex (replicated to clients) 
This team's team number.
string TeamName (localized, replicated to clients) 
The team's display name.

Methods

Inherited From Actor

string GetHumanReadableName ( ) 
Returns the team's human readable name. If the TeamName has not changed from its default, the color name corresponding to the team number is returned, or "TeamName TeamIndex" if the team number doesn't have a corresponding color name. Otherwise only the TeamName is returned.

Other Methods

bool AddToTeam(Controller Other) 
Tries to add the Controller to this team and returnes whether it was successfully added.
bool BelongsOnTeam(class<Pawn> PawnClass) 
Returns whether a Pawn class is allowed in this team.
RemoveFromTeam(Controller Other) 
Removes a Controller from this team.

Known Subclasses

TeamInfo
 +- UnrealTeamInfo
     +- DMRoster
     |   +- xDMRoster
     |       +- (various subclasses used in the single player DM ladder)
     +- xTeamRoster
         +- (various subclasses used in the UT2003 single player team ladders)
         +- UT2K4TeamRoster
             +- (various subclasses used in the UT2004 single player team ladders)
             +- UT2K4PhantomRoster
Retrieved from "https://wiki.beyondunreal.com/Legacy:TeamInfo?oldid=8078"