Inheritance diagram for SCR_NotificationSenderComponent:

[legend]

Public Member Functions
override void	OnControllableDestroyed (notnull SCR_InstigatorContextData instigatorContextData)
	When a controllable entity is destroyed, this event is raised.

override void	OnPlayerRegistered (int playerId)
	Called on every machine after a player is registered (identity, name etc.).

override void	OnPlayerDisconnected (int playerId, KickCauseCode cause, int timeout)
	Called after a player is disconnected.

override void	OnPlayerSpawned (int playerId, IEntity controlledEntity)
	Called after a player is spawned.

void	OnWeatherChangedNotification (int playerID)
	Called when weather is set to looping or when weather itself is changed (which auto sets it on looping) This is to make sure the notification, that weather is set, is only called once.

int	GetKillFeedTypeNames (notnull array< ref SCR_NotificationKillfeedTypeName > killFeedTypeNames)
	Get an list of all killfeed types and the localized name.

int	GetKillFeedReceiveTypeNames (notnull array< ref SCR_NotificationKillfeedreceiveTypeName > killFeedReceiveTypeNames)
	Get an list of all killfeed receive types and the localized name.

EKillFeedType	GetKillFeedType ()

void	SetKillFeedType (EKillFeedType killFeedType, int playerNotificationId=-1)
	Server set killfeed type.

EKillFeedReceiveType	GetReceiveKillFeedType ()

void	SetReceiveKillFeedType (EKillFeedReceiveType receiveKillFeedType, int playerNotificationId=-1)
	Server set killfeed receive type.

override bool	RplSave (ScriptBitWriter writer)

override bool	RplLoad (ScriptBitReader reader)

override void	EOnInit (IEntity owner)

override void	OnPostInit (IEntity owner)

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)

Protected Member Functions
void	OnEditorLimitedChanged (bool isLimited)

void	OnWeatherChangedNotificationDelay (int playerID)

void	SetKillFeedTypeBroadcast (EKillFeedType killFeedType)

void	SetReceiveKillFeedTypeBroadcast (EKillFeedReceiveType receiveKillFeedType)

override void	OnDelete (IEntity owner)

Protected Attributes
bool	m_bShowPlayerLeftNotification

EKillFeedType	m_iKillFeedType

EKillFeedReceiveType	m_iReceiveKillFeedType

ref array< ref SCR_NotificationKillfeedTypeName >	m_aKillfeedTypeNames

ref array< ref SCR_NotificationKillfeedreceiveTypeName >	m_aKillfeedReceiveTypeNames

ref SCR_ConfigurableDialogUiPresets	m_PlayerKickReasonsConfig

Faction	m_FactionOnSpawn

SCR_FactionManager	m_FactionManager

bool	m_bListeningToWeatherChanged

Protected Attributes inherited from SCR_BaseGameModeComponent
SCR_BaseGameMode	m_pGameMode
	The game mode entity this component is attached to.

Member Function Documentation

◆ EOnInit()

override void SCR_NotificationSenderComponent.EOnInit ( IEntity owner )

◆ GetKillFeedReceiveTypeNames()

int SCR_NotificationSenderComponent.GetKillFeedReceiveTypeNames ( notnull array< ref SCR_NotificationKillfeedreceiveTypeName > killFeedReceiveTypeNames )

Get an list of all killfeed receive types and the localized name.

Parameters

[in] killFeedReceiveTypeNames list of killfeed receive type and name

Returns: the amount of names in the list

◆ GetKillFeedType()

EKillFeedType SCR_NotificationSenderComponent.GetKillFeedType ( )

Returns: the type of killfeed that is currently displayed

◆ GetKillFeedTypeNames()

int SCR_NotificationSenderComponent.GetKillFeedTypeNames ( notnull array< ref SCR_NotificationKillfeedTypeName > killFeedTypeNames )

Get an list of all killfeed types and the localized name.

Parameters

[in] killFeedTypeNames list of killfeed type and name

Returns: the amount of names in the list

◆ GetReceiveKillFeedType()

EKillFeedReceiveType SCR_NotificationSenderComponent.GetReceiveKillFeedType ( )

Returns: the current killfeed receive type

◆ OnControllableDestroyed()

override void SCR_NotificationSenderComponent.OnControllableDestroyed ( notnull SCR_InstigatorContextData instigatorContextData )

When a controllable entity is destroyed, this event is raised.

Parameters

[in] instigatorContextData Holds the data of the victim and killer

Implements SCR_BaseGameModeComponent.

◆ OnDelete()

override void SCR_NotificationSenderComponent.OnDelete ( IEntity owner )

protected

◆ OnEditorLimitedChanged()

void SCR_NotificationSenderComponent.OnEditorLimitedChanged ( bool isLimited )

protected

◆ OnPlayerDisconnected()

override void SCR_NotificationSenderComponent.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.

◆ OnPlayerRegistered()

override void SCR_NotificationSenderComponent.OnPlayerRegistered ( int playerId )

Called on every machine after a player is registered (identity, name etc.).

Always called after OnPlayerConnected.

Parameters

[in] playerId PlayerId of registered player.

Implements SCR_BaseGameModeComponent.

◆ OnPlayerSpawned()

override void SCR_NotificationSenderComponent.OnPlayerSpawned	(	int	playerId,
		IEntity	controlledEntity
	)

Called after a player is spawned.

Parameters

[in]	playerId	PlayerId of spawned player.
[in]	controlledEntity	Spawned entity for this player.

Implements SCR_BaseGameModeComponent.

◆ OnPostInit()

override void SCR_NotificationSenderComponent.OnPostInit ( IEntity owner )

◆ OnWeatherChangedNotification()

void SCR_NotificationSenderComponent.OnWeatherChangedNotification ( int playerID )

Called when weather is set to looping or when weather itself is changed (which auto sets it on looping) This is to make sure the notification, that weather is set, is only called once.

Parameters

[in] playerID

◆ OnWeatherChangedNotificationDelay()

void SCR_NotificationSenderComponent.OnWeatherChangedNotificationDelay ( int playerID )

protected

◆ RplLoad()

override bool SCR_NotificationSenderComponent.RplLoad ( ScriptBitReader reader )

◆ RplSave()

override bool SCR_NotificationSenderComponent.RplSave ( ScriptBitWriter writer )

◆ SetKillFeedType()

void SCR_NotificationSenderComponent.SetKillFeedType	(	EKillFeedType	killFeedType,
		int	playerNotificationId = `-1`
	)

Server set killfeed type.

Parameters

[in]	killFeedType	new killfeed type to set
[in]	playerNotificationId	add player ID of player that changed the type to display a notification

◆ SetKillFeedTypeBroadcast()

void SCR_NotificationSenderComponent.SetKillFeedTypeBroadcast ( EKillFeedType killFeedType )

protected

◆ SetReceiveKillFeedType()

void SCR_NotificationSenderComponent.SetReceiveKillFeedType	(	EKillFeedReceiveType	receiveKillFeedType,
		int	playerNotificationId = `-1`
	)

Server set killfeed receive type.

Parameters

[in]	receiveKillFeedType	new killfeed reveive type to set
[in]	playerNotificationId	add player ID of player that changed the type to display a notification

◆ SetReceiveKillFeedTypeBroadcast()

void SCR_NotificationSenderComponent.SetReceiveKillFeedTypeBroadcast ( EKillFeedReceiveType receiveKillFeedType )

protected

Member Data Documentation

◆ m_aKillfeedReceiveTypeNames

ref array<ref SCR_NotificationKillfeedreceiveTypeName> SCR_NotificationSenderComponent.m_aKillfeedReceiveTypeNames

protected

◆ m_aKillfeedTypeNames

ref array<ref SCR_NotificationKillfeedTypeName> SCR_NotificationSenderComponent.m_aKillfeedTypeNames

protected

◆ m_bListeningToWeatherChanged

bool SCR_NotificationSenderComponent.m_bListeningToWeatherChanged

protected

◆ m_bShowPlayerLeftNotification

bool SCR_NotificationSenderComponent.m_bShowPlayerLeftNotification

protected

◆ m_FactionManager

SCR_FactionManager SCR_NotificationSenderComponent.m_FactionManager

protected

◆ m_FactionOnSpawn

Faction SCR_NotificationSenderComponent.m_FactionOnSpawn

protected

◆ m_iKillFeedType

EKillFeedType SCR_NotificationSenderComponent.m_iKillFeedType

protected

◆ m_iReceiveKillFeedType

EKillFeedReceiveType SCR_NotificationSenderComponent.m_iReceiveKillFeedType

protected

◆ m_PlayerKickReasonsConfig

ref SCR_ConfigurableDialogUiPresets SCR_NotificationSenderComponent.m_PlayerKickReasonsConfig

protected

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

Game/GameMode/SCR_NotificationSenderComponent.c

Public Member Functions

Protected Member Functions

Protected Attributes

Member Function Documentation

◆ EOnInit()

◆ GetKillFeedReceiveTypeNames()

◆ GetKillFeedType()

◆ GetKillFeedTypeNames()

◆ GetReceiveKillFeedType()

◆ OnControllableDestroyed()

◆ OnDelete()

◆ OnEditorLimitedChanged()

◆ OnPlayerDisconnected()

◆ OnPlayerRegistered()

◆ OnPlayerSpawned()

◆ OnPostInit()

◆ OnWeatherChangedNotification()

◆ OnWeatherChangedNotificationDelay()

◆ RplLoad()

◆ RplSave()

◆ SetKillFeedType()

◆ SetKillFeedTypeBroadcast()

◆ SetReceiveKillFeedType()

◆ SetReceiveKillFeedTypeBroadcast()

Member Data Documentation

◆ m_aKillfeedReceiveTypeNames

◆ m_aKillfeedTypeNames

◆ m_bListeningToWeatherChanged

◆ m_bShowPlayerLeftNotification

◆ m_FactionManager

◆ m_FactionOnSpawn

◆ m_iKillFeedType

◆ m_iReceiveKillFeedType

◆ m_PlayerKickReasonsConfig