I love the smell of UnrealEd crashing in the morning. – tarquin

Difference between revisions of "UE3:UTTeamGame instance functions (UT3)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Auto-generated page)
 
m (added missing members)
 
Line 30: Line 30:
 
====AnnounceScore====
 
====AnnounceScore====
 
{{code|function '''AnnounceScore''' ([[int]] '''ScoringTeam''')}}
 
{{code|function '''AnnounceScore''' ([[int]] '''ScoringTeam''')}}
 +
 +
<!-- enter function description -->
 +
 +
====BalanceTeams====
 +
{{code|function '''BalanceTeams''' (optional&nbsp;[[bool]]&nbsp;'''bForceBalance''')}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->
Line 78: Line 83:
  
 
'''Overrides:''' {{tl|CheckScore|UTGame|instance functions}}
 
'''Overrides:''' {{tl|CheckScore|UTGame|instance functions}}
 +
 +
<!-- enter function description -->
 +
 +
====CheckTeamBasedAchievements====
 +
{{code|function '''CheckTeamBasedAchievements''' ()}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->
Line 118: Line 128:
  
 
'''Overrides:''' {{tl|GetBotTeam|UTGame|instance functions}}
 
'''Overrides:''' {{tl|GetBotTeam|UTGame|instance functions}}
 +
 +
<!-- enter function description -->
 +
 +
====GetFriendTeam====
 +
{{code|function [[byte]]&nbsp;'''GetFriendTeam''' ({{tl|UniqueNetId|OnlineSubsystem}}&nbsp;'''FriendNetId''')}}
  
 
<!-- enter function description -->
 
<!-- enter function description -->
Line 185: Line 200:
  
 
parses the given speech for the bots that should receive it
 
parses the given speech for the bots that should receive it
 +
 +
====PickFriendTeam====
 +
{{code|function [[byte]]&nbsp;'''PickFriendTeam''' ([[byte]]&nbsp;'''Num''', {{cl|Controller}}&nbsp;'''C''', {{tl|UniqueNetId|OnlineSubsystem}}&nbsp;'''FriendNetId''')}}
 +
 +
'''Overrides:''' {{tl|PickFriendTeam|GameInfo|instance functions}}
 +
 +
<!-- enter function description -->
  
 
====PickTeam====
 
====PickTeam====
Line 290: Line 312:
 
'''Parameters:'''
 
'''Parameters:'''
 
* ''BotToRemove'' - The Bot to remove
 
* ''BotToRemove'' - The Bot to remove
 +
 +
====WriteOnlineStats====
 +
{{code|function '''WriteOnlineStats''' ()}}
 +
 +
'''Overrides:''' {{tl|WriteOnlineStats|UTDeathmatch}}
 +
 +
Writes out the stats for the game type

Latest revision as of 05:54, 16 August 2009

UT3 Object >> Actor >> Info >> GameInfo >> UTGame >> UTDeathmatch >> UTTeamGame (instance functions)
UTTeamGame instance functions in other games:
UDK

Instance functions[edit]

AdjustSkill[edit]

function AdjustSkill (AIController B, PlayerController P, bool bWinner)

Overrides: UTGame.AdjustSkill


AllowClientToTeleport[edit]

function bool AllowClientToTeleport (UTPlayerReplicationInfo ClientPRI, Actor DestinationActor)

Overrides: UTGame.AllowClientToTeleport

This function allows the server to override any requested teleport attempts from a client

Returns:

returns true if the teleport is allowed

AnnounceScore[edit]

function AnnounceScore (int ScoringTeam)


BalanceTeams[edit]

function BalanceTeams (optional bool bForceBalance)


CampaignSkillAdjust[edit]

function CampaignSkillAdjust (UTBot aBot)

Overrides: UTGame.CampaignSkillAdjust

Called to adjust skill when bot respawns

CanSpectate[edit]

function bool CanSpectate (PlayerController Viewer, PlayerReplicationInfo ViewTarget)

Overrides: UTGame.CanSpectate

returns true if Viewer is allowed to spectate ViewTarget

ChangeTeam[edit]

function bool ChangeTeam (Controller Other, int num, bool bNewTeam)

Overrides: GameInfo.ChangeTeam

ChangeTeam() verify whether controller Other is allowed to change team, and if so change his team by calling SetTeam().

Parameters:

  • Other - the controller which wants to change teams
  • num - the teamindex of the desired team. If 255, pick the smallest team.
  • bNewTeam - if true, broadcast team change notification

CheckEndGame[edit]

function bool CheckEndGame (PlayerReplicationInfo Winner, string Reason)

Overrides: UTGame.CheckEndGame


CheckMaxLives[edit]

function bool CheckMaxLives (PlayerReplicationInfo Scorer)

Overrides: UTGame.CheckMaxLives


CheckScore[edit]

function bool CheckScore (PlayerReplicationInfo Scorer)

Overrides: UTGame.CheckScore


CheckTeamBasedAchievements[edit]

function CheckTeamBasedAchievements ()


CreateTeam[edit]

function CreateTeam (int TeamIndex)


DominatingVictory[edit]

function bool DominatingVictory ()

Overrides: UTGame.DominatingVictory


FindNewObjectives[edit]

function FindNewObjectives (UTGameObjective DisabledObjective)

Overrides: UTGame.FindNewObjectives

re-evaluate objectives for players because the specified one has been changed/completed

FindVictimsTarget[edit]

function Pawn FindVictimsTarget (Controller Other)


ForceRespawn[edit]

function bool ForceRespawn ()

Overrides: UTGame.ForceRespawn

ForceRespawn() returns true if dead players should respawn immediately force respawn if single player and no bots on team 0

GetBotTeam[edit]

function UTTeamInfo GetBotTeam (optional int TeamBots, optional bool bUseTeamIndex, optional int TeamIndex)

Overrides: UTGame.GetBotTeam


GetFriendTeam[edit]

function byte GetFriendTeam (OnlineSubsystem.UniqueNetId FriendNetId)


GetHandicapNeed[edit]

function int GetHandicapNeed (Pawn Other)

Overrides: UTDeathmatch.GetHandicapNeed

return a value based on how much this pawn needs help

InitializeBot[edit]

function InitializeBot (UTBot NewBot, UTTeamInfo BotTeam, const out UTCustomChar_Data.CharacterInfo BotInfo)

Overrides: UTGame.InitializeBot


IsAWinner[edit]

function bool IsAWinner (PlayerController C)

Overrides: UTGame.IsAWinner


IsWinningTeam[edit]

function bool IsWinningTeam (TeamInfo T)


LevelRecommendedPlayers[edit]

function int LevelRecommendedPlayers ()

Overrides: UTGame.LevelRecommendedPlayers


Logout[edit]

function Logout (Controller Exiting)

Overrides: UTGame.Logout


NearGoal[edit]

function bool NearGoal (Controller C)

returns whether the given game object-holding player was near an objective the game object can be scored at

NotifyKilled[edit]

function NotifyKilled (Controller Killer, Controller KilledPlayer, Pawn KilledPawn)

Overrides: GameInfo.NotifyKilled


OverridePRI[edit]

function OverridePRI (PlayerController PC, PlayerReplicationInfo OldPRI)

Overrides: GameInfo.OverridePRI

OverridePRI() override as needed properties of NewPRI with properties from OldPRI which were assigned during the login process

ParseSpeechRecipients[edit]

function ParseSpeechRecipients (UTPlayerController Speaker, const out array<OnlineSubsystem.SpeechRecognizedWordWords, out array<UTBotRecipients)

parses the given speech for the bots that should receive it

PickFriendTeam[edit]

function byte PickFriendTeam (byte Num, Controller C, OnlineSubsystem.UniqueNetId FriendNetId)

Overrides: GameInfo.PickFriendTeam


PickTeam[edit]

function byte PickTeam (byte num, Controller C)

Overrides: GameInfo.PickTeam


PlayRegularEndOfMatchMessage[edit]

function PlayRegularEndOfMatchMessage ()

Overrides: UTGame.PlayRegularEndOfMatchMessage


ProcessSpeechOrders[edit]

function ProcessSpeechOrders (UTPlayerController Speaker, const out array<OnlineSubsystem.SpeechRecognizedWordWords, const out array<UTBotRecipients)

parses and sends the orders in the given speech to the Recipients

ProcessSpeechRecognition[edit]

function ProcessSpeechRecognition (UTPlayerController Speaker, const out array<OnlineSubsystem.SpeechRecognizedWordWords)

Overrides: UTGame.ProcessSpeechRecognition

parses the given player's recognized speech into bot orders, etc

RatePlayerStart[edit]

function float RatePlayerStart (PlayerStart P, byte Team, Controller Player)

Overrides: UTGame.RatePlayerStart

RatePlayerStart() Return a score representing how desireable a playerstart is.

Parameters:

  • P - is the playerstart being rated
  • Team - is the team of the player choosing the playerstart
  • Player - is the controller choosing the playerstart

Returns:

playerstart score

ReduceDamage[edit]

function ReduceDamage (out int Damage, Pawn injured, Controller instigatedBy, Object.Vector HitLocation, out Object.Vector Momentum, class<DamageTypeDamageType)

Overrides: UTGame.ReduceDamage


RestartGame[edit]

function RestartGame ()

Overrides: UTGame.RestartGame

Balance teams before restarting game

ScoreKill[edit]

function ScoreKill (Controller Killer, Controller Other)

Overrides: UTGame.ScoreKill


SendFlagKillMessage[edit]

function SendFlagKillMessage (Controller Killer, UTPlayerReplicationInfo KillerPRI)


SetEndGameFocus[edit]

function SetEndGameFocus (PlayerReplicationInfo Winner)

Overrides: UTGame.SetEndGameFocus


SetTeam[edit]

function SetTeam (Controller Other, UTTeamInfo NewTeam, bool bNewTeam)

SetTeam() Change Other's team to NewTeam.

Parameters:

  • Other - the controller which wants to change teams
  • NewTeam - the desired team.
  • bNewTeam - if true, broadcast team change notification

ShowPathTo[edit]

function ShowPathTo (PlayerController P, int TeamNum)

Overrides: UTGame.ShowPathTo

displays the path to the given base for the given player

TooManyBots[edit]

function bool TooManyBots (Controller botToRemove)

Overrides: UTGame.TooManyBots

(Description copied from UTGame.TooManyBots)
Look at the current game rules and determine if there are too many bots. In a single player game, this function will always return false since the teams are preset and changes are not allowed.

Parameters:

  • BotToRemove - The Bot to remove

WriteOnlineStats[edit]

function WriteOnlineStats ()

Overrides: UTDeathmatch.WriteOnlineStats

Writes out the stats for the game type