Home › Engine Lua tables › Friends (second platform)

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.

Friends (second platform)

Object type with 17 methods. same method style as the Steam Friends object, with different overlay methods (ActivateOverlayToUserGeneratedContent). Registering function 0x2694a0.

Methods are called on a value of this type with a colon (obj:Method(...)).

Method	Returns	In game scripts	Example	Status
`Friends (second platform):AcceptInvite(arg1: string, …)`	—	1 calls, 1 files	`pFriends:AcceptInvite(inviteID)`	inferred
`Friends (second platform):ActivateGameOverlay(arg1: string, …)`	—	not called	—	inferred
`Friends (second platform):ActivateGameOverlayToChat(arg1: string, …)`	—	1 calls, 1 files	`pFriends:ActivateGameOverlayToChat(friendID)`	inferred
`Friends (second platform):ActivateGameOverlayToFriendRequest(arg1: integer, …)`	—	1 calls, 1 files	`pFriends:ActivateGameOverlayToFriendRequest(iPlayerID)`	inferred
`Friends (second platform):ActivateGameOverlayToStore([arg1: integer], …)`	—	not called	—	inferred
`Friends (second platform):ActivateGameOverlayToUrl(arg1: string, …)`	—	not called	—	inferred
`Friends (second platform):ActivateGameOverlayToUser(arg1: string, …)`	—	1 calls, 1 files	`pFriends:ActivateGameOverlayToUser(friendID)`	inferred
`Friends (second platform):ActivateInviteOverlay(…)`	—	2 calls, 2 files	`pFriends:ActivateInviteOverlay()`	inferred
`Friends (second platform):ActivateOverlayToUserGeneratedContent([arg1], …)`	—	not called	—	inferred
`Friends (second platform):ClearRichPresence(…)`	—	4 calls, 4 files	`pFriends:ClearRichPresence()`	inferred
`Friends (second platform):DeclineInvite(arg1: string, …)`	—	1 calls, 1 files	`pFriends:DeclineInvite(inviteID)`	inferred
`Friends (second platform):GetFriendByIndex(arg1: integer, …) -> table, boolean, boolean`	table, boolean, boolean	2 calls, 2 files	`local friend:table = pFriends:GetFriendByIndex(i)`	inferred
`Friends (second platform):GetFriendCount(…) -> number`	number	2 calls, 2 files	`local numFriends:number = pFriends:GetFriendCount()`	inferred
`Friends (second platform):GetRichPresence(arg1: string, arg2: string, …) -> 1 value`	1 value	1 calls, 1 files	`friend.RichPresence = Locale.Lookup(pFriends:GetRichPresence(friend.ID, "civPresence")`	inferred
`Friends (second platform):InviteUserToGame(arg1: string, …)`	—	1 calls, 1 files	`pFriends:InviteUserToGame(friendID)`	inferred
`Friends (second platform):IsOverlayEnabled(…) -> boolean`	boolean	1 calls, 1 files	`if(pFriends ~= nil and pFriends:IsOverlayEnabled()`	inferred
`Friends (second platform):SetRichPresence(arg1: string, arg2: string, …)`	—	15 calls, 5 files	`pFriends:SetRichPresence("civPresence", "LOC_PRESENCE_IN_GAME_SP")`	inferred