Skip to content

Latest commit

 

History

History
87 lines (53 loc) · 3.31 KB

friends.rst

File metadata and controls

87 lines (53 loc) · 3.31 KB
Raw

ISteamFriends

List of Functions

  • friends.activateGameOverlay
  • friends.activateGameOverlayToWebPage
  • friends.getFriendPersonaName

List of Callbacks

  • friends.onGameOverlayActivated

Function Reference

friends.activateGameOverlay (dialog)

param string dialog

The dialog to open. Valid options are: "friends", "community", "players", "settings", "officialgamegroup", "stats", "achievements".

returns

nothing

SteamWorks

ActivateGameOverlay

Activates the Steam Overlay to a specific dialog.

Example:

Steam.friends.activateGameOverlay('stats')

friends.activateGameOverlayToWebPage(url)

param string url

The webpage to open. (A fully qualified address with the protocol is required, e.g. "http://www.steampowered.com")

returns

nothing

SteamWorks

ActivateGameOverlayToWebPage

Activates Steam Overlay web browser directly to the specified URL.

Example:

Steam.friends.activateGameOverlayToWebPage('https://www.google.com')

friends.getFriendPersonaName(steam_id)

param uint64 steam_id

The Steam ID of the other user.

returns

(string) The current users persona name. Returns an empty string (""), or "[unknown]" if the Steam ID is invalid or not known to the caller.

SteamWorks

GetFriendPersonaName

Gets the specified user's persona (display) name.

This will only be known to the current user if the other user is in their friends list, on the same game server, in a chat room or lobby, or in a small Steam group with the local user.

Example:

steam_id = getSteamIdSomehow()
print("Friend's name is:", Steam.friends.getFriendPersonaName(steam_id))

Callbacks Reference

Warning

Remember callbacks are functions that you should override in order to receive the events, and not call directly.

Also, you must constantly call Steam.runCallbacks() (preferably in your game loop) in order for your callbacks to be called.

friends.onGameOverlayActivated(data)

param table data

A table similar to GameOverlayActivated_t

  • data.active (boolean) -- true if it's just been activated, otherwise false.
returns

nothing

SteamWorks

GameOverlayActivated_t

Posted when the Steam Overlay activates or deactivates. The game can use this to be pause or resume single player games.

Example:

function Steam.friends.onGameOverlayActivated(data)
    print('Overlay active is', data.active)
end