SCR_PlayerFactionAffiliationComponent Class Reference

Inheritance diagram for SCR_PlayerFactionAffiliationComponent:

Protected Member Functions
SCR_SpawnLockComponent	GetLock ()
OnPlayerFactionRequestInvoker	GetOnCanPlayerFactionRequestInvoker_O ()
OnPlayerFactionRequestInvoker	GetOnCanPlayerFactionRequestInvoker_S ()
OnPlayerFactionResponseInvoker	GetOnCanPlayerFactionResponseInvoker_O ()
OnPlayerFactionResponseInvoker	GetOnCanPlayerFactionResponseInvoker_S ()
OnPlayerFactionRequestInvoker	GetOnPlayerFactionRequestInvoker_O ()
OnPlayerFactionRequestInvoker	GetOnPlayerFactionRequestInvoker_S ()
OnPlayerFactionResponseInvoker	GetOnPlayerFactionResponseInvoker_O ()
OnPlayerFactionResponseInvoker	GetOnPlayerFactionResponseInvoker_S ()
OnPlayerFactionChangedInvoker	GetOnPlayerFactionChangedInvoker ()
bool	IsOwner ()
bool	IsProxy ()
override void	OnPostInit (IEntity owner)
bool	RequestFaction (Faction faction)
void	Rpc_RequestFaction_S (int factionIndex)
void	LogFactionChange (notnull Faction newFaction, Faction originalFaction=null)
bool	SetFaction_S (Faction faction)
void	SendRequestFactionResponse_S (int factionIndex, bool response)
void	RequestFactionResponse_O (int factionIndex, bool response)
bool	CanRequestFaction (Faction faction)
void	Rpc_CanRequestFaction_S (int factionIndex)
bool	CanRequestFaction_S (Faction faction)
void	SendCanRequestFactionResponse_S (int factionIndex, bool response)
void	CanRequestFactionResponse_O (int factionIndex, bool response)
void	OnFactionChanged (Faction previous, Faction current)

Protected Attributes
ref OnPlayerFactionRequestInvoker	m_OnCanPlayerFactionRequestInvoker_O = new OnPlayerFactionRequestInvoker()
ref OnPlayerFactionRequestInvoker	m_OnCanPlayerFactionRequestInvoker_S = new OnPlayerFactionRequestInvoker()
ref OnPlayerFactionResponseInvoker	m_OnCanPlayerFactionResponseInvoker_O = new OnPlayerFactionResponseInvoker()
ref OnPlayerFactionResponseInvoker	m_OnCanPlayerFactionResponseInvoker_S = new OnPlayerFactionResponseInvoker()
ref OnPlayerFactionRequestInvoker	m_OnPlayerFactionRequestInvoker_O = new OnPlayerFactionRequestInvoker()
ref OnPlayerFactionRequestInvoker	m_OnPlayerFactionRequestInvoker_S = new OnPlayerFactionRequestInvoker()
ref OnPlayerFactionResponseInvoker	m_OnPlayerFactionResponseInvoker_O = new OnPlayerFactionResponseInvoker()
ref OnPlayerFactionResponseInvoker	m_OnPlayerFactionResponseInvoker_S = new OnPlayerFactionResponseInvoker()
ref OnPlayerFactionChangedInvoker	m_OnPlayerFactionChangedInvoker = new OnPlayerFactionChangedInvoker()

Detailed Description

This component should be attached to a PlayerController. It manages player-specific faction and the communication between player and authority regarding so.

Definition at line 20 of file SCR_PlayerFactionAffiliationComponent.c.

Member Function Documentation

CanRequestFaction()

bool SCR_PlayerFactionAffiliationComponent::CanRequestFaction ( Faction faction )

inlineprotected

Sends a can-ask request to the authority. NOTE: This is not the final result of the assignation. That result is can be listened to by hooking onto GetOnCanPlayerFactionResponseInvoker(), successful request will have a response of SCR_ESpawnResult.OK.

Parameters

[in]

faction

Returns

true if request was sent, false if request was caught (on owner, still!) because it was invalid.

Definition at line 332 of file SCR_PlayerFactionAffiliationComponent.c.

CanRequestFaction_S()

bool SCR_PlayerFactionAffiliationComponent::CanRequestFaction_S ( Faction faction )

inlineprotected

Authority: Handles ask request on the authority:

Parameters

[in]

faction

Returns

Returns true if faction can be assigned successfully.

Definition at line 396 of file SCR_PlayerFactionAffiliationComponent.c.

CanRequestFactionResponse_O()

void SCR_PlayerFactionAffiliationComponent::CanRequestFactionResponse_O ( int factionIndex, bool response )

inlineprotected

Owner: Response from the authority about whether faction was set successfully or not.

Parameters

[in]	factionIndex
[in]	response

Definition at line 444 of file SCR_PlayerFactionAffiliationComponent.c.

GetLock()

SCR_SpawnLockComponent SCR_PlayerFactionAffiliationComponent::GetLock ( )

inlineprotected

Returns

owner PlayerController lock component (if any).

Definition at line 43 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnCanPlayerFactionRequestInvoker_O()

OnPlayerFactionRequestInvoker SCR_PlayerFactionAffiliationComponent::GetOnCanPlayerFactionRequestInvoker_O ( )

inlineprotected

Returns

an invoker that is invoked after this component requests a faction change from the authority.

Definition at line 53 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnCanPlayerFactionRequestInvoker_S()

OnPlayerFactionRequestInvoker SCR_PlayerFactionAffiliationComponent::GetOnCanPlayerFactionRequestInvoker_S ( )

inlineprotected

Returns

an invoker that is invoked after this component requests a faction change from the authority.

Definition at line 62 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnCanPlayerFactionResponseInvoker_O()

OnPlayerFactionResponseInvoker SCR_PlayerFactionAffiliationComponent::GetOnCanPlayerFactionResponseInvoker_O ( )

inlineprotected

Returns

an invoker that is invoked after this component receives a response from the authority regarding faction change.

Definition at line 72 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnCanPlayerFactionResponseInvoker_S()

OnPlayerFactionResponseInvoker SCR_PlayerFactionAffiliationComponent::GetOnCanPlayerFactionResponseInvoker_S ( )

inlineprotected

Returns

an invoker that is invoked after this component receives a response from the authority regarding faction change.

Definition at line 81 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnPlayerFactionChangedInvoker()

OnPlayerFactionChangedInvoker SCR_PlayerFactionAffiliationComponent::GetOnPlayerFactionChangedInvoker ( )

inlineprotected

Returns

an invoker that is invoked after change of affliated faction on client and server.

Definition at line 127 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnPlayerFactionRequestInvoker_O()

OnPlayerFactionRequestInvoker SCR_PlayerFactionAffiliationComponent::GetOnPlayerFactionRequestInvoker_O ( )

inlineprotected

Returns

an invoker that is invoked after this component requests a faction change from the authority.

Definition at line 91 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnPlayerFactionRequestInvoker_S()

OnPlayerFactionRequestInvoker SCR_PlayerFactionAffiliationComponent::GetOnPlayerFactionRequestInvoker_S ( )

inlineprotected

Returns

an invoker that is invoked after this component requests a faction change from the authority.

Definition at line 100 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnPlayerFactionResponseInvoker_O()

OnPlayerFactionResponseInvoker SCR_PlayerFactionAffiliationComponent::GetOnPlayerFactionResponseInvoker_O ( )

inlineprotected

Returns

an invoker that is invoked after this component receives a response from the authority regarding faction change.

Definition at line 111 of file SCR_PlayerFactionAffiliationComponent.c.

GetOnPlayerFactionResponseInvoker_S()

OnPlayerFactionResponseInvoker SCR_PlayerFactionAffiliationComponent::GetOnPlayerFactionResponseInvoker_S ( )

inlineprotected

Returns

an invoker that is invoked after this component receives a response from the authority regarding faction change.

Definition at line 119 of file SCR_PlayerFactionAffiliationComponent.c.

IsOwner()

bool SCR_PlayerFactionAffiliationComponent::IsOwner ( )

inlineprotected

Definition at line 133 of file SCR_PlayerFactionAffiliationComponent.c.

IsProxy()

bool SCR_PlayerFactionAffiliationComponent::IsProxy ( )

inlineprotected

Definition at line 139 of file SCR_PlayerFactionAffiliationComponent.c.

LogFactionChange()

void SCR_PlayerFactionAffiliationComponent::LogFactionChange ( notnull Faction newFaction, Faction originalFaction = null )

inlineprotected

Definition at line 237 of file SCR_PlayerFactionAffiliationComponent.c.

OnFactionChanged()

void SCR_PlayerFactionAffiliationComponent::OnFactionChanged ( Faction previous, Faction current )

inlineprotected

Definition at line 460 of file SCR_PlayerFactionAffiliationComponent.c.

OnPostInit()

override void SCR_PlayerFactionAffiliationComponent::OnPostInit ( IEntity owner )

inlineprotected

Definition at line 145 of file SCR_PlayerFactionAffiliationComponent.c.

RequestFaction()

bool SCR_PlayerFactionAffiliationComponent::RequestFaction ( Faction faction )

inlineprotected

Sends a request to get assigned provided faction.

Parameters

[in]

faction

Returns

True if request was sent, false if request was caught (on owner, still!) because it was invalid. NOTE: This is not the final result of the assignation. That result is can be listened to by hooking onto GetOnPlayerFactionResponseInvoker(), successful request will have a response of SCR_ESpawnResult.OK.

Definition at line 168 of file SCR_PlayerFactionAffiliationComponent.c.

RequestFactionResponse_O()

void SCR_PlayerFactionAffiliationComponent::RequestFactionResponse_O ( int factionIndex, bool response )

inlineprotected

Owner: Response from the authority about whether faction was set successfully or not.

Parameters

[in]	factionIndex
[in]	response

Definition at line 311 of file SCR_PlayerFactionAffiliationComponent.c.

Rpc_CanRequestFaction_S()

void SCR_PlayerFactionAffiliationComponent::Rpc_CanRequestFaction_S ( int factionIndex )

inlineprotected

Ask the authority to whether provided faction can be assigned.

Parameters

[in]

factionIndex

Definition at line 364 of file SCR_PlayerFactionAffiliationComponent.c.

Rpc_RequestFaction_S()

void SCR_PlayerFactionAffiliationComponent::Rpc_RequestFaction_S ( int factionIndex )

inlineprotected

Ask the authority to assign provided faction.

Parameters

[in]

factionIndex

Definition at line 198 of file SCR_PlayerFactionAffiliationComponent.c.

SendCanRequestFactionResponse_S()

void SCR_PlayerFactionAffiliationComponent::SendCanRequestFactionResponse_S ( int factionIndex, bool response )

inlineprotected

Authority: Sends response to the owner whether faction assignation can be done or not.

Parameters

[in]	factionIndex
[in]	response	Can faction be assigned?

Definition at line 416 of file SCR_PlayerFactionAffiliationComponent.c.

SendRequestFactionResponse_S()

void SCR_PlayerFactionAffiliationComponent::SendRequestFactionResponse_S ( int factionIndex, bool response )

inlineprotected

Authority: Sends response to the owner whether faction assignation was successfull or not.

Parameters

[in]	factionIndex
[in]	response	Was faction assigned?

Definition at line 283 of file SCR_PlayerFactionAffiliationComponent.c.

SetFaction_S()

bool SCR_PlayerFactionAffiliationComponent::SetFaction_S ( Faction faction )

inlineprotected

Authority: Handles request on the authority:

Parameters

[in]

faction

Returns

true if request was processed successfully.

Definition at line 255 of file SCR_PlayerFactionAffiliationComponent.c.

Member Data Documentation

m_OnCanPlayerFactionRequestInvoker_O

ref OnPlayerFactionRequestInvoker SCR_PlayerFactionAffiliationComponent::m_OnCanPlayerFactionRequestInvoker_O = new OnPlayerFactionRequestInvoker()

protected

Definition at line 49 of file SCR_PlayerFactionAffiliationComponent.c.

m_OnCanPlayerFactionRequestInvoker_S

ref OnPlayerFactionRequestInvoker SCR_PlayerFactionAffiliationComponent::m_OnCanPlayerFactionRequestInvoker_S = new OnPlayerFactionRequestInvoker()

protected

Definition at line 58 of file SCR_PlayerFactionAffiliationComponent.c.

m_OnCanPlayerFactionResponseInvoker_O

ref OnPlayerFactionResponseInvoker SCR_PlayerFactionAffiliationComponent::m_OnCanPlayerFactionResponseInvoker_O = new OnPlayerFactionResponseInvoker()

protected

Definition at line 68 of file SCR_PlayerFactionAffiliationComponent.c.

m_OnCanPlayerFactionResponseInvoker_S

ref OnPlayerFactionResponseInvoker SCR_PlayerFactionAffiliationComponent::m_OnCanPlayerFactionResponseInvoker_S = new OnPlayerFactionResponseInvoker()

protected

Definition at line 77 of file SCR_PlayerFactionAffiliationComponent.c.

m_OnPlayerFactionChangedInvoker

ref OnPlayerFactionChangedInvoker SCR_PlayerFactionAffiliationComponent::m_OnPlayerFactionChangedInvoker = new OnPlayerFactionChangedInvoker()

protected

Definition at line 124 of file SCR_PlayerFactionAffiliationComponent.c.

m_OnPlayerFactionRequestInvoker_O

ref OnPlayerFactionRequestInvoker SCR_PlayerFactionAffiliationComponent::m_OnPlayerFactionRequestInvoker_O = new OnPlayerFactionRequestInvoker()

protected

Definition at line 87 of file SCR_PlayerFactionAffiliationComponent.c.

m_OnPlayerFactionRequestInvoker_S

ref OnPlayerFactionRequestInvoker SCR_PlayerFactionAffiliationComponent::m_OnPlayerFactionRequestInvoker_S = new OnPlayerFactionRequestInvoker()

protected

Definition at line 96 of file SCR_PlayerFactionAffiliationComponent.c.

m_OnPlayerFactionResponseInvoker_O

ref OnPlayerFactionResponseInvoker SCR_PlayerFactionAffiliationComponent::m_OnPlayerFactionResponseInvoker_O = new OnPlayerFactionResponseInvoker()

protected

Definition at line 107 of file SCR_PlayerFactionAffiliationComponent.c.

m_OnPlayerFactionResponseInvoker_S

ref OnPlayerFactionResponseInvoker SCR_PlayerFactionAffiliationComponent::m_OnPlayerFactionResponseInvoker_S = new OnPlayerFactionResponseInvoker()

protected

Definition at line 116 of file SCR_PlayerFactionAffiliationComponent.c.

---

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

• scripts/Game/Respawn/Factions/SCR_PlayerFactionAffiliationComponent.c