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

UE3:UTOnslaughtGame instance functions (UT3)

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
UT3 Object >> Actor >> Info >> GameInfo >> UTGame >> UTDeathmatch >> UTTeamGame >> UTOnslaughtGame (instance functions)

Instance functions[edit]

ActivateVehicleFactory[edit]

function ActivateVehicleFactory (UTVehicleFactory VF)

Overrides: UTGame.ActivateVehicleFactory

In Onslaught, vehicle factories are activated by active powernodes

AddBot[edit]

function UTBot AddBot (optional string BotName, optional bool bUseTeamIndex, optional int TeamIndex)

Overrides: UTGame.AddBot


AdjustOnslaughtSkill[edit]

function AdjustOnslaughtSkill ()

Adjust skill level in campaign based on relative health of cores

AllowClientToTeleport[edit]

function bool AllowClientToTeleport (UTPlayerReplicationInfo ClientPRI, Actor DestinationActor)

Overrides: UTTeamGame.AllowClientToTeleport

(Description copied from UTTeamGame.AllowClientToTeleport)
This function allows the server to override any requested teleport attempts from a client

Returns:

returns true if the teleport is allowed

BestPlayerStartAtNode[edit]

function PlayerStart BestPlayerStartAtNode (UTGameObjective SelectedPC, byte Team, Controller Player)


ChangeTeam[edit]

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

Overrides: UTTeamGame.ChangeTeam

(Description copied from UTTeamGame.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: UTTeamGame.CheckEndGame


CheckScore[edit]

function bool CheckScore (PlayerReplicationInfo Scorer)

Overrides: UTTeamGame.CheckScore


CheckSevering[edit]

function CheckSevering (UTOnslaughtNodeObjective PC, int TeamIndex)


ChoosePlayerStart[edit]

function PlayerStart ChoosePlayerStart (Controller Player, optional byte InTeam)

Overrides: UTGame.ChoosePlayerStart

ChoosePlayerStart() Return the 'best' player start for this player to start from. PlayerStarts are rated by RatePlayerStart().

Parameters:

  • Player - is the controller for whom we are choosing a playerstart
  • InTeam - specifies the Player's team (if the player hasn't joined a team yet)

Returns:

NavigationPoint chosen as player start (usually a PlayerStart)

ClosestNodeTo[edit]

function UTOnslaughtNodeObjective ClosestNodeTo (Actor A)


ClosestObjectiveTo[edit]

function UTOnslaughtObjective ClosestObjectiveTo (Actor A)


CreateTeam[edit]

function CreateTeam (int TeamIndex)

Overrides: UTTeamGame.CreateTeam


DominatingVictory[edit]

function bool DominatingVictory ()

Overrides: UTTeamGame.DominatingVictory


FindCloseActors[edit]

function FindCloseActors ()


FindNewObjectives[edit]

function FindNewObjectives (UTGameObjective DisabledObjective)

Overrides: UTTeamGame.FindNewObjectives

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

GetAutoObjectiveFor[edit]

function Actor GetAutoObjectiveFor (UTPlayerController PC)

Overrides: UTGame.GetAutoObjectiveFor

(Description copied from UTGame.GetAutoObjectiveFor)


Returns:

an objective that should be recommended to the given player based on their auto objective settings and the current game state

GetBestLocker[edit]

function UTWeaponLocker GetBestLocker (Pawn PlayerPawn)

Overrides: UTGame.GetBestLocker


GetClosestNodeToEnemyWithVehicles[edit]

function UTGameObjective GetClosestNodeToEnemyWithVehicles (Controller Player, const out array<intNumVehicleFactories)

finds the closest node to the enemy powercore that has vehicles available according to the passed in array may return None if no node with vehicles is available for that team

Parameters:

  • Player - the Player we're choosing a node for
  • NumVehicleFactories -

GetCurrentMapCycleIndex[edit]

function int GetCurrentMapCycleIndex (const out array<stringMapList)

Overrides: UTGame.GetCurrentMapCycleIndex

(Description copied from UTGame.GetCurrentMapCycleIndex)


Returns:

the index of the current map in the given list (used when starting up a server to start counting at the current map)

GetHandicapNeed[edit]

function int GetHandicapNeed (Pawn Other)

Overrides: UTTeamGame.GetHandicapNeed

return a value based on how much this pawn needs help

GetNextMap[edit]

function string GetNextMap ()

Overrides: UTGame.GetNextMap

Returns the next map to play. If we are in story mode, we need to go back to the map selection menu

InitGameReplicationInfo[edit]

function InitGameReplicationInfo ()

Overrides: UTGame.InitGameReplicationInfo


IsTouchingNodeTeleporter[edit]

function bool IsTouchingNodeTeleporter (Pawn P, optional out UTOnslaughtNodeTeleporter Teleporter)

Returns:

whether the given Pawn is touching/walking on an Actor that allows node teleporting

MainCoreDestroyed[edit]

function MainCoreDestroyed (byte T)


NearGoal[edit]

function bool NearGoal (Controller C)

Overrides: UTTeamGame.NearGoal

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

ScoreDraw[edit]

function ScoreDraw ()


ScoreFlag[edit]

function ScoreFlag (Controller Scorer, UTOnslaughtFlag TheFlag)


ScoreObjective[edit]

function ScoreObjective (PlayerReplicationInfo Scorer, int Score)

Overrides: GameInfo.ScoreObjective


SetEndGameFocus[edit]

function SetEndGameFocus (PlayerReplicationInfo Winner)

Overrides: UTTeamGame.SetEndGameFocus


SetPowerCores[edit]

function SetPowerCores ()


ShouldPrioritizeNodeWithFlag[edit]

function bool ShouldPrioritizeNodeWithFlag (byte Team, byte EnemyTeam, bool bEnemyCanAttackCore, Controller Player)

returns whether a node with a flag at it should be prioritized for spawning members of Team

ShouldReset[edit]

function bool ShouldReset (Actor ActorToReset)

Overrides: GameInfo.ShouldReset

(Description copied from GameInfo.ShouldReset)


Returns:

true if ActorToReset should have Reset() called on it while restarting the game, false if the GameInfo will manually reset it or if the actor does not need to be reset

ShowPathTo[edit]

function ShowPathTo (PlayerController P, int TeamNum)

Overrides: UTTeamGame.ShowPathTo

displays the path to the given base for the given player

StartAllPlayers[edit]

function StartAllPlayers ()


StartBots[edit]

function StartBots ()

Overrides: GameInfo.StartBots


StartHumans[edit]

function StartHumans ()

Overrides: GameInfo.StartHumans


TeamHasOrbRunner[edit]

function bool TeamHasOrbRunner (Controller Player)


UpdateLinks[edit]

function UpdateLinks ()


UpdateNodePlayerCountRequirements[edit]

function UpdateNodePlayerCountRequirements (bool bAllowDuringGame)

update the state of nodes with player count requirements because the number of players in the game has changed

ViewObjective[edit]

function ViewObjective (PlayerController PC)

Overrides: UTGame.ViewObjective