Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_MapUIElementContainer Interface Reference
Inheritance diagram for SCR_MapUIElementContainer:
SCR_MapUIBaseComponent SCR_MapCampaignUI SCR_TutorialMapUI

Public Member Functions

override void Init ()
 Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.
 
override void OnMapOpen (MapConfiguration config)
 SCR_MapEntity event.
 
override void OnMapClose (MapConfiguration config)
 SCR_MapEntity event.
 
void OnMapPan (float panX, float panY, bool adjustedPan)
 
void RemoveIcon (SCR_MapUIElement icon)
 
void OnSpawnPointSelectedExt (RplId id)
 
void OnElementSelected (notnull SCR_MapUIElement element)
 
void OnSpawnPointSelected (RplId spId=RplId.Invalid())
 
SCR_MapUISpawnPoint FindSpawnPoint (RplId id)
 
ScriptInvoker GetOnSpawnPointSelected ()
 
ScriptInvoker GetOnElementSelected ()
 
- Public Member Functions inherited from SCR_MapUIBaseComponent
bool IsConfigDisabled ()
 
void SetActive (bool active, bool isCleanup=false)
 Enable open/close events, called every time component is activated, usually on map open.
 
void Update (float timeSlice)
 Update method for frame operations.
 
bool IsToolMenuFocused ()
 
void SCR_MapUIBaseComponent ()
 

Protected Member Functions

void AddSpawnPoint (SCR_SpawnPoint spawnPoint)
 
void RemoveSpawnPoint (SCR_SpawnPoint spawnPoint)
 
void OnSpawnPointFactionChange (SCR_SpawnPoint spawnPoint)
 
void UpdateSpawnPointName (RplId id, string name)
 
void HideSpawnPoint (RplId spawnPointId)
 
void OnPlayerFactionResponse (SCR_PlayerFactionAffiliationComponent component, int factionIndex, bool response)
 
void UpdateIcons ()
 
void InitSpawnPoints ()
 
void ShowSpawnPoint (notnull SCR_SpawnPoint spawnPoint)
 
void InitTaskMarkers ()
 
void InitTaskIcon (SCR_BaseTask task)
 
void OnTaskAdded (SCR_BaseTask task)
 
void OnTaskRemoved (SCR_BaseTask task)
 
void RemoveAllIcons ()
 
SCR_MapUIElement FindSpawnPointIconById (RplId id)
 
void OnPlayerGroupChanged (SCR_AIGroup group)
 

Protected Attributes

string m_sIconsContainer
 
Widget m_wIconsContainer
 
ResourceName m_sSpawnPointElement
 
ResourceName m_sTaskElement
 
ResourceName m_sWarningWidget
 
Widget m_wWarningWidget
 
bool m_bShowSpawnPointsHint
 
bool m_bShowSpawnPoints
 
bool m_bShowTasks
 
bool m_bIsEditor
 
bool m_bIsDeployMap
 
ref map< Widget, SCR_MapUIElementm_mIcons = new map<Widget, SCR_MapUIElement>()
 
SCR_PlayerFactionAffiliationComponent m_PlyFactionAffilComp
 
SCR_PlayerControllerGroupComponent m_PlyGroupComp
 
SCR_BaseGameMode m_GameMode
 
ref ScriptInvoker< SCR_MapUIElementm_OnElementSelected
 
ref ScriptInvoker< RplId > m_OnSpawnPointSelected
 
- Protected Attributes inherited from SCR_MapUIBaseComponent
bool m_bDisableComponent
 
bool m_bHookToRoot = false
 
Widget m_RootWidget
 
SCR_MapEntity m_MapEntity
 

Member Function Documentation

◆ AddSpawnPoint()

void SCR_MapUIElementContainer.AddSpawnPoint ( SCR_SpawnPoint spawnPoint)
protected

◆ FindSpawnPoint()

SCR_MapUISpawnPoint SCR_MapUIElementContainer.FindSpawnPoint ( RplId id)
Parameters
[in]id
Returns

◆ FindSpawnPointIconById()

SCR_MapUIElement SCR_MapUIElementContainer.FindSpawnPointIconById ( RplId id)
protected

◆ GetOnElementSelected()

ScriptInvoker SCR_MapUIElementContainer.GetOnElementSelected ( )
Returns

◆ GetOnSpawnPointSelected()

ScriptInvoker SCR_MapUIElementContainer.GetOnSpawnPointSelected ( )
Returns

◆ HideSpawnPoint()

void SCR_MapUIElementContainer.HideSpawnPoint ( RplId spawnPointId)
protected

◆ Init()

override void SCR_MapUIElementContainer.Init ( )

Init method for cases where all modules and components should be loaded already so constructor cannot be used, called once after creation.

Implements SCR_MapUIBaseComponent.

◆ InitSpawnPoints()

void SCR_MapUIElementContainer.InitSpawnPoints ( )
protected

◆ InitTaskIcon()

void SCR_MapUIElementContainer.InitTaskIcon ( SCR_BaseTask task)
protected

◆ InitTaskMarkers()

void SCR_MapUIElementContainer.InitTaskMarkers ( )
protected

◆ OnElementSelected()

void SCR_MapUIElementContainer.OnElementSelected ( notnull SCR_MapUIElement element)
Parameters
[in]element

◆ OnMapClose()

override void SCR_MapUIElementContainer.OnMapClose ( MapConfiguration config)

SCR_MapEntity event.

Parameters
[in]config

Implements SCR_MapUIBaseComponent.

Implemented in SCR_MapCampaignUI.

◆ OnMapOpen()

override void SCR_MapUIElementContainer.OnMapOpen ( MapConfiguration config)

SCR_MapEntity event.

Parameters
[in]config

Implements SCR_MapUIBaseComponent.

Implemented in SCR_MapCampaignUI, and SCR_TutorialMapUI.

◆ OnMapPan()

void SCR_MapUIElementContainer.OnMapPan ( float panX,
float panY,
bool adjustedPan )
Parameters
[in]panX
[in]panY
[in]adjustedPan

◆ OnPlayerFactionResponse()

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

◆ OnPlayerGroupChanged()

void SCR_MapUIElementContainer.OnPlayerGroupChanged ( SCR_AIGroup group)
protected

◆ OnSpawnPointFactionChange()

void SCR_MapUIElementContainer.OnSpawnPointFactionChange ( SCR_SpawnPoint spawnPoint)
protected

Implemented in SCR_MapCampaignUI.

◆ OnSpawnPointSelected()

void SCR_MapUIElementContainer.OnSpawnPointSelected ( RplId spId = RplId::Invalid())
Parameters
[in]spId

◆ OnSpawnPointSelectedExt()

void SCR_MapUIElementContainer.OnSpawnPointSelectedExt ( RplId id)
Parameters
[in]id

◆ OnTaskAdded()

void SCR_MapUIElementContainer.OnTaskAdded ( SCR_BaseTask task)
protected

◆ OnTaskRemoved()

void SCR_MapUIElementContainer.OnTaskRemoved ( SCR_BaseTask task)
protected

◆ RemoveAllIcons()

void SCR_MapUIElementContainer.RemoveAllIcons ( )
protected

◆ RemoveIcon()

void SCR_MapUIElementContainer.RemoveIcon ( SCR_MapUIElement icon)
Parameters
[in]icon

◆ RemoveSpawnPoint()

void SCR_MapUIElementContainer.RemoveSpawnPoint ( SCR_SpawnPoint spawnPoint)
protected

◆ ShowSpawnPoint()

void SCR_MapUIElementContainer.ShowSpawnPoint ( notnull SCR_SpawnPoint spawnPoint)
protected

Implemented in SCR_MapCampaignUI.

◆ UpdateIcons()

void SCR_MapUIElementContainer.UpdateIcons ( )
protected

◆ UpdateSpawnPointName()

void SCR_MapUIElementContainer.UpdateSpawnPointName ( RplId id,
string name )
protected

Member Data Documentation

◆ m_bIsDeployMap

bool SCR_MapUIElementContainer.m_bIsDeployMap
protected

◆ m_bIsEditor

bool SCR_MapUIElementContainer.m_bIsEditor
protected

◆ m_bShowSpawnPoints

bool SCR_MapUIElementContainer.m_bShowSpawnPoints
protected

◆ m_bShowSpawnPointsHint

bool SCR_MapUIElementContainer.m_bShowSpawnPointsHint
protected

◆ m_bShowTasks

bool SCR_MapUIElementContainer.m_bShowTasks
protected

◆ m_GameMode

SCR_BaseGameMode SCR_MapUIElementContainer.m_GameMode
protected

◆ m_mIcons

ref map<Widget, SCR_MapUIElement> SCR_MapUIElementContainer.m_mIcons = new map<Widget, SCR_MapUIElement>()
protected

◆ m_OnElementSelected

ref ScriptInvoker<SCR_MapUIElement> SCR_MapUIElementContainer.m_OnElementSelected
protected

◆ m_OnSpawnPointSelected

ref ScriptInvoker<RplId> SCR_MapUIElementContainer.m_OnSpawnPointSelected
protected

◆ m_PlyFactionAffilComp

SCR_PlayerFactionAffiliationComponent SCR_MapUIElementContainer.m_PlyFactionAffilComp
protected

◆ m_PlyGroupComp

SCR_PlayerControllerGroupComponent SCR_MapUIElementContainer.m_PlyGroupComp
protected

◆ m_sIconsContainer

string SCR_MapUIElementContainer.m_sIconsContainer
protected

◆ m_sSpawnPointElement

ResourceName SCR_MapUIElementContainer.m_sSpawnPointElement
protected

◆ m_sTaskElement

ResourceName SCR_MapUIElementContainer.m_sTaskElement
protected

◆ m_sWarningWidget

ResourceName SCR_MapUIElementContainer.m_sWarningWidget
protected

◆ m_wIconsContainer

Widget SCR_MapUIElementContainer.m_wIconsContainer
protected

◆ m_wWarningWidget

Widget SCR_MapUIElementContainer.m_wWarningWidget
protected

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