SocialService

Méthodes

GetPlayersByPartyId(partyId : string):Instances
HideSelfView():()
Masque la voird'un joueur appelant lui-même.
PromptGameInvite(player : Instance,experienceInviteOptions : Instance):()
Demande à l'invitation donnée Player avec l'écran d'invitation.
PromptPhoneBook(player : Instance,tag : string):()
Demande au livre de téléphone donné Player avec l'annuaire téléphonique.
ShowSelfView(selfViewPosition : Enum.SelfViewPosition):()
Affiche la voird'un joueur appelant lui-même.
CanSendCallInviteAsync(player : Instance):boolean
Rendement
Indique si le Player donné peut inviter d'autres joueurs à un appel.
CanSendGameInviteAsync(player : Instance,recipientId : number):boolean
Rendement
Indique si le Player peut inviter d'autres joueurs.
GetPartyAsync(partyId : string):Array
Rendement

Évènements

CallInviteStateChanged(player : Instance,inviteState : Enum.InviteState):RBXScriptSignal
Se déclenche lorsque l'appel d'un joueur invite à modifier l'état.
GameInvitePromptClosed(player : Instance,recipientIds : Array):RBXScriptSignal
Se déclenche lorsqu'un joueur ferme une invite.
PhoneBookPromptClosed(player : Instance):RBXScriptSignal
Se déclenche lorsqu'un joueur ferme l'invite du répertoire téléphonique.

Rappels

OnCallInviteInvoked(tag : string,callParticipantIds : Array):Instance
Rappel lorsqu'un appel est effectué depuis le répertoire téléphonique.

Propriétés

Méthodes

GetPlayersByPartyId

Instances

Paramètres

partyId: string

Valeur par défaut : ""

Retours

Instances

HideSelfView

()

Masque la voird'un joueur appelant de lui-même. Si cette méthode est appelée alors que la vue d'un joueur est déjà cachée, elle ne fait rien.

Retours

()

PromptGameInvite

()

PromptGameInvite() affiche une invitation rapide au joueur local à travers laquelle il peut inviter ses amis à l'expérience actuelle.Avant d'appeler cette méthode, vous devez utiliser CanSendGameInviteAsync() pour déterminer si le joueur peut envoyer une invitation, car cette capacité peut varier en fonction de la plate-forme ou du joueur.

Voir invitations de joueur pour plus de détails sur la mise en œuvre d'invitations, la personnalisation d'invitations et de notifications, et l'utilisation des données de lancement.

Paramètres

player: Instance

Le Player pour demander avec la pop-up d'invitation.

Valeur par défaut : ""

experienceInviteOptions: Instance

Objet facultatif ExperienceInviteOptions optionnel pour personnaliser la demande.

Valeur par défaut : "nil"

Retours

()

Échantillons de code

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

()

Demande au livre de téléphone donné Player avec l'annuaire téléphonique.Si le joueur choisit d'appeler quelqu'un, l'événement CallInviteStateChanged se déclenche.Vous devez utiliser CanSendCallInviteAsync() avant d'appeler PromptPhoneBook() puisque la capacité de voir l'annuaire téléphonique peut varier en fonction du joueur.

Si un joueur n'est pas éligible pour ouvrir le répertoire téléphonique, un dialogue d'erreur est affiché.

Voir Roblox Connect pour une implémentation d'échantillon de cette méthode.

Paramètres

player: Instance

Le joueur à interroger avec le répertoire téléphonique.

Valeur par défaut : ""

tag: string

Chaîne pour aider à différencier entre divers points d'entrée du répertoire téléphonique ou similaires.Par exemple, vous pouvez passer une chaîne définissant dans quelle région d'une expérience le personnage de l'joueurse trouve actuellement.

Valeur par défaut : ""

Retours

()

Échantillons de code

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

()

Affiche la voird'un joueur appelant de lui-même. Si cette méthode est appelée alors que la vue d'un joueur est déjà visible, elle ne fait rien.

Paramètres

selfViewPosition: Enum.SelfViewPosition

La position pour placer la vue d'ensemble.

Valeur par défaut : "LastPosition"

Retours

()

CanSendCallInviteAsync

Rendement

Retourne true si le donné Player peut envoyer une invitation à un appel à un ami.Vous devez toujours utiliser le résultat de cette méthode avant d'appeler PromptPhoneBook() puisque la capacité d'ouvrir le répertoire téléphonique peut varier en fonction du joueur.

Voir Roblox Connect pour une implémentation d'échantillon de cette méthode.

Paramètres

player: Instance

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

Valeur par défaut : ""

Retours

Si le joueur spécifié peut envoyer une invitation à un appel.

É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 donné Player peut inviter d'autres joueurs à l'expérience actuelle.Vous devez toujours utiliser le résultat de cette méthode avant d'appeler PromptGameInvite() puisque la capacité d'inviter des joueurs peut varier en fonction de la plate-forme ou du joueur.

Voir invitations de joueur Prompts pour plus de détails sur la mise en œuvre d'invitations de joueur, la personnalisation d'invitations et de notifications, et l'utilisation des données de lancement.

Paramètres

player: Instance

L'instance Player du joueur envoie potentiellement une invitation.

Valeur par défaut : ""

recipientId: number

Facultatif du récepteur potentiel , utilisé pour vérifier si l'expéditeur peut inviter ce destinataire spécifique.

Valeur par défaut : 0

Retours

Si le joueur spécifié peut envoyer une invitation.

Échantillons de code

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

Rendement

Paramètres

partyId: string

Valeur par défaut : ""

Retours

Array

Évènements

CallInviteStateChanged

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

Paramètres

player: Instance

L'instance Player du joueur qui a eu un état de modification d'invocation 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 demande.

recipientIds: Array

Plus rempli ; une matricevide.

PhoneBookPromptClosed

Se déclenche lorsqu'un joueur ferme l'invite du répertoire téléphonique.

Paramètres

player: Instance

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