SocialService

Metody

GetPlayersByPartyId(partyId : string):Instances
HideSelfView():()
Ukrywa własny widok gracza wzywającego.
PromptGameInvite(player : Instance,experienceInviteOptions : Instance):()
Wysyła powiadomienie do podanego Player z ekranem zaproszenia.
PromptPhoneBook(player : Instance,tag : string):()
Pyta danego Player z książką telefoniczną.
ShowSelfView(selfViewPosition : Enum.SelfViewPosition):()
Pokazuje własny widok wezwującego gracza.
CanSendCallInviteAsync(player : Instance):boolean
Wynik
Wskazuje, czy podany Player może zaprosić innych graczy do wezwania.
CanSendGameInviteAsync(player : Instance,recipientId : number):boolean
Wynik
Wskazuje, czy podany Player może zaprosić innych graczy.
GetPartyAsync(partyId : string):Array
Wynik

Zdarzenia

CallInviteStateChanged(player : Instance,inviteState : Enum.InviteState):RBXScriptSignal
Wystrzeliwuje, gdy zmienia się stan wezwania gracza.
GameInvitePromptClosed(player : Instance,recipientIds : Array):RBXScriptSignal
Wypala się, gdy gracz zamyka monit o zaproszenie.
PhoneBookPromptClosed(player : Instance):RBXScriptSignal
Wystrzeliwuje, gdy gracz zamyka okno książki telefonicznej.

Wywołania zwrotne

OnCallInviteInvoked(tag : string,callParticipantIds : Array):Instance
Odwołanie, gdy dzwonienie jest wykonywane z książki telefonicznej.

Właściwości

Metody

GetPlayersByPartyId

Instances

Parametry

partyId: string

Wartość domyślna: ""

Zwroty

Instances

HideSelfView

()

Ukrywa widok siebie wzywającego gracza. Jeśli ta metoda jest wywoływana, gdy widok siebie jest już ukryty, nie robi nic.

Zwroty

()

PromptGameInvite

()

PromptGameInvite() wyświetla zaproszenie do lokalnego gracza poprzez który mogą zaprosić swoich znajomych do obecnego doświadczenia.Przed wywołaniem tej metody powinieneś użyć CanSendGameInviteAsync(), aby określić, czy gracz może wysłać zaproszenie, ponieważ ta zdolność może się różnić w zależności od platformy lub gracza.

Zobacz powiadomienia o zaproszeniu gracza dla więcej szczegółów na temat wdrażania powiadomień o zaproszeniu, dostosowywania powiadomień i powiadomień oraz wykorzystywania danych uruchomienia.

Parametry

player: Instance

The Player to prompt z oknem okno wyskakujące, monit.

Wartość domyślna: ""

experienceInviteOptions: Instance

Opcjonalny przedmiot ExperienceInviteOptions do dostosowywania monitu.

Wartość domyślna: "nil"

Zwroty

()

Przykłady kodu

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

Sending an Invite

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

()

Pyta danego Player z książką telefoniczną.Jeśli gracz wybiera wezwanie kogoś, wydarzenie CallInviteStateChanged włącza się.Powinieneś użyć CanSendCallInviteAsync() przed wywołaniem PromptPhoneBook(), ponieważ zdolność widzenia książki telefonicznej może się różnić w zależności od gracza.

Jeśli gracz nie może otworzyć książki telefonicznej, pokazany jest dialog o błędzie.

Zobacz Roblox Connect dla przykładowej implementacji tej metody.

Parametry

player: Instance

Gracz, który poprosi o książkę telefoniczną.

Wartość domyślna: ""

tag: string

Sznurek, który pomaga odróżnić różne punkty wejścia do książki telefonicznej lub podobne.Na przykład możesz przekazać ciąg określający, w którym regionie doświadczenia znajduje się obecnie postać wezwującego gracza.

Wartość domyślna: ""

Zwroty

()

Przykłady kodu

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.

SocialService:PromptPhoneBook()

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)
end

ShowSelfView

()

Pokazuje własny widok gracza, który dzwoni. Jeśli ta metoda jest wywoływana, gdy własny widok jest już widoczny, nie robi nic.

Parametry

selfViewPosition: Enum.SelfViewPosition

Pozycja, w której należy umieścić widok siebie.

Wartość domyślna: "LastPosition"

Zwroty

()

CanSendCallInviteAsync

Wynik

Wyświetla true, jeśli podany Player może wysłać zaproszenie do wezwania znajomy.Zawsze powinieneś używać wyniku tej metody przed wywołaniem PromptPhoneBook(), ponieważ możliwość otwarcia książki telefonicznej może się różnić w zależności od gracza.

Zobacz Roblox Connect dla przykładowej implementacji tej metody.

Parametry

player: Instance

Instancja Player gracza potencjalnie wysyłająca zaproszenie do wezwania.

Wartość domyślna: ""

Zwroty

Czy określony gracz może wysłać zaproszenie do wezwania.

Przykłady kodu

SocialService:PromptPhoneBook()

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)
end

CanSendGameInviteAsync

Wynik

CanSendGameInviteAsync() zwraca true jeśli podany Player może zaprosić innych graczy do obecnego doświadczenia.Zawsze powinieneś używać wyniku tej metody przed wezwaniem PromptGameInvite(), ponieważ możliwość zaproszenia graczy może się różnić w zależności od platformy lub gracza.

Zobacz powiadomienia o zaproszeniu gracza dla więcej szczegółów na temat wdrażania powiadomień o zaproszeniu gracza, dostosowywania powiadomień i powiadomień oraz wykorzystywania danych uruchomienia.

Parametry

player: Instance

Instancja Player gracza potencjalnie wysyłająca zaproszenie.

Wartość domyślna: ""

recipientId: number

Opcjonalny z potencjalnego odbiorcy >, używany do sprawdzenia, czy nadawca może zaprosić tego konkretnego odbiorca.

Wartość domyślna: 0

Zwroty

Czy wskazany gracz może wysłać zaproszenie.

Przykłady kodu

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

Sending an Invite

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

GetPartyAsync

Array

Wynik

Parametry

partyId: string

Wartość domyślna: ""

Zwroty

Array

Zdarzenia

CallInviteStateChanged

To wydarzenie wystrzeliwuje, gdy zmienia się stan zaproszenia do wezwania gracza.

Parametry

player: Instance

Instancja Player gracza, który miał zmianę stanu zaproszenia do wezwania

inviteState: Enum.InviteState

Nowy stan zaproszenia do wezwania.

Przykłady kodu

SocialService.CallInviteStateChanged

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

To wydarzenie wystrzeliwuje, gdy gracz zamyka monit o zaproszenie.

Parametry

player: Instance

Instancja Player gracza, który zamknął okno dialogowe.

recipientIds: Array

Nie jest już zapełniony; pusty array.

PhoneBookPromptClosed

Wystrzeliwuje, gdy gracz zamyka okno książki telefonicznej.

Parametry

player: Instance

Instancja Player gracza, który zamknął książkę telefoniczną.