EOnlineSessionState::Type

Enum indicating the current state of the online session (in progress, ended, etc.)

Windows
MacOS
Linux

References

Module

OnlineSubsystem

Header

/Engine/Plugins/Online/OnlineSubsystem/Source/Public/OnlineSubsystemTypes.h

Include

#include "OnlineSubsystemTypes.h"

Syntax

namespace EOnlineSessionState
{
    enum Type
    {
        NoSession,
        Creating,
        Pending,
        Starting,
        InProgress,
        Ending,
        Ended,
        Destroying,
    }
}

Values

Name

Description

NoSession

An online session has not been created yet

Creating

An online session is in the process of being created

Pending

Session has been created but the session hasn't started (pre match lobby)

Starting

Session has been asked to start (may take time due to communication with backend)

InProgress

The current session has started. Sessions with join in progress disabled are no longer joinable

Ending

The session is still valid, but the session is no longer being played (post match lobby)

Ended

The session is closed and any stats committed

Destroying

The session is being destroyed

Remarks

Enum indicating the current state of the online session (in progress, ended, etc.)

Help shape the future of Unreal Engine documentation! Tell us how we're doing so we can serve you better.
Take our survey
Dismiss