SocialService
SocialService facilitates social functions that impact relationships made on the Roblox platform. Its primary usage is to show invite prompts and the phone book to players, allowing them to send invitation requests to their friends through PromptGameInvite() and PromptPhoneBook() respectively. You may leverage signals when such requests are made.
Resumen
Métodos
Eventos
Fires when a player's call invite state changes.
Fires when a player closes an invite prompt.
Fires when a player closes the phone book prompt.
Llamadas
Callback for when a call is placed from the phone book.
Propiedades
Métodos
HideSelfView
Hides the calling player's self view. If this method is called while the self view is already hidden, it does nothing.
Devuelve
PromptGameInvite
PromptGameInvite() displays an invite prompt to the local player through which they may invite their friends to the current experience. Before calling this method, you should use CanSendGameInviteAsync() to determine whether the player can send an invite, as this ability may vary depending on the platform or player.
See Player Invite Prompts for more details on implementing invite prompts, customizing prompts and notifications, and using launch data.
Parámetros
Optional ExperienceInviteOptions object for customizing the prompt.
Devuelve
Muestras de código
The following code sample uses CanSendGameInviteAsync() to confirm whether the local Player can send an invite. If true, it then prompts the invite using PromptGameInvite().
local SocialService = game:GetService("SocialService")
local Players = game:GetService("Players")
local player = Players.LocalPlayer
-- Function to check whether the player can send an invite
local function canSendGameInvite(sendingPlayer)
local success, canSend = pcall(function()
return SocialService:CanSendGameInviteAsync(sendingPlayer)
end)
return success and canSend
end
local canInvite = canSendGameInvite(player)
if canInvite then
SocialService:PromptGameInvite(player)
end
PromptPhoneBook
Prompts the given Player with the phone book. If the player chooses to call someone, the CallInviteStateChanged event fires. You should use CanSendCallInviteAsync() prior to calling PromptPhoneBook() since the ability to see the phone book may vary depending on the player.
If a player is not eligible to open the phone book, an error dialog is shown.
See Roblox Connect for a sample implementation of this method.
Parámetros
The player to prompt with the phone book.
String to help differentiate between various phone book "entry points" or similar. For example, you can pass a string defining what region of an experience the calling player's character is currently in.
Devuelve
Muestras de código
The following code sample, placed within a child LocalScript of a GuiButton, uses CanSendCallInviteAsync() to confirm that the player can make a call. If so, it connects PromptPhoneBook() to the button's Activated event.
local Players = game:GetService("Players")
local SocialService = game:GetService("SocialService")
local player = Players.LocalPlayer
local button = script.Parent
button.Visible = false
-- Function to check whether the player can send a call invite
local function canSendCallingInvite(sendingPlayer)
local success, canSend = pcall(function()
return SocialService:CanSendCallInviteAsync(sendingPlayer)
end)
return success and canSend
end
local canCall = canSendCallingInvite(player)
if canCall then
button.Visible = true
button.Activated:Connect(function()
SocialService:PromptPhoneBook(player, "")
end)
endShowSelfView
Shows the calling player's self view. If this method is called while the self view is already visible, it does nothing.
Parámetros
The position to place the self view .
Devuelve
CanSendCallInviteAsync
Returns true if the given Player can send a call invite to a friend. You should always use the result of this method before calling PromptPhoneBook() since the ability to open the phone book may vary depending on the player.
See Roblox Connect for a sample implementation of this method.
Parámetros
Devuelve
Whether the specified player can send a call invite.
Muestras de código
The following code sample, placed within a child LocalScript of a GuiButton, uses CanSendCallInviteAsync() to confirm that the player can make a call. If so, it connects PromptPhoneBook() to the button's Activated event.
local Players = game:GetService("Players")
local SocialService = game:GetService("SocialService")
local player = Players.LocalPlayer
local button = script.Parent
button.Visible = false
-- Function to check whether the player can send a call invite
local function canSendCallingInvite(sendingPlayer)
local success, canSend = pcall(function()
return SocialService:CanSendCallInviteAsync(sendingPlayer)
end)
return success and canSend
end
local canCall = canSendCallingInvite(player)
if canCall then
button.Visible = true
button.Activated:Connect(function()
SocialService:PromptPhoneBook(player, "")
end)
endCanSendGameInviteAsync
CanSendGameInviteAsync() returns true if the given Player can invite other players to the current experience. You should always use the result of this method before calling PromptGameInvite() since the ability to invite players may vary depending on the platform or player.
See Player Invite Prompts for more details on implementing player invite prompts, customizing prompts and notifications, and using launch data.
Parámetros
Optional Player.UserId of the potential recipient, used to check whether the sender can invite that specific recipient.
Devuelve
Whether the specified player can send an invite.
Muestras de código
The following code sample uses CanSendGameInviteAsync() to confirm whether the local Player can send an invite. If true, it then prompts the invite using PromptGameInvite().
local SocialService = game:GetService("SocialService")
local Players = game:GetService("Players")
local player = Players.LocalPlayer
-- Function to check whether the player can send an invite
local function canSendGameInvite(sendingPlayer)
local success, canSend = pcall(function()
return SocialService:CanSendGameInviteAsync(sendingPlayer)
end)
return success and canSend
end
local canInvite = canSendGameInvite(player)
if canInvite then
SocialService:PromptGameInvite(player)
end
Eventos
CallInviteStateChanged
This event fires when a player's call invite state changes.
Parámetros
The new call invite state.
Muestras de código
local SocialService = game:GetService("SocialService")
local button = script.Parent
local isPhonebookOpen = false
SocialService.CallInviteStateChanged:Connect(function(_, inviteState)
local isCalling = inviteState == Enum.InviteState.Placed
if isCalling or isPhonebookOpen then
button.Visible = false
else
button.Visible = true
end
end)GameInvitePromptClosed
This event fires when a player closes an invite prompt.
Parámetros
No longer populated; an empty array.
Llamadas
OnCallInviteInvoked
A callback to process when a call is placed from the phone book. The tag parameter can be used to differentiate between different "entry points" or similar, as described in PromptPhoneBook(). Only one callback can be set.
Parámetros
String to help differentiate between various phone book entry points.
Array containing all of the players involved in the call. The caller will always be the first player in the array.
Devuelve
Table including the PlaceId and ReservedServerAccessCode keys whose values are the DataModel.PlaceId and the server access code returned by TeleportService:ReserveServer(), respectively.
Muestras de código
local SocialService = game:GetService("SocialService")
local TeleportService = game:GetService("TeleportService")
SocialService.OnCallInviteInvoked = function()
local placeId = 0123456789 -- This is the place ID of the desired place to drop call participants into
local accessCode = TeleportService:ReserveServer(placeId)
return { ReservedServerAccessCode = accessCode, PlaceId = placeId }
end