Syntaxe
Paramètres
targetChatControlCount uint32_t
Le nombre de contrôles de chat cibles dans le tableau targetChatControls.
targetChatControls PartyChatControlArrayinput array of size
targetChatControlCount
Le tableau de targetChatControlCount entrées des PartyChatControls cibles.
chatText PartyString
Le texte à envoyer.
dataBufferCount uint32_t
Le nombre de structures de mémoire tampon fournies dans le tableau dataBuffers.
dataBuffers PartyDataBuffer*input array of size
dataBufferCount
Le tableau de dataBufferCount entrées de structures PartyDataBuffer décrivant une charge utile de message auxiliaire à envoyer. Il est ignoré lorsque dataBufferCount vaut zéro.
Valeur renvoyée
PartyErrorc_partyErrorSuccess si l’appel a réussi ; sinon, un code d’erreur. La forme lisible du code d’erreur peut être obtenue via PartyManager::GetErrorMessage().
Remarques
L’envoi de texte de chat à des contrôles de chat locaux n’est actuellement pas pris en charge. Si le tableau des contrôles de chat cibles inclut des cibles locales, cet appel échoue de manière synchrone.Aucune traduction, localisation ni filtrage des propos offensants du contenu texte n’est garanti ; la chaîne de texte de chat est présentée telle quelle.
La chaîne de texte n’est remise qu’aux contrôles de chat cibles qui ont configuré leurs propres instances pour recevoir les messages texte du contrôle de chat local via PartyLocalChatControl::SetPermissions().
Si un contrôle de chat cible n’est pas connecté à au moins un réseau en commun avec le contrôle de chat source, la chaîne de texte n’est pas remise. Cela est possible s’il existe deux contrôles de chat locaux. Un contrôle de chat cible connecté à l’un des contrôles de chat locaux peut ne pas être connecté à tous les autres contrôles de chat locaux.
Les structures PartyDataBuffer du tableau
dataBuffers sont destinées aux données auxiliaires associées au texte de chat, comme des métadonnées indiquant la couleur à utiliser pour afficher le texte, ou un blob binaire contenant les données d’image d’une icône à afficher avec le texte de chat. Pour envoyer des données de jeu sans rapport avec le chat textuel, consultez PartyLocalEndpoint::SendMessage(), une option de messagerie qui offre un contrôle plus précis du comportement de transmission des messages. Les appelants fournissent 0 ou plusieurs structures PartyDataBuffer dans le tableau
dataBuffers. La mémoire référencée par ces structures n’a pas besoin d’être contiguë, ce qui permet par exemple d’avoir facilement une mémoire tampon d’en-tête fixe suivie d’une charge utile variable. Les mémoires tampons sont assemblées dans l’ordre, transmises et remises aux contrôles de chat cibles sous la forme d’un bloc de données contigu unique, distinct du texte de chat, dans un PartyChatTextReceivedStateChange. La bibliothèque Party ne consomme pas de bande passante pour transmettre des métadonnées décrivant la segmentation d’origine en PartyDataBuffer.
Configuration requise
En-tête : Party.hVoir aussi
PartyLocalChatControlPartyChatTextReceivedStateChange