SCR_PlayerLoadoutComponent Class Reference

Inheritance diagram for SCR_PlayerLoadoutComponent:

Protected Member Functions
PlayerController	GetPlayerController ()
int	GetPlayerId ()
SCR_SpawnLockComponent	GetLock ()
SCR_PlayerFactionAffiliationComponent	GetPlayerFactionAffiliationComponent ()
SCR_BasePlayerLoadout	GetLoadout ()
OnPlayerLoadoutRequestInvoker	GetOnCanPlayerLoadoutRequestInvoker_O ()
OnPlayerLoadoutRequestInvoker	GetOnCanPlayerLoadoutRequestInvoker_S ()
OnPlayerLoadoutResponseInvoker	GetOnCanPlayerLoadoutResponseInvoker_O ()
OnPlayerLoadoutResponseInvoker	GetOnCanPlayerLoadoutResponseInvoker_S ()
OnPlayerLoadoutRequestInvoker	GetOnPlayerLoadoutRequestInvoker_O ()
OnPlayerLoadoutRequestInvoker	GetOnPlayerLoadoutRequestInvoker_S ()
OnPlayerLoadoutResponseInvoker	GetOnPlayerLoadoutResponseInvoker_O ()
OnPlayerLoadoutResponseInvoker	GetOnPlayerLoadoutResponseInvoker_S ()
bool	IsOwner ()
bool	IsProxy ()
override void	OnPostInit (IEntity owner)
override void	OnDelete (IEntity owner)
void	OnFactionChanged (FactionAffiliationComponent owner, Faction old, Faction current)
SCR_BasePlayerLoadout	GetAssignedLoadout ()
bool	RequestLoadout (SCR_BasePlayerLoadout loadout)
void	Rpc_RequestLoadout_S (int loadoutIndex)
bool	AssignLoadout_S (int loadoutIndex)
void	SendRequestLoadoutResponse_S (int loadoutIndex, bool response)
void	RequestLoadoutResponse_O (int loadoutIndex, bool response)
bool	CanRequestLoadout (SCR_BasePlayerLoadout loadout)
void	Rpc_CanRequestLoadout_S (int loadoutIndex)
bool	CanAssignLoadout_S (int loadoutIndex)
bool	IsLoadoutUseableByFaction (SCR_BasePlayerLoadout loadout, Faction faction)
void	SendCanRequestLoadoutResponse_S (int loadoutIndex, bool response)
void	CanRequestLoadoutResponse_O (int loadoutIndex, bool response)
void	DoSetPlayerHasLoadout (bool loadoutValid, bool loadoutChanged, bool notification)
void	DoSetPlayerHasLoadout_O (bool loadoutValid, bool loadoutChanged, bool notification)
void	DoSendPlayerLoadout (SCR_PlayerLoadoutData loadoutData)
void	DoSendPlayerLoadout_O (SCR_PlayerLoadoutData loadoutData)
void	DoPlayerClearHasLoadout ()
void	DoPlayerClearHasLoadout_O ()

Protected Attributes
SCR_BasePlayerLoadout	m_Loadout
	Assigned loadout index. Relevant to authority only.
ref OnPlayerLoadoutRequestInvoker	m_OnCanPlayerLoadoutRequestInvoker_O = new OnPlayerLoadoutRequestInvoker()
ref OnPlayerLoadoutRequestInvoker	m_OnCanPlayerLoadoutRequestInvoker_S = new OnPlayerLoadoutRequestInvoker()
ref OnPlayerLoadoutResponseInvoker	m_OnCanPlayerLoadoutResponseInvoker_O = new OnPlayerLoadoutResponseInvoker()
ref OnPlayerLoadoutResponseInvoker	m_OnCanPlayerLoadoutResponseInvoker_S = new OnPlayerLoadoutResponseInvoker()
ref OnPlayerLoadoutRequestInvoker	m_OnPlayerLoadoutRequestInvoker_O = new OnPlayerLoadoutRequestInvoker()
ref OnPlayerLoadoutRequestInvoker	m_OnPlayerLoadoutRequestInvoker_S = new OnPlayerLoadoutRequestInvoker()
ref OnPlayerLoadoutResponseInvoker	m_OnPlayerLoadoutResponseInvoker_O = new OnPlayerLoadoutResponseInvoker()
ref OnPlayerLoadoutResponseInvoker	m_OnPlayerLoadoutResponseInvoker_S = new OnPlayerLoadoutResponseInvoker()

Detailed Description

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

Definition at line 16 of file SCR_PlayerLoadoutComponent.c.

Member Function Documentation

AssignLoadout_S()

bool SCR_PlayerLoadoutComponent::AssignLoadout_S ( int loadoutIndex )

inlineprotected

Definition at line 289 of file SCR_PlayerLoadoutComponent.c.

CanAssignLoadout_S()

bool SCR_PlayerLoadoutComponent::CanAssignLoadout_S ( int loadoutIndex )

inlineprotected

Authority: Returns whether provided loadout can be assigned for this player.

Parameters

[in]

loadoutIndex

Definition at line 428 of file SCR_PlayerLoadoutComponent.c.

CanRequestLoadout()

bool SCR_PlayerLoadoutComponent::CanRequestLoadout ( SCR_BasePlayerLoadout loadout )

inlineprotected

Sends a can-ask request to the authority.

Parameters

[in]

loadout

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 GetOnCanPlayerLoadoutResponseInvoker(), successful request will have a response of SCR_ESpawnResult.OK.

Definition at line 366 of file SCR_PlayerLoadoutComponent.c.

CanRequestLoadoutResponse_O()

void SCR_PlayerLoadoutComponent::CanRequestLoadoutResponse_O ( int loadoutIndex, bool response )

inlineprotected

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

Parameters

[in]	loadoutIndex
[in]	response

Definition at line 496 of file SCR_PlayerLoadoutComponent.c.

DoPlayerClearHasLoadout()

void SCR_PlayerLoadoutComponent::DoPlayerClearHasLoadout ( )

inlineprotected

Definition at line 563 of file SCR_PlayerLoadoutComponent.c.

DoPlayerClearHasLoadout_O()

void SCR_PlayerLoadoutComponent::DoPlayerClearHasLoadout_O ( )

inlineprotected

Definition at line 570 of file SCR_PlayerLoadoutComponent.c.

DoSendPlayerLoadout()

void SCR_PlayerLoadoutComponent::DoSendPlayerLoadout ( SCR_PlayerLoadoutData loadoutData )

inlineprotected

Definition at line 546 of file SCR_PlayerLoadoutComponent.c.

DoSendPlayerLoadout_O()

void SCR_PlayerLoadoutComponent::DoSendPlayerLoadout_O ( SCR_PlayerLoadoutData loadoutData )

inlineprotected

Definition at line 553 of file SCR_PlayerLoadoutComponent.c.

DoSetPlayerHasLoadout()

void SCR_PlayerLoadoutComponent::DoSetPlayerHasLoadout ( bool loadoutValid, bool loadoutChanged, bool notification )

inlineprotected

Definition at line 514 of file SCR_PlayerLoadoutComponent.c.

DoSetPlayerHasLoadout_O()

void SCR_PlayerLoadoutComponent::DoSetPlayerHasLoadout_O ( bool loadoutValid, bool loadoutChanged, bool notification )

inlineprotected

Definition at line 521 of file SCR_PlayerLoadoutComponent.c.

GetAssignedLoadout()

SCR_BasePlayerLoadout SCR_PlayerLoadoutComponent::GetAssignedLoadout ( )

inlineprotected

Authority

Returns

assigned loadout for this player.

Definition at line 214 of file SCR_PlayerLoadoutComponent.c.

GetLoadout()

SCR_BasePlayerLoadout SCR_PlayerLoadoutComponent::GetLoadout ( )

inlineprotected

Returns

player faction affiliation, if any is present.

Definition at line 57 of file SCR_PlayerLoadoutComponent.c.

GetLock()

SCR_SpawnLockComponent SCR_PlayerLoadoutComponent::GetLock ( )

inlineprotected

Returns

owner PlayerController lock component (if any).

Definition at line 43 of file SCR_PlayerLoadoutComponent.c.

GetOnCanPlayerLoadoutRequestInvoker_O()

OnPlayerLoadoutRequestInvoker SCR_PlayerLoadoutComponent::GetOnCanPlayerLoadoutRequestInvoker_O ( )

inlineprotected

Returns

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

Definition at line 67 of file SCR_PlayerLoadoutComponent.c.

GetOnCanPlayerLoadoutRequestInvoker_S()

OnPlayerLoadoutRequestInvoker SCR_PlayerLoadoutComponent::GetOnCanPlayerLoadoutRequestInvoker_S ( )

inlineprotected

Returns

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

Definition at line 76 of file SCR_PlayerLoadoutComponent.c.

GetOnCanPlayerLoadoutResponseInvoker_O()

OnPlayerLoadoutResponseInvoker SCR_PlayerLoadoutComponent::GetOnCanPlayerLoadoutResponseInvoker_O ( )

inlineprotected

Returns

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

Definition at line 86 of file SCR_PlayerLoadoutComponent.c.

GetOnCanPlayerLoadoutResponseInvoker_S()

OnPlayerLoadoutResponseInvoker SCR_PlayerLoadoutComponent::GetOnCanPlayerLoadoutResponseInvoker_S ( )

inlineprotected

Returns

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

Definition at line 94 of file SCR_PlayerLoadoutComponent.c.

GetOnPlayerLoadoutRequestInvoker_O()

OnPlayerLoadoutRequestInvoker SCR_PlayerLoadoutComponent::GetOnPlayerLoadoutRequestInvoker_O ( )

inlineprotected

Returns

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

Definition at line 104 of file SCR_PlayerLoadoutComponent.c.

GetOnPlayerLoadoutRequestInvoker_S()

OnPlayerLoadoutRequestInvoker SCR_PlayerLoadoutComponent::GetOnPlayerLoadoutRequestInvoker_S ( )

inlineprotected

Returns

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

Definition at line 112 of file SCR_PlayerLoadoutComponent.c.

GetOnPlayerLoadoutResponseInvoker_O()

OnPlayerLoadoutResponseInvoker SCR_PlayerLoadoutComponent::GetOnPlayerLoadoutResponseInvoker_O ( )

inlineprotected

Returns

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

Definition at line 122 of file SCR_PlayerLoadoutComponent.c.

GetOnPlayerLoadoutResponseInvoker_S()

OnPlayerLoadoutResponseInvoker SCR_PlayerLoadoutComponent::GetOnPlayerLoadoutResponseInvoker_S ( )

inlineprotected

Returns

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

Definition at line 131 of file SCR_PlayerLoadoutComponent.c.

GetPlayerController()

PlayerController SCR_PlayerLoadoutComponent::GetPlayerController ( )

inlineprotected

Returns

owner PlayerController this component is attached to.

Definition at line 29 of file SCR_PlayerLoadoutComponent.c.

GetPlayerFactionAffiliationComponent()

SCR_PlayerFactionAffiliationComponent SCR_PlayerLoadoutComponent::GetPlayerFactionAffiliationComponent ( )

inlineprotected

Returns

player faction affiliation, if any is present.

Definition at line 50 of file SCR_PlayerLoadoutComponent.c.

GetPlayerId()

int SCR_PlayerLoadoutComponent::GetPlayerId ( )

inlineprotected

Returns

owner player PlayerController id.

Definition at line 36 of file SCR_PlayerLoadoutComponent.c.

IsLoadoutUseableByFaction()

bool SCR_PlayerLoadoutComponent::IsLoadoutUseableByFaction ( SCR_BasePlayerLoadout loadout, Faction faction )

inlineprotected

Parameters

[in]	loadout
[in]	faction

Returns

whether the provided loadout is useable by the provided faction (if provided).

Definition at line 450 of file SCR_PlayerLoadoutComponent.c.

IsOwner()

bool SCR_PlayerLoadoutComponent::IsOwner ( )

inlineprotected

Definition at line 137 of file SCR_PlayerLoadoutComponent.c.

IsProxy()

bool SCR_PlayerLoadoutComponent::IsProxy ( )

inlineprotected

Definition at line 143 of file SCR_PlayerLoadoutComponent.c.

OnDelete()

override void SCR_PlayerLoadoutComponent::OnDelete ( IEntity owner )

inlineprotected

Definition at line 171 of file SCR_PlayerLoadoutComponent.c.

OnFactionChanged()

void SCR_PlayerLoadoutComponent::OnFactionChanged ( FactionAffiliationComponent owner, Faction old, Faction current )

inlineprotected

Definition at line 180 of file SCR_PlayerLoadoutComponent.c.

OnPostInit()

override void SCR_PlayerLoadoutComponent::OnPostInit ( IEntity owner )

inlineprotected

Definition at line 149 of file SCR_PlayerLoadoutComponent.c.

RequestLoadout()

bool SCR_PlayerLoadoutComponent::RequestLoadout ( SCR_BasePlayerLoadout loadout )

inlineprotected

Sends a request to get assignedf provided loadout.

Parameters

[in]

loadout

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 GetOnPlayerLoadoutResponseInvoker(), successful request will have a response of SCR_ESpawnResult.OK.

Definition at line 225 of file SCR_PlayerLoadoutComponent.c.

RequestLoadoutResponse_O()

void SCR_PlayerLoadoutComponent::RequestLoadoutResponse_O ( int loadoutIndex, bool response )

inlineprotected

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

Parameters

[in]	loadoutIndex
[in]	response

Definition at line 338 of file SCR_PlayerLoadoutComponent.c.

Rpc_CanRequestLoadout_S()

void SCR_PlayerLoadoutComponent::Rpc_CanRequestLoadout_S ( int loadoutIndex )

inlineprotected

Ask the authority to whether provided loadout can be assigned.

Parameters

[in]

loadoutIndex

Definition at line 397 of file SCR_PlayerLoadoutComponent.c.

Rpc_RequestLoadout_S()

void SCR_PlayerLoadoutComponent::Rpc_RequestLoadout_S ( int loadoutIndex )

inlineprotected

Ask the authority to assign provided loadout.

Parameters

[in]

loadoutIndex

Definition at line 255 of file SCR_PlayerLoadoutComponent.c.

SendCanRequestLoadoutResponse_S()

void SCR_PlayerLoadoutComponent::SendCanRequestLoadoutResponse_S ( int loadoutIndex, bool response )

inlineprotected

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

Parameters

[in]	loadoutIndex
[in]	response	Can loadout be assigned?

Definition at line 469 of file SCR_PlayerLoadoutComponent.c.

SendRequestLoadoutResponse_S()

void SCR_PlayerLoadoutComponent::SendRequestLoadoutResponse_S ( int loadoutIndex, bool response )

inlineprotected

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

Parameters

[in]	loadoutIndex
[in]	response	Was loadout assigned?

Definition at line 311 of file SCR_PlayerLoadoutComponent.c.

Member Data Documentation

m_Loadout

SCR_BasePlayerLoadout SCR_PlayerLoadoutComponent::m_Loadout

protected

Assigned loadout index. Relevant to authority only.

Definition at line 25 of file SCR_PlayerLoadoutComponent.c.

m_OnCanPlayerLoadoutRequestInvoker_O

ref OnPlayerLoadoutRequestInvoker SCR_PlayerLoadoutComponent::m_OnCanPlayerLoadoutRequestInvoker_O = new OnPlayerLoadoutRequestInvoker()

protected

Definition at line 63 of file SCR_PlayerLoadoutComponent.c.

m_OnCanPlayerLoadoutRequestInvoker_S

ref OnPlayerLoadoutRequestInvoker SCR_PlayerLoadoutComponent::m_OnCanPlayerLoadoutRequestInvoker_S = new OnPlayerLoadoutRequestInvoker()

protected

Definition at line 72 of file SCR_PlayerLoadoutComponent.c.

m_OnCanPlayerLoadoutResponseInvoker_O

ref OnPlayerLoadoutResponseInvoker SCR_PlayerLoadoutComponent::m_OnCanPlayerLoadoutResponseInvoker_O = new OnPlayerLoadoutResponseInvoker()

protected

Definition at line 82 of file SCR_PlayerLoadoutComponent.c.

m_OnCanPlayerLoadoutResponseInvoker_S

ref OnPlayerLoadoutResponseInvoker SCR_PlayerLoadoutComponent::m_OnCanPlayerLoadoutResponseInvoker_S = new OnPlayerLoadoutResponseInvoker()

protected

Definition at line 91 of file SCR_PlayerLoadoutComponent.c.

m_OnPlayerLoadoutRequestInvoker_O

ref OnPlayerLoadoutRequestInvoker SCR_PlayerLoadoutComponent::m_OnPlayerLoadoutRequestInvoker_O = new OnPlayerLoadoutRequestInvoker()

protected

Definition at line 100 of file SCR_PlayerLoadoutComponent.c.

m_OnPlayerLoadoutRequestInvoker_S

ref OnPlayerLoadoutRequestInvoker SCR_PlayerLoadoutComponent::m_OnPlayerLoadoutRequestInvoker_S = new OnPlayerLoadoutRequestInvoker()

protected

Definition at line 109 of file SCR_PlayerLoadoutComponent.c.

m_OnPlayerLoadoutResponseInvoker_O

ref OnPlayerLoadoutResponseInvoker SCR_PlayerLoadoutComponent::m_OnPlayerLoadoutResponseInvoker_O = new OnPlayerLoadoutResponseInvoker()

protected

Definition at line 118 of file SCR_PlayerLoadoutComponent.c.

m_OnPlayerLoadoutResponseInvoker_S

ref OnPlayerLoadoutResponseInvoker SCR_PlayerLoadoutComponent::m_OnPlayerLoadoutResponseInvoker_S = new OnPlayerLoadoutResponseInvoker()

protected

Definition at line 127 of file SCR_PlayerLoadoutComponent.c.

---

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

• scripts/Game/Respawn/Loadouts/SCR_PlayerLoadoutComponent.c