UE3:GameInfo (UT3)

Object >> Actor >> Info >> GameInfo

Package: 

Engine

Direct subclasses:

DemoGame, UTGame

This class in other games:

RTNP, U1, UT, UT2004, UE2Runtime, U2, U2XMP, UT2003, UDK

GameInfo.

The GameInfo defines the game being played: the game rules, scoring, what actors are allowed to exist in this game type, and who may enter the game. While the GameInfo class is the public interface, much of this functionality is delegated to several classes to allow easy modification of specific game components. These classes include GameInfo, AccessControl, Mutator, BroadcastHandler, and GameRules. A GameInfo actor is instantiated when the level is initialized for gameplay (in C++ UGameEngine::LoadMap() ). The class of this GameInfo actor is determined by (in order) either the URL ?game=xxx, or the DefaultGame entry in the game's .ini file (in the Engine.Engine section), unless its a network game in which case the DefaultServerGame entry is used. The GameType used can be overridden in the GameInfo script event SetGameType(), called on the game class picked by the above process.

Copyright 1998-2008 Epic Games, Inc. All Rights Reserved.

Properties

See GameInfo properties.

Delegates

CanUnpause

delegate bool CanUnpause ()

Default delegate that provides an implementation for those that don't have special needs other than a toggle

Functions

Static events

SetGameType

static event class<GameInfo> SetGameType (string MapName, string Options)

Other static functions

AllowMutator

static function bool AllowMutator (string MutatorClassName)

GetIntOption

static function int GetIntOption (string Options, string ParseString, int CurrentValue)

GetKeyValue

static function GetKeyValue (string Pair, out string Key, out string Value)

GrabOption

static function bool GrabOption (out string Options, out string Result)

HasOption

static function bool HasOption (string Options, string InKey)

ParseKillMessage

static function string ParseKillMessage (string KillerName, string VictimName, string DeathMessage)

ParseMessageString

static function string ParseMessageString (Controller Who, string Message)

ParseOption

static function string ParseOption (string Options, string InKey)

UseLowGore

static function bool UseLowGore (WorldInfo WI)

Exec functions

KillBots

exec function KillBots ()

Native functions

CurrentPlayerCount

native function int CurrentPlayerCount ()

DoNavFearCostFallOff

final native function DoNavFearCostFallOff ()

Update navigation point fear cost fall off.

GetNetworkNumber

native function string GetNetworkNumber ()

GetNextPlayerID

native final function int GetNextPlayerID ()

SwapPlayerControllers

native final function SwapPlayerControllers (PlayerController OldPC, PlayerController NewPC)

used to swap a viewport/connection's PlayerControllers when seamless travelling and the new gametype's controller class is different than the previous includes network handling

Parameters:

• OldPC - the old PC that should be discarded
• NewPC - the new PC that should be used for the player

Events

AcceptInventory

event AcceptInventory (Pawn PlayerPawn)

AddDefaultInventory

event AddDefaultInventory (Pawn P)

Broadcast

event Broadcast (Actor Sender, coerce string Msg, optional name Type)

BroadcastLocalized

event BroadcastLocalized (Actor Sender, class<LocalMessage> Message, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)

BroadcastLocalizedTeam

event BroadcastLocalizedTeam (int TeamIndex, Actor Sender, class<LocalMessage> Message, optional int Switch, optional PlayerReplicationInfo RelatedPRI_1, optional PlayerReplicationInfo RelatedPRI_2, optional Object OptionalObject)

GameEnding

event GameEnding ()

GetBeaconText

event string GetBeaconText ()

GetSeamlessTravelActorList

event GetSeamlessTravelActorList (bool bToEntry, out array<Actor> ActorList)

called on server during seamless level transitions to get the list of Actors that should be moved into the new level PlayerControllers, Role < ROLE_Authority Actors, and any non-Actors that are inside an Actor that is in the list (i.e. Object.Outer == Actor in the list) are all autmoatically moved regardless of whether they're included here only dynamic (!bStatic and !bNoDelete) actors in the PersistentLevel may be moved (this includes all actors spawned during gameplay) this is called for both parts of the transition because actors might change while in the middle (e.g. players might join or leave the game)

Parameters:

• bToEntry - true if we are going from old level -> entry, false if we are going from entry -> new level
• ActorList - out) list of actors to maintain

See: also PlayerController::GetSeamlessTravelActorList() (the function that's called on clients)

HandleSeamlessTravelPlayer

event HandleSeamlessTravelPlayer (out Controller C)

handles reinitializing players that remained through a seamless level transition called from C++ for players that finished loading after the server

Parameters:

• C - the Controller to handle

InitGame

event InitGame (string Options, out string ErrorMessage)

KickIdler

event KickIdler (PlayerController PC)

Login

event PlayerController Login (string Portal, string Options, out string ErrorMessage)

MatineeCancelled

event MatineeCancelled ()

Called when this PC is in cinematic mode, and its matinee is cancelled by the user.

PostBeginPlay

event PostBeginPlay ()

Overrides: Actor.PostBeginPlay

PostCommitMapChange

event PostCommitMapChange ()

Called from C++'s CommitMapChange after unloading previous level and loading new level+sublevels

PostLogin

event PostLogin (PlayerController NewPlayer)

PostSeamlessTravel

event PostSeamlessTravel ()

called after a seamless level transition has been completed on the *new* GameInfo used to reinitialize players already in the game as they won't have *Login() called on them

PreBeginPlay

event PreBeginPlay ()

Overrides: Actor.PreBeginPlay

PreCommitMapChange

event PreCommitMapChange (string PreviousMapName, string NextMapName)

Called from C++'s CommitMapChange before unloading previous level

Parameters:

• PreviousMapName - Name of the previous persistent level
• NextMapName - Name of the persistent level being streamed to

PreExit

event PreExit ()

Engine is shutting down.

PreLogin

event PreLogin (string Options, string Address, out string ErrorMessage)

Reset

event Reset ()

Overrides: Actor.Reset

Timer

event Timer ()

Overrides: Actor.Timer

Other instance functions

See GameInfo instance functions.

States

PendingMatch

This state is used to change the flow of start/end match to handle arbitration.

Basic flow of events:

• Server prepares to start the match and tells all clients to register arbitration
• Clients register with arbitration and tell the server when they are done
• Server checks for all clients to be registered and kicks any clients if they don't register in time.
• Server registers with arbitration and the match begins
• Match ends and the server tells connected clients to write arbitrated stats
• Clients write stats and notifies server of completion
• Server writes stats and ends the match

Modifiers: auto

PendingMatch.EndState

event EndState (name NextStateName)

Overrides: Object.EndState (global)

Called immediately before going out of the current state, while within the GotoState() call that caused the state change, and before BeginState() is called within the new state.

PendingMatch.ArbitrationRegistrationComplete

function ArbitrationRegistrationComplete (bool bWasSuccessful)

Overrides: ArbitrationRegistrationComplete (global)

Callback from the server that starts the match if the registration was successful. If not, it goes back to the menu

Parameters:

• bWasSuccessful - whether the registration worked or not

PendingMatch.ArbitrationTimeout

function ArbitrationTimeout ()

Handles kicking any clients that haven't completed handshaking

PendingMatch.MatchIsInProgress

function bool MatchIsInProgress ()

Overrides: MatchIsInProgress (global)

PendingMatch.ProcessClientRegistrationCompletion

function ProcessClientRegistrationCompletion (PlayerController PC, bool bWasSuccessful)

Overrides: ProcessClientRegistrationCompletion (global)

Removes the player controller from the pending list. Kicks that PC if it failed to register for arbitration. Starts the match if all clients have completed their registration

Parameters:

• PC - the player controller to mark as done
• bWasSuccessful - whether the PC was able to register for arbitration or not

PendingMatch.RegisterServerForArbitration

function RegisterServerForArbitration ()

Overrides: RegisterServerForArbitration (global)

Does the registration for the server. This must be done last as it includes all the players info from their registration

PendingMatch.StartArbitratedMatch

function StartArbitratedMatch ()

Overrides: StartArbitratedMatch (global)

Empty implementation of the code that starts an arbitrated match

PendingMatch.StartArbitrationRegistration

function StartArbitrationRegistration ()

Overrides: StartArbitrationRegistration (global)

Kicks off the async tasks of having the clients register with arbitration before the server does. Sets a timeout for when all slow to respond clients get kicked

PendingMatch.StartMatch

function StartMatch ()

Overrides: StartMatch (global)

Tells all of the currently connected clients to register with arbitration. The clients will call back to the server once they have done so, which will tell this state to see if it is time for the server to register with arbitration.