PartyLocalChatControl::SendText
Überträgt eine Chattextzeichenfolge an jedes angegebene Zielchatsteuerelement.
Syntax
PartyError SendText(
uint32_t targetChatControlCount,
PartyChatControlArray targetChatControls,
PartyString chatText,
uint32_t dataBufferCount,
const PartyDataBuffer* dataBuffers
)
Parameter
targetChatControlCount uint32_t
Die Anzahl der Zielchatsteuerelemente im targetChatControls Array.
targetChatControls
PartyChatControlArray
Eingabearray der Größe targetChatControlCount
Das targetChatControlCount Einstiegsarray von PartyChatControls.The entry array of target PartyChatControls.
chatText
PartyString
Der zu sendende Text.
dataBufferCount uint32_t
Die Anzahl der im dataBuffers Array bereitgestellten Pufferstrukturen.
dataBuffers
PartyDataBuffer*
Eingabearray der Größe dataBufferCount
Das dataBufferCount Einstiegsarray von PartyDataBuffer-Strukturen, die eine zu sendende Hilfsnachrichtennutzlast beschreiben. Dies wird ignoriert, wenn dataBufferCount null ist.
Rückgabewert
PartyError
c_partyErrorSuccess , wenn der Aufruf erfolgreich war oder andernfalls ein Fehlercode vorliegt. Die lesbare Form des Fehlercodes kann über PartyManager::GetErrorMessage() abgerufen werden.
Hinweise
Das Senden von Chattext an lokale Chatsteuerelemente wird derzeit nicht unterstützt. Wenn das Array von Zielchatsteuerelementen lokale Ziele enthält, schlägt dieser Aufruf synchron fehl.
Es gibt keine garantierte Übersetzung, Lokalisierung oder anstößige Sprachfilterung des Textinhalts; der Chattextzeichenfolge wird der Text unverändert angezeigt.
Die Textzeichenfolge wird nur an Zielchatsteuerelemente übermittelt, die ihre eigenen Instanzen für den Empfang von Textnachrichten vom lokalen Chat-Steuerelement über PartyLocalChatControl::SetPermissions() konfiguriert haben.
Wenn ein Ziel-Chat-Steuerelement nicht mit mindestens einem Netzwerk verbunden ist, das mit der Quellchatsteuerung gemeinsam ist, wird die Textzeichenfolge nicht übermittelt. Dies ist möglich, wenn zwei lokale Chatsteuerelemente vorhanden sind. Ein Zielchat-Steuerelement, das mit einem der lokalen Chatsteuerelemente verbunden ist, ist möglicherweise nicht mit allen anderen lokalen Chatsteuerelementen verbunden.
Die PartyDataBuffer-Strukturen im Array dienen für zusätzliche Daten, die dataBuffers dem Chattext zugeordnet sind, z. B. Metadaten, die die Farbe angeben, die zum Rendern des Texts verwendet werden soll, oder ein binäres Blob, das Bilddaten enthält, damit ein Symbol zusammen mit dem Chattext gerendert werden kann. Informationen zum Senden von Spieldaten, die nichts mit Textchats zu tun haben, finden Sie unter PartyLocalEndpoint::SendMessage(), eine Messagingoption, die eine genauere Kontrolle über das Nachrichtenübertragungsverhalten bietet.
Aufrufer stellen 0 oder mehr PartyDataBuffer-Strukturen im dataBuffers Array bereit. Der Speicher, auf den die Strukturen verweisen, muss nicht zusammenhängend sein, sodass beispielsweise ein fester Headerpuffer gefolgt von einer Variablennutzlast problemlos vorhanden ist. Die Puffer werden in der Reihenfolge zusammengestellt, übertragen und als einzelner zusammenhängender Datenblock getrennt vom Chattext in einem PartyChatTextReceivedStateChange an die Ziel-Chat-Steuerelemente übermittelt. Die Parteibibliothek verbraucht keine Bandbreite zur Übertragung von Metadaten, um die ursprüngliche PartyDataBuffer-Segmentierung zu beschreiben.
Voraussetzungen
Header: Party.h