Arma Reforger Script API
Loading...
Searching...
No Matches
Public Member Functions | Public Attributes | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
SCR_CampaignMapUIBase Interface Reference
Inheritance diagram for SCR_CampaignMapUIBase:
[legend]

Public Member Functions

ScriptInvoker GetOnMapIconEnter ()
 
ScriptInvoker GetOnMapIconClick ()
 
override bool OnClick (Widget w, int x, int y, int button)
 
override void SelectIcon (bool invoke=true)
 
void FlashBaseIcon (Faction faction=null, bool changeToDefault=false)
 
override bool OnMouseEnter (Widget w, int x, int y)
 
override bool OnMouseLeave (Widget w, Widget enterW, int x, int y)
 
override void AnimExpand ()
 
override void AnimCollapse ()
 
void ShowServiceHint (string name, string text, bool show, int suppliesAmount=-1, int suppliesMax=-1)
 
override void HandlerAttached (Widget w)
 
void OnMapCloseInvoker (MapConfiguration config)
 
void RemoveHint ()
 
override void HandlerDeattached (Widget w)
 
void SetIconInfoText ()
 
void InitServices ()
 
void UpdateBaseIcon (int id)
 
void InitBase (SCR_CampaignMilitaryBaseComponent base)
 
void InitMobile (SCR_CampaignMobileAssemblyStandaloneComponent assembly)
 
void ChangeBaseIconSize ()
 
void SetLocalTaskIcon (SCR_BaseTask task=null)
 
override void ShowName (bool visible)
 
override vector GetPos ()
 
void ChangeNameSize (bool visible)
 
void ChangeNameSizeOnLayerChange (int layer)
 
string GetFactionKey ()
 
Color GetFactionColor ()
 
SCR_CampaignMilitaryBaseComponent GetBase ()
 
void SetBaseIconFactionColor (Faction faction)
 
override void SetImage (string image)
 
override RplId GetSpawnPointId ()
 
void SetAntennaIconVisible (bool visible)
 
void ~SCR_CampaignMapUIBase ()
 
override void HandlerAttached (Widget w)
 
override bool OnMouseEnter (Widget w, int x, int y)
 
override void SetImage (string image)
 
- Public Member Functions inherited from SCR_MapUIElement
override void HandlerAttached (Widget w)
 
void SetParent (SCR_MapUIElementContainer parent)
 
string GetName ()
 
bool GetIconVisible ()
 
void ShowName (bool visible)
 
void SetVisible (bool visible)
 
Widget GetRoot ()
 
override bool OnClick (Widget w, int x, int y, int button)
 
void SelectIcon (bool invoke=true)
 
void Select (bool select=true)
 
vector GetPos ()
 
Color GetColorForFaction (string factionKey)
 
RplId GetSpawnPointId ()
 
void SetName (string name)
 
- Public Member Functions inherited from SCR_ScriptedWidgetComponent
override void HandlerAttached (Widget w)
 
override bool OnClick (Widget w, int x, int y, int button)
 
Widget GetRootWidget ()
 
bool IsVisible ()
 

Public Attributes

bool m_bHighlighted
 
bool m_bIsAnyElementHovered
 
bool m_bIsAnyElementClicked
 
- Public Attributes inherited from SCR_MapUIElement
ref Color m_UnknownFactionColor
 
- Public Attributes inherited from SCR_ScriptedWidgetComponent
ref ScriptInvoker m_OnClick = new ScriptInvoker
 

Static Public Attributes

static ref ScriptInvoker Event_OnIconUpdated = new ScriptInvoker()
 

Protected Member Functions

void SelectBase ()
 
void OnLeave ()
 
void FocusOnBase (SCR_SpawnPoint sp)
 
void OnSelected (SCR_SpawnPoint sp)
 
void ShowServices (bool show)
 
void ShowBase (bool show)
 
void UpdateIconAndText ()
 
void InitBaseIcon ()
 
void UpdateResources ()
 
void UpdateAssemblyIcon ()
 
void SetIconFaction (Faction faction)
 
void SetBaseImage ()
 
void OnMapClose (MapConfiguration config)
 
void SetIconName (string name)
 
void CheckIfCanRespawn ()
 
void SetBaseType (SCR_ECampaignBaseType type)
 
void SetBaseServices (SCR_CampaignMilitaryBaseComponent base)
 
- Protected Member Functions inherited from SCR_MapUIElement
void AnimExpand ()
 
void AnimCollapse ()
 
void PlayHoverSound (string sound)
 
void SetImage (string image)
 

Protected Attributes

ResourceName m_sServiceElement
 
ResourceName m_sServiceHint
 
ResourceName m_sSupplyIcon
 
int m_iServicesPadding = 0
 
float m_fNameOffset = 2
 
ref map< EEditableEntityLabel, SCR_ServicePointDelegateComponentm_mServices = new map<EEditableEntityLabel, SCR_ServicePointDelegateComponent>()
 
ref map< Widget, SCR_MapUITaskm_mTasks = new map<Widget, SCR_MapUITask>()
 
SCR_CampaignMilitaryBaseComponent m_Base
 
string m_sFactionKey
 
SCR_CampaignFaction m_PlayerFaction
 
SCR_CampaignMobileAssemblyStandaloneComponent m_MobileAssembly
 
SCR_ResourceComponent m_ResourceComponent
 
SCR_ResourceConsumer m_ResourceConsumer
 
ref SCR_ResourceSystemSubscriptionHandleBase m_ResourceSubscriptionHandleConsumer
 
RplId m_ResourceInventoryPlayerComponentRplId
 
SizeLayoutWidget m_wImageOverlay
 
Widget m_wBaseFrame
 
Widget m_wBaseIcon
 
Widget m_wBaseOverlay
 
Widget m_wInfoOverlay
 
Widget m_wServices
 
TextWidget m_w_NameDialog
 
Widget m_w_ServicesOverlay
 
TextWidget m_wBaseName
 
TextWidget m_wCallsignName
 
TextWidget m_wBaseNameDialog
 
TextWidget m_wCallsignNameDialog
 
TextWidget m_wSuppliesText Widget m_wInfoText
 
Widget m_wAntennaImg
 
int m_iBaseSize = 80
 
int m_iDefBaseSize = 46
 
int m_iMaxBaseSize = 80
 
int m_iDefHQSize = 88
 
int m_iDefRelaySize = 64
 
ImageWidget m_wLocalTask
 
LocalizedString m_sAssembly = "#AR-Vehicle_MobileAssembly_Name"
 
ref ScriptInvoker m_OnBaseSelected = new ScriptInvoker()
 
ref ScriptInvoker m_OnMapIconEnter
 
ref ScriptInvoker m_OnMapIconClick
 
bool m_bServicesShown
 
bool m_bCanRespawn
 
bool m_bIsRespawnMenu
 
bool m_bIsEditor
 
bool m_bCanPlaySounds = true
 
SCR_SpawnPoint m_SpawnPoint
 
- Protected Attributes inherited from SCR_CampaignMapUIElement
string m_sArmory
 
string m_sFuelDepot
 
string m_sLightVehicleDepot
 
string m_sHeavyVehicleDepot
 
string m_sRadioAntenna
 
string m_sFieldHospital
 
string m_sBarracks
 
string m_sSupplyDepot
 
string m_sVehicleDepot
 
string m_sHelipad
 
string m_sFactionNeutral
 
string m_sRelay
 
string m_sBase
 
string m_sMobileAssembly
 
string m_sMajorBase
 
string m_sMinorBase
 
string m_sSmallBase
 
string m_sRespawn
 
string m_sRespawnBackground
 
string m_sSelection
 
ResourceName m_sImageSet
 
- Protected Attributes inherited from SCR_MapUIElement
SCR_MapUIElementContainer m_Parent
 
MapItem m_MapItem
 
ImageWidget m_wImage
 
ImageWidget m_wGradient
 
ImageWidget m_wSelectImg
 
ImageWidget m_wHighlightImg
 
bool m_bIsSelected
 
SCR_EIconType m_eIconType
 
bool m_bVisible = false
 
ResourceName m_sImageSetARO
 
ResourceName m_sImageSetSpecial
 
bool m_bUseBackgroundGradient
 
string m_sSoundBase
 
string m_sSoundEnemyBase
 
string m_sSoundRelay
 
string m_sSoundTask
 
string m_sSoundService
 
string m_sSoundHover
 
string m_sName
 
- Protected Attributes inherited from SCR_ScriptedWidgetComponent
Widget m_wRoot
 

Static Protected Attributes

static const float OPACITY_DISABLED = 0.5
 
static const float OPACITY_UNSELECTED = 0.9
 
static Widget m_wServiceHint
 
- Static Protected Attributes inherited from SCR_MapUIElement
static SCR_MapUIElement s_SelectedElement
 
const float ANIM_SPEED = 20
 

Additional Inherited Members

- Static Public Member Functions inherited from SCR_ScriptedWidgetComponent
static SCR_ScriptedWidgetComponent GetComponent (TypeName componentType, string name, Widget parent, bool searchAllChildren=true)
 Base method for component lookup through the widget library.
 

Constructor & Destructor Documentation

◆ ~SCR_CampaignMapUIBase()

void SCR_CampaignMapUIBase.~SCR_CampaignMapUIBase ( )

Member Function Documentation

◆ AnimCollapse()

override void SCR_CampaignMapUIBase.AnimCollapse ( )

Implements SCR_MapUIElement.

◆ AnimExpand()

override void SCR_CampaignMapUIBase.AnimExpand ( )

Implements SCR_MapUIElement.

◆ ChangeBaseIconSize()

void SCR_CampaignMapUIBase.ChangeBaseIconSize ( )

◆ ChangeNameSize()

void SCR_CampaignMapUIBase.ChangeNameSize ( bool  visible)
Parameters
[in]visible

◆ ChangeNameSizeOnLayerChange()

void SCR_CampaignMapUIBase.ChangeNameSizeOnLayerChange ( int  layer)
Parameters
[in]layer

◆ CheckIfCanRespawn()

void SCR_CampaignMapUIBase.CheckIfCanRespawn ( )
protected

◆ FlashBaseIcon()

void SCR_CampaignMapUIBase.FlashBaseIcon ( Faction  faction = null,
bool  changeToDefault = false 
)
Parameters
[in]faction
[in]changeToDefault

◆ FocusOnBase()

void SCR_CampaignMapUIBase.FocusOnBase ( SCR_SpawnPoint  sp)
protected

◆ GetBase()

SCR_CampaignMilitaryBaseComponent SCR_CampaignMapUIBase.GetBase ( )
Returns

◆ GetFactionColor()

Color SCR_CampaignMapUIBase.GetFactionColor ( )
Returns

◆ GetFactionKey()

string SCR_CampaignMapUIBase.GetFactionKey ( )
Returns

◆ GetOnMapIconClick()

ScriptInvoker SCR_CampaignMapUIBase.GetOnMapIconClick ( )
Returns

◆ GetOnMapIconEnter()

ScriptInvoker SCR_CampaignMapUIBase.GetOnMapIconEnter ( )
Returns

◆ GetPos()

override vector SCR_CampaignMapUIBase.GetPos ( )

Implements SCR_MapUIElement.

◆ GetSpawnPointId()

override RplId SCR_CampaignMapUIBase.GetSpawnPointId ( )

Implements SCR_MapUIElement.

◆ HandlerAttached()

override void SCR_CampaignMapUIBase.HandlerAttached ( Widget  w)

◆ HandlerDeattached()

override void SCR_CampaignMapUIBase.HandlerDeattached ( Widget  w)

◆ InitBase()

void SCR_CampaignMapUIBase.InitBase ( SCR_CampaignMilitaryBaseComponent  base)
Parameters
[in]base

◆ InitBaseIcon()

void SCR_CampaignMapUIBase.InitBaseIcon ( )
protected

◆ InitMobile()

void SCR_CampaignMapUIBase.InitMobile ( SCR_CampaignMobileAssemblyStandaloneComponent  assembly)
Parameters
[in]assembly

◆ InitServices()

void SCR_CampaignMapUIBase.InitServices ( )

◆ OnClick()

override bool SCR_CampaignMapUIBase.OnClick ( Widget  w,
int  x,
int  y,
int  button 
)

Implements SCR_MapUIElement.

◆ OnLeave()

void SCR_CampaignMapUIBase.OnLeave ( )
protected

◆ OnMapClose()

void SCR_CampaignMapUIBase.OnMapClose ( MapConfiguration  config)
protected

◆ OnMapCloseInvoker()

void SCR_CampaignMapUIBase.OnMapCloseInvoker ( MapConfiguration  config)
Parameters
[in]config

◆ OnMouseEnter()

override bool SCR_CampaignMapUIBase.OnMouseEnter ( Widget  w,
int  x,
int  y 
)

◆ OnMouseLeave()

override bool SCR_CampaignMapUIBase.OnMouseLeave ( Widget  w,
Widget  enterW,
int  x,
int  y 
)

◆ OnSelected()

void SCR_CampaignMapUIBase.OnSelected ( SCR_SpawnPoint  sp)
protected

◆ RemoveHint()

void SCR_CampaignMapUIBase.RemoveHint ( )

◆ SelectBase()

void SCR_CampaignMapUIBase.SelectBase ( )
protected

◆ SelectIcon()

override void SCR_CampaignMapUIBase.SelectIcon ( bool  invoke = true)

Implements SCR_MapUIElement.

◆ SetAntennaIconVisible()

void SCR_CampaignMapUIBase.SetAntennaIconVisible ( bool  visible)
Parameters
[in]visible

◆ SetBaseIconFactionColor()

void SCR_CampaignMapUIBase.SetBaseIconFactionColor ( Faction  faction)
Parameters
[in]faction

◆ SetBaseImage()

void SCR_CampaignMapUIBase.SetBaseImage ( )
protected

◆ SetBaseServices()

void SCR_CampaignMapUIBase.SetBaseServices ( SCR_CampaignMilitaryBaseComponent  base)
protected

◆ SetBaseType()

void SCR_CampaignMapUIBase.SetBaseType ( SCR_ECampaignBaseType  type)
protected

◆ SetIconFaction()

void SCR_CampaignMapUIBase.SetIconFaction ( Faction  faction)
protected

◆ SetIconInfoText()

void SCR_CampaignMapUIBase.SetIconInfoText ( )

◆ SetIconName()

void SCR_CampaignMapUIBase.SetIconName ( string  name)
protected

◆ SetImage()

override void SCR_CampaignMapUIBase.SetImage ( string  image)

◆ SetLocalTaskIcon()

void SCR_CampaignMapUIBase.SetLocalTaskIcon ( SCR_BaseTask  task = null)
Parameters
[in]task

◆ ShowBase()

void SCR_CampaignMapUIBase.ShowBase ( bool  show)
protected

◆ ShowName()

override void SCR_CampaignMapUIBase.ShowName ( bool  visible)

Implements SCR_MapUIElement.

◆ ShowServiceHint()

void SCR_CampaignMapUIBase.ShowServiceHint ( string  name,
string  text,
bool  show,
int  suppliesAmount = -1,
int  suppliesMax = -1 
)
Parameters
[in]name
[in]text
[in]show
[in]suppliesAmount
[in]suppliesMax

◆ ShowServices()

void SCR_CampaignMapUIBase.ShowServices ( bool  show)
protected

◆ UpdateAssemblyIcon()

void SCR_CampaignMapUIBase.UpdateAssemblyIcon ( )
protected

◆ UpdateBaseIcon()

void SCR_CampaignMapUIBase.UpdateBaseIcon ( int  id)
Parameters
[in]id

◆ UpdateIconAndText()

void SCR_CampaignMapUIBase.UpdateIconAndText ( )
protected

◆ UpdateResources()

void SCR_CampaignMapUIBase.UpdateResources ( )
protected

Member Data Documentation

◆ Event_OnIconUpdated

ref ScriptInvoker SCR_CampaignMapUIBase.Event_OnIconUpdated = new ScriptInvoker()
static

◆ m_Base

SCR_CampaignMilitaryBaseComponent SCR_CampaignMapUIBase.m_Base
protected

◆ m_bCanPlaySounds

bool SCR_CampaignMapUIBase.m_bCanPlaySounds = true
protected

◆ m_bCanRespawn

bool SCR_CampaignMapUIBase.m_bCanRespawn
protected

◆ m_bHighlighted

bool SCR_CampaignMapUIBase.m_bHighlighted

◆ m_bIsAnyElementClicked

bool SCR_CampaignMapUIBase.m_bIsAnyElementClicked

◆ m_bIsAnyElementHovered

bool SCR_CampaignMapUIBase.m_bIsAnyElementHovered

◆ m_bIsEditor

bool SCR_CampaignMapUIBase.m_bIsEditor
protected

◆ m_bIsRespawnMenu

bool SCR_CampaignMapUIBase.m_bIsRespawnMenu
protected

◆ m_bServicesShown

bool SCR_CampaignMapUIBase.m_bServicesShown
protected

◆ m_fNameOffset

float SCR_CampaignMapUIBase.m_fNameOffset = 2
protected

◆ m_iBaseSize

int SCR_CampaignMapUIBase.m_iBaseSize = 80
protected

◆ m_iDefBaseSize

int SCR_CampaignMapUIBase.m_iDefBaseSize = 46
protected

◆ m_iDefHQSize

int SCR_CampaignMapUIBase.m_iDefHQSize = 88
protected

◆ m_iDefRelaySize

int SCR_CampaignMapUIBase.m_iDefRelaySize = 64
protected

◆ m_iMaxBaseSize

int SCR_CampaignMapUIBase.m_iMaxBaseSize = 80
protected

◆ m_iServicesPadding

int SCR_CampaignMapUIBase.m_iServicesPadding = 0
protected

◆ m_MobileAssembly

SCR_CampaignMobileAssemblyStandaloneComponent SCR_CampaignMapUIBase.m_MobileAssembly
protected

◆ m_mServices

ref map<EEditableEntityLabel, SCR_ServicePointDelegateComponent> SCR_CampaignMapUIBase.m_mServices = new map<EEditableEntityLabel, SCR_ServicePointDelegateComponent>()
protected

◆ m_mTasks

ref map<Widget, SCR_MapUITask> SCR_CampaignMapUIBase.m_mTasks = new map<Widget, SCR_MapUITask>()
protected

◆ m_OnBaseSelected

ref ScriptInvoker SCR_CampaignMapUIBase.m_OnBaseSelected = new ScriptInvoker()
protected

◆ m_OnMapIconClick

ref ScriptInvoker SCR_CampaignMapUIBase.m_OnMapIconClick
protected

◆ m_OnMapIconEnter

ref ScriptInvoker SCR_CampaignMapUIBase.m_OnMapIconEnter
protected

◆ m_PlayerFaction

SCR_CampaignFaction SCR_CampaignMapUIBase.m_PlayerFaction
protected

◆ m_ResourceComponent

SCR_ResourceComponent SCR_CampaignMapUIBase.m_ResourceComponent
protected

◆ m_ResourceConsumer

SCR_ResourceConsumer SCR_CampaignMapUIBase.m_ResourceConsumer
protected

◆ m_ResourceInventoryPlayerComponentRplId

RplId SCR_CampaignMapUIBase.m_ResourceInventoryPlayerComponentRplId
protected

◆ m_ResourceSubscriptionHandleConsumer

ref SCR_ResourceSystemSubscriptionHandleBase SCR_CampaignMapUIBase.m_ResourceSubscriptionHandleConsumer
protected

◆ m_sAssembly

LocalizedString SCR_CampaignMapUIBase.m_sAssembly = "#AR-Vehicle_MobileAssembly_Name"
protected

◆ m_sFactionKey

string SCR_CampaignMapUIBase.m_sFactionKey
protected

◆ m_SpawnPoint

SCR_SpawnPoint SCR_CampaignMapUIBase.m_SpawnPoint
protected

◆ m_sServiceElement

ResourceName SCR_CampaignMapUIBase.m_sServiceElement
protected

◆ m_sServiceHint

ResourceName SCR_CampaignMapUIBase.m_sServiceHint
protected

◆ m_sSupplyIcon

ResourceName SCR_CampaignMapUIBase.m_sSupplyIcon
protected

◆ m_w_NameDialog

TextWidget SCR_CampaignMapUIBase.m_w_NameDialog
protected

◆ m_w_ServicesOverlay

Widget SCR_CampaignMapUIBase.m_w_ServicesOverlay
protected

◆ m_wAntennaImg

Widget SCR_CampaignMapUIBase.m_wAntennaImg
protected

◆ m_wBaseFrame

Widget SCR_CampaignMapUIBase.m_wBaseFrame
protected

◆ m_wBaseIcon

Widget SCR_CampaignMapUIBase.m_wBaseIcon
protected

◆ m_wBaseName

TextWidget SCR_CampaignMapUIBase.m_wBaseName
protected

◆ m_wBaseNameDialog

TextWidget SCR_CampaignMapUIBase.m_wBaseNameDialog
protected

◆ m_wBaseOverlay

Widget SCR_CampaignMapUIBase.m_wBaseOverlay
protected

◆ m_wCallsignName

TextWidget SCR_CampaignMapUIBase.m_wCallsignName
protected

◆ m_wCallsignNameDialog

TextWidget SCR_CampaignMapUIBase.m_wCallsignNameDialog
protected

◆ m_wImageOverlay

SizeLayoutWidget SCR_CampaignMapUIBase.m_wImageOverlay
protected

◆ m_wInfoOverlay

Widget SCR_CampaignMapUIBase.m_wInfoOverlay
protected

◆ m_wInfoText

TextWidget m_wSuppliesText Widget SCR_CampaignMapUIBase.m_wInfoText
protected

◆ m_wLocalTask

ImageWidget SCR_CampaignMapUIBase.m_wLocalTask
protected

◆ m_wServiceHint

Widget SCR_CampaignMapUIBase.m_wServiceHint
staticprotected

◆ m_wServices

Widget SCR_CampaignMapUIBase.m_wServices
protected

◆ OPACITY_DISABLED

const float SCR_CampaignMapUIBase.OPACITY_DISABLED = 0.5
staticprotected

◆ OPACITY_UNSELECTED

const float SCR_CampaignMapUIBase.OPACITY_UNSELECTED = 0.9
staticprotected

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