SCR_DeployMenuBase.c File Reference

Go to the source code of this file.

Classes
class	SCR_DeployMenuBase
	Base deploy menu class. More...
class	SCR_DeployButton
	Component that handles the request respawn button. More...

Typedefs
typedef func	OnSpawnPointRplIdSet
typedef ScriptInvokerBase< OnSpawnPointRplIdSet >	OnSpawnPointRplIdSetInvoker

Functions
void	OnSpawnPointRplIdSet (RplId id)
int	GetLoadoutCost (SCR_PlayerLoadoutComponent component)
void	AllowMapContext (bool allow)
	Sets map context active based on whether or not any of the selectors are focused with a gamepad.
bool	GetAllowMapContext ()
override void	OnMenuOpen ()
override void	OnMenuHide ()
override void	OnMenuFocusLost ()
override void	OnMenuFocusGained ()
void	NextSpawn ()
	Select next available spawn point.
void	PrevSpawn ()
	Select previous available spawn point.
override void	OnMenuOpened ()
override void	OnMenuClose ()
override void	OnMenuUpdate (float tDelta)
void	ResetRespawnResultVars ()
void	OnCanRespawnRequestResponse (SCR_SpawnRequestComponent requestComponent, SCR_ESpawnResult response, SCR_SpawnData data)
void	FindRequestHandlers ()
	Find all components in the layout that are needed in order for deploy menu to function correctly.
void	HookEvents ()
	Initialize necessary callbacks.
void	OnMapOpen (MapConfiguration config)
void	OnLocalPlayerGroupJoined (SCR_AIGroup group)
	Callback when player joins a group.
void	InitMapDeploy ()
	Initializes the map with deploy menu config.
void	SetSpawnPointExt (RplId id)
	Sets spawn point from an external source (ie. by clicking the spawn point icon).
void	SetInitialSpawnPoint (RplId spawnPointId)
	Sets initial spawn point when the deploy map is open for the first time.
void	OnSpawnPointSelected (RplId id)
void	SetSpawnPoint (RplId id, bool smoothPan=true)
	Sets the currently selected spawn point.
void	FocusOnPoint (notnull SCR_SpawnPoint spawnPoint, bool smooth=true)
	Centers map to a specific spawn point.
void	HideLoading ()
	Hides loading spinner widget.
void	RequestRespawn ()
	Sends a respawn request based on assigned loadout and selected spawn point.
void	OnPlayerFactionRequest (SCR_PlayerFactionAffiliationComponent component, int factionIndex)
	Callback when player requests a faction.
void	OnPlayerFactionResponse (SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response)
	Callback when faction request receives a response.
void	OnPlayerLoadoutRequest (SCR_PlayerLoadoutComponent component, int loadoutIndex)
	Callback when player requests a loadout.
void	OnPlayerLoadoutResponse (SCR_PlayerLoadoutComponent component, int loadoutIndex, bool response)
	Callback when loadout request receives a response.
void	OnPlayerFactionSet (Faction assignedFaction)
void	OnChatToggle ()
	Toggle chat.
void	OnPauseMenu ()
	Opens pause menu.
void	OnRespawnRequest (SCR_SpawnRequestComponent requestComponent)
	Callback when respawn request was sent for the player.
void	OnRespawnResponse (SCR_SpawnRequestComponent requestComponent, SCR_ESpawnResult response)
	Callback when player respawn request received a response.
void	UpdateRespawnButton ()
	Sets respawn button enabled based on certain conditions.
void	OpenGroupMenu ()
SCR_SpawnPointRequestUIComponent	GetSpawnPointRequestHandler ()
OnSpawnPointRplIdSetInvoker	GetOnSpawnPointRplIdSet ()

Variables
SCR_DeployMenuBase	m_MenuHandler
	Main deploy menu with the map present.
SCR_LoadoutRequestUIComponent	m_LoadoutRequestUIHandler
SCR_GroupRequestUIComponent	m_GroupRequestUIHandler
SCR_SpawnPointRequestUIComponent	m_SpawnPointRequestUIHandler
ref MapConfiguration	m_MapConfigDeploy = new MapConfiguration()
SCR_MapUIElementContainer	m_UIElementContainer
SCR_BaseGameMode	m_GameMode
SCR_RespawnComponent	m_SpawnRequestManager
RplId	m_iSelectedSpawnPointId = RplId.Invalid()
SCR_PlayerDeployMenuHandlerComponent	m_PlayerMenuHandler
Widget	m_wLoadingSpinner
SCR_LoadingSpinner	m_LoadingSpinner
FactionManager	m_FactionManager
SCR_PlayerFactionAffiliationComponent	m_PlyFactionAffilComp
SCR_PlayerLoadoutComponent	m_PlyLoadoutComp
Widget	m_wRespawnButton
SCR_DeployButton	m_RespawnButton
Widget	m_wMenuFrame
SCR_RespawnTimerComponent	m_ActiveRespawnTimer
SCR_RespawnTimerComponent	m_PlayerRespawnTimer
SCR_TimedSpawnPointComponent	m_TimedSpawnPointTimer
int	m_iPreviousTime = 0
bool	m_bRespawnRequested = false
bool	m_bSuppliesEnabled
SCR_RespawnSystemComponent	m_RespawnSystemComp
SCR_RespawnComponent	m_RespawnComponent
int	m_iPlayerId
bool	m_bMapContextAllowed = true
bool	m_bInitialSpawnPointSet = false
bool	m_bCanRespawnAtSpawnPoint
SCR_UIInfoSpawnRequestResult	m_UIInfoSpawnRequestResult
bool	m_bDisplayTime
float	m_fCurrentCanSpawnUpdateTime
const float	CHECK_CAN_SPAWN_SPAWNPOINT_TIME = 1
const string	FALLBACK_DEPLOY_STRING = "#AR-ButtonSelectDeploy"
SCR_InputButtonComponent	m_GroupOpenButton
float	m_fCurrentDeployTimeOut
const float	DEPLOY_TIME_OUT = 0.5
ref OnSpawnPointRplIdSetInvoker	m_OnSpawnPointSet

Typedef Documentation

OnSpawnPointRplIdSet

typedef func OnSpawnPointRplIdSet

Definition at line 2 of file SCR_DeployMenuBase.c.

OnSpawnPointRplIdSetInvoker

typedef ScriptInvokerBase<OnSpawnPointRplIdSet> OnSpawnPointRplIdSetInvoker

Definition at line 3 of file SCR_DeployMenuBase.c.

Function Documentation

AllowMapContext()

void AllowMapContext ( bool allow )

protected

Sets map context active based on whether or not any of the selectors are focused with a gamepad.

Definition at line 211 of file SCR_DeployMenuBase.c.

FindRequestHandlers()

void FindRequestHandlers ( )

protected

Find all components in the layout that are needed in order for deploy menu to function correctly.

Definition at line 592 of file SCR_DeployMenuBase.c.

FocusOnPoint()

void FocusOnPoint ( notnull SCR_SpawnPoint spawnPoint, bool smooth = true )

protected

Centers map to a specific spawn point.

Definition at line 731 of file SCR_DeployMenuBase.c.

GetAllowMapContext()

bool GetAllowMapContext ( )

protected

Returns true if map context is allowed

Returns

Definition at line 219 of file SCR_DeployMenuBase.c.

GetLoadoutCost()

int GetLoadoutCost ( SCR_PlayerLoadoutComponent component )

protected

Parameters

[in]

component

Returns

Definition at line 171 of file SCR_DeployMenuBase.c.

GetOnSpawnPointRplIdSet()

OnSpawnPointRplIdSetInvoker GetOnSpawnPointRplIdSet ( )

protected

Returns

Definition at line 959 of file SCR_DeployMenuBase.c.

GetSpawnPointRequestHandler()

SCR_SpawnPointRequestUIComponent GetSpawnPointRequestHandler ( )

protected

Returns

Definition at line 951 of file SCR_DeployMenuBase.c.

HideLoading()

void HideLoading ( )

protected

Hides loading spinner widget.

Definition at line 754 of file SCR_DeployMenuBase.c.

HookEvents()

void HookEvents ( )

protected

Initialize necessary callbacks.

Definition at line 618 of file SCR_DeployMenuBase.c.

InitMapDeploy()

void InitMapDeploy ( )

protected

Initializes the map with deploy menu config.

Definition at line 670 of file SCR_DeployMenuBase.c.

NextSpawn()

void NextSpawn ( )

protected

Select next available spawn point.

Definition at line 373 of file SCR_DeployMenuBase.c.

OnCanRespawnRequestResponse()

void OnCanRespawnRequestResponse ( SCR_SpawnRequestComponent requestComponent, SCR_ESpawnResult response, SCR_SpawnData data )

protected

Definition at line 521 of file SCR_DeployMenuBase.c.

OnChatToggle()

void OnChatToggle ( )

protected

Toggle chat.

Definition at line 847 of file SCR_DeployMenuBase.c.

OnLocalPlayerGroupJoined()

void OnLocalPlayerGroupJoined ( SCR_AIGroup group )

protected

Callback when player joins a group.

Definition at line 663 of file SCR_DeployMenuBase.c.

OnMapOpen()

void OnMapOpen ( MapConfiguration config )

protected

Definition at line 638 of file SCR_DeployMenuBase.c.

OnMenuClose()

override void OnMenuClose ( )

protected

Definition at line 400 of file SCR_DeployMenuBase.c.

OnMenuFocusGained()

override void OnMenuFocusGained ( )

protected

Definition at line 357 of file SCR_DeployMenuBase.c.

OnMenuFocusLost()

override void OnMenuFocusLost ( )

protected

Definition at line 345 of file SCR_DeployMenuBase.c.

OnMenuHide()

override void OnMenuHide ( )

protected

Definition at line 333 of file SCR_DeployMenuBase.c.

OnMenuOpen()

override void OnMenuOpen ( )

protected

Definition at line 225 of file SCR_DeployMenuBase.c.

OnMenuOpened()

override void OnMenuOpened ( )

protected

Definition at line 387 of file SCR_DeployMenuBase.c.

OnMenuUpdate()

override void OnMenuUpdate ( float tDelta )

protected

Definition at line 418 of file SCR_DeployMenuBase.c.

OnPauseMenu()

void OnPauseMenu ( )

protected

Opens pause menu.

Definition at line 863 of file SCR_DeployMenuBase.c.

OnPlayerFactionRequest()

void OnPlayerFactionRequest ( SCR_PlayerFactionAffiliationComponent component, int factionIndex )

protected

Callback when player requests a faction.

Definition at line 791 of file SCR_DeployMenuBase.c.

OnPlayerFactionResponse()

void OnPlayerFactionResponse ( SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response )

protected

Callback when faction request receives a response.

Definition at line 797 of file SCR_DeployMenuBase.c.

OnPlayerFactionSet()

void OnPlayerFactionSet ( Faction assignedFaction )

protected

Definition at line 830 of file SCR_DeployMenuBase.c.

OnPlayerLoadoutRequest()

void OnPlayerLoadoutRequest ( SCR_PlayerLoadoutComponent component, int loadoutIndex )

protected

Callback when player requests a loadout.

Definition at line 809 of file SCR_DeployMenuBase.c.

OnPlayerLoadoutResponse()

void OnPlayerLoadoutResponse ( SCR_PlayerLoadoutComponent component, int loadoutIndex, bool response )

protected

Callback when loadout request receives a response.

Definition at line 815 of file SCR_DeployMenuBase.c.

OnRespawnRequest()

void OnRespawnRequest ( SCR_SpawnRequestComponent requestComponent )

protected

Callback when respawn request was sent for the player.

Definition at line 876 of file SCR_DeployMenuBase.c.

OnRespawnResponse()

void OnRespawnResponse ( SCR_SpawnRequestComponent requestComponent, SCR_ESpawnResult response )

protected

Callback when player respawn request received a response.

Definition at line 888 of file SCR_DeployMenuBase.c.

OnSpawnPointRplIdSet()

void OnSpawnPointRplIdSet

(

RplId

id

)

OnSpawnPointSelected()

void OnSpawnPointSelected ( RplId id )

protected

Definition at line 697 of file SCR_DeployMenuBase.c.

OpenGroupMenu()

void OpenGroupMenu ( )

protected

Definition at line 914 of file SCR_DeployMenuBase.c.

PrevSpawn()

void PrevSpawn ( )

protected

Select previous available spawn point.

Definition at line 380 of file SCR_DeployMenuBase.c.

ResetRespawnResultVars()

void ResetRespawnResultVars ( )

protected

Definition at line 512 of file SCR_DeployMenuBase.c.

SetInitialSpawnPoint()

void SetInitialSpawnPoint ( RplId spawnPointId )

protected

Sets initial spawn point when the deploy map is open for the first time.

Definition at line 690 of file SCR_DeployMenuBase.c.

SetSpawnPoint()

void SetSpawnPoint ( RplId id, bool smoothPan = true )

protected

Sets the currently selected spawn point.

Definition at line 703 of file SCR_DeployMenuBase.c.

SetSpawnPointExt()

void SetSpawnPointExt ( RplId id )

protected

Sets spawn point from an external source (ie. by clicking the spawn point icon).

Definition at line 684 of file SCR_DeployMenuBase.c.

UpdateRespawnButton()

void UpdateRespawnButton ( )

protected

Sets respawn button enabled based on certain conditions.

Definition at line 901 of file SCR_DeployMenuBase.c.

Variable Documentation

CHECK_CAN_SPAWN_SPAWNPOINT_TIME

const float CHECK_CAN_SPAWN_SPAWNPOINT_TIME = 1

protected

Definition at line 155 of file SCR_DeployMenuBase.c.

DEPLOY_TIME_OUT

const float DEPLOY_TIME_OUT = 0.5

protected

Definition at line 162 of file SCR_DeployMenuBase.c.

FALLBACK_DEPLOY_STRING

const string FALLBACK_DEPLOY_STRING = "#AR-ButtonSelectDeploy"

protected

Definition at line 156 of file SCR_DeployMenuBase.c.

m_ActiveRespawnTimer

SCR_RespawnTimerComponent m_ActiveRespawnTimer

protected

Definition at line 136 of file SCR_DeployMenuBase.c.

m_bCanRespawnAtSpawnPoint

bool m_bCanRespawnAtSpawnPoint

protected

Definition at line 149 of file SCR_DeployMenuBase.c.

m_bDisplayTime

bool m_bDisplayTime

protected

Definition at line 152 of file SCR_DeployMenuBase.c.

m_bInitialSpawnPointSet

bool m_bInitialSpawnPointSet = false

protected

Definition at line 148 of file SCR_DeployMenuBase.c.

m_bMapContextAllowed

bool m_bMapContextAllowed = true

protected

Definition at line 147 of file SCR_DeployMenuBase.c.

m_bRespawnRequested

bool m_bRespawnRequested = false

protected

Definition at line 140 of file SCR_DeployMenuBase.c.

m_bSuppliesEnabled

bool m_bSuppliesEnabled

protected

Definition at line 141 of file SCR_DeployMenuBase.c.

m_FactionManager

FactionManager m_FactionManager

protected

Definition at line 126 of file SCR_DeployMenuBase.c.

m_fCurrentCanSpawnUpdateTime

float m_fCurrentCanSpawnUpdateTime

protected

Definition at line 154 of file SCR_DeployMenuBase.c.

m_fCurrentDeployTimeOut

float m_fCurrentDeployTimeOut

protected

Definition at line 161 of file SCR_DeployMenuBase.c.

m_GameMode

SCR_BaseGameMode m_GameMode

protected

Definition at line 118 of file SCR_DeployMenuBase.c.

m_GroupOpenButton

SCR_InputButtonComponent m_GroupOpenButton

protected

Definition at line 158 of file SCR_DeployMenuBase.c.

m_GroupRequestUIHandler

SCR_GroupRequestUIComponent m_GroupRequestUIHandler

protected

Definition at line 112 of file SCR_DeployMenuBase.c.

m_iPlayerId

int m_iPlayerId

protected

Definition at line 145 of file SCR_DeployMenuBase.c.

m_iPreviousTime

int m_iPreviousTime = 0

protected

Definition at line 139 of file SCR_DeployMenuBase.c.

m_iSelectedSpawnPointId

RplId m_iSelectedSpawnPointId = RplId.Invalid()

protected

Definition at line 120 of file SCR_DeployMenuBase.c.

m_LoadingSpinner

SCR_LoadingSpinner m_LoadingSpinner

protected

Definition at line 124 of file SCR_DeployMenuBase.c.

m_LoadoutRequestUIHandler

SCR_LoadoutRequestUIComponent m_LoadoutRequestUIHandler

protected

Definition at line 111 of file SCR_DeployMenuBase.c.

m_MapConfigDeploy

ref MapConfiguration m_MapConfigDeploy = new MapConfiguration()

protected

Definition at line 115 of file SCR_DeployMenuBase.c.

m_MenuHandler

SCR_DeployMenuBase m_MenuHandler

Main deploy menu with the map present.

m_OnSpawnPointSet

ref OnSpawnPointRplIdSetInvoker m_OnSpawnPointSet

protected

Definition at line 164 of file SCR_DeployMenuBase.c.

m_PlayerMenuHandler

SCR_PlayerDeployMenuHandlerComponent m_PlayerMenuHandler

protected

Definition at line 121 of file SCR_DeployMenuBase.c.

m_PlayerRespawnTimer

SCR_RespawnTimerComponent m_PlayerRespawnTimer

protected

Definition at line 137 of file SCR_DeployMenuBase.c.

m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent m_PlyFactionAffilComp

protected

Definition at line 127 of file SCR_DeployMenuBase.c.

m_PlyLoadoutComp

SCR_PlayerLoadoutComponent m_PlyLoadoutComp

protected

Definition at line 129 of file SCR_DeployMenuBase.c.

m_RespawnButton

SCR_DeployButton m_RespawnButton

protected

Definition at line 132 of file SCR_DeployMenuBase.c.

m_RespawnComponent

SCR_RespawnComponent m_RespawnComponent

protected

Definition at line 143 of file SCR_DeployMenuBase.c.

m_RespawnSystemComp

SCR_RespawnSystemComponent m_RespawnSystemComp

protected

Definition at line 142 of file SCR_DeployMenuBase.c.

m_SpawnPointRequestUIHandler

SCR_SpawnPointRequestUIComponent m_SpawnPointRequestUIHandler

protected

Definition at line 113 of file SCR_DeployMenuBase.c.

m_SpawnRequestManager

SCR_RespawnComponent m_SpawnRequestManager

protected

Definition at line 119 of file SCR_DeployMenuBase.c.

m_TimedSpawnPointTimer

SCR_TimedSpawnPointComponent m_TimedSpawnPointTimer

protected

Definition at line 138 of file SCR_DeployMenuBase.c.

m_UIElementContainer

SCR_MapUIElementContainer m_UIElementContainer

protected

Definition at line 116 of file SCR_DeployMenuBase.c.

m_UIInfoSpawnRequestResult

SCR_UIInfoSpawnRequestResult m_UIInfoSpawnRequestResult

protected

Definition at line 151 of file SCR_DeployMenuBase.c.

m_wLoadingSpinner

Widget m_wLoadingSpinner

protected

Definition at line 123 of file SCR_DeployMenuBase.c.

m_wMenuFrame

Widget m_wMenuFrame

protected

Definition at line 134 of file SCR_DeployMenuBase.c.

m_wRespawnButton

Widget m_wRespawnButton

protected

Definition at line 131 of file SCR_DeployMenuBase.c.