I search for solutions in this order: Past Code, Unreal Source, Wiki, BUF, groups.yahoo, google, screaming at monitor. – RegularX

Difference between revisions of "UE3:GameInfo instance functions (UDK)"

From Unreal Wiki, The Unreal Engine Documentation Site
Jump to: navigation, search
(Talk)
 
(Talk)
Line 140: Line 140:
  
 
<!-- enter function description -->
 
<!-- enter function description -->
 +
 +
====DisplayDebug====
 +
{{code|simulated function '''DisplayDebug''' ({{cl|HUD}}&nbsp;'''HUD''', out&nbsp;[[float]]&nbsp;'''out_YL''', out&nbsp;[[float]]&nbsp;'''out_YPos''')}}
 +
 +
'''Overrides:''' {{tl|DisplayDebug|Actor|instance functions}}
 +
 +
Use 'ShowGameDebug' console command to show this debug info
 +
Useful to show general debug info not tied to a particular actor physically in the level.
  
 
====DriverEnteredVehicle====
 
====DriverEnteredVehicle====
Line 605: Line 613:
  
 
====TellClientsToReturnToPartyHost====
 
====TellClientsToReturnToPartyHost====
−
{{code|function '''TellClientsToReturnToPartyHost''' (optional&nbsp;{{cl|PlayerReplicationInfo}}&nbsp;'''PartyLeader''')}}
+
{{code|function '''TellClientsToReturnToPartyHost''' ()}}
  
 
Iterates the player controllers and tells them to return to their party
 
Iterates the player controllers and tells them to return to their party
−
 
−
'''Parameters:'''
 
−
* ''PartyLeader'' - if specified, only clients in the specified player's party will leave; otherwise, all players will leave.
 
  
 
====TellClientsToTravelToSession====
 
====TellClientsToTravelToSession====

Revision as of 05:24, 17 January 2010

UDK Object >> Actor >> Info >> GameInfo (instance functions)

Contents

GameInfo instance functions in other games:
RTNP, U1, UT, U2, U2XMP, UE2Runtime, UT2003, UT2004, UT3
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

AddInactivePRI

function AddInactivePRI (PlayerReplicationInfo PRI, PlayerController PC)

AddInactivePRI() Add PRI to the inactive list, remove from the active list

AddMutator

function AddMutator (string mutname, optional bool bUserAdded)


AddObjectiveScore

function AddObjectiveScore (PlayerReplicationInfo Scorer, int Score)


AllowCheats

function bool AllowCheats (PlayerController P)


AllowPausing

function bool AllowPausing (optional PlayerController PC)

Returns:

TRUE if the player is allowed to pause the game.

ArbitrationRegistrationComplete

function ArbitrationRegistrationComplete (name SessionName, bool bWasSuccessful)

Empty implementation of the code that handles the callback for completion

Parameters:

  • SessionName - the name of the session this is for
  • bWasSuccessful - whether the call worked or not

AtCapacity

function bool AtCapacity (bool bSpectator)


BroadcastDeathMessage

function BroadcastDeathMessage (Controller Killer, Controller Other, class<DamageType> damageType)


BroadcastTeam

function BroadcastTeam (Controller Sender, coerce string Msg, optional name Type)


CalculatedNetSpeed

function int CalculatedNetSpeed ()


CanLeaveVehicle

function bool CanLeaveVehicle (Vehicle V, Pawn P)


CanSpectate

function bool CanSpectate (PlayerController Viewer, PlayerReplicationInfo ViewTarget)


ChangeName

function ChangeName (Controller Other, coerce string S, bool bNameChange)


ChangeTeam

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


CheckEndGame

function bool CheckEndGame (PlayerReplicationInfo Winner, string Reason)


CheckForSentinelRun

function bool CheckForSentinelRun ()

Asks AutoTestManager to start a sentinel run if needed

Must be called by gameinfo subclass - not called in base implementation of GameInfo.StartMatch()

Returns:

true if should skip normal startmatch process

CheckModifiedEndGame

function bool CheckModifiedEndGame (PlayerReplicationInfo Winner, string Reason)


CheckRelevance

function bool CheckRelevance (Actor Other)


CheckScore

function bool CheckScore (PlayerReplicationInfo Scorer)


ChoosePlayerStart

function PlayerStart ChoosePlayerStart (Controller Player, optional byte InTeam)

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

function ClearAutoLoginDelegates ()

Clears the login delegates once the login process has passed or failed

DebugPause

function DebugPause ()

Dumps the pause delegate list to track down who has the game paused

DiscardInventory

function DiscardInventory (Pawn Other, optional Controller Killer)


DisplayDebug

simulated function DisplayDebug (HUD HUD, out float out_YL, out float out_YPos)

Overrides: Actor.DisplayDebug

Use 'ShowGameDebug' console command to show this debug info

Useful to show general debug info not tied to a particular actor physically in the level.

DriverEnteredVehicle

function DriverEnteredVehicle (Vehicle V, Pawn P)


DriverLeftVehicle

function DriverLeftVehicle (Vehicle V, Pawn P)


EndGame

function EndGame (PlayerReplicationInfo Winner, string Reason)


EndLogging

function EndLogging (string Reason)


EndOnlineGame

function EndOnlineGame ()

Tells the online system to end the game and tells all clients to do the same

FindInactivePRI

function bool FindInactivePRI (PlayerController PC)

FindInactivePRI() returns the PRI associated with this re-entering player

FindPlayerByID

function string FindPlayerByID (int PlayerID)


FindPlayerStart

function NavigationPoint FindPlayerStart (Controller Player, optional byte InTeam, optional string IncomingName)

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)

GenericPlayerInitialization

function GenericPlayerInitialization (Controller C)

handles all player initialization that is shared between the travel methods (i.e. called from both PostLogin() and HandleSeamlessTravelPlayer())

GetCoverReplicator

function CoverReplicator GetCoverReplicator ()


GetDefaultPlayerClass

function class<Pawn> GetDefaultPlayerClass (Controller C)

Returns the default pawn class for the specified controller,

Parameters:

  • C - controller to figure out pawn class for

Returns:

default pawn class

GetNextMap

function string GetNextMap ()

Returns:

the map we should travel to for the next game

GetNumPlayers

function int GetNumPlayers ()


GetServerPort

function int GetServerPort ()


GetTravelType

function bool GetTravelType ()

Returns true if we want to travel_absolute

InitGameReplicationInfo

function InitGameReplicationInfo ()


IsAutomatedPerfTesting

function bool IsAutomatedPerfTesting ()


IsCheckingForFragmentation

function bool IsCheckingForFragmentation ()

Returns:

true if checking for fragmentation is enabled

IsCheckingForMemLeaks

function bool IsCheckingForMemLeaks ()

Returns:

true if checking for memory leaks is enabled

IsDoingASentinelRun

function bool IsDoingASentinelRun ()

Returns:

true if doing a sentinel run

Kick

function Kick (string S)


KickBan

function KickBan (string S)


Killed

function Killed (Controller Killer, Controller KilledPlayer, Pawn KilledPawn, class<DamageType> damageType)


Logout

function Logout (Controller Exiting)


MatchIsInProgress

function bool MatchIsInProgress ()


ModifyScoreKill

function ModifyScoreKill (Controller Killer, Controller Other)

For subclasses which don't call GameInfo.ScoreKill()

Mutate

function Mutate (string MutateString, PlayerController Sender)


NotifyArbitratedMatchEnd

function NotifyArbitratedMatchEnd ()


NotifyKilled

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


NotifyNavigationChanged

function NotifyNavigationChanged (NavigationPoint N)

notification when a NavigationPoint becomes blocked or unblocked

OnLoginChange

function OnLoginChange (byte LocalUserNum)

Used to tell the game when the autologin has completed

Parameters:

  • LocalUserNum - ignored

OnLoginFailed

function OnLoginFailed (byte LocalUserNum, OnlineSubsystem.EOnlineServerConnectionStatus ErrorCode)

Called if the autologin fails

Parameters:

  • LocalUserNum - the controller number of the associated user
  • ErrorCode - the async error code that occurred

OnServerCreateComplete

function OnServerCreateComplete (name SessionName, bool bWasSuccessful)

Notifies us of the game being registered successfully or not

Parameters:

  • SessionName - the name of the session that was created
  • bWasSuccessful - flag telling us whether it worked or not

OnStartOnlineGameComplete

function OnStartOnlineGameComplete (name SessionName, bool bWasSuccessful)

Callback when the start completes

Parameters:

  • SessionName - the name of the session this is for
  • bWasSuccessful - true if it worked, false otherwise

OverridePRI

function OverridePRI (PlayerController PC, PlayerReplicationInfo OldPRI)

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

PerformEndGameHandling

function PerformEndGameHandling ()

Does end of game handling for the online layer

PickTeam

function byte PickTeam (byte Current, Controller C)


PickupQuery

function bool PickupQuery (Pawn Other, class<Inventory> ItemClass, Actor Pickup)

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

function bool PlayerCanRestart (PlayerController aPlayer)


PlayerCanRestartGame

function bool PlayerCanRestartGame (PlayerController aPlayer)


PreventDeath

function bool PreventDeath (Pawn KilledPawn, Controller Killer, class<DamageType> DamageType, Object.Vector HitLocation)


ProcessClientRegistrationCompletion

function ProcessClientRegistrationCompletion (PlayerController PC, bool bWasSuccessful)

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

ProcessClientTravel

function PlayerController ProcessClientTravel (out string URL, Object.Guid NextMapGuid, bool bSeamless, bool bAbsolute)

Notifies all clients to travel to the specified URL.

Parameters:

  • URL - a string containing the mapname (or IP address) to travel to, along with option key/value pairs
  • NextMapGuid - the GUID of the server's version of the next map
  • bSeamless - indicates whether the travel should use seamless travel or not.
  • bAbsolute - indicates which type of travel the server will perform (i.e. TRAVEL_Relative or TRAVEL_Absolute)

ProcessServerLogin

function bool ProcessServerLogin ()

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

function ProcessServerTravel (string URL, optional bool bAbsolute)


RatePlayerStart

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

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

function RecalculateSkillRating ()

Used by the game type to update the advertised skill for this game

ReduceDamage

function ReduceDamage (out int Damage, Pawn injured, Controller instigatedBy, Object.Vector HitLocation, out Object.Vector Momentum, class<DamageType> DamageType, Actor DamageCauser)


RegisterServer

function RegisterServer ()

Registers the dedicated server with the online service

RegisterServerForArbitration

function RegisterServerForArbitration ()

Empty implementation of the code that registers the server for arbitration

RemoveMutator

function RemoveMutator (Mutator MutatorToRemove)


ReplicateStreamingStatus

function ReplicateStreamingStatus (PlayerController PC)

replicates the current level streaming status to the given PlayerController

RequiresPassword

function bool RequiresPassword ()


ResetLevel

function ResetLevel ()

Resets level by calling Reset() on all actors

RestartGame

function RestartGame ()


RestartPlayer

function RestartPlayer (Controller NewPlayer)


ScoreKill

function ScoreKill (Controller Killer, Controller Other)


ScoreObjective

function ScoreObjective (PlayerReplicationInfo Scorer, int Score)


SendPlayer

function SendPlayer (PlayerController aPlayer, string URL)


SetGameSpeed

function SetGameSpeed (float T)


SetPause

function bool SetPause (PlayerController PC, optional delegate<CanUnpause> CanUnpauseDelegate)

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

function SetPlayerDefaults (Pawn PlayerPawn)


SetSeamlessTravelViewTarget

function SetSeamlessTravelViewTarget (PlayerController PC)


ShouldAutoContinueToNextRound

function bool ShouldAutoContinueToNextRound ()

Returns:

true if should auto-continue to next round

ShouldReset

function bool ShouldReset (Actor ActorToReset)

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

function bool ShouldRespawn (PickupFactory Other)


ShouldSpawnAtStartSpot

function bool ShouldSpawnAtStartSpot (Controller Player)

returns whether the given Controller StartSpot property should be used as the spawn location for its Pawn

SpawnDefaultPawnFor

function Pawn SpawnDefaultPawnFor (Controller NewPlayer, NavigationPoint StartSpot)

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

SpawnPlayerController

function PlayerController SpawnPlayerController (Object.Vector SpawnLocation, Object.Rotator SpawnRotation)

spawns a PlayerController at the specified location; split out from Login()/HandleSeamlessTravelPlayer() for easier overriding

StartArbitratedMatch

function StartArbitratedMatch ()

Empty implementation of the code that starts an arbitrated match

StartArbitrationRegistration

function StartArbitrationRegistration ()

Empty implementation of the code that kicks off async registration

StartBots

function StartBots ()


StartHumans

function StartHumans ()


StartMatch

function StartMatch ()


StartOnlineGame

function StartOnlineGame ()

Tells the online system to start the game and waits for the callback. Tells each connected client to mark their session as in progress

TellClientsToReturnToPartyHost

function TellClientsToReturnToPartyHost ()

Iterates the player controllers and tells them to return to their party

TellClientsToTravelToSession

function TellClientsToTravelToSession (name SessionName, class<OnlineGameSearch> SearchClass, byte PlatformSpecificInfo[68])

Iterates the player controllers and tells remote players to travel to the specified session

Parameters:

  • SessionName - the name of the session to register
  • SearchClass - the search that should be populated with the session
  • PlatformSpecificInfo - the binary data to place in the platform specific areas

UnregisterPlayer

function UnregisterPlayer (PlayerController PC)

Removes the player from the named session when they leave

Parameters:

  • PC - the player controller that just left

UpdateGameplayMuteList

function UpdateGameplayMuteList (PlayerController PC)

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

function UpdateGameSettings ()

Used to update any changes in game settings that need to be published to players that are searching for games

UpdateGameSettingsCounts

function UpdateGameSettingsCounts ()

Updates the online subsystem's information for player counts so that LAN matches can show the correct player counts

UpdateNetSpeeds

function UpdateNetSpeeds ()


WriteOnlinePlayerScores

function WriteOnlinePlayerScores ()

If the match is arbitrated, tells all clients to write out their copies of the player scores. If not arbitrated, it only has the first local player write the scores.

WriteOnlineStats

function WriteOnlineStats ()

Tells all clients to write stats and then handles writing local stats

Retrieved from "https://wiki.beyondunreal.com/UE3:GameInfo_instance_functions_(UDK)?oldid=40932"