Mostly Harmless
UE3:GameInfo instance functions (UT3)
Contents
- 1 Instance functions
- 1.1 AddGameRules
- 1.2 AddInactivePRI
- 1.3 AddMutator
- 1.4 AddObjectiveScore
- 1.5 AllowCheats
- 1.6 ArbitrationRegistrationComplete
- 1.7 AtCapacity
- 1.8 AttemptReconnect
- 1.9 BeginPlay
- 1.10 BroadcastDeathMessage
- 1.11 BroadcastTeam
- 1.12 CalculatedNetSpeed
- 1.13 CanLeaveVehicle
- 1.14 CanSpectate
- 1.15 ChangeName
- 1.16 ChangeTeam
- 1.17 CheckEndGame
- 1.18 CheckModifiedEndGame
- 1.19 CheckRelevance
- 1.20 CheckScore
- 1.21 ChoosePlayerStart
- 1.22 ClearAutoLoginDelegates
- 1.23 ClearPause
- 1.24 DebugPause
- 1.25 DiscardInventory
- 1.26 DriverEnteredVehicle
- 1.27 DriverLeftVehicle
- 1.28 EnableAutoReconnect
- 1.29 EndGame
- 1.30 FindInactivePRI
- 1.31 FindPlayerByID
- 1.32 FindPlayerStart
- 1.33 GetCoverReplicator
- 1.34 GetDefaultPlayerClass
- 1.35 GetNextMap
- 1.36 GetNumPlayers
- 1.37 GetServerPort
- 1.38 GetTravelType
- 1.39 InitGameReplicationInfo
- 1.40 Kick
- 1.41 KickBan
- 1.42 Killed
- 1.43 Logout
- 1.44 MatchIsInProgress
- 1.45 ModifyScoreKill
- 1.46 Mutate
- 1.47 NotifyArbitratedMatchEnd
- 1.48 NotifyKilled
- 1.49 NotifyNavigationChanged
- 1.50 OnConnectionStatusChange
- 1.51 OnDestroyOnlineGameComplete
- 1.52 OnLoginChange
- 1.53 OnLoginFailed
- 1.54 OnServerCreateComplete
- 1.55 OnStartOnlineGameComplete
- 1.56 OverridePRI
- 1.57 PickFriendTeam
- 1.58 PickTeam
- 1.59 PickupQuery
- 1.60 PlayerCanRestart
- 1.61 PlayerCanRestartGame
- 1.62 PreventDeath
- 1.63 ProcessClientDataWriteCompletion
- 1.64 ProcessClientRegistrationCompletion
- 1.65 ProcessEndGameHandshake
- 1.66 ProcessServerLogin
- 1.67 ProcessServerTravel
- 1.68 RatePlayerStart
- 1.69 RecalculateSkillRating
- 1.70 ReduceDamage
- 1.71 RegisterServer
- 1.72 RegisterServerForArbitration
- 1.73 RemoveMutator
- 1.74 ReplicateStreamingStatus
- 1.75 RequiresPassword
- 1.76 ResetLevel
- 1.77 ResetLog
- 1.78 RestartGame
- 1.79 RestartPlayer
- 1.80 ScoreKill
- 1.81 ScoreObjective
- 1.82 SendPlayer
- 1.83 ServerWriteArbitrationEndGameData
- 1.84 SessionBan
- 1.85 SetGameSpeed
- 1.86 SetPause
- 1.87 SetPlayerDefaults
- 1.88 ShouldReset
- 1.89 ShouldRespawn
- 1.90 ShouldSpawnAtStartSpot
- 1.91 SpawnDefaultPawnFor
- 1.92 StartArbitratedMatch
- 1.93 StartArbitrationRegistration
- 1.94 StartBots
- 1.95 StartHumans
- 1.96 StartMatch
- 1.97 StartOnlineGame
- 1.98 TravelFailed
- 1.99 UpdateGameplayMuteList
- 1.100 UpdateGameSettings
- 1.101 UpdateGameSettingsCounts
- 1.102 UpdateNetSpeeds
- 1.103 WriteOnlinePlayerScores
- 1.104 WriteOnlineStats
- GameInfo instance functions in other games:
- RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UDK
- Other member categories for this class:
- properties
This is an auto-generated page and may need human attention. Please remove the {{autogenerated}} tag if the page seems reasonably complete or replace it with the {{expand}} tag if the page is not yet complete. |
Instance functions[edit]
AddGameRules[edit]
AddInactivePRI[edit]
AddInactivePRI() Add PRI to the inactive list, remove from the active list
AddMutator[edit]
AddObjectiveScore[edit]
AllowCheats[edit]
ArbitrationRegistrationComplete[edit]
Empty implementation of the code that handles the callback for completion
AtCapacity[edit]
AttemptReconnect[edit]
BeginPlay[edit]
BroadcastDeathMessage[edit]
BroadcastTeam[edit]
CalculatedNetSpeed[edit]
CanLeaveVehicle[edit]
CanSpectate[edit]
ChangeName[edit]
ChangeTeam[edit]
CheckEndGame[edit]
CheckModifiedEndGame[edit]
CheckRelevance[edit]
CheckScore[edit]
ChoosePlayerStart[edit]
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)
ClearAutoLoginDelegates[edit]
Clears the login delegates once the login process has passed or failed
ClearPause[edit]
Checks the list of delegates to determine if the pausing can be cleared. If the delegate says it's ok to unpause, that delegate is removed from the list and the rest are checked. The game is considered unpaused when the list is empty.
DebugPause[edit]
Dumps the pause delegate list to track down who has the game paused
DiscardInventory[edit]
DriverEnteredVehicle[edit]
DriverLeftVehicle[edit]
EnableAutoReconnect[edit]
EndGame[edit]
FindInactivePRI[edit]
FindInactivePRI() returns the PRI associated with this re-entering player
FindPlayerByID[edit]
FindPlayerStart[edit]
FindPlayerStart() 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)
- IncomingName - specifies the tag of a teleporter to use as the Playerstart
Returns:
- NavigationPoint chosen as player start (usually a PlayerStart)
GetCoverReplicator[edit]
GetDefaultPlayerClass[edit]
Returns the default pawn class for the specified controller,
Parameters:
- C - controller to figure out pawn class for
Returns:
- default pawn class
GetNextMap[edit]
Returns:
- the map we should travel to for the next game
GetNumPlayers[edit]
GetServerPort[edit]
GetTravelType[edit]
Returns true if we want to travel_absolute
InitGameReplicationInfo[edit]
Kick[edit]
KickBan[edit]
Killed[edit]
Logout[edit]
MatchIsInProgress[edit]
ModifyScoreKill[edit]
For subclasses which don't call GameInfo.ScoreKill()
Mutate[edit]
NotifyArbitratedMatchEnd[edit]
Tells all clients to disconnect and then goes to the menu
NotifyKilled[edit]
[edit]
notification when a NavigationPoint becomes blocked or unblocked
OnConnectionStatusChange[edit]
Delegate fired when the online server connection state changes
Parameters:
- ConnectionStatus - the new connection status
OnDestroyOnlineGameComplete[edit]
OnLoginChange[edit]
Used to tell the game when the autologin has completed
OnLoginFailed[edit]
Called if the autologin fails
Parameters:
- LocalUserNum - the controller number of the associated user
- ErrorCode - the async error code that occurred
OnServerCreateComplete[edit]
Notifies us of the game being registered successfully or not
Parameters:
- bWasSuccessful - flag telling us whether it worked or not
OnStartOnlineGameComplete[edit]
Callback when the start completes
Parameters:
- bWasSuccessful - true if it worked, false otherwise
OverridePRI[edit]
OverridePRI() override as needed properties of NewPRI with properties from OldPRI which were assigned during the login process
PickFriendTeam[edit]
PickTeam[edit]
PickupQuery[edit]
PickupQuery: Called when pawn has a chance to pick Item up (i.e. when the pawn touches a weapon pickup). Should return true if he wants to pick it up, false if he does not want it.
Parameters:
- Other - the Pawn that wants the item
- ItemClass - the Inventory class the Pawn can pick up
- Pickup - the Actor containing that item (this may be a PickupFactory or it may be a DroppedPickup)
Returns:
- whether or not the Pickup actor should give its item to Other
PlayerCanRestart[edit]
PlayerCanRestartGame[edit]
PreventDeath[edit]
ProcessClientDataWriteCompletion[edit]
Removes the specified client from the pending list and tells the game to restart once all clients have notified
Parameters:
- PC - the player controller that completed the write
ProcessClientRegistrationCompletion[edit]
This is a base (empty) implementation of the completion notification
Parameters:
- PC - the player controller to mark as done
- bWasSuccessful - whether the PC was able to register for arbitration or not
ProcessEndGameHandshake[edit]
ProcessServerLogin[edit]
Checks for the login parameters being passed on the command line. If present, it does an async login before starting the dedicated server registration process
Returns:
- true if the login is in progress, false otherwise
ProcessServerTravel[edit]
RatePlayerStart[edit]
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
RecalculateSkillRating[edit]
Used by the game type to update the advertised skill for this game
ReduceDamage[edit]
RegisterServer[edit]
Registers the dedicated server with the online service
RegisterServerForArbitration[edit]
Empty implementation of the code that registers the server for arbitration
RemoveMutator[edit]
ReplicateStreamingStatus[edit]
replicates the current level streaming status to the given PlayerController
RequiresPassword[edit]
ResetLevel[edit]
Resets level by calling Reset() on all actors
ResetLog[edit]
RestartGame[edit]
RestartPlayer[edit]
ScoreKill[edit]
ScoreObjective[edit]
SendPlayer[edit]
ServerWriteArbitrationEndGameData[edit]
Commits arbitration data for the server and restarts the match
SessionBan[edit]
SetGameSpeed[edit]
SetPause[edit]
Adds the delegate to the list if the player controller has the right to pause the game. The delegate is called to see if it is ok to unpause the game, e.g. the reason the game was paused has been cleared.
Parameters:
- PC - the player controller to check for admin privs
- CanUnpauseDelegate - the delegate to query when checking for unpause
SetPlayerDefaults[edit]
ShouldReset[edit]
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
ShouldRespawn[edit]
ShouldSpawnAtStartSpot[edit]
returns whether the given Controller StartSpot property should be used as the spawn location for its Pawn
SpawnDefaultPawnFor[edit]
Returns a pawn of the default pawn class
Parameters:
- NewPlayer - Controller for whom this pawn is spawned
- StartSpot - PlayerStart at which to spawn pawn
Returns:
- pawn
StartArbitratedMatch[edit]
Empty implementation of the code that starts an arbitrated match
StartArbitrationRegistration[edit]
Empty implementation of the code that kicks off async registration
StartBots[edit]
StartHumans[edit]
StartMatch[edit]
StartOnlineGame[edit]
Tells the online system to start the game and waits for the callback. Tells each connected client to register their
TravelFailed[edit]
Called from the WorldInfo when travelling fails
UpdateGameplayMuteList[edit]
Used to notify the game type that it is ok to update a player's gameplay specific muting information now. The playercontroller needs to notify the server when it is possible to do so or the unique net id will be incorrect and the muting not work.
Parameters:
- PC - the playercontroller that is ready for updates
UpdateGameSettings[edit]
Used to update any changes in game settings that need to be published to players that are searching for games
UpdateGameSettingsCounts[edit]
Updates the online subsystem's information for player counts so that LAN matches can show the correct player counts
UpdateNetSpeeds[edit]
WriteOnlinePlayerScores[edit]
Overload this method so that your game writes out player scores
WriteOnlineStats[edit]
Overload this method so that your game writes out stats