Ark Server API (ASE) - Wiki
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
AGameSession Struct Reference

#include <GameState.h>

+ Inheritance diagram for AGameSession:

Public Member Functions

int & MaxSpectatorsField ()
 
int & MaxPlayersField ()
 
char & ReservedPlayerSlotsField ()
 
char & MaxSplitscreensPerConnectionField ()
 
bool & bRequiresPushToTalkField ()
 
FName & SessionNameField ()
 
bool RequiresPushToTalk ()
 
FString * ApproveLogin (FString *result, FString *Options, FString *authToken, unsigned int *NewHomeServerId)
 
bool AtCapacity (bool bSpectator, FString *AuthToken, bool UseReservedSlots, int *NumFreeSlots)
 
bool BanPlayer (APlayerController *BannedPlayer, FText *BanReason)
 
void DumpSessionState ()
 
void InitOptions (FString *Options)
 
bool KickPlayer (APlayerController *KickedPlayer, FText *KickReason)
 
void NotifyLogout (APlayerController *PC)
 
void OnLoginComplete (int LocalUserNum, bool bWasSuccessful, FUniqueNetId *UserId, FString *Error)
 
bool ProcessAutoLogin ()
 
void RegisterPlayer (APlayerController *NewPlayer, TSharedPtr< FUniqueNetId, 0 > *UniqueId, bool bWasFromInvite)
 
void ReturnToMainMenuHost ()
 
bool TravelToSession (int ControllerId, FName InSessionName)
 
void UnregisterPlayer (APlayerController *ExitingPlayer)
 
void UpdateSessionJoinability (FName InSessionName, bool bPublicSearchable, bool bAllowInvites, bool bJoinViaPresence, bool bJoinViaPresenceFriendsOnly)
 
int & MaxSpectatorsField ()
 
int & MaxPlayersField ()
 
char & MaxSplitscreensPerConnectionField ()
 
bool & bRequiresPushToTalkField ()
 
FName & SessionNameField ()
 
bool RequiresPushToTalk ()
 
void InitOptions (FString *Options)
 
bool ProcessAutoLogin ()
 
void OnLoginComplete (int LocalUserNum, bool bWasSuccessful, FUniqueNetId *UserId, FString *Error)
 
FString * ApproveLogin (FString *result, FString *Options, FString *authToken)
 
void RegisterPlayer (APlayerController *NewPlayer, TSharedPtr< FUniqueNetId, 0 > *UniqueId, bool bWasFromInvite)
 
void UnregisterPlayer (APlayerController *ExitingPlayer)
 
bool AtCapacity (bool bSpectator, FString *AuthToken)
 
void NotifyLogout (APlayerController *PC)
 
bool KickPlayer (APlayerController *KickedPlayer, FText *KickReason)
 
void BanPlayer ()
 
void ReturnToMainMenuHost ()
 
bool TravelToSession (int ControllerId, FName InSessionName)
 
void UpdateSessionJoinability (FName InSessionName, bool bPublicSearchable, bool bAllowInvites, bool bJoinViaPresence, bool bJoinViaPresenceFriendsOnly)
 

Static Public Member Functions

static UClass * GetPrivateStaticClass (const wchar_t *Package)
 

Detailed Description

Definition at line 372 of file GameState.h.

Member Function Documentation

◆ ApproveLogin() [1/2]

FString * AGameSession::ApproveLogin ( FString * result,
FString * Options,
FString * authToken )
inline

Definition at line 328 of file GameState.h.

◆ ApproveLogin() [2/2]

FString * AGameSession::ApproveLogin ( FString * result,
FString * Options,
FString * authToken,
unsigned int * NewHomeServerId )
inline

Definition at line 386 of file GameState.h.

◆ AtCapacity() [1/2]

bool AGameSession::AtCapacity ( bool bSpectator,
FString * AuthToken )
inline

Definition at line 331 of file GameState.h.

◆ AtCapacity() [2/2]

bool AGameSession::AtCapacity ( bool bSpectator,
FString * AuthToken,
bool UseReservedSlots,
int * NumFreeSlots )
inline

Definition at line 387 of file GameState.h.

◆ BanPlayer() [1/2]

void AGameSession::BanPlayer ( )
inline

Definition at line 334 of file GameState.h.

◆ BanPlayer() [2/2]

bool AGameSession::BanPlayer ( APlayerController * BannedPlayer,
FText * BanReason )
inline

Definition at line 388 of file GameState.h.

◆ bRequiresPushToTalkField() [1/2]

bool & AGameSession::bRequiresPushToTalkField ( )
inline

Definition at line 319 of file GameState.h.

◆ bRequiresPushToTalkField() [2/2]

bool & AGameSession::bRequiresPushToTalkField ( )
inline

Definition at line 378 of file GameState.h.

◆ DumpSessionState()

void AGameSession::DumpSessionState ( )
inline

Definition at line 389 of file GameState.h.

◆ GetPrivateStaticClass()

static UClass * AGameSession::GetPrivateStaticClass ( const wchar_t * Package)
inlinestatic

Definition at line 400 of file GameState.h.

◆ InitOptions() [1/2]

void AGameSession::InitOptions ( FString * Options)
inline

Definition at line 325 of file GameState.h.

◆ InitOptions() [2/2]

void AGameSession::InitOptions ( FString * Options)
inline

Definition at line 390 of file GameState.h.

◆ KickPlayer() [1/2]

bool AGameSession::KickPlayer ( APlayerController * KickedPlayer,
FText * KickReason )
inline

Definition at line 333 of file GameState.h.

◆ KickPlayer() [2/2]

bool AGameSession::KickPlayer ( APlayerController * KickedPlayer,
FText * KickReason )
inline

Definition at line 391 of file GameState.h.

◆ MaxPlayersField() [1/2]

int & AGameSession::MaxPlayersField ( )
inline

Definition at line 317 of file GameState.h.

◆ MaxPlayersField() [2/2]

int & AGameSession::MaxPlayersField ( )
inline

Definition at line 375 of file GameState.h.

◆ MaxSpectatorsField() [1/2]

int & AGameSession::MaxSpectatorsField ( )
inline

Definition at line 316 of file GameState.h.

◆ MaxSpectatorsField() [2/2]

int & AGameSession::MaxSpectatorsField ( )
inline

Definition at line 374 of file GameState.h.

◆ MaxSplitscreensPerConnectionField() [1/2]

char & AGameSession::MaxSplitscreensPerConnectionField ( )
inline

Definition at line 318 of file GameState.h.

◆ MaxSplitscreensPerConnectionField() [2/2]

char & AGameSession::MaxSplitscreensPerConnectionField ( )
inline

Definition at line 377 of file GameState.h.

◆ NotifyLogout() [1/2]

void AGameSession::NotifyLogout ( APlayerController * PC)
inline

Definition at line 332 of file GameState.h.

◆ NotifyLogout() [2/2]

void AGameSession::NotifyLogout ( APlayerController * PC)
inline

Definition at line 392 of file GameState.h.

◆ OnLoginComplete() [1/2]

void AGameSession::OnLoginComplete ( int LocalUserNum,
bool bWasSuccessful,
FUniqueNetId * UserId,
FString * Error )
inline

Definition at line 327 of file GameState.h.

◆ OnLoginComplete() [2/2]

void AGameSession::OnLoginComplete ( int LocalUserNum,
bool bWasSuccessful,
FUniqueNetId * UserId,
FString * Error )
inline

Definition at line 393 of file GameState.h.

◆ ProcessAutoLogin() [1/2]

bool AGameSession::ProcessAutoLogin ( )
inline

Definition at line 326 of file GameState.h.

◆ ProcessAutoLogin() [2/2]

bool AGameSession::ProcessAutoLogin ( )
inline

Definition at line 394 of file GameState.h.

◆ RegisterPlayer() [1/2]

void AGameSession::RegisterPlayer ( APlayerController * NewPlayer,
TSharedPtr< FUniqueNetId, 0 > * UniqueId,
bool bWasFromInvite )
inline

Definition at line 329 of file GameState.h.

◆ RegisterPlayer() [2/2]

void AGameSession::RegisterPlayer ( APlayerController * NewPlayer,
TSharedPtr< FUniqueNetId, 0 > * UniqueId,
bool bWasFromInvite )
inline

Definition at line 395 of file GameState.h.

◆ RequiresPushToTalk() [1/2]

bool AGameSession::RequiresPushToTalk ( )
inline

Definition at line 324 of file GameState.h.

◆ RequiresPushToTalk() [2/2]

bool AGameSession::RequiresPushToTalk ( )
inline

Definition at line 383 of file GameState.h.

◆ ReservedPlayerSlotsField()

char & AGameSession::ReservedPlayerSlotsField ( )
inline

Definition at line 376 of file GameState.h.

◆ ReturnToMainMenuHost() [1/2]

void AGameSession::ReturnToMainMenuHost ( )
inline

Definition at line 335 of file GameState.h.

◆ ReturnToMainMenuHost() [2/2]

void AGameSession::ReturnToMainMenuHost ( )
inline

Definition at line 396 of file GameState.h.

◆ SessionNameField() [1/2]

FName & AGameSession::SessionNameField ( )
inline

Definition at line 320 of file GameState.h.

◆ SessionNameField() [2/2]

FName & AGameSession::SessionNameField ( )
inline

Definition at line 379 of file GameState.h.

◆ TravelToSession() [1/2]

bool AGameSession::TravelToSession ( int ControllerId,
FName InSessionName )
inline

Definition at line 336 of file GameState.h.

◆ TravelToSession() [2/2]

bool AGameSession::TravelToSession ( int ControllerId,
FName InSessionName )
inline

Definition at line 397 of file GameState.h.

◆ UnregisterPlayer() [1/2]

void AGameSession::UnregisterPlayer ( APlayerController * ExitingPlayer)
inline

Definition at line 330 of file GameState.h.

◆ UnregisterPlayer() [2/2]

void AGameSession::UnregisterPlayer ( APlayerController * ExitingPlayer)
inline

Definition at line 398 of file GameState.h.

◆ UpdateSessionJoinability() [1/2]

void AGameSession::UpdateSessionJoinability ( FName InSessionName,
bool bPublicSearchable,
bool bAllowInvites,
bool bJoinViaPresence,
bool bJoinViaPresenceFriendsOnly )
inline

Definition at line 337 of file GameState.h.

◆ UpdateSessionJoinability() [2/2]

void AGameSession::UpdateSessionJoinability ( FName InSessionName,
bool bPublicSearchable,
bool bAllowInvites,
bool bJoinViaPresence,
bool bJoinViaPresenceFriendsOnly )
inline

Definition at line 399 of file GameState.h.

The documentation for this struct was generated from the following files: