SocialService

Methoden

HideSelfView():void
Versteckt die Ansichtdes aufrufenden Spieler:in.
PromptGameInvite(player : Instance,experienceInviteOptions : Instance):void
Fordert den gegebenen Player mit dem Einladungsbildschirm an.
PromptPhoneBook(player : Instance,tag : string):void
Fordert den angegebenen Player mit dem Telefonbuch.
ShowSelfView(selfViewPosition : Enum.SelfViewPosition):void
Zeigt den Ansichtdes Spieler:inan.
CanSendCallInviteAsync(player : Instance):bool
Angehalten
Zeigt an, ob der angegebene Player andere Spieler zu einem Anruf einladen kann.
CanSendGameInviteAsync(player : Instance,recipientId : number):bool
Angehalten
Zeigt an, ob der angegebene Player andere Spieler einladen kann.

Ereignisse

CallInviteStateChanged(player : Instance,inviteState : Enum.InviteState):RBXScriptSignal
Feuert, wenn der Zustand "Einladung annehmen" eines Spieler:ingeändert wird.
GameInvitePromptClosed(player : Instance,recipientIds : Array):RBXScriptSignal
Feuert, wenn ein Spieler eine Einladung abgibt.
PhoneBookPromptClosed(player : Instance):RBXScriptSignal
Feuert, wenn ein Spieler die Telefon-Book-Anfrage schließt.

Callbacks

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

Eigenschaften

Methoden

HideSelfView

void

Versteckt die Ansichtdes aufrufenden Spieler:in. Wenn diese Methode aufgerufen wird, während die Selbstansicht bereits versteckt ist, tut es nichts.

Rückgaben

void

PromptGameInvite

void

PromptGameInvite() zeigt eine Einladung an den lokalen Spieler an, durch die er seine Freunde zur aktuellen Erlebniseinladen kann. Bevor Sie diesen Methode aufrufen, sollten Sie CanSendGameInviteAsync() verwenden, um zu bestimmen, ob der Spieler eine Einladung senden kann,

Siehe Einladungseite-Beispiele für weitere Informationen zu Einladungsfeldern, Anpassungen und Benachrichtigungen und zur Verwendung von Startdaten.

Parameter

player: Instance

Der Player zum Ausführen mit dem Pop-up.

experienceInviteOptions: Instance

Optionaler ExperienceInviteOptions Objekt zum Anpassen der Anfrage.

Standardwert: "nil"

Rückgaben

void

Code-Beispiele

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

Fordert den angegebenen Player mit dem Telefonbuch. Wenn der Spieler:injemanden anruft, wird das CallInviteStateChanged -Ereignis ausgelöst. Sie sollten Class.SocialService:CanSendCallInvite

Wenn ein Spieler nicht in der Lage ist, das Telefonbuch zu öffnen, wird ein Fehler-Dialog angezeigt.

Siehe Roblox Connect für eine Beispiel实装ierung dieser Methode.

Parameter

player: Instance

Der Spieler, der mit dem Telefonbuch anfängt.

tag: string

String, um zu helfen, verschiedene Telefon-Buch-Eintragspunkte oder ähnliches zu unterscheiden. Zum Beispiel kannst du einen String übergeben, der definiert, in welcher Region sich der aktuelle Charakter des Spieler:inbefindet.

Rückgaben

void

Code-Beispiele

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

Zeigt den Ansichtdes Spieler:inan. Wenn diese Methode aufgerufen wird, während der Selbstansichts-Self-View bereits sichtbar ist, wird nichts getan.

Parameter

selfViewPosition: Enum.SelfViewPosition

Die Position, in der der Self-View platziert werden soll.

Standardwert: "LastPosition"

Rückgaben

void

CanSendCallInviteAsync

Angehalten

Gibt true zurück, wenn der angegebene Player einen Anruf-Einladung an einen Freund:insenden kann. Sie sollten immer das Ergebnis dieser Methode verwenden, bevor Sie den Ergebnis des Telefonbuches aufrufen, da die Fähigkeit, das Telefonbuch zu öffnen, abhängig von dem Spieler:insein kann.

Siehe Roblox Connect für eine Beispiel实装ierung dieser Methode.

Parameter

player: Instance

Die Player Instanz des Spielers, die möglicherweise eine Einladung sendet.

Rückgaben

Ob der angegebene Spieler eine Einladung senden kann.

Code-Beispiele

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

Angehalten

CanSendGameInviteAsync() gibt zurück true , wenn der angegebene Player andere Spieler in die aktuelle Erlebniseinladen kann. Sie sollten immer das Ergebnis dieser Methode verwenden, bevor Sie 0> Class.SocialService:PromptGameInvite()

Siehe Spieler-Einladungs-Aufforderungen für weitere Informationen zu der Umsetzung von Spieler-Einladungs-Aufforderungen, Anpassungen und Benachrichtigungen und Verwendung von Start-Daten.

Parameter

player: Instance

Die Player Instanz des Spielers, der möglicherweise eine Einladung sendet.

recipientId: number

Optional Player.UserId des potenziellen Empfängers , verwendet, um zu überprüfen, ob der Sender diesen bestimmten Empfänger einladen kann.

Standardwert: 0

Rückgaben

Ob der angegebene Spieler eine Einladung senden kann.

Code-Beispiele

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

Ereignisse

CallInviteStateChanged

Dieses Ereignis wird ausgelöst, wenn der Zustand "Einladung annehmen" eines Spieler:ingeändert wird.

Parameter

player: Instance

Die Player Instanz des Spielers, der eine Anruf-Einladung-Statusänderung hatte.

inviteState: Enum.InviteState

Der neue Anruf-Einladungs-Zustand.

Code-Beispiele

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

Dieses Ereignis wird ausgelöst, wenn ein Spieler eine Einladungsmeldung schließt.

Parameter

player: Instance

Die Player Instanz des Spielers, der die Anfrage geschlossen hat.

recipientIds: Array

Nicht mehr belegt; eine leere Array.

PhoneBookPromptClosed

Feuert, wenn ein Spieler die Telefon-Book-Anfrage schließt.

Parameter

player: Instance

Die Player Instanz des Spielers, der das Telefonbuch geschlossen hat.