game_chat_state_change

Represents a generic, base structure for an event, change in state, or outgoing data.

Syntax

typedef struct game_chat_state_change {  
    game_chat_state_change_type state_change_type;  
} game_chat_state_change  

Members

state_change_type
Type: game_chat_state_change_type

The specific type of the state change represented. Use this field to determine which corresponding derived structure is represented by this game_chat_state_change structure header.

Remarks

This base structure represents a state change, such as the receipt of a text chat. game_chat_state_change structures are reported by the chat_manager::start_processing_state_changes method. The app handles the represented state changes, and then promptly passes them back by calling the chat_manager::finish_processing_state_changes method.

The state_change_type field indicates what kind of state change occurred. Your app should cast this base structure to the indicated derived structure to retrieve additional, event-specific information. The following structures are derived from this base structure:

game_chat_state_change_array

The game_chat_state_change_array type is a constant array of game_chat_state_change pointers. This type is provided for convenience, and is used with the chat_manager::start_processing_state_changes and chat_manager::finish_processing_state_changes methods.

typedef const game_chat_state_change * const * game_chat_state_change_array;

Requirements

Header: GameChat2.h

Supported platforms: Windows, Xbox One family consoles and Xbox Series consoles

See also

Intro to Game Chat 2
chat_manager
GameChat2 members