SCR_PlayerListedAdminManagerComponent Interface Reference

Inheritance diagram for SCR_PlayerListedAdminManagerComponent:

Public Member Functions
override void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.
override void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.
bool	IsPlayerOnAdminList (int playerId)
	return True if the player ID is in the active listed admins. Meaning that the player that joined can login as admin even if the player is not yet logged in
int	GetActiveListedAdmins (out notnull array< int > activeListedAdmins)
	param[out] Get a list of all players that are listed admins currently in the server.
ScriptInvokerBase< SCR_PlayerAdminManager_OnActiveListedAdminsChanged >	GetOnActiveListedAdminsChanged ()
void	SCR_PlayerListedAdminManagerComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
Public Member Functions inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	GetGameMode ()
void	OnGameEnd ()
	Called on all machines when the world ends.
void	OnGameStateChanged (SCR_EGameModeState state)
	Called when game mode state changes called on all machines.
void	OnGameModeStart ()
	Called on every machine when game mode starts.
void	OnGameModeEnd (SCR_GameModeEndData data)
	Called when game mode ends.
void	OnPlayerConnected (int playerId)
	Called after a player is connected.
void	OnPlayerAuditSuccess (int playerId)
	Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.
void	OnPlayerAuditFail (int playerId)
	Event is called when player connecting Session hosting current Game Mode AuditFail() call may be called under two occasions: 1) verification is required but failed (account is not valid, player is banned, internet issues) 2) player cannot be verified as authentication is not required or possible - where it may be valid behavior (server online connectivity turned off for example) Basically non-audited player cannot access persistency/ etc.
void	OnPlayerAuditTimeouted (int playerId)
	Event is called when player connected to Session was kicked and did not reconnected in time This mean that slot reservation can be canceled.
void	OnPlayerAuditRevived (int playerId)
	Event is called when player reconnected successfully back to Session after kick This mean that slot reservation need to be finished (closed).
void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).
void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.
void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
	Called after a player is spawned.
bool	PreparePlayerEntity_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
void	OnSpawnPlayerEntityFailure_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, IEntity entity, SCR_SpawnData data, SCR_ESpawnResult reason)
void	OnPlayerSpawnFinalize_S (SCR_SpawnRequestComponent requestComponent, SCR_SpawnHandlerComponent handlerComponent, SCR_SpawnData data, IEntity entity)
bool	HandlePlayerKilled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	See SCR_BaseGameMode.HandlePlayerKilled.
void	OnPlayerKilled (notnull SCR_InstigatorContextData instigatorContextData)
	Called after a player gets killed.
void	OnPlayerKilledHandled (int playerId, IEntity playerEntity, IEntity killerEntity, notnull Instigator instigator)
	Called after player gets killed in cases where the kill was handled by the game mode, supressing the default OnPlayerKilled behaviour.
void	OnPlayerDeleted (int playerId, IEntity player)
	Called after a player gets deleted.
void	OnPlayerRoleChange (int playerId, EPlayerRole roleFlags)
	Called when player role changes.
void	OnWorldPostProcess (World world)
	Called once loading of all entities of the world have been finished (still within the loading)
void	HandleOnLoadoutAssigned (int playerID, SCR_BasePlayerLoadout assignedLoadout)
	What happens when a player is assigned a loadout.
void	HandleOnFactionAssigned (int playerID, Faction assignedFaction)
	What happens when a player is assigned a faction.
void	HandleOnSpawnPointAssigned (int playerID, SCR_SpawnPoint spawnPoint)
	What happens when a player is assigned a spawn point.
void	OnControllableSpawned (IEntity entity)
	When a controllable entity is spawned, this event is raised.
void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.
void	OnControllableDeleted (IEntity entity)
	Prior to a controllable entity being DELETED, this event is raised.
void	SCR_BaseGameModeComponent (IEntityComponentSource src, IEntity ent, IEntity parent)

Static Public Member Functions
static SCR_PlayerListedAdminManagerComponent	GetInstance ()
	return Get Instance of SCR_PlayerListedAdminManagerComponent

Protected Member Functions
void	OnListedAdminsChanged ()
	Called on player connect or disconnect and that player is a listed admin for the server.

Protected Attributes
ref array< int >	m_aAdminPlayers = {}
ref ScriptInvokerBase< SCR_PlayerAdminManager_OnActiveListedAdminsChanged >	m_OnActiveListedAdminsChanged
Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Static Protected Attributes
static SCR_PlayerListedAdminManagerComponent	m_Instance

Constructor & Destructor Documentation

SCR_PlayerListedAdminManagerComponent()

void SCR_PlayerListedAdminManagerComponent.SCR_PlayerListedAdminManagerComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent
	)

Member Function Documentation

GetActiveListedAdmins()

int SCR_PlayerListedAdminManagerComponent.GetActiveListedAdmins

(

out notnull array< int >

activeListedAdmins

)

param[out] Get a list of all players that are listed admins currently in the server.

Both those are logged in and those who are not return Count of currently active listed admins

GetInstance()

static SCR_PlayerListedAdminManagerComponent SCR_PlayerListedAdminManagerComponent.GetInstance ( )

static

return Get Instance of SCR_PlayerListedAdminManagerComponent

GetOnActiveListedAdminsChanged()

ScriptInvokerBase< SCR_PlayerAdminManager_OnActiveListedAdminsChanged > SCR_PlayerListedAdminManagerComponent.GetOnActiveListedAdminsChanged

(

)

Returns

Script invoker when active listed admins changed aka: A player connected or left that is a listed admin of the server

IsPlayerOnAdminList()

bool SCR_PlayerListedAdminManagerComponent.IsPlayerOnAdminList

(

int

playerId

)

return True if the player ID is in the active listed admins. Meaning that the player that joined can login as admin even if the player is not yet logged in

OnListedAdminsChanged()

void SCR_PlayerListedAdminManagerComponent.OnListedAdminsChanged ( )

protected

Called on player connect or disconnect and that player is a listed admin for the server.

OnPlayerAuditSuccess()

override void SCR_PlayerListedAdminManagerComponent.OnPlayerAuditSuccess

(

int

playerId

)

Event is called when player connecting Session hosting current Game Mode where is required authentication verification via.

platform services AuditSuccess() call specifically mean this verification was successful Basically audited player has access to persistency/ etc. related functionality provided by online services.

Parameters

[in]

playerId

is index of player in game, equal to the one assigned at PlayerController

Implements SCR_BaseGameModeComponent.

OnPlayerDisconnected()

override void SCR_PlayerListedAdminManagerComponent.OnPlayerDisconnected	(	int	playerId,
		KickCauseCode	cause,
		int	timeout
	)

Called after a player is disconnected.

Parameters

[in]	playerId	PlayerId of disconnected player.
[in]	cause	Reason player disconnected
[in]	timeout	Timeout for when players are allowed to connect again. -1 means Ban without an assigned timeout

Implements SCR_BaseGameModeComponent.

Member Data Documentation

m_aAdminPlayers

ref array<int> SCR_PlayerListedAdminManagerComponent.m_aAdminPlayers = {}

protected

m_Instance

SCR_PlayerListedAdminManagerComponent SCR_PlayerListedAdminManagerComponent.m_Instance

staticprotected

m_OnActiveListedAdminsChanged

ref ScriptInvokerBase<SCR_PlayerAdminManager_OnActiveListedAdminsChanged> SCR_PlayerListedAdminManagerComponent.m_OnActiveListedAdminsChanged

protected

---

The documentation for this interface was generated from the following file:

• Game/GameMode/Components/SCR_PlayerListedAdminManagerComponent.c