GameChatOverlay 클래스

정의

네임스페이스:

Windows.Gaming.UI

게임 채팅 오버레이를 나타냅니다.

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

상속

Object Platform::Object IInspectable GameChatOverlay

특성

ContractVersionAttribute MarshalingBehaviorAttribute

Windows 요구 사항

디바이스 패밀리	Windows 10 Creators Update (10.0.15063.0에서 도입되었습니다.)
API contract	Windows.Foundation.UniversalApiContract (v4.0에서 도입되었습니다.)

예제

이 샘플에서는 게임 채팅을 설정하고 문자 메시지를 추가하는 방법을 보여 줍니다.

#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.
    } 
}

설명

이 클래스는 기본 게임 채팅 오버레이 instance 얻고, 오버레이의 원하는 위치를 설정하고, 메시지를 추가하는 메서드를 제공합니다.

속성

DesiredPosition

게임 채팅 오버레이의 원하는 위치입니다.

메서드

AddMessage(String, String, GameChatMessageOrigin)	게임 채팅 오버레이에서 메시지를 렌더링합니다.
GetDefault()	기본 게임 채팅 오버레이 instance 가져옵니다.

추가 정보

• GameChatOverlayPosition