ActionTurnOffHeadtorch Class Reference

Inheritance diagram for ActionTurnOffHeadtorch:

Collaboration diagram for ActionTurnOffHeadtorch:

Private Member Functions
void	ActionTurnOffHeadtorch ()
override bool	IsInstant ()
override bool	HasTarget ()
override bool	UseMainItem ()
override void	CreateConditionComponents ()
override	GetInputType ()
override bool	ActionCondition (PlayerBase player, ActionTarget target, ItemBase item)
override void	Start (ActionData action_data)

Detailed Description

Definition at line 1 of file ActionTurnOffHeadtorch.c.

Constructor & Destructor Documentation

ActionTurnOffHeadtorch()

void ActionTurnOffHeadtorch::ActionTurnOffHeadtorch ( )

inlineprivate

Definition at line 3 of file ActionTurnOffHeadtorch.c.

  {
  }

Member Function Documentation

ActionCondition()

override bool ActionTurnOffHeadtorch::ActionCondition ( PlayerBase player, ActionTarget target, ItemBase item )

inlineprivate

Definition at line 33 of file ActionTurnOffHeadtorch.c.

  {
    Headtorch_ColorBase headtorch;
    headtorch = Headtorch_ColorBase.Cast(target.GetObject());
    if (!headtorch)
      return false;
 
    if (headtorch.HasEnergyManager() && headtorch.GetCompEM().CanSwitchOff()) //TODO review conditions for turning off
      return true;
 
    return false;
  }

CreateConditionComponents()

override void ActionTurnOffHeadtorch::CreateConditionComponents ( )

inlineprivate

Definition at line 22 of file ActionTurnOffHeadtorch.c.

  {
    m_ConditionItem = new CCINone;
    m_ConditionTarget = new CCTNonRuined(UAMaxDistances.DEFAULT);
  }

References UAMaxDistances::DEFAULT, m_ConditionItem, and m_ConditionTarget.

GetInputType()

override ActionTurnOffHeadtorch::GetInputType ( )

inlineprivate

Definition at line 28 of file ActionTurnOffHeadtorch.c.

  {
    return ToggleLightsActionInput;
  }

HasTarget()

override bool ActionTurnOffHeadtorch::HasTarget ( )

inlineprivate

Definition at line 12 of file ActionTurnOffHeadtorch.c.

  {
    return true;
  }

IsInstant()

override bool ActionTurnOffHeadtorch::IsInstant ( )

inlineprivate

Definition at line 7 of file ActionTurnOffHeadtorch.c.

  {
    return true;
  }

Start()

override void ActionTurnOffHeadtorch::Start ( ActionData action_data )

inlineprivate

Definition at line 46 of file ActionTurnOffHeadtorch.c.

  {
    super.Start(action_data);
 
    Headtorch_ColorBase headtorch;
    headtorch = Headtorch_ColorBase.Cast(action_data.m_Target.GetObject());
    if (headtorch.HasEnergyManager())
    {
      if (headtorch.GetCompEM().IsSwitchedOn())
        headtorch.GetCompEM().SwitchOff();
    }
  }

UseMainItem()

override bool ActionTurnOffHeadtorch::UseMainItem ( )

inlineprivate

Definition at line 17 of file ActionTurnOffHeadtorch.c.

  {
    return false;
  }

---

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

• scripts/4_World/Classes/UserActionsComponent/Actions/SingleUse/ActionTurnOffHeadtorch.c