SocialService

Méthodes

HideSelfView():void
Masque la voird'ensemble du joueur.
PromptGameInvite(player : Instance,experienceInviteOptions : Instance):void
Invite le Player donné avec l'écran d'invitation.
PromptPhoneBook(player : Instance,tag : string):void
Invite le Player donné avec le livre d'appels.
ShowSelfView(selfViewPosition : Enum.SelfViewPosition):void
Affiche la voirde l'intérieur du joueur.
CanSendCallInviteAsync(player : Instance):bool
Rendement
Indique si le Player donné peut inviter d'autres joueurs à un appel.
CanSendGameInviteAsync(player : Instance,recipientId : number):bool
Rendement
Indique si le Player donné peut inviter d'autres joueurs.

Évènements

CallInviteStateChanged(player : Instance,inviteState : Enum.InviteState):RBXScriptSignal
Feuille quand l'état d'invitation d'un joueur change.
GameInvitePromptClosed(player : Instance,recipientIds : Array):RBXScriptSignal
Tire quand un joueur ferme une invite.
PhoneBookPromptClosed(player : Instance):RBXScriptSignal
Tire quand un joueur ferme la demande de livre de téléphone.

Rappels

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

Propriétés

Méthodes

HideSelfView

void

Masque la voird'ensemble du joueur. Si cette méthode est appelée pendant que la vue d'ensemble est déjà cachée, il ne fait rien.

Retours

void

PromptGameInvite

void

PromptGameInvite() affiche une invite à l'invitation du joueur local pour qu'il puisse inviter ses amis dans l'expérience actuelle. Avant d'appeler cette méthode, vous devriez utiliser CanSendGameInviteAsync() pour déterminer si le joueur peut envoyer une invitation, car cette capacité peut var

Voir Inviter les invitations de joueurs pour plus de détails sur l'implémentation d'invitations, la personnalisation d'invitations et les notifications, et l'utilisation des données de lancement.

Paramètres

player: Instance

Le Player pour inviter dans la fenêtre pop-upd'invite.

experienceInviteOptions: Instance

Objet ExperienceInviteOptions facultatif pour personnaliser la demande.

Valeur par défaut : "nil"

Retours

void

Échantillons de code

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

Invite le joueur à utiliser le livre de téléphone. Si le joueur choisit de contacter quelqu'un, l'événement Player se déclenche. Vous devriez utiliser Class.SocialService:CanSendCallInviteAsync()|Can

Si un joueur n'est pas éligible pour ouvrir le livre de téléphone, une boîte de dialogue d'erreur est affichée.

Voir Roblox Connect pour une implémentation de例 de cette méthode.

Paramètres

player: Instance

Le joueur à qui le livre de téléphone.

tag: string

String pour aider à différentier entre différents points d'entrée dans un livre de télévision ou similaire. Par exemple, vous pouvez passer une chaîne définissant dans quelle région une expérience de appel est actuellement dans.

Retours

void

Échantillons de code

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

Affiche la voirde l'joueur. Si cette méthode est appelée pendant que la vue de l'appelant est déjà visible, il ne fait rien.

Paramètres

selfViewPosition: Enum.SelfViewPosition

La position à laquelle placer la vue de soi.

Valeur par défaut : "LastPosition"

Retours

void

CanSendCallInviteAsync

Rendement

Renvoie true si le donné Player peut envoyer une invitation d'appel à un ami. Vous devriez toujours utiliser le résultat de cette méthode avant d'appeler PromptPhoneBook() car la capacité d'ouvrir le livre d'appel peut varier en fonction du joueur.

Voir Roblox Connect pour une implémentation de例 de cette méthode.

Paramètres

player: Instance

L'instance Player du joueur envoie potentiellement une invitation à un appel.

Retours

Whether the specified player can send a call invite.

Échantillons de code

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

Rendement

CanSendGameInviteAsync() renvoie true si le Player donné peut inviter d'autres joueurs dans l'expérience actuelle. Vous devriez toujours utiliser le résultat de cette méthode avant d'appeler 0> Class.SocialService:PromptGameInv

Voir Inviter des joueurs des invitations pour plus de détails sur l'implémentation des invitations de joueurs, la personnalisation des invitations et les notifications, et l'utilisation des données de lancement.

Paramètres

player: Instance

L'instance Player du joueur potentiellement envoyant une invitation.

recipientId: number

Optionnellement Player.UserId de la cible potentielle, utilisée pour vérifier si le serveur peut inviter ce destinataire spécifique.

Valeur par défaut : 0

Retours

Whether the specified player can send an invitation.

Échantillons de code

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

Évènements

CallInviteStateChanged

Cet événement se déclenche lorsque l'état d'invitation d'un joueur change.

Paramètres

player: Instance

L'instance Player du joueur qui avait un état d'invitation d'appel.

inviteState: Enum.InviteState

L'état d'invitation de nouvel appel.

Échantillons de code

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

Cet événement se déclenche lorsqu'un joueur ferme une invite.

Paramètres

player: Instance

L'instance Player du joueur qui a fermé la fenêtre d'invite.

recipientIds: Array

Plus rempli; un matricevide.

PhoneBookPromptClosed

Tire quand un joueur ferme la demande de livre de téléphone.

Paramètres

player: Instance

L'instance Player du joueur qui a fermé le livre de téléphone.