Sintaxis
Parámetros
targetChatControlCount uint32_t
El número de controles de chat de destino en la matriz targetChatControls.
targetChatControls PartyChatControlArraymatriz de entrada de tamaño
targetChatControlCount
La matriz de targetChatControlCount entradas de PartyChatControls de destino.
chatText PartyString
El texto que se va a enviar.
dataBufferCount uint32_t
El número de estructuras de búfer proporcionadas en la matriz dataBuffers.
dataBuffers PartyDataBuffer*matriz de entrada de tamaño
dataBufferCount
La matriz de dataBufferCount entradas de estructuras PartyDataBuffer que describen una carga de mensaje auxiliar que se va a enviar. Se omite cuando dataBufferCount es cero.
Valor devuelto
PartyErrorc_partyErrorSuccess si la llamada se realizó correctamente o un código de error en caso contrario. La forma legible del código de error se puede recuperar mediante PartyManager::GetErrorMessage().
Comentarios
Actualmente no se admite el envío de texto de chat a controles de chat locales. Si la matriz de controles de chat de destino incluye algún destino local, esta llamada producirá un error de forma sincrónica.No hay traducción, localización ni filtrado de lenguaje ofensivo garantizados del contenido del texto; la cadena de texto de chat se presentará con el texto tal cual.
La cadena de texto solo se entregará a los controles de chat de destino que hayan configurado sus propias instancias para recibir mensajes de texto del control de chat local mediante PartyLocalChatControl::SetPermissions().
Si un control de chat de destino no está conectado al menos a una red en común con el control de chat de origen, la cadena de texto no se entregará. Esto es posible si hay dos controles de chat locales. Es posible que un control de chat de destino conectado a uno de los controles de chat locales no esté conectado a todos los demás controles de chat locales.
Las estructuras PartyDataBuffer de la matriz
dataBuffers son para datos auxiliares asociados al texto de chat, como metadatos que indican el color que se debe usar para representar el texto o un blob binario que contiene datos de imagen para un icono que se representará junto con el texto de chat. Para enviar datos de juego que no estén relacionados con el chat de texto, consulte PartyLocalEndpoint::SendMessage(), una opción de mensajería que expone un control más preciso sobre el comportamiento de transmisión de mensajes. Los autores de la llamada proporcionan 0 o más estructuras PartyDataBuffer en la matriz
dataBuffers. La memoria a la que hacen referencia las estructuras no tiene que ser contigua, lo que facilita tener un búfer de encabezado fijo seguido de una carga variable, por ejemplo. Los búferes se ensamblarán en orden, se transmitirán y se entregarán a los controles de chat de destino como un único bloque de datos contiguo, separado del texto de chat, en un cambio de estado PartyChatTextReceivedStateChange. La biblioteca Party no consume ancho de banda transmitiendo metadatos para describir la segmentación original de PartyDataBuffer.
Requisitos
Encabezado: Party.hConsulte también
PartyLocalChatControlPartyChatTextReceivedStateChange