Home › Engine Lua tables › Friends (Steam)

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 (Steam)

Object type with 18 methods. game scripts call these on pFriends; Steam overlay methods (ActivateGameOverlay...). Registering function 0x503bb0.

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

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