Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_DeployMenuMain Interface Reference

Main deploy menu with the map present. More...

Inheritance diagram for SCR_DeployMenuMain:
[legend]

Public Member Functions

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 ()
 Returns true if map context is allowed.
 
override void OnMenuOpen ()
 
override void OnMenuHide ()
 
override void OnMenuFocusLost ()
 
override void OnMenuFocusGained ()
 
override void OnMenuOpened ()
 
override void OnMenuClose ()
 
override void OnMenuUpdate (float tDelta)
 
SCR_SpawnPointRequestUIComponent GetSpawnPointRequestHandler ()
 
OnSpawnPointRplIdSetInvoker GetOnSpawnPointRplIdSet ()
 
- Public Member Functions inherited from SCR_DeployMenuBase
override void OnMenuOpen ()
 
override void OnMenuOpened ()
 
override void OnMenuClose ()
 
override void OnMenuHide ()
 
void MuteSounds (bool mute=true)
 
- Public Member Functions inherited from ChimeraMenuBase
override void OnMenuInit ()
 
override void OnMenuUpdate (float tDelta)
 
override void OnMenuOpen ()
 
override void OnMenuOpened ()
 
override void OnMenuClose ()
 
override void OnMenuFocusGained ()
 
override void OnMenuFocusLost ()
 
override void OnMenuShow ()
 
override void OnMenuHide ()
 

Static Public Member Functions

static SCR_DeployMenuMain OpenDeployMenu ()
 Opens deploy menu.
 
static void CloseDeployMenu ()
 As the name suggests, this method closes the deploy menu instance.
 
static SCR_DeployMenuMain GetDeployMenu ()
 Returns the deploy menu instance.
 
- Static Public Member Functions inherited from SCR_DeployMenuBase
static OnDeployMenuOpenInvoker SGetOnMenuOpen ()
 
- Static Public Member Functions inherited from ChimeraMenuBase
static ChimeraMenuBase CurrentChimeraMenu ()
 
static ChimeraMenuBase GetOwnerMenu (Widget w)
 Returns parent menu of a widget.
 

Protected Member Functions

void NextSpawn ()
 Select next available spawn point.
 
void PrevSpawn ()
 Select previous available spawn point.
 
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 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 ()
 
- Protected Member Functions inherited from SCR_DeployMenuBase
void OnLanguageChanged (SCR_GameplaySettingsSubMenu menu)
 Hack used to refresh the map after language is changed in order to force reload fonts used by location descriptors.
 
void OpenPlayerList ()
 
void OnEditorLimitedChanged (bool limited)
 If limited, don't show the game master switch button.
 

Protected Attributes

SCR_DeployMenuHandler m_MenuHandler
 
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()
 
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_bCanRespawnAtSpawnPoint
 
SCR_UIInfoSpawnRequestResult m_UIInfoSpawnRequestResult
 
bool m_bDisplayTime
 
float m_fCurrentCanSpawnUpdateTime
 
SCR_InputButtonComponent m_GroupOpenButton
 
float m_fCurrentDeployTimeOut
 
ref OnSpawnPointRplIdSetInvoker m_OnSpawnPointSet
 
- Protected Attributes inherited from SCR_DeployMenuBase
SCR_InputButtonComponent m_PauseButton
 
SCR_InputButtonComponent m_GameMasterButton
 
SCR_InputButtonComponent m_ChatButton
 
SCR_ChatPanel m_ChatPanel
 
SCR_MapEntity m_MapEntity
 
- Protected Attributes inherited from ChimeraMenuBase
bool m_bTextEditActive = false
 

Static Protected Attributes

const float CHECK_CAN_SPAWN_SPAWNPOINT_TIME = 1
 
const string FALLBACK_DEPLOY_STRING = "#AR-ButtonSelectDeploy"
 
const float DEPLOY_TIME_OUT = 0.5
 
- Static Protected Attributes inherited from SCR_DeployMenuBase
static ref OnDeployMenuOpenInvoker s_OnMenuOpen
 
- Static Protected Attributes inherited from ChimeraMenuBase
const string INPUT_CONTEXT_EDIT = "MenuTextEditContext"
 
static ChimeraMenuBase m_ThisMenu
 

Additional Inherited Members

- Public Attributes inherited from ChimeraMenuBase
ref ScriptInvoker m_OnTextEditContextChange = new ScriptInvoker
 
ref ScriptInvoker m_OnUpdate = new ScriptInvoker
 

Detailed Description

Main deploy menu with the map present.

Member Function Documentation

◆ AllowMapContext()

void SCR_DeployMenuMain.AllowMapContext ( bool  allow)

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

◆ CloseDeployMenu()

static void SCR_DeployMenuMain.CloseDeployMenu ( )
static

As the name suggests, this method closes the deploy menu instance.

◆ FindRequestHandlers()

void SCR_DeployMenuMain.FindRequestHandlers ( )
protected

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

◆ FocusOnPoint()

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

Centers map to a specific spawn point.

◆ GetAllowMapContext()

bool SCR_DeployMenuMain.GetAllowMapContext ( )

Returns true if map context is allowed.

Returns

◆ GetDeployMenu()

static SCR_DeployMenuMain SCR_DeployMenuMain.GetDeployMenu ( )
static

Returns the deploy menu instance.

◆ GetLoadoutCost()

int SCR_DeployMenuMain.GetLoadoutCost ( SCR_PlayerLoadoutComponent  component)
Parameters
[in]component
Returns

◆ GetOnSpawnPointRplIdSet()

OnSpawnPointRplIdSetInvoker SCR_DeployMenuMain.GetOnSpawnPointRplIdSet ( )
Returns

◆ GetSpawnPointRequestHandler()

SCR_SpawnPointRequestUIComponent SCR_DeployMenuMain.GetSpawnPointRequestHandler ( )
Returns

◆ HideLoading()

void SCR_DeployMenuMain.HideLoading ( )
protected

Hides loading spinner widget.

◆ HookEvents()

void SCR_DeployMenuMain.HookEvents ( )
protected

Initialize necessary callbacks.

◆ InitMapDeploy()

void SCR_DeployMenuMain.InitMapDeploy ( )
protected

Initializes the map with deploy menu config.

◆ NextSpawn()

void SCR_DeployMenuMain.NextSpawn ( )
protected

Select next available spawn point.

◆ OnCanRespawnRequestResponse()

void SCR_DeployMenuMain.OnCanRespawnRequestResponse ( SCR_SpawnRequestComponent  requestComponent,
SCR_ESpawnResult  response,
SCR_SpawnData  data 
)
protected

◆ OnChatToggle()

void SCR_DeployMenuMain.OnChatToggle ( )
protected

Toggle chat.

◆ OnLocalPlayerGroupJoined()

void SCR_DeployMenuMain.OnLocalPlayerGroupJoined ( SCR_AIGroup  group)
protected

Callback when player joins a group.

◆ OnMapOpen()

void SCR_DeployMenuMain.OnMapOpen ( MapConfiguration  config)
protected

◆ OnMenuClose()

override void SCR_DeployMenuMain.OnMenuClose ( )

Implements SCR_DeployMenuBase.

◆ OnMenuFocusGained()

override void SCR_DeployMenuMain.OnMenuFocusGained ( )

Implements ChimeraMenuBase.

◆ OnMenuFocusLost()

override void SCR_DeployMenuMain.OnMenuFocusLost ( )

Implements ChimeraMenuBase.

◆ OnMenuHide()

override void SCR_DeployMenuMain.OnMenuHide ( )

Implements SCR_DeployMenuBase.

◆ OnMenuOpen()

override void SCR_DeployMenuMain.OnMenuOpen ( )

Implements SCR_DeployMenuBase.

◆ OnMenuOpened()

override void SCR_DeployMenuMain.OnMenuOpened ( )

Implements SCR_DeployMenuBase.

◆ OnMenuUpdate()

override void SCR_DeployMenuMain.OnMenuUpdate ( float  tDelta)

Implements ChimeraMenuBase.

◆ OnPauseMenu()

void SCR_DeployMenuMain.OnPauseMenu ( )
protected

Opens pause menu.

◆ OnPlayerFactionRequest()

void SCR_DeployMenuMain.OnPlayerFactionRequest ( SCR_PlayerFactionAffiliationComponent  component,
int  factionIndex 
)
protected

Callback when player requests a faction.

◆ OnPlayerFactionResponse()

void SCR_DeployMenuMain.OnPlayerFactionResponse ( SCR_PlayerFactionAffiliationComponent  component,
int  factionIndex,
bool  response 
)
protected

Callback when faction request receives a response.

◆ OnPlayerFactionSet()

void SCR_DeployMenuMain.OnPlayerFactionSet ( Faction  assignedFaction)
protected

◆ OnPlayerLoadoutRequest()

void SCR_DeployMenuMain.OnPlayerLoadoutRequest ( SCR_PlayerLoadoutComponent  component,
int  loadoutIndex 
)
protected

Callback when player requests a loadout.

◆ OnPlayerLoadoutResponse()

void SCR_DeployMenuMain.OnPlayerLoadoutResponse ( SCR_PlayerLoadoutComponent  component,
int  loadoutIndex,
bool  response 
)
protected

Callback when loadout request receives a response.

◆ OnRespawnRequest()

void SCR_DeployMenuMain.OnRespawnRequest ( SCR_SpawnRequestComponent  requestComponent)
protected

Callback when respawn request was sent for the player.

◆ OnRespawnResponse()

void SCR_DeployMenuMain.OnRespawnResponse ( SCR_SpawnRequestComponent  requestComponent,
SCR_ESpawnResult  response 
)
protected

Callback when player respawn request received a response.

◆ OpenDeployMenu()

static SCR_DeployMenuMain SCR_DeployMenuMain.OpenDeployMenu ( )
static

Opens deploy menu.

◆ OpenGroupMenu()

void SCR_DeployMenuMain.OpenGroupMenu ( )
protected

◆ PrevSpawn()

void SCR_DeployMenuMain.PrevSpawn ( )
protected

Select previous available spawn point.

◆ RequestRespawn()

void SCR_DeployMenuMain.RequestRespawn ( )
protected

Sends a respawn request based on assigned loadout and selected spawn point.

◆ ResetRespawnResultVars()

void SCR_DeployMenuMain.ResetRespawnResultVars ( )
protected

◆ SetInitialSpawnPoint()

void SCR_DeployMenuMain.SetInitialSpawnPoint ( RplId  spawnPointId)
protected

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

◆ SetSpawnPoint()

void SCR_DeployMenuMain.SetSpawnPoint ( RplId  id,
bool  smoothPan = true 
)
protected

Sets the currently selected spawn point.

◆ SetSpawnPointExt()

void SCR_DeployMenuMain.SetSpawnPointExt ( RplId  id)
protected

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

◆ UpdateRespawnButton()

void SCR_DeployMenuMain.UpdateRespawnButton ( )
protected

Sets respawn button enabled based on certain conditions.

Member Data Documentation

◆ CHECK_CAN_SPAWN_SPAWNPOINT_TIME

const float SCR_DeployMenuMain.CHECK_CAN_SPAWN_SPAWNPOINT_TIME = 1
staticprotected

◆ DEPLOY_TIME_OUT

const float SCR_DeployMenuMain.DEPLOY_TIME_OUT = 0.5
staticprotected

◆ FALLBACK_DEPLOY_STRING

const string SCR_DeployMenuMain.FALLBACK_DEPLOY_STRING = "#AR-ButtonSelectDeploy"
staticprotected

◆ m_ActiveRespawnTimer

SCR_RespawnTimerComponent SCR_DeployMenuMain.m_ActiveRespawnTimer
protected

◆ m_bCanRespawnAtSpawnPoint

bool SCR_DeployMenuMain.m_bCanRespawnAtSpawnPoint
protected

◆ m_bDisplayTime

bool SCR_DeployMenuMain.m_bDisplayTime
protected

◆ m_bMapContextAllowed

bool SCR_DeployMenuMain.m_bMapContextAllowed = true
protected

◆ m_bRespawnRequested

bool SCR_DeployMenuMain.m_bRespawnRequested = false
protected

◆ m_bSuppliesEnabled

bool SCR_DeployMenuMain.m_bSuppliesEnabled
protected

◆ m_FactionManager

FactionManager SCR_DeployMenuMain.m_FactionManager
protected

◆ m_fCurrentCanSpawnUpdateTime

float SCR_DeployMenuMain.m_fCurrentCanSpawnUpdateTime
protected

◆ m_fCurrentDeployTimeOut

float SCR_DeployMenuMain.m_fCurrentDeployTimeOut
protected

◆ m_GameMode

SCR_BaseGameMode SCR_DeployMenuMain.m_GameMode
protected

◆ m_GroupOpenButton

SCR_InputButtonComponent SCR_DeployMenuMain.m_GroupOpenButton
protected

◆ m_GroupRequestUIHandler

SCR_GroupRequestUIComponent SCR_DeployMenuMain.m_GroupRequestUIHandler
protected

◆ m_iPlayerId

int SCR_DeployMenuMain.m_iPlayerId
protected

◆ m_iPreviousTime

int SCR_DeployMenuMain.m_iPreviousTime = 0
protected

◆ m_iSelectedSpawnPointId

RplId SCR_DeployMenuMain.m_iSelectedSpawnPointId = RplId.Invalid()
protected

◆ m_LoadingSpinner

SCR_LoadingSpinner SCR_DeployMenuMain.m_LoadingSpinner
protected

◆ m_LoadoutRequestUIHandler

SCR_LoadoutRequestUIComponent SCR_DeployMenuMain.m_LoadoutRequestUIHandler
protected

◆ m_MapConfigDeploy

ref MapConfiguration SCR_DeployMenuMain.m_MapConfigDeploy = new MapConfiguration()
protected

◆ m_MenuHandler

SCR_DeployMenuHandler SCR_DeployMenuMain.m_MenuHandler
protected

◆ m_OnSpawnPointSet

ref OnSpawnPointRplIdSetInvoker SCR_DeployMenuMain.m_OnSpawnPointSet
protected

◆ m_PlayerRespawnTimer

SCR_RespawnTimerComponent SCR_DeployMenuMain.m_PlayerRespawnTimer
protected

◆ m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_DeployMenuMain.m_PlyFactionAffilComp
protected

◆ m_PlyLoadoutComp

SCR_PlayerLoadoutComponent SCR_DeployMenuMain.m_PlyLoadoutComp
protected

◆ m_RespawnButton

SCR_DeployButton SCR_DeployMenuMain.m_RespawnButton
protected

◆ m_RespawnComponent

SCR_RespawnComponent SCR_DeployMenuMain.m_RespawnComponent
protected

◆ m_RespawnSystemComp

SCR_RespawnSystemComponent SCR_DeployMenuMain.m_RespawnSystemComp
protected

◆ m_SpawnPointRequestUIHandler

SCR_SpawnPointRequestUIComponent SCR_DeployMenuMain.m_SpawnPointRequestUIHandler
protected

◆ m_SpawnRequestManager

SCR_RespawnComponent SCR_DeployMenuMain.m_SpawnRequestManager
protected

◆ m_TimedSpawnPointTimer

SCR_TimedSpawnPointComponent SCR_DeployMenuMain.m_TimedSpawnPointTimer
protected

◆ m_UIElementContainer

SCR_MapUIElementContainer SCR_DeployMenuMain.m_UIElementContainer
protected

◆ m_UIInfoSpawnRequestResult

SCR_UIInfoSpawnRequestResult SCR_DeployMenuMain.m_UIInfoSpawnRequestResult
protected

◆ m_wLoadingSpinner

Widget SCR_DeployMenuMain.m_wLoadingSpinner
protected

◆ m_wMenuFrame

Widget SCR_DeployMenuMain.m_wMenuFrame
protected

◆ m_wRespawnButton

Widget SCR_DeployMenuMain.m_wRespawnButton
protected
The documentation for this interface was generated from the following file:
Generated by doxygen 1.9.6