Arma Reforger Script API
Loading...
Searching...
No Matches
SCR_CampaignOperationsMapUIBase Interface Reference
Inheritance diagram for SCR_CampaignOperationsMapUIBase:
SCR_CampaignMapUIBase SCR_CampaignMapUIElement SCR_MapUIElement SCR_ScriptedWidgetComponent

Public Member Functions

override bool OnMouseEnter (Widget w, int x, int y)
 
override bool OnMouseLeave (Widget w, Widget enterW, int x, int y)
 
bool EvaluateEntity (notnull IEntity entity)
 Check if this entity can block player to enter a building mode. If such an entity is found, return false to stop evaluating next entity found by query.
 
- Public Member Functions inherited from SCR_CampaignMapUIBase
ScriptInvoker GetOnMapIconEnter ()
 
ScriptInvoker GetOnMapIconClick ()
 
int GetBaseIconSize ()
 
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 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 ()
 
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 ()
 
- Public Member Functions inherited from SCR_MapUIElement
void SetParent (SCR_MapUIElementContainer parent)
 
string GetName ()
 
bool GetIconVisible ()
 
void SetVisible (bool visible)
 
Widget GetRoot ()
 
void Select (bool select=true)
 
Color GetColorForFaction (string factionKey)
 
void SetName (string name)
 
- Public Member Functions inherited from SCR_ScriptedWidgetComponent
Widget GetRootWidget ()
 
bool IsVisible ()
 

Protected Member Functions

override void DeinitOpenButton (Widget w)
 
void SetOpenButtonEnabled (bool enable)
 Enables or disables button for entering the build mode.
 
void EvaluateBuildModeAvailability ()
 Checks all entities in vicinity of the base and if any entities blocking the build mode in the base are found. Enter build mode button is disabled.
 
- Protected Member Functions inherited from SCR_CampaignMapUIBase
void SelectBase ()
 
void OnLeave ()
 
bool CanShowOpenButton ()
 
void InitOpenButton (Widget w)
 
void OnOpenButtonActivated (SCR_InputButtonComponent button, string action)
 
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)
 
void OnGroupRallyPointChanged (SCR_AIGroup group)
 
void SetRallyPointVisibility (SCR_AIGroup playerGroup=null)
 
void SetRallyPointVisible (bool visible)
 
- Protected Member Functions inherited from SCR_MapUIElement
void PlayHoverSound (string sound)
 

Static Protected Attributes

const int EVALUATE_BUILD_MODE_AVAILABILITY_DELAY = 3000
 
- Static Protected Attributes inherited from SCR_CampaignMapUIBase
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.
 
- Public Attributes inherited from SCR_CampaignMapUIBase
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 inherited from SCR_CampaignMapUIBase
static ref ScriptInvoker Event_OnIconUpdated = new ScriptInvoker()
 
- Protected Attributes inherited from SCR_CampaignMapUIBase
ResourceName m_sServiceElement
 
ResourceName m_sServiceHint
 
ResourceName m_sSupplyIcon
 
string m_sOpenButtonName
 
int m_iServicesPadding = 0
 
float m_fNameOffset = 2
 
ref map< EEditableEntityLabel, SCR_ServicePointDelegateComponentm_mServices = new map<EEditableEntityLabel, SCR_ServicePointDelegateComponent>()
 
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
 
Widget m_wOpenButton
 
SCR_InputButtonComponent m_OpenInputButtonComponent
 
TextWidget m_wBaseName
 
TextWidget m_wCallsignName
 
TextWidget m_wBaseNameDialog
 
TextWidget m_wCallsignNameDialog
 
TextWidget m_wSuppliesText Widget m_wInfoText
 
Widget m_wAntennaImg
 
Widget m_wRallyPointIconTop
 
Widget m_wRallyPointIconBalancer
 
Widget m_wRallyPointIconBottom
 
TextWidget m_wRallyPointText
 
LocalizedString m_sRallyPointText = "#AR-RallyPoint_Name"
 
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_sSourceBase
 
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
 

Member Function Documentation

◆ DeinitOpenButton()

override void SCR_CampaignOperationsMapUIBase.DeinitOpenButton ( Widget w)
protected

Implements SCR_CampaignMapUIBase.

◆ EvaluateBuildModeAvailability()

void SCR_CampaignOperationsMapUIBase.EvaluateBuildModeAvailability ( )
protected

Checks all entities in vicinity of the base and if any entities blocking the build mode in the base are found. Enter build mode button is disabled.

◆ EvaluateEntity()

bool SCR_CampaignOperationsMapUIBase.EvaluateEntity ( notnull IEntity entity)

Check if this entity can block player to enter a building mode. If such an entity is found, return false to stop evaluating next entity found by query.

◆ OnMouseEnter()

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

Implements SCR_CampaignMapUIBase.

◆ OnMouseLeave()

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

Implements SCR_CampaignMapUIBase.

◆ SetOpenButtonEnabled()

void SCR_CampaignOperationsMapUIBase.SetOpenButtonEnabled ( bool enable)
protected

Enables or disables button for entering the build mode.

Parameters
[in]enable

Member Data Documentation

◆ EVALUATE_BUILD_MODE_AVAILABILITY_DELAY

const int SCR_CampaignOperationsMapUIBase.EVALUATE_BUILD_MODE_AVAILABILITY_DELAY = 3000
staticprotected

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