Inheritance diagram for SCR_PingEditorComponent:

Protected Member Functions
void	SendPing (bool unlimitedOnly=false, vector position=vector.Zero, SCR_EditableEntityComponent target=null)
void	ActivateCooldown ()
void	UpdateCooldown ()
void	OnCooldownDone ()
void	SendPingServer (bool unlimitedOnly, vector position, RplId targetID)
void	ReceivePing (int reporterID, bool reporterInEditor, SCR_EditableEntityComponent reporterEntity, bool unlimitedOnly, vector position, RplId targetID)
void	ReceivePingOwner (int reporterID, bool reporterInEditor, bool unlimitedOnly, vector position, RplId targetID)
int	GetPlayerPings (out notnull map< int, SCR_EditableEntityComponent > outPlayerPings)
ScriptInvoker	GetOnPingSend ()
ScriptInvoker	GetOnPingReceive ()
ScriptInvoker	GetOnPingEntityRegister ()
ScriptInvoker	GetOnPingEntityUnregister ()
bool	IsPingOnCooldown ()
void	CallEvents (SCR_EditorManagerEntity manager, bool isReceiver, int reporterID, bool reporterInEditor, bool unlimitedOnly, vector position, SCR_EditableEntityComponent target)
void	Expire (int reporterID, SCR_EditableEntityComponent pingEntity)
override void	EOnEffect (SCR_BaseEditorEffect effect)
void	SCR_PingEditorComponent (IEntityComponentSource src, IEntity ent, IEntity parent)
void	~SCR_PingEditorComponent ()

Protected Attributes
float	m_fPingEntityLifetime
float	m_fCooldownTime
float	m_fCurrentCooldownTime
float	m_fCooldownUpdateFreq = 50
bool	m_bIsOnCooldown
SCR_EditorManagerCore	m_Core
ref map< int, SCR_EditableEntityComponent >	m_PlayerPings = new map<int, SCR_EditableEntityComponent>
SCR_EditableEntityComponent	m_LastPingEntity
ref ScriptInvoker	Event_OnPingSend = new ScriptInvoker
ref ScriptInvoker	Event_OnPingReceive = new ScriptInvoker
ref ScriptInvoker	Event_OnPingEntityRegister = new ScriptInvoker
ref ScriptInvoker	Event_OnPingEntityUnregister = new ScriptInvoker

Detailed Description

Player <> Game Master communication.

Definition at line 70 of file SCR_PingEditorComponent.c.

Constructor & Destructor Documentation

◆ SCR_PingEditorComponent()

void SCR_PingEditorComponent::SCR_PingEditorComponent	(	IEntityComponentSource	src,
		IEntity	ent,
		IEntity	parent )

inlineprotected

Definition at line 392 of file SCR_PingEditorComponent.c.

◆ ~SCR_PingEditorComponent()

void SCR_PingEditorComponent::~SCR_PingEditorComponent ( )

inlineprotected

Definition at line 400 of file SCR_PingEditorComponent.c.

Member Function Documentation

◆ ActivateCooldown()

void SCR_PingEditorComponent::ActivateCooldown ( )

inlineprotected

Definition at line 153 of file SCR_PingEditorComponent.c.

◆ CallEvents()

void SCR_PingEditorComponent::CallEvents	(	SCR_EditorManagerEntity	manager,
		bool	isReceiver,
		int	reporterID,
		bool	reporterInEditor,
		bool	unlimitedOnly,
		vector	position,
		SCR_EditableEntityComponent	target )

inlineprotected

Definition at line 291 of file SCR_PingEditorComponent.c.

◆ EOnEffect()

override void SCR_PingEditorComponent::EOnEffect ( SCR_BaseEditorEffect effect )

inlineprotected

Definition at line 385 of file SCR_PingEditorComponent.c.

◆ Expire()

void SCR_PingEditorComponent::Expire	(	int	reporterID,
		SCR_EditableEntityComponent	pingEntity )

inlineprotected

Definition at line 373 of file SCR_PingEditorComponent.c.

◆ GetOnPingEntityRegister()

ScriptInvoker SCR_PingEditorComponent::GetOnPingEntityRegister ( )

inlineprotected

Get event called when a ping entity is created. Called on editor owner.

Returns: Script invoker

Definition at line 268 of file SCR_PingEditorComponent.c.

◆ GetOnPingEntityUnregister()

ScriptInvoker SCR_PingEditorComponent::GetOnPingEntityUnregister ( )

inlineprotected

Get event called when a ping entity is removed. Called on editor owner.

Returns: Script invoker

Definition at line 277 of file SCR_PingEditorComponent.c.

◆ GetOnPingReceive()

ScriptInvoker SCR_PingEditorComponent::GetOnPingReceive ( )

inlineprotected

Get event called when a ping is received. Called on machine of every player who has editor opened, apart from the one who sent the ping.

Returns: Script invoker

Definition at line 259 of file SCR_PingEditorComponent.c.

◆ GetOnPingSend()

ScriptInvoker SCR_PingEditorComponent::GetOnPingSend ( )

inlineprotected

Get event called when a ping is sent. Called only on the machine of whoever sent the ping.

Returns: Script invoker

Definition at line 250 of file SCR_PingEditorComponent.c.

◆ GetPlayerPings()

int SCR_PingEditorComponent::GetPlayerPings ( out notnull map< int, SCR_EditableEntityComponent > outPlayerPings )

inlineprotected

Get the list of current ping entities.

Parameters

[out] outPlayerPings List of player IDs and ping entities

Returns: Number of pings

Definition at line 240 of file SCR_PingEditorComponent.c.

◆ IsPingOnCooldown()

bool SCR_PingEditorComponent::IsPingOnCooldown ( )

inlineprotected

Get if ping is on cooldown (Locally)

Returns: True if the ping is on cooldown and cannot be excecuted

Definition at line 286 of file SCR_PingEditorComponent.c.

◆ OnCooldownDone()

void SCR_PingEditorComponent::OnCooldownDone ( )

inlineprotected

Definition at line 172 of file SCR_PingEditorComponent.c.

◆ ReceivePing()

void SCR_PingEditorComponent::ReceivePing	(	int	reporterID,
		bool	reporterInEditor,
		SCR_EditableEntityComponent	reporterEntity,
		bool	unlimitedOnly,
		vector	position,
		RplId	targetID )

inlineprotected

Definition at line 196 of file SCR_PingEditorComponent.c.

◆ ReceivePingOwner()

void SCR_PingEditorComponent::ReceivePingOwner	(	int	reporterID,
		bool	reporterInEditor,
		bool	unlimitedOnly,
		vector	position,
		RplId	targetID )

inlineprotected

Definition at line 223 of file SCR_PingEditorComponent.c.

◆ SendPing()

void SCR_PingEditorComponent::SendPing	(	bool	unlimitedOnly = false,
		vector	position = vector.Zero,
		SCR_EditableEntityComponent	target = null )

inlineprotected

Send ping (If not on cooldown).

Parameters

True	if the ping is unlimited only
position	Pinged position
target	Pinged target

Returns: Script invoker

Definition at line 102 of file SCR_PingEditorComponent.c.

◆ SendPingServer()

void SCR_PingEditorComponent::SendPingServer	(	bool	unlimitedOnly,
		vector	position,
		RplId	targetID )

inlineprotected

Definition at line 179 of file SCR_PingEditorComponent.c.

◆ UpdateCooldown()

void SCR_PingEditorComponent::UpdateCooldown ( )

inlineprotected

Definition at line 163 of file SCR_PingEditorComponent.c.

Member Data Documentation

◆ Event_OnPingEntityRegister

ref ScriptInvoker SCR_PingEditorComponent::Event_OnPingEntityRegister = new ScriptInvoker

protected

Definition at line 92 of file SCR_PingEditorComponent.c.

◆ Event_OnPingEntityUnregister

ref ScriptInvoker SCR_PingEditorComponent::Event_OnPingEntityUnregister = new ScriptInvoker

protected

Definition at line 93 of file SCR_PingEditorComponent.c.

◆ Event_OnPingReceive

ref ScriptInvoker SCR_PingEditorComponent::Event_OnPingReceive = new ScriptInvoker

protected

Definition at line 91 of file SCR_PingEditorComponent.c.

◆ Event_OnPingSend

ref ScriptInvoker SCR_PingEditorComponent::Event_OnPingSend = new ScriptInvoker

protected

Definition at line 90 of file SCR_PingEditorComponent.c.

◆ m_bIsOnCooldown

bool SCR_PingEditorComponent::m_bIsOnCooldown

protected

Definition at line 84 of file SCR_PingEditorComponent.c.

◆ m_Core

SCR_EditorManagerCore SCR_PingEditorComponent::m_Core

protected

Definition at line 86 of file SCR_PingEditorComponent.c.

◆ m_fCooldownTime

float SCR_PingEditorComponent::m_fCooldownTime

protected

Definition at line 76 of file SCR_PingEditorComponent.c.

◆ m_fCooldownUpdateFreq

float SCR_PingEditorComponent::m_fCooldownUpdateFreq = 50

protected

Definition at line 82 of file SCR_PingEditorComponent.c.

◆ m_fCurrentCooldownTime

float SCR_PingEditorComponent::m_fCurrentCooldownTime

protected

Definition at line 79 of file SCR_PingEditorComponent.c.

◆ m_fPingEntityLifetime

float SCR_PingEditorComponent::m_fPingEntityLifetime

protected

Definition at line 73 of file SCR_PingEditorComponent.c.

◆ m_LastPingEntity

SCR_EditableEntityComponent SCR_PingEditorComponent::m_LastPingEntity

protected

Definition at line 88 of file SCR_PingEditorComponent.c.

◆ m_PlayerPings

ref map<int, SCR_EditableEntityComponent> SCR_PingEditorComponent::m_PlayerPings = new map<int, SCR_EditableEntityComponent>

protected

Definition at line 87 of file SCR_PingEditorComponent.c.

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

scripts/Game/Editor/Components/Editor/SCR_PingEditorComponent.c

Protected Member Functions

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ SCR_PingEditorComponent()

◆ ~SCR_PingEditorComponent()

Member Function Documentation

◆ ActivateCooldown()

◆ CallEvents()

◆ EOnEffect()

◆ Expire()

◆ GetOnPingEntityRegister()

◆ GetOnPingEntityUnregister()

◆ GetOnPingReceive()

◆ GetOnPingSend()

◆ GetPlayerPings()

◆ IsPingOnCooldown()

◆ OnCooldownDone()

◆ ReceivePing()

◆ ReceivePingOwner()

◆ SendPing()

◆ SendPingServer()

◆ UpdateCooldown()

Member Data Documentation

◆ Event_OnPingEntityRegister

◆ Event_OnPingEntityUnregister

◆ Event_OnPingReceive

◆ Event_OnPingSend

◆ m_bIsOnCooldown

◆ m_Core

◆ m_fCooldownTime

◆ m_fCooldownUpdateFreq

◆ m_fCurrentCooldownTime

◆ m_fPingEntityLifetime

◆ m_LastPingEntity

◆ m_PlayerPings