SocialService

Metode

HideSelfView():void
Sembunyikan pandangan pemain yang menelepon diri mereka sendiri.
PromptGameInvite(player : Instance,experienceInviteOptions : Instance):void
Mengundang Player yang diberikan dengan layar undangan.
PromptPhoneBook(player : Instance,tag : string):void
Menginstruksikan Player yang diberikan dengan buku telepon.
ShowSelfView(selfViewPosition : Enum.SelfViewPosition):void
Menunjukkan pandangan pemain yang memanggil diri.
CanSendCallInviteAsync(player : Instance):bool
Hasil
Menunjukkan apakah Player yang diberikan dapat mengundang pemain lain untuk panggilan.
CanSendGameInviteAsync(player : Instance,recipientId : number):bool
Hasil
Menunjukkan apakah Player yang diberikan dapat mengundang pemain lain.

Acara

CallInviteStateChanged(player : Instance,inviteState : Enum.InviteState):RBXScriptSignal
Diaktifkan ketika status undangan pemain berubah.
GameInvitePromptClosed(player : Instance,recipientIds : Array):RBXScriptSignal
Dibakar saat seorang pemain menutup prompt undangan.
PhoneBookPromptClosed(player : Instance):RBXScriptSignal
Dibakar saat seorang pemain menutup prompt buku telepon.

Callback

OnCallInviteInvoked(tag : string,callParticipantIds : Array):Instance

Properti

Metode

HideSelfView

void

Sembunyikan pandangan pemain yang memanggil diri mereka sendiri. Jika metode ini dipanggil saat pandangan pemain sudah tersembunyi, itu tidak melakukan apa-apa.

Memberikan nilai

void

PromptGameInvite

void

PromptGameInvite() menampilkan undangan untuk pemain lokal melalui mana mereka dapat mengundang teman mereka ke pengalaman saat ini. Sebelum menggunakan metode ini, Anda harus menggunakan CanSendGameInviteAsync() untuk menentukan

Lihat Undang Pemain Prompt untuk lebih banyak rincian tentang menerapkan undang undang prompt, kustomisasi undang dan notifikasi, dan menggunakan data peluncuran.

Parameter

player: Instance

Class.Player untuk mengundang dengan pop-upundangan.

experienceInviteOptions: Instance

Objek ExperienceInviteOptions yang dapat diopsionalisasi untuk menyesuaikan prompt.

Nilai Default: "nil"

Memberikan nilai

void

Contoh Kode

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

void

Menginstruksikan Player dengan buku telepon. Jika pemain memilih untuk menelepon seseorang, acara CallInviteStateChanged diaktifkan. Anda harus menggunakan Class

Jika seorang pemain tidak memenuhi syarat untuk membuka buku telepon, jendela dialog kesalahan ditunjukkan.

Lihat Roblox Connect untuk implementasi sampel metode ini.

Parameter

player: Instance

Pemain untuk mengundang dengan buku telepon.

tag: string

String untuk membantu menentukan antara berbagai poin buku telepon "entri" atau serupa. Misalnya, Anda dapat mengirimkan string yang mendefinisikan wilayah pengalaman yang panggilan pemain berada saat ini.

Memberikan nilai

void

Contoh Kode

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

void

Menunjukkan pandangan pemain yang memanggil diri mereka sendiri. Jika metode ini dipanggil saat pandangan pemain sudah terlihat, itu tidak melakukan apa-apa.

Parameter

selfViewPosition: Enum.SelfViewPosition

Posisi untuk menempatkan pandangan diri.

Nilai Default: "LastPosition"

Memberikan nilai

void

CanSendCallInviteAsync

Hasil

Mengembalikan true jika Player yang diberikan dapat mengirim undangan panggilan ke teman. Anda harus selalu menggunakan hasil metode ini sebelum memanggil PromptPhoneBook() karena kemampuan untuk membuka buku telepon dapat bervariasi tergantung pada pemain.

Lihat Roblox Connect untuk implementasi sampel metode ini.

Parameter

player: Instance

Class.Player instansi pemain potensial mengirim undangan panggilan.

Memberikan nilai

Apakah pemain yang ditentukan dapat mengirim undangan panggilan.

Contoh Kode

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

Hasil

CanSendGameInviteAsync() mengembalikan true jika Player yang diberikan dapat mengundang pemain lain ke pengalaman saat ini. Anda harus selalu menggunakan hasil dari metode ini sebelum memanggil

Lihat Undang Pemain Prompt untuk lebih banyak rincian tentang menerapkan undangan pemain, menyesuaikan undangan, dan menggunakan data peluncuran.

Parameter

player: Instance

Class.Player instansi pemain potensial mengirim undangan.

recipientId: number

Opsional Player.UserId dari potensi pelanggan , digunakan untuk memeriksa apakah pengirim dapat mengundang penerima khusus itu.

Nilai Default: 0

Memberikan nilai

Apakah pemain yang ditentukan dapat mengirim undangan.

Contoh Kode

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

Acara

CallInviteStateChanged

Acara ini diaktifkan ketika status undangan pemain berubah.

Parameter

player: Instance

Class.Player instansi pemain yang memiliki status undangan panggilan.

inviteState: Enum.InviteState

Negara undangan panggilan baru.

Contoh Kode

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

Acara ini diaktifkan ketika seorang pemain menutup prompt undangan.

Parameter

player: Instance

Class.Player instansi pemain yang menutup prompt.

recipientIds: Array

Tidak lagi populated; array kosong.

PhoneBookPromptClosed

Dibakar saat seorang pemain menutup prompt buku telepon.

Parameter

player: Instance

Class.Player instansi pemain yang menutup buku telepon.