GameStateTransitions

Classes
interface	GameStateTransitions
interface	KickCauseCodeAPI

Enumerations
enum	KickCauseCode { KickCauseCode.NONE }
	Opaque code representing various reasons for ending gameplay. More...
enum	KickCauseGroup2 { KickCauseGroup2.PLATFORM , KickCauseGroup2.PLAYER_MANAGER }
	Extends KickCauseGroup by adding game-specific groups. More...
enum	PlatformKickReason { PlatformKickReason.ACTIVE_USER_LOST , PlatformKickReason.NO_MP_PRIVILEGE , PlatformKickReason.NO_CROSSPLAY_PRIVILEGE , PlatformKickReason.USER_SIGNED_OUT }

Detailed Description

Enumeration Type Documentation

KickCauseCode

enum KickCauseCode

Opaque code representing various reasons for ending gameplay.

It must be manipulated using KickCauseCodeAPI functions, which provide access to category and category-specific reason. Categories differentiate various systems and each system should provide it's own list of possible reasons that could cause gameplay to end.

Enumerator
NONE	Predefined value used when gameplay ends as a result of user action and does not need to be explained.

KickCauseGroup2

enum KickCauseGroup2

Extends KickCauseGroup by adding game-specific groups.

Enumerator
PLATFORM	Kick reason comes from PlatformKickReason.
PLAYER_MANAGER	Kick reason comes from PlayerManagerKickReason.

PlatformKickReason

enum PlatformKickReason

Enumerator
ACTIVE_USER_LOST	User who originally started the game is no longer active.
NO_MP_PRIVILEGE	User is not allowed to play multiplayer games.
NO_CROSSPLAY_PRIVILEGE	User is not allowed to play cross-platform multiplayer.
USER_SIGNED_OUT	User signed out of online services.