Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |
00001 00002 00003 00004 00005 00006 00007 00008 00009 00010 00011 00012 00013 00014 00015 00016 00017 00018 00019 00020 00021 00022 00023 00024 00025 00026 00027 00028 00029 00030 00031 00032 00033 00034 00035 00036 00037 00038 00039 00040 00041 00042 00043 00044 00045 00046 00047 00048 00049 00050 00051 00052 00053 00054 00055 00056 00057 00058 00059 00060 00061 00062 00063 00064 00065 00066 00067 00068 00069 00070 00071 00072 00073 00074 00075 00076 00077 00078 00079 00080 00081 00082 00083 00084 00085 00086 00087 00088 00089 00090 00091 00092 00093 00094 00095 00096 00097 00098 00099 00100 00101 00102 00103 00104 00105 00106 00107 00108 00109 00110 00111 00112 00113 00114 00115 00116 00117 00118 00119 00120 00121 00122 00123 00124 00125 00126 00127 00128 00129 00130 00131 00132 00133 00134 00135 00136 00137 00138 00139 00140 00141 00142 00143 00144 00145 00146 00147 00148 00149 00150 00151 00152 00153 00154 00155 00156 00157 00158 00159 00160 00161 00162 00163 00164 00165 00166 00167 00168 00169 00170 00171 00172 00173 00174 00175 00176 00177 00178 00179 00180 00181 00182 00183 00184 00185 00186 00187 00188 00189 00190 00191 00192 00193 00194 00195 00196 00197 00198 00199 00200 00201 00202 00203 00204 00205 00206 00207 00208 00209 00210 00211 00212 00213 00214 00215 00216 00217 00218 00219 00220 00221 00222 00223 00224 00225 00226 00227 00228 00229 00230 00231 00232 00233 00234 00235 00236 00237 00238 00239 00240 00241 00242 00243 00244 00245 00246 00247 00248 00249 00250 00251 00252 00253 00254 00255 00256 00257 00258 00259 00260 00261 00262 00263 00264 00265 00266 00267 00268 00269 00270 00271 00272 00273 00274 00275 00276 00277 00278 00279 00280 00281 00282 00283 00284 00285 00286 00287 00288 00289 00290 00291 00292 00293 00294 00295 00296 00297 00298 00299 00300 00301 00302 00303 00304 00305 00306 00307 00308 00309 00310 00311 00312 00313 00314 00315 00316 00317 00318 00319 00320 00321 00322 00323 00324 00325 00326 00327 00328 00329 00330 00331 00332 00333 00334 00335 00336 00337 00338 00339 00340 00341 00342 00343 00344 00345 00346 00347 00348 00349 00350 00351 00352 00353 00354 00355 00356 00357 00358 00359 00360 00361 00362 00363 00364 00365 00366 00367 00368 00369 00370 00371 00372 00373 00374 00375 00376 00377 00378 00379 00380 00381 00382 00383 00384 00385 00386 00387 00388 00389 00390 00391 00392 00393 00394 00395 00396 00397 00398 00399 00400 00401 00402 00403 00404 00405 00406 00407 00408 00409 00410 00411 00412 00413 00414 00415 00416 00417 00418 00419 00420 00421 00422 00423 00424 00425 00426 00427 00428 00429 00430 00431 00432 00433 00434 00435 00436 00437 00438 00439 00440 00441 00442 00443 00444 00445 00446 00447 00448 00449 00450 00451 00452 00453 00454 00455 00456 00457 00458 00459 00460 00461 00462 00463 00464 00465 00466 00467 00468 00469 00470 00471 00472 00473 00474 00475 00476 00477 00478 00479 00480 00481 00482 00483 00484 00485 00486 00487 00488 00489 00490 00491 00492 00493 00494 00495 00496 00497 00498 00499 00500 00501 00502 00503 00504 00505 00506 00507 00508 00509 00510 00511 00512 00513 00514 00515 00516 00517 00518 00519 |
/** * Provides data about the current game. * * Copyright 1998-2008 Epic Games, Inc. All Rights Reserved. */ class CurrentGameDataStore extends UIDataStore_GameState native(inherit); #linenumber 9 // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) // (cpptext) /** * Contains the classes which should be used for instancing data providers. */ struct native GameDataProviderTypes { /** * the class to use for the game info data provider */ var const class<GameInfoDataProvider> GameDataProviderClass; /** * the class to use for the player data providers */ var const class<PlayerDataProvider> PlayerDataProviderClass; /** * the class to use for the team data provider. */ var const class<TeamDataProvider> TeamDataProviderClass; }; var const GameDataProviderTypes ProviderTypes; /** * The GameInfoDataProvider that manages access to the current gameinfo's exposed data. */ var protected GameInfoDataProvider GameData; /** * The data providers for all players in the current match */ var protected array<PlayerDataProvider> PlayerData; /** * The data providers for all teams in the current match. */ var protected array<TeamDataProvider> TeamData; /** * Creates the GameInfoDataProvider that will track all game info state data */ final function CreateGameDataProvider( GameReplicationInfo GRI ) { if ( GRI != None ) { GameData = new ProviderTypes.GameDataProviderClass; if ( !GameData.BindProviderInstance(GRI) ) { LogInternal(Name$"::"$GetFuncName()@"Failed to bind GameReplicationInfo to game data store:"@"GRI:"$(GRI!= None ? string(GRI.Name) : "None"),'DevDataStore'); } } else { LogInternal(Name$"::"$GetFuncName()@"NULL GRI specified!"@ "GameData:"$(GameData!= None ? string(GameData.Name) : "None"),'DevDataStore'); } } /** * Creates a PlayerDataProvider for the specified PlayerReplicationInfo, and adds it to the PlayerData array. * * @param PRI the PlayerReplicationInfo to create the PlayerDataProvider for. */ final function AddPlayerDataProvider( PlayerReplicationInfo PRI ) { local int ExistingIndex; local PlayerDataProvider DataProvider; local string PlayerName; PlayerName = PRI != None ? PRI.PlayerName : "None"; LogInternal(">> CurrentGameDataStore::AddPlayerDataProvider -" @ PRI @ "(" $ PlayerName $ ")",'DevDataStore'); if ( PRI != None ) { if ( GameData != None ) { ExistingIndex = FindPlayerDataProviderIndex(PRI); if ( ExistingIndex == INDEX_NONE ) { DataProvider = new ProviderTypes.PlayerDataProviderClass; if ( !DataProvider.BindProviderInstance(PRI) ) { LogInternal("Failed to bind PRI to PlayerDataProvider:"@ DataProvider @ "for player" @ PlayerName,'DevDataStore'); } else { PlayerData[PlayerData.Length] = DataProvider; } } else { LogInternal("PlayerDataProvider already registered in 'CurrentGame' data store for" @ PlayerName @ "PlayerData[ExistingIndex]:"$(PlayerData[ExistingIndex]!= None ? string(PlayerData[ExistingIndex].Name) : "None"),'DevDataStore'); } } else { LogInternal("CurrentGame data provider not yet created!",'DevDataStore'); } } else { LogInternal("NULL PRI specified - current number of player data provider:"@ PlayerData.Length,'DevDataStore'); } LogInternal("<< CurrentGameDataStore::AddPlayerDataProvider -" @ PRI @ "(" $ PlayerName $ ")",'DevDataStore'); } /** * Removes the PlayerDataProvider associated with the specified PlayerReplicationInfo. * * @param PRI the PlayerReplicationInfo to remove the data provider for. */ final function RemovePlayerDataProvider( PlayerReplicationInfo PRI ) { local int ExistingIndex; if ( PRI != None ) { ExistingIndex = FindPlayerDataProviderIndex(PRI); if ( ExistingIndex != INDEX_NONE ) { if ( PlayerData[ExistingIndex].CleanupDataProvider() ) { PlayerData.Remove(ExistingIndex,1); } } } else { LogInternal(Name$"::"$GetFuncName()@"NULL PRI specified!"@ "PlayerData.Length:'"$PlayerData.Length$"'",'DevDataStore'); } } /** * Creates a TeamDataProvider for the specified TeamInfo, and adds it to the TeamData array. * * @param TI the TeamInfo to create the TeamDataProvider for. */ final function AddTeamDataProvider( TeamInfo TI ) { local int ExistingIndex; local TeamDataProvider DataProvider; local string TeamName; TeamName = TI != None ? TI.TeamName : "None"; LogInternal(">> CurrentGameDataStore::AddTeamDataProvider -" @ TI @ "(" $ TeamName $ ")",'DevDataStore'); if ( TI != None ) { if ( GameData != None ) { ExistingIndex = FindTeamDataProviderIndex(TI); if ( ExistingIndex == INDEX_NONE ) { DataProvider = new ProviderTypes.TeamDataProviderClass; if ( !DataProvider.BindProviderInstance(TI) ) { LogInternal("Failed to bind TeamInfo to TeamDataProvider in 'CurrentGame' data store:" @ DataProvider @ "for team" @ TeamName,'DevDataStore'); } else { TeamData[TeamData.Length] = DataProvider; } } else { LogInternal("TeamDataProvider already registered in 'CurrentGame' data store for" @ TeamName @ "TeamData[ExistingIndex]:"$(TeamData[ExistingIndex]!= None ? string(TeamData[ExistingIndex].Name) : "None"),'DevDataStore'); } } } else { LogInternal("NULL TeamInfo specified - current number of team data providers:"@ TeamData.Length,'DevDataStore'); } } /** * Removes the TeamDataProvider associated with the specified TeamInfo. * * @param TI the TeamInfo to remove the data provider for. */ final function RemoveTeamDataProvider( TeamInfo TI ) { local int ExistingIndex; if ( TI != None ) { ExistingIndex = FindTeamDataProviderIndex(TI); if ( ExistingIndex != INDEX_NONE ) { if ( TeamData[ExistingIndex].CleanupDataProvider() ) { TeamData.Remove(ExistingIndex,1); } } } else { LogInternal(Name$"::"$GetFuncName()@"NULL TeamInfo specified!"@ "TeamCount:'"$TeamData.Length$"'",'DevDataStore'); } } /** * Returns the index into the PlayerData array for the PlayerDataProvider associated with the specified PlayerReplicationInfo. * * @param PRI the PlayerReplicationInfo to search for * * @return an index into the PlayerData array for the PlayerDataProvider associated with the specified PlayerReplicationInfo, * or INDEX_NONE if no associated PlayerDataProvider was found */ final function int FindPlayerDataProviderIndex( PlayerReplicationInfo PRI ) { local int i, Result; Result = INDEX_NONE; for ( i = 0; i < PlayerData.Length; i++ ) { if ( PlayerData[i].GetDataSource() == PRI ) { Result = i; break; } } return Result; } /** * Returns the index into the TeamData array for the TeamDataProvider associated with the specified TeamInfo. * * @param TI the TeamInfo to search for * * @return an index into the TeamData array for the TeamDataProvider associated with the specified TeamInfo, or INDEX_NONE * if no associated TeamDataProvider was found */ final function int FindTeamDataProviderIndex( TeamInfo TI ) { local int i, Result; Result = INDEX_NONE; for ( i = 0; i < TeamData.Length; i++ ) { if ( TeamData[i].GetDataSource() == TI ) { Result = i; break; } } return Result; } /** * Returns a reference to the PlayerDataProvider associated with the PRI specified. * * @param PRI the PlayerReplicationInfo to search for * * @return the PlayerDataProvider associated with the PRI specified, or None if there was no PlayerDataProvider for the * PRI specified. */ final function PlayerDataProvider GetPlayerDataProvider( PlayerReplicationInfo PRI ) { local int Index; local PlayerDataProvider Provider; Index = FindPlayerDataProviderIndex(PRI); if ( Index != INDEX_NONE ) { Provider = PlayerData[Index]; } return Provider; } /** * Returns a reference to the TeamDataProvider associated with the TI specified. * * @param TI the TeamInfo to search for * * @return the TeamDataProvider associated with the TeamInfo specified, or None if there was no TeamDataProvider for the * TeamInfo specified. */ final function TeamDataProvider GetTeamDataProvider( TeamInfo TI ) { local int Index; local TeamDataProvider Provider; Index = FindTeamDataProviderIndex(TI); if ( Index != INDEX_NONE ) { Provider = TeamData[Index]; } return Provider; } /** * Clears all data provider references. */ final function ClearDataProviders() { local int i; LogInternal(">>" @ Name$"::"$GetFuncName(),'DevDataStore'); if ( GameData != None ) { GameData.CleanupDataProvider(); } for ( i = 0; i < PlayerData.Length; i++ ) { PlayerData[i].CleanupDataProvider(); } for ( i = 0; i < TeamData.Length; i++ ) { TeamData[i].CleanupDataProvider(); } GameData = None; PlayerData.Length = 0; TeamData.Length = 0; LogInternal("<<" @ Name$"::"$GetFuncName(),'DevDataStore'); } /** * Called when the current map is being unloaded. Cleans up any references which would prevent garbage collection. * * @return TRUE indicates that this data store should be automatically unregistered when this game session ends. */ function bool NotifyGameSessionEnded() { ClearDataProviders(); // this game state data store should not be unregistered when the match is over. return false; } defaultproperties { ProviderTypes=(GameDataProviderClass=Class'Engine.GameInfoDataProvider',PlayerDataProviderClass=Class'Engine.PlayerDataProvider',TeamDataProviderClass=Class'Engine.TeamDataProvider') Tag="CurrentGame" Name="Default__CurrentGameDataStore" ObjectArchetype=UIDataStore_GameState'Engine.Default__UIDataStore_GameState' } |
Overview | Package | Class | Source | Class tree | Glossary | UnrealScript Documentation |
previous class next class | frames no frames |