ActionMineBase Class Reference

Inheritance diagram for ActionMineBase:

Collaboration diagram for ActionMineBase:

Private Member Functions
override ActionData	CreateActionData ()
override void	OnActionInfoUpdate (PlayerBase player, ActionTarget target, ItemBase item)
string	GetYieldName (PlayerBase player, ActionTarget target, ItemBase item)
Private Member Functions inherited from ActionContinuousBase
void	OnStartAnimationLoopServer (ActionData action_data)
void	OnStartAnimationLoopClient (ActionData action_data)
void	OnEndAnimationLoopServer (ActionData action_data)
void	OnEndAnimationLoopClient (ActionData action_data)
void	OnFinishProgressServer (ActionData action_data)
void	OnFinishProgressClient (ActionData action_data)

Private Attributes
EHarvestType	m_HarvestType = EHarvestType.NORMAL

Detailed Description

Definition at line 16 of file ActionMineTree.c.

Member Function Documentation

CreateActionData()

override ActionData ActionMineBase::CreateActionData ( )

inlineprivate

Definition at line 20 of file ActionMineTree.c.

  {
    MineActionData data = new MineActionData;
    data.m_HarvestType = m_HarvestType;
    return data;
  }

References m_HarvestType.

GetYieldName()

string ActionMineBase::GetYieldName ( PlayerBase player, ActionTarget target, ItemBase item )

inlineprivate

Definition at line 32 of file ActionMineTree.c.

  {
    //given the circumstances, the implementation bellow is the path of least resistance
    Object targetObject = target.GetObject();
    WoodBase wood = WoodBase.Cast(targetObject);
    RockBase rock = RockBase.Cast(targetObject);
    string yieldName;
    if (wood || rock)
    {
      map<string, int> output_map = new map<string, int>;
      if (wood)
        wood.GetMaterialAndQuantityMapEx(item, output_map, m_HarvestType);
      else
        rock.GetMaterialAndQuantityMap(item, output_map);
      if (output_map.Count() > 0)
        yieldName = MiscGameplayFunctions.GetItemDisplayName(output_map.GetKey(0));
    }
    return yieldName;
  }

References m_HarvestType, and WoodBase().

Referenced by OnActionInfoUpdate().

OnActionInfoUpdate()

override void ActionMineBase::OnActionInfoUpdate ( PlayerBase player, ActionTarget target, ItemBase item )

inlineprivate

Definition at line 27 of file ActionMineTree.c.

  {
    m_Text = "#harvest" + " " + GetYieldName(player, target, item);
  }

References GetYieldName(), and m_Text.

Member Data Documentation

m_HarvestType

EHarvestType ActionMineBase::m_HarvestType = EHarvestType.NORMAL

private

Definition at line 18 of file ActionMineTree.c.

Referenced by CreateActionData(), and GetYieldName().

---

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

• scripts/4_World/Classes/UserActionsComponent/Actions/Continuous/ActionMineTree.c