Home › Engine Lua tables › Network

Engine executable. Settings and tools of the game program (CivilizationVI.exe), usable without a mod. Mostly undocumented debug and configuration functionality; descriptions come from analysis of the executable and have not all been tried in the running game.

Network

Static table with 94 methods. named from how the game scripts call it (76 of 94 methods matched). Registering function 0x26ce30.

Methods are called with a dot (Network.Method(...)).

Method Returns In game scripts Example Status
Network.AttemptConnectionToCrossPlayLobbyService() -> boolean boolean 3 calls, 2 files Network.AttemptConnectionToCrossPlayLobbyService() inferred
Network.BroadcastGameConfig([arg1: boolean], …) — 24 calls, 6 files Network.BroadcastGameConfig() inferred
Network.BroadcastPlayerInfo([playerID]) — 12 calls, 7 files Network.BroadcastPlayerInfo() inferred
Network.CanShowFriendChatWindow() -> boolean boolean 1 calls, 1 files if Network.CanShowFriendChatWindow() inferred
Network.CanViewFriendProfile() -> boolean boolean 1 calls, 1 files if Network.CanViewFriendProfile() inferred
Network.CheckServerForCloudNotifications(arg1) -> number number 1 calls, 1 files listing.CloudNotify = Network.CheckServerForCloudNotifications(listing.ServerID) inferred
Network.CheckServerForUnseenComplete(arg1) -> boolean boolean 1 calls, 1 files listing.UnseenComplete = Network.CheckServerForUnseenComplete(listing.ServerID) inferred
Network.CloseConnection([arg1]) — not called — inferred
Network.CloudEndTurn() -> boolean boolean not called — inferred
Network.CloudKillGame() -> boolean boolean 2 calls, 2 files Network.CloudKillGame() inferred
Network.CloudQuitGame() -> boolean boolean 2 calls, 2 files Network.CloudQuitGame() inferred
Network.DisplayPossibleNetworkError() — 1 calls, 1 files if(Network.DisplayPossibleNetworkError() inferred
Network.DisplayUGCRestrictionsWarning() — 2 calls, 1 files — inferred
Network.EnsureNetworkServiceAccountAvailable() — 1 calls, 1 files if(not Network.EnsureNetworkServiceAccountAvailable() inferred
Network.ForceResync() — not called — inferred
Network.GetCapability(…) -> number number not called — inferred
Network.GetChangePlayerID(arg1) -> number number 1 calls, 1 files local oldDesiredPlayerID = Network.GetChangePlayerID(localPlayerID) inferred
Network.GetElapsedSessionTime() -> number number 1 calls, 1 files local sessionTime :number = Network.GetElapsedSessionTime() inferred
Network.GetFriends([arg1], …) — 22 calls, 13 files local pFriends = Network.GetFriends() inferred
Network.GetGameConfigurationSaveType() -> number number 4 calls, 3 files g_GameType = Network.GetGameConfigurationSaveType() inferred
Network.GetGameHostPlayerID() -> number number 4 calls, 3 files if iPlayerID == Network.GetGameHostPlayerID() inferred
Network.GetInternetTransportType() — 1 calls, 1 files if( Network.GetInternetTransportType() inferred
Network.GetJoinCode(…) -> 1 value 1 value 2 calls, 2 files local joinCode :string = Network.GetJoinCode() inferred
Network.GetLastJoinedHostName() -> 1 value 1 value not called — inferred
Network.GetLocalPlayerID() -> number number 36 calls, 13 files if(playerID == Network.GetLocalPlayerID() inferred
Network.GetNetSessionHostPlayerID() -> number number not called — inferred
Network.GetNetworkPlatform() — 16 calls, 9 files if(Network.GetNetworkPlatform() inferred
Network.GetPingTime(arg1: integer) -> number number 1 calls, 1 files local iPingTime = Network.GetPingTime( playerID ) inferred
Network.GetServerHostName([arg1: number], …) -> 1 value 1 value not called — inferred
Network.GetSessionID() -> number number 1 calls, 1 files local networkSessionID:number = Network.GetSessionID() inferred
Network.GetTransportType() -> number number 8 calls, 3 files if (Network.GetFriends(Network.GetTransportType() inferred
Network.HasCapability(arg1: string, …) -> boolean boolean 4 calls, 1 files if(not Network.HasCapability("CloudGame") inferred
Network.HasKickVotedStarted(arg1) -> boolean boolean 1 calls, 1 files and not Network.HasKickVotedStarted(iPlayerID) inferred
Network.HasSeparateCrossPlayLobbyService() — 1 calls, 1 files if (Network.HasSeparateCrossPlayLobbyService() inferred
Network.HasSingleFriendInvite() -> boolean boolean 2 calls, 2 files if allowInvites and Network.HasSingleFriendInvite() inferred
Network.HasVotedToKick(arg1) -> boolean boolean 1 calls, 1 files and not Network.HasKickVotedStarted(iPlayerID) and not Network.HasVotedToKick(iPlayerID) inferred
Network.HostGame(arg1: integer) -> number number 13 calls, 8 files Network.HostGame(serverType) inferred
Network.InvitePlayTogetherUsers() — not called — inferred
Network.IsAgeRestricted() -> boolean boolean 12 calls, 5 files if( Network.IsAgeRestricted() inferred
Network.IsCloudJoinsBlocked() -> boolean boolean 1 calls, 1 files or Network.IsCloudJoinsBlocked() inferred
Network.IsCloudLaunching() -> boolean boolean 1 calls, 1 files and not Network.IsCloudLaunching() inferred
Network.IsCloudMatchStarted() -> boolean boolean 1 calls, 1 files if(Network.IsGameHost() and not Network.IsCloudMatchStarted() inferred
Network.IsCloudTurnPlayer() -> boolean boolean 2 calls, 1 files if(Network.IsCloudTurnPlayer() inferred
Network.IsCrossPlayLobbyServiceAvailable() -> boolean boolean 1 calls, 1 files if (Network.IsCrossPlayLobbyServiceAvailable() inferred
Network.IsEveryoneConnected() -> boolean boolean 2 calls, 1 files if(not Network.IsEveryoneConnected() inferred
Network.IsGameCoreActive() -> boolean boolean not called — inferred
Network.IsGameHost() -> boolean boolean 16 calls, 5 files if(Network.IsGameHost() inferred
Network.IsInGameStartedState() -> boolean boolean 3 calls, 3 files if Network.IsInGameStartedState() inferred
Network.IsInSession() -> boolean boolean 14 calls, 4 files if Network.IsInSession() inferred
Network.IsInternetLobbyServiceAvailable() -> boolean boolean 11 calls, 4 files if (Network.IsInternetLobbyServiceAvailable() inferred
Network.IsInternetMultiplayerInitialized(arg1: boolean) — 1 calls, 1 files if Network.IsInternetMultiplayerInitialized(true) inferred
Network.IsMatchMaking([arg1: number]) -> boolean boolean 4 calls, 2 files if(Network.IsMatchMaking() inferred
Network.IsMultiplayerRestrictionEnabled() — 1 calls, 1 files if (Network.IsMultiplayerRestrictionEnabled() inferred
Network.IsNetSessionHost() -> boolean boolean 4 calls, 3 files if(Network.IsNetSessionHost() inferred
Network.IsNetworkAvailable() — 4 calls, 1 files if (not Network.IsNetworkAvailable() inferred
Network.IsNetworkServiceAccountAvailable() — 1 calls, 1 files if (not Network.IsNetworkServiceAccountAvailable() inferred
Network.IsNpReachable() — 1 calls, 1 files if Network.IsNpReachable() inferred
Network.IsPendingAgeRestriction() -> boolean boolean not called — inferred
Network.IsPlayerConnected(arg1: integer) -> boolean boolean 11 calls, 4 files if(Network.IsPlayerConnected(iPlayer) inferred
Network.IsPlayerHotJoining(arg1: integer) -> boolean boolean 3 calls, 2 files if(Network.IsPlayerHotJoining(playerID) inferred
Network.IsPlayerKicked(playerID: integer) -> boolean boolean 5 calls, 4 files if(Network.IsPlayerKicked(playerID) inferred
Network.IsPlayerResyncing(arg1: integer) -> boolean boolean 2 calls, 1 files elseif(Network.IsPlayerResyncing(playerID) inferred
Network.IsSessionActive() -> boolean boolean not called — inferred
Network.IsSessionClosing() -> boolean boolean not called — inferred
Network.IsSessionInCloseState() -> boolean boolean 1 calls, 1 files and not Network.IsSessionInCloseState() inferred
Network.IsUpdateRequired() — not called — inferred
Network.IsUserLoggedIntoCrossPlayLobbyService() -> boolean boolean 1 calls, 1 files if(Network.IsUserLoggedIntoCrossPlayLobbyService() inferred
Network.JoinGame(arg1: integer) -> boolean, boolean boolean, boolean 2 calls, 2 files Network.JoinGame(serverEntry.serverID) inferred
Network.JoinGameByJoinCode(arg1: string) -> boolean, boolean boolean, boolean 1 calls, 1 files local bSuccess, bPending = Network.JoinGameByJoinCode(joinCodeString) inferred
Network.KickPlayer(arg1: integer) — 2 calls, 2 files Network.KickPlayer( g_kickIdx ) inferred
Network.KickVote(arg1, arg2: boolean, [arg3]) — 5 calls, 2 files Network.KickVote(targetPlayerID, true) inferred
Network.LaunchGame() -> boolean boolean 2 calls, 1 files Network.LaunchGame() inferred
Network.LeaveGame() -> boolean boolean 14 calls, 6 files Network.LeaveGame() inferred
Network.LoadGame(arg1: string, arg2: integer) -> boolean boolean 13 calls, 5 files Network.LoadGame(m_thisLoadFile, serverType) inferred
Network.LogIntoCrossPlayLobbyService([arg1: string], [arg2: string]) -> boolean boolean not called — inferred
Network.MatchMake() -> boolean, boolean boolean, boolean 2 calls, 1 files Network.MatchMake() inferred
Network.PSPlusAvailability() — 1 calls, 1 files local psPlusAvailability = Network.PSPlusAvailability() inferred
Network.PresentNpDisconnectedError() — 2 calls, 1 files Network.PresentNpDisconnectedError() inferred
Network.PresentPSPlusCommerceDialog() — 1 calls, 1 files Network.PresentPSPlusCommerceDialog() inferred
Network.ProfanityFilter([arg1: string], …) -> 1 value 1 value not called — inferred
Network.RequestInternetConnection(arg1: boolean) — 1 calls, 1 files if (not Network.RequestInternetConnection(true) inferred
Network.RequestPlayerIDChange(arg1) — 1 calls, 1 files Network.RequestPlayerIDChange(newDesiredPlayerID) inferred
Network.RequestSnapshot() — not called — inferred
Network.ResetHasShownNetworkDisconnectError() — not called — inferred
Network.ResetPlayTogether() — 1 calls, 1 files Network.ResetPlayTogether() inferred
Network.RestartGame() -> boolean boolean 1 calls, 1 files Network.RestartGame() inferred
Network.SaveGame(gameFile) -> boolean boolean 8 calls, 5 files Network.SaveGame(gameFile) inferred
Network.SendChat(arg1: string, arg2: number, arg3: integer) — 4 calls, 3 files Network.SendChat( "Test message #"..tostring(i), -1, -1 ) inferred
Network.SetCompletedGameSeen(arg1) -> boolean boolean 1 calls, 1 files Network.SetCompletedGameSeen(serverID) inferred
Network.SetInPSPlusFeature(arg1: boolean) — 1 calls, 1 files Network.SetInPSPlusFeature(false) inferred
Network.SetLocalNetworkMode(arg1: boolean) — 3 calls, 1 files Network.SetLocalNetworkMode(true) inferred
Network.TriggerTestSync() — not called — inferred
Network.UGCRestrictionsEnabled() — 2 calls, 1 files if Network.UGCRestrictionsEnabled() inferred
Network.UserAccountChanged() -> 1 value 1 value 1 calls, 1 files Network.UserAccountChanged() inferred