GameChatOverlay Classe
Definizione
Importante
Alcune informazioni sono relative alla release non definitiva del prodotto, che potrebbe subire modifiche significative prima della release definitiva. Microsoft non riconosce alcuna garanzia, espressa o implicita, in merito alle informazioni qui fornite.
Rappresenta la sovrapposizione della chat del gioco.
public ref class GameChatOverlay sealed
/// [Windows.Foundation.Metadata.ContractVersion(Windows.Foundation.UniversalApiContract, 262144)]
/// [Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
class GameChatOverlay final
[Windows.Foundation.Metadata.ContractVersion(typeof(Windows.Foundation.UniversalApiContract), 262144)]
[Windows.Foundation.Metadata.MarshalingBehavior(Windows.Foundation.Metadata.MarshalingType.Agile)]
public sealed class GameChatOverlay
Public NotInheritable Class GameChatOverlay
- Ereditarietà
- Attributi
Requisiti Windows
Famiglia di dispositivi |
Windows 10 Creators Update (è stato introdotto in 10.0.15063.0)
|
API contract |
Windows.Foundation.UniversalApiContract (è stato introdotto in v4.0)
|
Esempio
Questo esempio illustra la configurazione della chat di gioco e l'aggiunta di messaggi di testo.
#include <winrt/Windows.Gaming.UI.h>
using namespace winrt;
using namespace Windows::Gaming::UI;
...
GameChatOverlay m_gameChatOverlay{nullptr};
...
void ChatSample::SetUpGameChat(GameChatOverlayPosition position)
{
// Get the default game chat overlay object. Platforms that don't support
// it will return null.
m_gameChatOverlay = GameChatOverlay::GetDefault();
if (m_gameChatOverlay)
{
// Position the overlay in the given position.
m_gameChatOverlay.DesiredPosition(position);
}
}
// This method typically would be wired to a text entry box in order to send
// text messages.
void ChatSample::SendTextMessage(std::wstring gamertag, std::wstring message)
{
if (m_gameChatOverlay)
{
// Render the text in the overlay.
m_gameChatOverlay.AddMessage(
gamertag,
message,
GameChatMessageOrigin::Text);
}
else
{
// The game should render the outgoing message in its own UI.
}
}
void ChatSample::SetUpGameChat(GameChatOverlayPosition position)
{
// Get the default game chat overlay object. Platforms that don't support
// it will return null.
m_gameChatOverlay = GameChatOverlay::GetDefault();
if (m_gameChatOverlay)
{
// Position the overlay in the given position.
m_gameChatOverlay->DesiredPosition = position;
}
}
// This method typically would be wired to a text entry box in order to send
// text messages.
void ChatSample::SendTextMessage(String^ gamertag, String^ message)
{
if (m_gameChatOverlay)
{
// Render the text in the overlay.
m_gameChatOverlay->AddMessage(
gamertag,
message,
GameChatMessageOrigin::Text);
}
else
{
// The game should render the outgoing message in its own UI.
}
}
Commenti
Questa classe fornisce metodi per ottenere l'istanza di sovrapposizione di chat di gioco predefinita, impostare la posizione desiderata della sovrapposizione e aggiungere messaggi a esso.
Proprietà
DesiredPosition |
Posizione desiderata della sovrapposizione della chat del gioco. |
Metodi
AddMessage(String, String, GameChatMessageOrigin) |
Eseguire il rendering di un messaggio nella sovrapposizione della chat del gioco. |
GetDefault() |
Ottiene l'istanza di sovrapposizione di chat di gioco predefinita. |