SCR_MapMarkerSquadLeader.c

Go to the documentation of this file.

//------------------------------------------------------------------------------------------------
[EntityEditorProps(category: "GameScripted/Markers")]
class SCR_MapMarkerSquadLeaderClass : SCR_MapMarkerEntityClass
{}
 
//------------------------------------------------------------------------------------------------
class SCR_MapMarkerSquadLeader : SCR_MapMarkerEntity
{
    [RplProp(onRplName: "OnPlayerIdUpdate")]
    protected int m_PlayerID;                           // target ID, needed for visibility rules and fetching group
    
    const float SL_UPDATE_DELAY = 1;                    // seconds 
    const float ASPECT_RATIO_FLAG = 1.45;               // temp -> force aspect ratio of a military symbol
    const int SIZE_FLAG = 56;                           // temp -> required due to aspect ratio's need to be set
        
    bool m_bDoGroupTextUpdate;                          // group text update flag
    protected bool m_bDoGroupSymbolUpdate;              // group symbol update flag
    protected SCR_AIGroup m_Group;
    protected SCR_MapMarkerSquadLeaderComponent m_SquadLeaderWidgetComp;
        
    //------------------------------------------------------------------------------------------------
    // RPL EVENTS
    //------------------------------------------------------------------------------------------------
    void OnPlayerIdUpdate()
    {
        PlayerController pController = GetGame().GetPlayerController();
        if (!pController)
            return;
        
        if (m_PlayerID == pController.GetPlayerId())    // if this is us, dont display
            SetLocalVisible(false);
        else
        {
            SetLocalVisible(true);
        }
    }
    
    //------------------------------------------------------------------------------------------------
    // API SERVER
    //------------------------------------------------------------------------------------------------
    void SetPlayerID(int id)
    {
        m_PlayerID = id;
        m_MarkerFaction = SCR_FactionManager.SGetPlayerFaction(id);
        
        Replication.BumpMe();
        
        if (!System.IsConsoleApp())
            OnPlayerIdUpdate();
        
        UpdateTarget();
    }
    
    //------------------------------------------------------------------------------------------------
    // EVENTS & OTHERS
    //------------------------------------------------------------------------------------------------
    void SetTextUpdate()
    {
        m_bDoGroupTextUpdate = true;
    }
    
    //------------------------------------------------------------------------------------------------
    SCR_AIGroup GetGroup()
    {
        return m_Group;
    }
    
    //------------------------------------------------------------------------------------------------
    protected void AssignGroup()
    {
        SCR_GroupsManagerComponent comp = SCR_GroupsManagerComponent.GetInstance();
        if (!comp)
            return;
        
        m_Group = comp.GetPlayerGroup(m_PlayerID);
        
        if (m_Group)
            SCR_MapMarkerEntrySquadLeader.Cast(m_ConfigEntry).RegisterMarker(this, m_Group);
    }
    
    //------------------------------------------------------------------------------------------------
    protected void UpdateTarget()
    {
        IEntity ent = GetGame().GetPlayerManager().GetPlayerControlledEntity(m_PlayerID);
        if (ent)
        {
            SCR_CharacterControllerComponent charController = SCR_CharacterControllerComponent.Cast(ent.FindComponent(SCR_CharacterControllerComponent));
            if (!charController.IsDead())
            {
                SetTarget(ent);
                SetGlobalVisible(true);
                                
                return;
            }
        }
        
        SetTarget(null);
        SetGlobalVisible(false);
    }
        
    //------------------------------------------------------------------------------------------------
    protected void UpdateGroupMilitarySymbol()
    {
        if (!m_Group)
        {
            AssignGroup();
            return;
        }
        
        string company, platoon, squad, character, format;
        m_Group.GetCallsigns(company, platoon, squad, character, format);
 
        SCR_Faction faction = SCR_Faction.Cast(m_Group.GetFaction());
        if (faction)
        {
            string flag = m_Group.GetGroupFlag();
            if (flag == string.Empty)
                flag = faction.GetFlagName(0);
            
            SetImage(faction.GetGroupFlagImageSet(), flag);
        }
        
        if (m_SquadLeaderWidgetComp)
            m_SquadLeaderWidgetComp.SetImage(m_sImageset, m_sIconName, ASPECT_RATIO_FLAG, SIZE_FLAG);   
        
        UpdatePlayerAffiliation();
        m_bDoGroupSymbolUpdate = false;
    }
    
    //------------------------------------------------------------------------------------------------
    protected void UpdateGroupText()
    {
        if (!m_Group)
        {
            AssignGroup();
            return;
        }
        
        string customName = m_Group.GetCustomName();
        if (customName != string.Empty)
            SetText(customName);
        else 
        {
            string company, platoon, squad, character, format;
            m_Group.GetCallsigns(company, platoon, squad, character, format);
                
            SetText(WidgetManager.Translate(format, company, platoon, squad, character));
        }
        
        if (m_SquadLeaderWidgetComp)
            m_SquadLeaderWidgetComp.SetText(m_sText);
        
        m_bDoGroupTextUpdate = false;
    }
    
    //------------------------------------------------------------------------------------------------
    void UpdatePlayerAffiliation()
    {   
        if (!m_wRoot)
            return;
        
        if (m_Group.IsPlayerInGroup(GetGame().GetPlayerController().GetPlayerId()))
            m_SquadLeaderWidgetComp.SetGroupActive(true, m_Group.GetFactionName());
        else
            m_SquadLeaderWidgetComp.SetGroupActive(false);
    }
    
    //------------------------------------------------------------------------------------------------
    protected void OnUserSettingsChanged()
    {
        m_bDoGroupTextUpdate = true;
    }
    
    //------------------------------------------------------------------------------------------------
    protected void OnFlagSelected()
    {
        m_bDoGroupSymbolUpdate = true;
    }
    
    //------------------------------------------------------------------------------------------------
    // OVERRIDES
    //------------------------------------------------------------------------------------------------
    override protected void OnMapLayerChanged(int layerID)
    {
        super.OnMapLayerChanged(layerID);
        
        if (m_SquadLeaderWidgetComp)
            m_SquadLeaderWidgetComp.SetLayerID(layerID);
    }
    
    //------------------------------------------------------------------------------------------------
    override void OnCreateMarker()
    {
        RplComponent rplComp = RplComponent.Cast(FindComponent(RplComponent));
        if (rplComp.IsOwner())  // authority only
        {
            IEntity ent = GetGame().GetPlayerManager().GetPlayerControlledEntity(m_PlayerID);
            if (ent)
                SetTarget(ent);
        }
        
        Faction markerFaction = SCR_FactionManager.SGetPlayerFaction(m_PlayerID);   
        Faction localFaction = SCR_FactionManager.SGetLocalPlayerFaction(); 
        if (!localFaction || localFaction.IsFactionEnemy(markerFaction))    // markers could still get streamed in rare cases due to distance based streaming, in which case we check for faction and dont display
            return; 
            
        super.OnCreateMarker();
        
        m_bDoGroupSymbolUpdate = true;
        m_bDoGroupTextUpdate = true;
        
        m_SquadLeaderWidgetComp = SCR_MapMarkerSquadLeaderComponent.Cast(m_MarkerWidgetComp);
        
        GetGame().OnUserSettingsChangedInvoker().Insert(OnUserSettingsChanged);
        SCR_AIGroup.GetOnFlagSelected().Insert(OnFlagSelected);
    }
    
    //------------------------------------------------------------------------------------------------
    override void OnDelete()
    {
        super.OnDelete();
        
        GetGame().OnUserSettingsChangedInvoker().Remove(OnUserSettingsChanged);
        SCR_AIGroup.GetOnFlagSelected().Remove(OnFlagSelected);
    }
    
    //------------------------------------------------------------------------------------------------
    override void OnUpdate()
    {
        if (!m_wRoot)
            return;
        
        super.OnUpdate();
        
        if (m_bDoGroupSymbolUpdate)
            UpdateGroupMilitarySymbol();
        
        if (m_bDoGroupTextUpdate)
            UpdateGroupText();
        
        if (m_SquadLeaderWidgetComp.m_bIsHovered)
            m_SquadLeaderWidgetComp.UpdateGroupInfoPosition(m_iScreenX, m_iScreenY);
    }
    
    //------------------------------------------------------------------------------------------------
    override protected void EOnInit(IEntity owner)
    {
        super.EOnInit(owner);
        
        m_fUpdateDelay = SL_UPDATE_DELAY;
    }
    
    //------------------------------------------------------------------------------------------------
    void ~SCR_MapMarkerSquadLeader()
    {
        if (m_ConfigEntry)
            SCR_MapMarkerEntrySquadLeader.Cast(m_ConfigEntry).UnregisterMarker(m_Group);
    }
}